@helium/blockchain-api 0.1.0 → 0.1.1

package/README.md

@@ -1,25 +1,86 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# @helium/blockchain-api
 
-## Getting Started
+TypeScript types for the Helium Blockchain API. Provides full type safety when building clients for the Helium blockchain services.
 
-First, setup the indexers and postgres database for solana data. You'll need to get a solana RPC url.
+## Installation
 
+```bash
+npm install @helium/blockchain-api
+# or
+yarn add @helium/blockchain-api
 ```
-SOLANA_URL=<your-rpc-url> docker-compose up
-```
 
-You may need to wait a few minutes until the asset-ownership service is running.
+## Peer Dependencies
+
+- `@orpc/server` ^1.12.0
+- `zod` ^4.0.0
+
+## Usage
+
+### Setting up a typed client
 
-Next, migrate the database:
+```typescript
+import type { BlockchainAPIClient } from "@helium/blockchain-api"
+import { createORPCClient } from "@orpc/client"
+import { RPCLink } from "@orpc/client/fetch"
 
+const link = new RPCLink({
+  url: "https://your-api-url.com/rpc",
+})
+
+const client: BlockchainAPIClient = createORPCClient(link)
 ```
-yarn sequelize-cli db:migrate
+
+### Example API calls
+
+```typescript
+// Get token balances
+const balances = await client.tokens.getBalances({
+  walletAddress: "your-wallet-address"
+})
+
+// Get swap quote
+const quote = await client.swap.getQuote({
+  inputMint: "input-token-mint",
+  outputMint: "output-token-mint",
+  amount: "1000000"
+})
+
+// Claim hotspot rewards
+const { transactionData } = await client.hotspots.claimRewards({
+  walletAddress: "your-wallet-address"
+})
 ```
 
-Now, run the development server:
+### With TanStack Query
 
-```bash
-yarn dev
+```typescript
+import { createRouterUtils } from "@orpc/tanstack-query"
+
+const orpc = createRouterUtils(client)
+
+// In a React component
+const { data, isLoading } = orpc.tokens.getBalances.useQuery({
+  input: { walletAddress: "your-wallet-address" }
+})
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Available Routers
+
+- `hotspots` - Hotspot management, rewards, splits
+- `tokens` - Token balances, transfers
+- `swap` - Jupiter DEX integration
+- `transactions` - Transaction submission/tracking
+- `welcomePacks` - Onboarding rewards
+- `fiat` - Bank accounts, KYC, offramp
+- `health` - Health checks
+
+## Exports
+
+- `ORPCRouter` - The full router type
+- `BlockchainAPIClient` - Helper type for typed clients
+- `RouterClient` - Re-exported from @orpc/server
+
+## License
+
+Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helium/blockchain-api",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "TypeScript types for the Helium Blockchain API",
   "license": "Apache-2.0",
   "repository": {
@@ -33,7 +33,8 @@
     }
   },
   "scripts": {
-    "prepublishOnly": "npm run lint && echo 'Ready to publish!'",
+    "prepublishOnly": "mv README.md DEV_README.md && cp types/README.md README.md && npm run lint && echo 'Ready to publish!'",
+    "postpublish": "mv DEV_README.md README.md",
     "dev": "node scripts/dev-with-background.js",
     "dev:next-only": "next dev --turbopack",
     "build": "next build",

package/types/README.md

@@ -0,0 +1,86 @@
+# @helium/blockchain-api
+
+TypeScript types for the Helium Blockchain API. Provides full type safety when building clients for the Helium blockchain services.
+
+## Installation
+
+```bash
+npm install @helium/blockchain-api
+# or
+yarn add @helium/blockchain-api
+```
+
+## Peer Dependencies
+
+- `@orpc/server` ^1.12.0
+- `zod` ^4.0.0
+
+## Usage
+
+### Setting up a typed client
+
+```typescript
+import type { BlockchainAPIClient } from "@helium/blockchain-api"
+import { createORPCClient } from "@orpc/client"
+import { RPCLink } from "@orpc/client/fetch"
+
+const link = new RPCLink({
+  url: "https://your-api-url.com/rpc",
+})
+
+const client: BlockchainAPIClient = createORPCClient(link)
+```
+
+### Example API calls
+
+```typescript
+// Get token balances
+const balances = await client.tokens.getBalances({
+  walletAddress: "your-wallet-address"
+})
+
+// Get swap quote
+const quote = await client.swap.getQuote({
+  inputMint: "input-token-mint",
+  outputMint: "output-token-mint",
+  amount: "1000000"
+})
+
+// Claim hotspot rewards
+const { transactionData } = await client.hotspots.claimRewards({
+  walletAddress: "your-wallet-address"
+})
+```
+
+### With TanStack Query
+
+```typescript
+import { createRouterUtils } from "@orpc/tanstack-query"
+
+const orpc = createRouterUtils(client)
+
+// In a React component
+const { data, isLoading } = orpc.tokens.getBalances.useQuery({
+  input: { walletAddress: "your-wallet-address" }
+})
+```
+
+## Available Routers
+
+- `hotspots` - Hotspot management, rewards, splits
+- `tokens` - Token balances, transfers
+- `swap` - Jupiter DEX integration
+- `transactions` - Transaction submission/tracking
+- `welcomePacks` - Onboarding rewards
+- `fiat` - Bank accounts, KYC, offramp
+- `health` - Health checks
+
+## Exports
+
+- `ORPCRouter` - The full router type
+- `BlockchainAPIClient` - Helper type for typed clients
+- `RouterClient` - Re-exported from @orpc/server
+
+## License
+
+Apache-2.0