@helium/blockchain-api

TypeScript client and schemas for the Helium Blockchain API.

Installation

``bash
npm install @helium/blockchain-api


or


yarn add @helium/blockchain-api
`

Quick Start

`typescript
import { apiContract } from "@helium/blockchain-api";
import { createORPCClient, onError } from "@orpc/client";
import { RPCLink } from "@orpc/client/fetch";
import { ContractRouterClient } from "@orpc/contract";

const link = new RPCLink({
url: "",
headers: () => ({
//...
}),
// fetch: <-- provide fetch polyfill fetch if needed
interceptors: [
onError((error) => {
console.error(error);
}),
],
});
// Create a client using an imported contract
const client: ContractRouterClient = createORPCClient(link);
`

Schema Validation

All Zod schemas are exported for direct use:

`typescript
import {
GetBalancesInputSchema,
TokenBalanceDataSchema,
} from "@helium/blockchain-api";

// Validate input
const input = GetBalancesInputSchema.parse({
walletAddress: userInput,
});
`

Error Handling

See https://orpc.dev/docs/client/error-handling

Typed error definitions are available:

`typescript
import { INSUFFICIENT_FUNDS } from "@helium/blockchain-api";
`

API Reference

$3

- health - Health check
- tokens - Token balances and transfers
- hotspots - Hotspot management and rewards
- swap - Token swaps via Jupiter
- transactions - Transaction submission and tracking
- welcomePacks - Welcome pack management
- fiat - Fiat offramp and bank accounts
- webhooks` - Webhook handlers

License

Apache-2.0