@helium/blockchain-api 0.1.1 → 0.1.3

package/README.md

@@ -1,6 +1,6 @@
 # @helium/blockchain-api
 
-TypeScript types for the Helium Blockchain API. Provides full type safety when building clients for the Helium blockchain services.
+TypeScript types and Zod schemas for the Helium Blockchain API. Provides full type safety when building clients for the Helium blockchain services.
 
 ## Installation
 
@@ -12,7 +12,7 @@ yarn add @helium/blockchain-api
 
 ## Peer Dependencies
 
-- `@orpc/server` ^1.12.0
+- `@orpc/client` ^1.12.0
 - `zod` ^4.0.0
 
 ## Usage
@@ -52,6 +52,18 @@ const { transactionData } = await client.hotspots.claimRewards({
 })
 ```
 
+### Using Zod schemas for validation
+
+```typescript
+import { HotspotSchema, TokenAccountSchema } from "@helium/blockchain-api"
+
+// Validate data
+const hotspot = HotspotSchema.parse(rawData)
+
+// Type inference
+type Hotspot = z.infer<typeof HotspotSchema>
+```
+
 ### With TanStack Query
 
 ```typescript
@@ -77,10 +89,20 @@ const { data, isLoading } = orpc.tokens.getBalances.useQuery({
 
 ## Exports
 
+### Types
 - `ORPCRouter` - The full router type
 - `BlockchainAPIClient` - Helper type for typed clients
 - `RouterClient` - Re-exported from @orpc/server
 
+### Zod Schemas
+- `HotspotSchema`, `HotspotsDataSchema` - Hotspot data validation
+- `TokenAccountSchema`, `TokenBalanceDataSchema` - Token data validation
+- `TransactionDataSchema`, `TransactionItemSchema` - Transaction validation
+- `QuoteResponseSchema` - Swap quote validation
+- `WelcomePackSchema` - Welcome pack validation
+- `BankAccountSchema`, `KycStatusOutputSchema` - Fiat/KYC validation
+- And many more input/output schemas for each router
+
 ## License
 
 Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helium/blockchain-api",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "TypeScript types for the Helium Blockchain API",
   "license": "Apache-2.0",
   "repository": {
@@ -11,21 +11,21 @@
   "types": "./types/index.ts",
   "files": [
     "types/",
-    "src/server/api/",
     "tsconfig.json"
   ],
   "exports": {
     ".": {
       "types": "./types/index.ts",
-      "default": "./types/index.ts"
+      "import": "./types/generated/index.mjs",
+      "require": "./types/generated/index.js"
     }
   },
   "peerDependencies": {
-    "@orpc/server": "^1.12.0",
+    "@orpc/client": "^1.12.0",
     "zod": "^4.0.0"
   },
   "peerDependenciesMeta": {
-    "@orpc/server": {
+    "@orpc/client": {
       "optional": false
     },
     "zod": {
@@ -33,19 +33,21 @@
     }
   },
   "scripts": {
-    "prepublishOnly": "mv README.md DEV_README.md && cp types/README.md README.md && npm run lint && echo 'Ready to publish!'",
+    "build:types": "tsup",
+    "prepublishOnly": "yarn build:types && 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",
     "start": "next start",
-    "lint": "prettier --check \"src/**/*.{js,ts,tsx}\" && eslint src/",
+    "lint": "prettier --check --write \"src/**/*.{js,ts,tsx}\" && eslint src/",
     "background-service": "node scripts/start-background-service.js",
     "test:e2e": "mocha -r @swc-node/register \"tests/e2e/**/*.test.ts\" --timeout 100000",
     "test:e2e:file": "mocha -r @swc-node/register --timeout 100000"
   },
-  "dependencies": {
+  "devDependencies": {
     "@coral-xyz/anchor": "^0.31.1",
+    "@eslint/eslintrc": "^3.3.3",
     "@helium/cron-sdk": "^0.0.10",
     "@helium/distributor-oracle": "^0.11.6",
     "@helium/helium-entity-manager-sdk": "^0.11.6",
@@ -80,25 +82,41 @@
     "@radix-ui/react-slot": "^1.2.3",
     "@solana/spl-token": "^0.4.13",
     "@solana/web3.js": "^1.98.2",
+    "@swc-node/register": "^1.11.1",
+    "@swc/core": "^1.13.5",
+    "@swc/register": "^0.1.10",
     "@t3-oss/env-nextjs": "^0.13.8",
+    "@tailwindcss/postcss": "^4",
     "@tanstack/react-query": "^5.80.10",
     "@types/bn.js": "^5.2.0",
+    "@types/chai": "^5.2.3",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^20",
     "@types/node-cron": "^3.0.11",
+    "@types/pg": "^8.15.4",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
     "angry-purple-tiger": "^1.0.5",
     "aws-sdk": "^2.1692.0",
     "axios": "^1.10.0",
     "bn.js": "^5.2.2",
+    "chai": "^6.2.0",
     "class-variance-authority": "^0.7.1",
     "classnames": "^2.5.1",
     "clsx": "^2.1.1",
+    "dotenv": "^17.2.2",
+    "eslint": "^9",
+    "eslint-config-next": "15.4.6",
     "jito-ts": "^4.2.0",
     "js-sha256": "^0.11.1",
     "lucide-react": "^0.522.0",
+    "mocha": "^11.7.5",
     "next": "^16.0.10",
     "next-themes": "^0.4.6",
     "node-cron": "^4.2.1",
     "pg": "^8.16.2",
     "pg-hstore": "^2.3.4",
+    "prettier": "^3.7.4",
     "qrcode.react": "^4.2.0",
     "react": "^19.0.0",
     "react-async-hook": "^4.0.0",
@@ -106,38 +124,20 @@
     "react-hook-form": "^7.60.0",
     "react-jazzicon": "^1.0.4",
     "sequelize": "^6.37.7",
+    "sequelize-cli": "^6.6.3",
     "sonner": "^2.0.5",
     "sqlite3": "^5.1.7",
     "tailwind-merge": "^3.3.1",
-    "uuid": "^11.1.0",
-    "zod": "^4.0.5"
-  },
-  "devDependencies": {
-    "@eslint/eslintrc": "^3.3.3",
-    "@swc-node/register": "^1.11.1",
-    "@swc/core": "^1.13.5",
-    "@swc/register": "^0.1.10",
-    "@tailwindcss/postcss": "^4",
-    "@types/chai": "^5.2.3",
-    "@types/mocha": "^10.0.10",
-    "@types/node": "^20",
-    "@types/pg": "^8.15.4",
-    "@types/react": "^19",
-    "@types/react-dom": "^19",
-    "chai": "^6.2.0",
-    "dotenv": "^17.2.2",
-    "eslint": "^9",
-    "eslint-config-next": "15.4.6",
-    "mocha": "^11.7.5",
-    "prettier": "^3.7.4",
-    "sequelize-cli": "^6.6.3",
     "tailwindcss": "^4",
     "ts-node": "^10.9.2",
+    "tsup": "^8.5.1",
     "tsx": "^4.19.2",
     "tw-animate-css": "^1.3.4",
     "typescript": "^5",
+    "uuid": "^11.1.0",
     "why-is-node-running": "^3.2.2",
-    "yaml": "^2.8.1"
+    "yaml": "^2.8.1",
+    "zod": "^4.0.5"
   },
   "packageManager": "yarn@1.22.21+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72"
 }

package/types/README.md

@@ -1,6 +1,6 @@
 # @helium/blockchain-api
 
-TypeScript types for the Helium Blockchain API. Provides full type safety when building clients for the Helium blockchain services.
+TypeScript types and Zod schemas for the Helium Blockchain API. Provides full type safety when building clients for the Helium blockchain services.
 
 ## Installation
 
@@ -12,7 +12,7 @@ yarn add @helium/blockchain-api
 
 ## Peer Dependencies
 
-- `@orpc/server` ^1.12.0
+- `@orpc/client` ^1.12.0
 - `zod` ^4.0.0
 
 ## Usage
@@ -52,6 +52,18 @@ const { transactionData } = await client.hotspots.claimRewards({
 })
 ```
 
+### Using Zod schemas for validation
+
+```typescript
+import { HotspotSchema, TokenAccountSchema } from "@helium/blockchain-api"
+
+// Validate data
+const hotspot = HotspotSchema.parse(rawData)
+
+// Type inference
+type Hotspot = z.infer<typeof HotspotSchema>
+```
+
 ### With TanStack Query
 
 ```typescript
@@ -77,10 +89,20 @@ const { data, isLoading } = orpc.tokens.getBalances.useQuery({
 
 ## Exports
 
+### Types
 - `ORPCRouter` - The full router type
 - `BlockchainAPIClient` - Helper type for typed clients
 - `RouterClient` - Re-exported from @orpc/server
 
+### Zod Schemas
+- `HotspotSchema`, `HotspotsDataSchema` - Hotspot data validation
+- `TokenAccountSchema`, `TokenBalanceDataSchema` - Token data validation
+- `TransactionDataSchema`, `TransactionItemSchema` - Transaction validation
+- `QuoteResponseSchema` - Swap quote validation
+- `WelcomePackSchema` - Welcome pack validation
+- `BankAccountSchema`, `KycStatusOutputSchema` - Fiat/KYC validation
+- And many more input/output schemas for each router
+
 ## License
 
 Apache-2.0