@helium/blockchain-api 0.2.3 → 0.3.0

package/README.md

@@ -13,50 +13,25 @@ yarn add @helium/blockchain-api
 ## Quick Start
 
 ```typescript
-import { createClient } from "@helium/blockchain-api";
-
-const client = createClient({
-  url: "https://api.helium.com",
-  transport: "rpc",
-});
-
-// Get token balances
-const balances = await client.tokens.getBalances({
-  walletAddress: "YOUR_WALLET_ADDRESS",
-});
-
-// Get hotspots
-const hotspots = await client.hotspots.getHotspots({
-  walletAddress: "YOUR_WALLET_ADDRESS",
-  type: "iot",
-  page: 1,
-  limit: 20,
-});
-```
-
-## Authentication
-
-For protected endpoints, provide a context factory:
-
-```typescript
-const client = createClient({
-  url: "https://api.helium.com",
-  transport: "rpc",
-  getContext: () => ({
-    userId: currentUser.id,
-    walletAddress: connectedWallet?.address ?? null,
-    user: privyUser,
+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: "<RPC_URL>",
+  headers: () => ({
+    //...
   }),
+  // fetch: <-- provide fetch polyfill fetch if needed
+  interceptors: [
+    onError((error) => {
+      console.error(error);
+    }),
+  ],
 });
-```
-
-Or use an access token:
-
-```typescript
-const client = createClient({
-  url: "https://api.helium.com",
-  accessToken: "your-access-token",
-});
+// Create a client using an imported contract
+const client: ContractRouterClient<typeof apiContract> = createORPCClient(link);
 ```
 
 ## Schema Validation
@@ -77,41 +52,12 @@ const input = GetBalancesInputSchema.parse({
 
 ## Error Handling
 
-Typed error definitions are available:
-
-```typescript
-import { createClient, INSUFFICIENT_FUNDS, solanaErrors } from "@helium/blockchain-api";
-
-try {
-  await client.tokens.transfer({ ... });
-} catch (error) {
-  if (error.code === INSUFFICIENT_FUNDS.code) {
-    console.error("Not enough SOL:", error.data);
-  }
-}
-```
+See https://orpc.dev/docs/client/error-handling
 
-## Testing with Mock Client
+Typed error definitions are available:
 
 ```typescript
-import { createMockClient } from "@helium/blockchain-api";
-
-const mockClient = createMockClient({
-  tokens: {
-    getBalances: async () => ({
-      totalBalanceUsd: 100,
-      solBalance: 1,
-      solBalanceUsd: 50,
-      tokens: [],
-    }),
-  },
-  health: {
-    check: async () => ({ ok: true }),
-  },
-});
-
-// Use in tests
-const result = await mockClient.tokens.getBalances({ walletAddress: "..." });
+import { INSUFFICIENT_FUNDS } from "@helium/blockchain-api";
 ```
 
 ## API Reference