Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions AGENTS.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ https://www.helius.dev/docs/agents/rust-sdk.md
```bash
npm install -g helius-cli
helius keygen
# Fund wallet: 1 USDC + ~0.001 SOL
helius signup --json
# (Autopay only) Fund the keypair with ~0.001 SOL + plan USDC — skip if paying via the hosted link.
helius signup --email you@example.com --first-name Jane --last-name Doe --json
```

Success response:
Expand All @@ -64,8 +64,14 @@ Or use the TypeScript SDK auth module for in-process signup (no CLI needed):
```typescript
import { makeAuthClient } from "helius-sdk/auth/client";
const auth = makeAuthClient();
const result = await auth.agenticSignup({ secretKey: keypair.secretKey });
// result: { jwt, walletAddress, projectId, apiKey, endpoints, credits }
const result = await auth.signupAndPay({
secretKey: keypair.secretKey,
plan: "agent",
email: "you@example.com",
firstName: "Ada",
lastName: "Lovelace",
});
// result.kind: "completed" | "pending" | "expired" | "failed" | "already_subscribed" | "upgrade_required"
```

## Use Helius APIs Instead Of Standard Solana RPC
Expand Down
18 changes: 10 additions & 8 deletions agents/claude-code-plugin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,21 +82,23 @@ The plugin auto-starts the MCP server, but you still need a Helius API key. On f

Just tell Claude: "Set my Helius API key to `YOUR_API_KEY`"
</Tab>
<Tab title="Autonomous Signup">
Create a new account entirely within Claude Code — no browser needed. Each step is an action on `heliusAccount`:
<Tab title="Signup">
Create a new account from Claude Code via a hosted payment link or autopay. Each step is an action on `heliusAccount`:

1. Claude calls `heliusAccount` with `action: "generateKeypair"` — creates a Solana wallet
2. You fund the wallet with **~0.001 SOL** + **1 USDC**
3. Claude calls `heliusAccount` with `action: "checkSignupBalance"` to verify
4. Claude calls `heliusAccount` with `action: "agenticSignup"` — API key is configured automatically
2. Claude calls `heliusAccount` with `action: "signup"` and `mode: "link"` — returns a payment URL you open in a browser to pay with any wallet (or `mode: "autopay"` to pay USDC from the local keypair automatically)
3. After paying via link, Claude calls `heliusAccount` with `action: "signup"` and `mode: "resume"` — finalizes provisioning and configures the API key automatically
</Tab>
<Tab title="CLI">
Use the [Helius CLI](/agents/cli) from the terminal:

```bash
npx helius-cli@latest keygen # Generate keypair
# Fund wallet with ~0.001 SOL + 1 USDC
npx helius-cli@latest signup # Create account
npx helius-cli@latest keygen
npx helius-cli@latest signup --plan agent --email you@example.com --first-name Jane --last-name Doe # Print hosted payment link
# (pay in browser, then:)
npx helius-cli@latest signup --resume # Finalize account
# Or autopay from the local keypair:
npx helius-cli@latest signup --plan agent --pay --email you@example.com --first-name Jane --last-name Doe
```
</Tab>
</Tabs>
Expand Down
47 changes: 26 additions & 21 deletions agents/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ Get your key from [dashboard.helius.dev](https://dashboard.helius.dev). That's i

## Quick Start — New Users

<Note>
All `helius signup` invocations require `--email`, `--first-name`, and `--last-name` — including the Agent plan.
</Note>

<Steps>
<Step title="Generate a keypair">
```bash
Expand All @@ -44,21 +48,22 @@ Get your key from [dashboard.helius.dev](https://dashboard.helius.dev). That's i
• ~0.001 SOL for transaction fees
• 1 USDC for Helius signup
```
</Step>
<Step title="Fund the wallet">
Send funds to the wallet address from the previous step:

| Asset | Amount | Purpose |
|-------|--------|---------|
| SOL | ~0.001 | Transaction fees + rent |
| [USDC](https://orbmarkets.io/token/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v) | 1+ | Plan payment (see pricing below) |
The funding hint above only applies if you'll use autopay — skip funding if you plan to pay via the hosted link.
</Step>
<Step title="Create account">
Two payment modes: hosted link (pay from any wallet, nothing to fund) or autopay (pay USDC from the local keypair, which must hold ~0.001 SOL + the plan amount).

```bash
helius signup
```
# Default: print a hosted payment link, pay with any wallet in the browser
helius signup --email you@example.com --first-name Jane --last-name Doe

# After paying via link, finalize the account
helius signup --resume

This checks balances, sends the USDC payment, and creates your Helius account and project.
# Or autopay from the local keypair
helius signup --plan agent --pay --email you@example.com --first-name Jane --last-name Doe
```
</Step>
<Step title="Get your API keys and endpoints">
```bash
Expand All @@ -79,20 +84,20 @@ You can purchase any Helius shared plan directly through the CLI. Pass `--plan`

| Plan | Price | Credits | `--plan` value |
|------|-------|---------|----------------|
| Agent (Basic) | $1 one-time | 1,000,000 | `basic` |
| Agent | $1 one-time | 1,000,000 | `agent` |
| Developer | $49/mo | 10,000,000 | `developer` |
| Business | $499/mo | 100,000,000 | `business` |
| Professional | $999/mo | 200,000,000 | `professional` |

<Note>
The **Agent** plan (`basic`) is the default. It costs $1 (paid in USDC) to prevent abuse and gives you 1,000,000 credits. For higher rate limits and more credits, sign up with a paid plan or upgrade later.
The **Agent** plan (`agent`) is the default. It costs $1 (paid in USDC) to prevent abuse and gives you 1,000,000 credits. For higher rate limits and more credits, sign up with a paid plan or upgrade later.
</Note>

### Signup with a specific plan

```bash
# Default: Agent plan ($1)
helius signup
helius signup --email you@example.com --first-name Jane --last-name Doe

# Developer plan ($49/mo)
helius signup --plan developer --email you@example.com --first-name Jane --last-name Doe
Expand Down Expand Up @@ -209,20 +214,20 @@ All commands accept these flags:
# Step 1: Generate keypair
helius keygen

# Step 2: Fund wallet externally
# Send ~0.001 SOL + 1 USDC to the address

# Step 3: Create account
helius signup
# Step 2: Create account (default: hosted payment link, pay from any wallet)
helius signup --email you@example.com --first-name Jane --last-name Doe
helius signup --resume # Finalize after paying via link
# Or autopay from the local keypair (requires ~0.001 SOL + plan USDC):
# helius signup --plan agent --pay --email you@example.com --first-name Jane --last-name Doe

# Step 4: Get API keys
# Step 3: Get API keys
helius projects
helius apikeys <project-id>

# Step 5: Get RPC endpoints
# Step 4: Get RPC endpoints
helius rpc <project-id>

# Step 6: Start querying
# Step 5: Start querying
helius balance <address>
helius asset owner <wallet-address>
helius tx history <address> --limit 10
Expand Down
2 changes: 1 addition & 1 deletion agents/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Create Helius accounts, generate keypairs, authenticate, upgrade plans, and pay
| Command | Description |
|---------|-------------|
| `helius keygen` | Generate a new Solana keypair |
| `helius signup` | Create a Helius account (requires `--email`, `--first-name`, `--last-name`; supports `--plan`, `--period`, `--coupon`) |
| `helius signup` | Create a Helius account (requires `--email`, `--first-name`, `--last-name`; supports `--plan`, `--period`, `--coupon`, `--pay`, `--resume`) |
| `helius login` | Authenticate with an existing wallet |
| `helius upgrade` | Upgrade your plan (requires `--email`, `--first-name`, `--last-name`; supports `--plan`, `--period`, `--coupon`) |
| `helius pay <id>` | Pay an existing payment intent (e.g., renewal) |
Expand Down
16 changes: 11 additions & 5 deletions agents/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Get an API key from https://dashboard.helius.dev or programmatically via the Hel

The Helius MCP server is the recommended way for AI agents to interact with Helius. It provides 10 routed tools with structured inputs/outputs — the AI calls tools directly rather than spawning shell commands and parsing output. Use the CLI only for shell scripts, CI/CD, or when MCP is not available.

- MCP: Structured tool calls (9 routed domain tools — `heliusAccount`, `heliusWallet`, `heliusAsset`, `heliusTransaction`, `heliusChain`, `heliusStreaming`, `heliusKnowledge`, `heliusWrite`, `heliusCompression` — plus `expandResult` for paging large responses), built-in signup via `heliusAccount` actions (`generateKeypair` → `agenticSignup`), works with Claude Code, Codex, Cursor, VS Code, Claude Desktop, Windsurf, and any MCP-compatible tool
- MCP: Structured tool calls (9 routed domain tools — `heliusAccount`, `heliusWallet`, `heliusAsset`, `heliusTransaction`, `heliusChain`, `heliusStreaming`, `heliusKnowledge`, `heliusWrite`, `heliusCompression` — plus `expandResult` for paging large responses), built-in signup via `heliusAccount` actions (`generateKeypair` → `signup`), works with Claude Code, Codex, Cursor, VS Code, Claude Desktop, Windsurf, and any MCP-compatible tool
- CLI: Shell commands with `--json` output, for terminal workflows and automation scripts

## Pages
Expand Down Expand Up @@ -110,8 +110,8 @@ https://www.helius.dev/docs/agents/rust-sdk/api-reference.md
```bash
npm install -g helius-cli
helius keygen
# Fund wallet: 1 USDC + ~0.001 SOL
helius signup --json
# (Autopay only) Fund wallet with plan USDC + ~0.001 SOL — skip if paying via the hosted link
helius signup --email you@example.com --first-name Jane --last-name Doe --json
```

Success response:
Expand All @@ -132,8 +132,14 @@ Or use the TypeScript SDK auth module for in-process signup (no CLI needed):
```typescript
import { makeAuthClient } from "helius-sdk/auth/client";
const auth = makeAuthClient();
const result = await auth.agenticSignup({ secretKey: keypair.secretKey });
// result: { jwt, walletAddress, projectId, apiKey, endpoints, credits }
const result = await auth.signupAndPay({
secretKey: keypair.secretKey,
plan: "agent",
email: "you@example.com",
firstName: "Ada",
lastName: "Lovelace",
});
// result.kind: "completed" | "pending" | "expired" | "failed" | "already_subscribed" | "upgrade_required"
```

## Use Helius APIs Instead Of Standard Solana RPC
Expand Down
32 changes: 16 additions & 16 deletions agents/mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ The [Helius MCP server](https://www.npmjs.com/package/helius-mcp) gives AI tools
<Card title="9 Routed Tools" icon="bolt">
Domain-grouped tools (`heliusWallet`, `heliusAsset`, `heliusTransaction`, …) — every Helius action is reachable through one of them
</Card>
<Card title="Autonomous Signup" icon="robot">
Create a Helius account and get an API key entirely within Claude — no browser needed
<Card title="Account Signup" icon="robot">
Create a Helius account from your AI tool — pay via hosted link or autopay USDC from a local keypair
</Card>
<Card title="Real-Time Data" icon="signal-stream">
Subscribe to Enhanced WebSockets and LaserStream gRPC directly from your AI tool
Expand Down Expand Up @@ -65,7 +65,7 @@ The Helius docs site at [helius.dev/docs](https://www.helius.dev/docs) also expo
2. `HELIUS_API_KEY` environment variable
3. `~/.helius/config.json` (set via the [Helius CLI](/agents/cli))

**If you need a new account:** See [Autonomous Signup](#autonomous-signup) below.
**If you need a new account:** See [Signup](#signup) below.
</Step>
<Step title="Start using tools">
Ask questions in plain English — the right tool and action are selected automatically:
Expand Down Expand Up @@ -258,35 +258,35 @@ Heavy responses are **summary-first**. Routed tools return a compact summary plu

This keeps token usage low for exploratory queries while still letting agents drill into the full payload when needed.

## Autonomous Signup
## Signup

Create a Helius account entirely within your AI tool — no browser needed. The signup flow runs through the `heliusAccount` routed tool:
Create a Helius account from your AI tool through a hosted payment link or by paying USDC directly from a local keypair. The signup flow runs through the `heliusAccount` routed tool:

<Steps>
<Step title="Generate a keypair">
The AI calls `heliusAccount` with `action: "generateKeypair"` — it creates a Solana wallet and returns the address.
</Step>
<Step title="Fund the wallet">
Send **~0.001 SOL** (transaction fees) + **1 USDC** (basic plan costs $1) to the wallet address.
<Step title="Create the payment intent">
The AI calls `heliusAccount` with `action: "signup"` and `mode: "link"` — returns a `paymentUrl` (e.g. `https://dashboard.helius.dev/pay/<id>`) the user opens to pay with any wallet. Or pass `mode: "autopay"` to send USDC from the local keypair automatically (wallet must hold ~0.001 SOL + the plan amount in USDC).
</Step>
<Step title="Verify balance">
The AI calls `heliusAccount` with `action: "checkSignupBalance"` to confirm funds arrived.
</Step>
<Step title="Create account">
The AI calls `heliusAccount` with `action: "agenticSignup"` — processes the USDC payment, creates the Helius account, and configures the API key automatically.
<Step title="Resume after payment">
After paying via link, the AI calls `heliusAccount` with `action: "signup"` and `mode: "resume"` — polls the payment intent, finalizes account provisioning, and configures the API key automatically.
</Step>
</Steps>

<Note>
**Paid plans (Developer / Business / Professional):** `agenticSignup` and `upgradePlan` require `email`, `firstName`, and `lastName`. The basic Agent plan does not.
**Contact info:** every new signup — including the Agent plan — requires `email`, `firstName`, and `lastName`. `upgradePlan` requires the same.
</Note>

Or do the same from the terminal with the [Helius CLI](/agents/cli):

```bash
npx helius-cli@latest keygen # Generate keypair
# Fund the wallet address with ~0.001 SOL + 1 USDC
npx helius-cli@latest signup # Create account
npx helius-cli@latest keygen
npx helius-cli@latest signup --plan agent --email you@example.com --first-name Jane --last-name Doe # Print hosted payment link
# (pay in browser, then:)
npx helius-cli@latest signup --resume # Finalize account
# Or autopay from the local keypair:
npx helius-cli@latest signup --plan agent --pay --email you@example.com --first-name Jane --last-name Doe
```

## Network Configuration
Expand Down
8 changes: 4 additions & 4 deletions agents/mcp/tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@ Account setup, auth, plans, and billing — including the autonomous signup flow
| `setHeliusApiKey` | Configure your API key |
| `setNetwork` | Switch between mainnet and devnet for the session |
| `generateKeypair` | Create a Solana wallet for signup |
| `checkSignupBalance` | Verify wallet has enough SOL + USDC |
| `agenticSignup` | Pay USDC and create a Helius account (paid plans require `email`, `firstName`, `lastName`) |
| `signup` | Create a Helius account via hosted payment link. `mode: "link"` returns a payment URL the user opens in a browser; `mode: "autopay"` pays USDC from the local keypair; `mode: "resume"` polls a previously created intent. Every new signup (all plans, including Agent) requires `email`, `firstName`, `lastName`. |
| `getAccountStatus` | Check account status and credits |
| `getHeliusPlanInfo` | Get your current plan details |
| `compareHeliusPlans` | Compare available plans |
| `previewUpgrade` | Preview cost of upgrading |
| `upgradePlan` | Upgrade your plan (requires `email`, `firstName`, `lastName`) |
| `payRenewal` | Pay plan renewal |
| `upgradePlan` | Upgrade your plan. `mode: "link"` returns a payment URL; `mode: "autopay"` pays USDC from the local keypair. Requires `email`, `firstName`, `lastName`. |
| `payRenewal` | Pay a plan renewal. `mode: "link"` returns a payment URL; `mode: "autopay"` pays USDC from the local keypair. |
| `purchaseCredits` | Buy prepaid credits (one-time top-up). `mode: "link"` returns a payment URL; `mode: "autopay"` pays USDC from the local keypair. |

## heliusWallet

Expand Down
6 changes: 3 additions & 3 deletions agents/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The [Helius MCP server](/agents/mcp) is the recommended way for AI agents to int
| **Best for** | AI agents in Claude Code, Cursor, Claude Desktop, and any MCP-compatible tool | Shell scripts, CI/CD pipelines, terminal workflows |
| **Interface** | Structured tool calls with typed inputs/outputs | Command-line with `--json` output |
| **Capabilities** | 10 routed tools (`heliusWallet`, `heliusAsset`, `heliusTransaction`, …) covering blockchain queries, transactions, webhooks, streaming, wallet analysis, docs, and signup | 95+ commands: same capabilities plus config management and interactive flows |
| **Account setup** | Built-in: `heliusAccount` actions `generateKeypair` → `agenticSignup` — no external tools needed | `helius keygen` → `helius signup` |
| **Account setup** | Built-in: `heliusAccount` actions `generateKeypair` → `signup` (link or autopay) — no external tools needed | `helius keygen` → `helius signup` |
| **When to use** | Default choice for any AI agent | When you need shell-level automation or are not using an MCP-compatible tool |

<Tip>
Expand All @@ -40,8 +40,8 @@ Agents can create a Helius account and get an API key in four steps using the [H
```bash
npm install -g helius-cli # Install CLI
helius keygen # Generate keypair
# Fund wallet with 1 USDC + ~0.001 SOL
helius signup --json # Get API key (JSON output)
# (Autopay only) Fund wallet with 1 USDC + ~0.001 SOL — skip if paying via the hosted link
helius signup --email you@example.com --first-name Jane --last-name Doe --json # Get API key (JSON output)
```

On success, your agent receives an API key, RPC endpoints, and 1,000,000 credits. See the [full CLI guide](/agents/cli) for details.
Expand Down
2 changes: 1 addition & 1 deletion agents/skills/build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The Build skill routes the AI to the correct Helius tools and documentation for
| **Event Pipelines** | Webhooks | `createWebhook`, `getAllWebhooks`, `updateWebhook`, `deleteWebhook` |
| **Wallet Analysis** | Wallet API | `getWalletIdentity`, `getWalletBalances`, `getWalletHistory`, `getWalletTransfers` |
| **Transaction History** | Enhanced Transactions | `parseTransactions` |
| **Onboarding** | CLI, Auth | `generateKeypair`, `agenticSignup`, `setHeliusApiKey` |
| **Onboarding** | CLI, Auth | `generateKeypair`, `signup`, `setHeliusApiKey` |
| **Solana Knowledge** | SIMDs, Source Code, Blog | `getSIMD`, `readSolanaSourceFile`, `fetchHeliusBlog` |

## Prerequisites
Expand Down
31 changes: 20 additions & 11 deletions agents/typescript-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,17 +89,26 @@ import { makeAuthClient } from "helius-sdk/auth/client";

const auth = makeAuthClient();

// All-in-one shortcut:
const result = await auth.agenticSignup({ secretKey: keypair.secretKey });
// result: { jwt, walletAddress, projectId, apiKey, endpoints, credits }

// Or step-by-step:
const keypair = await auth.generateKeypair();
const address = await auth.getAddress(keypair);
const { message, signature } = await auth.signAuthMessage(keypair.secretKey);
const { token } = await auth.walletSignup(message, signature, address);
const project = await auth.createProject(token);
const apiKey = await auth.createApiKey(token, project.id, address);
// Hosted-link signup (returns a paymentUrl the user opens in a browser):
const link = await auth.signup({
secretKey: keypair.secretKey,
plan: "agent",
email: "you@example.com",
firstName: "Ada",
lastName: "Lovelace",
});
// link: { kind: "payment_required", jwt, refId, walletAddress, paymentLink: { paymentUrl, ... } }

// Or pay USDC directly from the local keypair and provision in one call:
const result = await auth.signupAndPay({
secretKey: keypair.secretKey,
plan: "agent",
email: "you@example.com",
firstName: "Ada",
lastName: "Lovelace",
});
// result.kind: "completed" | "pending" | "expired" | "failed" | "already_subscribed" | "upgrade_required"
// On "completed": result has { jwt, walletAddress, projectId, apiKey, endpoints, txSignature }
```

## Deep Dives
Expand Down
6 changes: 3 additions & 3 deletions api-reference/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,15 @@ helius keygen
```
</CodeGroup>

### Fund the Generated Wallet (Manual)
### Fund the Generated Wallet (Autopay only)

Send 1 USDC and 0.001 SOL to the wallet address provided in Step 2.
Skip this step if paying via the hosted payment link (`--pay` / `--resume`). For autopay, send 1 USDC and 0.001 SOL to the wallet address provided in Step 2.

### Signup and Get API Key

<CodeGroup>
```bash
helius signup --json
helius signup --email you@example.com --first-name Jane --last-name Doe --json
```
</CodeGroup>

Expand Down
Loading