@sperax/tool-helius
v0.2.2
Published
Explore Solana on-chain data: token balances, transactions, NFTs, priority fees, and name resolution via Helius API — an agent tool for SperaxOS.
Downloads
675
Maintainers
Readme
@sperax/tool-helius
Explore Solana on-chain data: token balances, transactions, NFTs, priority fees, and name resolution via Helius API
Helius (Solana) is an agent tool from SperaxOS, packaged headless so you can call
it from any agent framework. It ships two things: the manifest — a JSON-Schema function
definition a model can call — and the executor that runs the call against the real API.
There is no UI layer and no framework lock-in. It works anywhere TypeScript runs.
Install
npm install @sperax/tool-heliusUsage
Call it directly
import { heliusExecutor } from '@sperax/tool-helius';
const result = await heliusExecutor.invoke('getTokenBalances', {"address":"<address>","showZeroBalance":"<showZeroBalance>"}, {
messageId: 'msg-1',
});
console.log(result.content); // prose summary written for the model to read
console.log(result.state); // typed data payload for your own UIGive it to a model
import Anthropic from '@anthropic-ai/sdk';
import { HeliusManifest, heliusExecutor } from '@sperax/tool-helius';
const client = new Anthropic();
const response = await client.messages.create({
model: 'claude-opus-4-8',
max_tokens: 1024,
messages: [{ role: 'user', content: 'Ask something this tool can answer' }],
tools: HeliusManifest.api.map((api) => ({
name: api.name,
description: api.description,
input_schema: api.parameters,
})),
});
for (const block of response.content) {
if (block.type !== 'tool_use') continue;
const result = await heliusExecutor.invoke(block.name, block.input, { messageId: response.id });
console.log(result.content);
}HeliusManifest.api is already in JSON-Schema form, so it maps onto any tool-calling API —
Anthropic, OpenAI, the Vercel AI SDK, or an MCP server — without translation.
Every executor returns a BuiltinToolResult — { success, content, state }. content is
prose written for the model to read; state is the typed data payload for your own code.
Executors never throw: a failed call comes back as { success: false, content: '<reason>' },
so a network blip degrades the answer instead of crashing the agent loop.
Configuration — required
This tool needs a backend you control. It will not work on a bare npm install alone.
The upstream API requires a secret key. That key is deliberately not bundled here —
shipping it in an npm package would leak it to every consumer. Instead the executor calls
a SperaxOS /webapi/* route, which holds the key server-side and injects it. That route
is session-authenticated, so the public deployment at https://chat.sperax.io (the
default origin) answers 401 to anonymous callers.
To use this tool you need one of:
- a SperaxOS deployment of your own, or
- any HTTP endpoint that implements the same request shape and supplies the key.
Point the package at it before importing the tool — the URL is resolved once, when the module first loads:
SPERAX_API_BASE_URL=https://my-speraxos.example.comor in code:
import { configureSperaxApi } from '@sperax/agent-tools-core';
configureSperaxApi({ baseUrl: 'https://my-speraxos.example.com' });
// import the tool only after configuring, so the path resolves against your origin
const { heliusExecutor } = await import('@sperax/tool-helius');Inside a browser that already serves those routes at its own origin, requests stay same-origin and no configuration is needed.
If you want a tool that runs with zero setup, use one of the standalone tools — those call public APIs directly and need no key, no origin, and no backend.
Tool identifier
sperax-helius
API reference
getTokenBalances
Get all SPL token balances for a Solana wallet including SOL, token names, symbols, prices, and USD values. Displays a token portfolio card in chat.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| address | string | yes | Solana wallet address (base58) |
| showZeroBalance | boolean | no | Include zero-balance tokens (default false) |
getTransactionHistory
Get enhanced, parsed transaction history for a Solana wallet. Shows human-readable transaction types (TRANSFER, SWAP, NFT_SALE, etc.), descriptions, and token movements.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| address | string | yes | Solana wallet address (base58) |
| limit | number | no | Number of transactions to return (default 10, max 100) |
| type | string | no | Filter by transaction type (e.g. TRANSFER, SWAP, NFT_SALE, NFT_MINT, COMPRESSED_NFT_MINT) |
getAssetsByOwner
Get all NFTs and digital assets owned by a Solana wallet using the DAS (Digital Asset Standard) API. Supports regular NFTs and compressed NFTs (cNFTs).
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| address | string | yes | Solana wallet address (base58) |
| limit | number | no | Number of assets per page (default 20, max 1000) |
| page | number | no | Page number for pagination (default 1) |
getAssetDetails
Get detailed metadata for a specific NFT or digital asset on Solana. Returns name, description, image, attributes/traits, collection, creators, and royalty info.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| assetId | string | yes | Asset mint address or ID |
getPriorityFees
Get current Solana priority fee estimates for different urgency levels (min, low, medium, high, very high). Helps decide how much priority fee to set for transactions.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| accountKeys | array | no | Optional list of account keys to scope fee estimates to specific programs |
resolveAddress
Resolve a .sol domain name to a Solana address, or look up if an address has an associated .sol domain. Uses Solana Name Service (SNS).
| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| input | string | yes | .sol domain name (e.g. "toly.sol") or Solana address |
Types
Shared types come from @sperax/agent-tools-core:
BuiltinToolManifest, BuiltinToolResult, BuiltinToolContext, and the BaseExecutor
class every tool executor extends.
Related
@sperax/agent-tools-core— the tool contract- All SperaxOS agent tools — tool-helius is one of many
- SperaxOS — the agent workspace these tools were built for
License
Apache-2.0
