> ## Documentation Index
> Fetch the complete documentation index at: https://www.helius.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Helius TypeScript SDK para Agentes
> Guia completo do Helius TypeScript SDK para agentes de IA. Métodos com tipagem de segurança para API DAS, transações, Helius Sender, webhooks, WebSockets, staking, compressão ZK e inscrição programática.
O [Helius TypeScript SDK](https://github.com/helius-labs/helius-sdk) fornece métodos com tipagem de segurança para todas as APIs Helius, tornando-se a maneira mais rápida para os agentes interagirem com Solana.
* **Pacote**: `helius-sdk` (npm / pnpm / yarn)
* **Versão**: 2.x (usa `@solana/kit`, não `@solana/web3.js`)
* **Tempo de Execução**: Qualquer tempo de execução JavaScript — navegadores, Deno, Bun, tempos de execução na borda (Cloudflare Workers, Vercel Edge), Node.js 20+
* **TypeScript**: 5.8+ (definições de tipo completas incluídas)
* **Licença**: ISC
## Instalação
```bash theme={"system"}
npm install helius-sdk
```
## Começo Rápido
```typescript theme={"system"}
import { createHelius } from "helius-sdk";
const helius = createHelius({
apiKey: "YOUR_API_KEY",
network: "mainnet", // or "devnet"
});
// Get all NFTs and tokens owned by a wallet
const assets = await helius.getAssetsByOwner({
ownerAddress: "86xCnPeV69n6t3DnyGvkKobf9FdN2H9oiVDdaMpo2MMY",
page: 1,
limit: 50,
});
// Get transaction history (with token account activity)
const txs = await helius.getTransactionsForAddress([
"86xCnPeV69n6t3DnyGvkKobf9FdN2H9oiVDdaMpo2MMY",
{ limit: 100, transactionDetails: "full", filters: { tokenAccounts: "balanceChanged" } },
]);
// Send a transaction via Helius Sender (ultra-low latency)
const sig = await helius.tx.sendTransactionWithSender({
instructions: [transferInstruction],
signers: [walletSigner],
region: "US_EAST",
});
```
## Opções do Cliente
```typescript theme={"system"}
const helius = createHelius({
apiKey: "YOUR_API_KEY", // Required for webhooks, enhanced txs, wallet API
network: "mainnet", // "mainnet" (default) or "devnet"
baseUrl: "https://custom..", // Override RPC URL (optional)
rebateAddress: "wallet", // Wallet for RPC rebates (optional)
userAgent: "my-agent/1.0", // Sent as X-Helius-Client header (optional)
});
```
## Namespaces
Todos os métodos são acessados através do cliente `helius`. Os métodos da API DAS e os métodos padrão do RPC Solana estão disponíveis diretamente no `helius.*`. Outras funcionalidades são organizadas em namespaces:
| Namespace | Acesso | Finalidade |
| ------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| DAS API | `helius.getAsset()`, `helius.getAssetsByOwner()`, etc. | Consultar NFTs, tokens, ativos comprimidos |
| RPC V2 | `helius.getTransactionsForAddress()`, `helius.getProgramAccountsV2()` | RPC aprimorado com paginação e filtros |
| Transações | `helius.tx.*` | Transações inteligentes e Helius Sender |
| Aprimorado | `helius.enhanced.*` | Parsear transações em formato legível |
| Webhooks | `helius.webhooks.*` | Criar e gerenciar assinaturas de webhook |
| WebSockets | `helius.ws.*` | Fluxos de dados em tempo real da blockchain |
| Staking | `helius.stake.*` | Fazer stake de SOL para o validador Helius |
| Compressão ZK | `helius.zk.*` | Contas comprimidas e provas |
| Wallet API | `helius.wallet.*` | Saldos, histórico, consultas de identidade |
| RPC Padrão | `helius.getBalance()`, `helius.getSlot()`, etc. | Todos os métodos padrão RPC Solana via proxy |
| RPC Bruto | `helius.raw` | Acesso direto ao cliente Rpc subjacente `@solana/kit` |
| Auth | `import { makeAuthClient } from "helius-sdk/auth/client"` | Inscrição do agente e gerenciamento de chave de API (importação independente) |
## Inscrição Programática (Módulo Auth)
O módulo auth é uma importação independente — não está no principal `HeliusClient`. Use-o para fluxos de inscrição programática de agentes.
```typescript theme={"system"}
import { makeAuthClient } from "helius-sdk/auth/client";
const auth = makeAuthClient();
// 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 }
```
## Explorações Detalhadas
Padrões recomendados, paginação, erros comuns e tratamento de erros
Lista completa de métodos para cada namespace
## Recursos
Código-fonte, exemplos e acompanhamento de problemas
Exemplos funcionais para cada método organizados por namespace
Documentação completa da API gerada a partir do código-fonte
Atualização de @solana/web3.js para @solana/kit