feat: add examples

examples/onchain_list-address-transactions/README.md

@@ -0,0 +1,7 @@
+# List address transactions - Onchain Data
+
+Run
+
+```sh
+$ bun run index.ts
+```

examples/onchain_list-address-transactions/index.ts

@@ -0,0 +1,15 @@
+import { createClient } from "@coinbase-platform/onchain";
+
+const apiKey = process.env.API_KEY;
+if (!apiKey) throw new Error("API_KEY not found");
+
+const client = createClient({ apiKey });
+
+const response = await client.listAddressTransactions([
+  {
+    address: "0x0e73fc61bb9d6b7588910c2d14e83bae68222c5d",
+    pageSize: 2,
+  },
+]);
+
+console.log(response);

examples/onchain_list-address-transactions/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@examples/onchain_list-address-transactions",
+  "private": true,
+  "module": "index.ts",
+  "type": "module",
+  "dependencies": {
+    "@coinbase-platform/onchain": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

examples/onchain_list-address-transactions/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}

examples/onchain_list-balance-details/README.md

@@ -0,0 +1,7 @@
+# List balance details - Onchain Data
+
+Run
+
+```sh
+$ bun run index.ts
+```

examples/onchain_list-balance-details/index.ts

@@ -0,0 +1,16 @@
+import { createClient } from "@coinbase-platform/onchain";
+
+const apiKey = process.env.API_KEY;
+if (!apiKey) throw new Error("API_KEY not found");
+
+const client = createClient({ apiKey });
+
+const response = await client.listBalanceDetails([
+  {
+    address: "1dice6GV5Rz2iaifPvX7RMjfhaNPC8SXH",
+    assetId: "6ecc0dcc-10a2-500e-b315-a3b9abae19ce",
+    pageSize: 1,
+  },
+]);
+
+console.log(response);

examples/onchain_list-balance-details/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@examples/onchain_list-balance-details",
+  "private": true,
+  "module": "index.ts",
+  "type": "module",
+  "dependencies": {
+    "@coinbase-platform/onchain": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

examples/onchain_list-balance-details/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}

examples/onchain_list-balance-histories/README.md

@@ -0,0 +1,7 @@
+# List balance histories - Onchain Data
+
+Run
+
+```sh
+$ bun run index.ts
+```

examples/onchain_list-balance-histories/index.ts

@@ -0,0 +1,15 @@
+import { createClient } from "@coinbase-platform/onchain";
+
+const apiKey = process.env.API_KEY;
+if (!apiKey) throw new Error("API_KEY not found");
+
+const client = createClient({ apiKey });
+
+const response = await client.listBalanceHistories([
+  {
+    address: "0x0e73fc61bb9d6b7588910c2d14e83bae68222c5d",
+    assetId: "123d82ca-b3f4-527c-ace7-559d5791a564",
+  },
+]);
+
+console.log(response);

examples/onchain_list-balance-histories/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@examples/onchain_list-balance-histories",
+  "private": true,
+  "module": "index.ts",
+  "type": "module",
+  "dependencies": {
+    "@coinbase-platform/onchain": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

examples/onchain_list-balance-histories/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}

examples/onchain_list-balances/README.md

@@ -0,0 +1,7 @@
+# List balances - Onchain Data
+
+Run
+
+```sh
+$ bun run index.ts
+```

examples/onchain_list-balances/index.ts

@@ -0,0 +1,15 @@
+import { createClient } from "@coinbase-platform/onchain";
+
+const apiKey = process.env.API_KEY;
+if (!apiKey) throw new Error("API_KEY not found");
+
+const client = createClient({ apiKey });
+
+const response = await client.listBalances([
+  {
+    address: "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789",
+    pageSize: 1,
+  },
+]);
+
+console.log(response);

examples/onchain_list-balances/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@examples/onchain_list-balances",
+  "private": true,
+  "module": "index.ts",
+  "type": "module",
+  "dependencies": {
+    "@coinbase-platform/onchain": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

examples/onchain_list-balances/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}

examples/onchain_rpc-client/README.md

@@ -0,0 +1,7 @@
+# RPC client- Onchain Data
+
+Run
+
+```sh
+$ bun run index.ts
+```

examples/onchain_rpc-client/index.ts

@@ -0,0 +1,18 @@
+import { createRpcClient } from "@coinbase-platform/onchain";
+
+const apiKey = process.env.API_KEY;
+if (!apiKey) throw new Error("API_KEY not found");
+
+const rpc = createRpcClient({ apiKey });
+
+const response = await rpc.request({
+  method: "cdp_listBalances",
+  parameters: [
+    {
+      address: "0x0e73fc61bb9d6b7588910c2d14e83bae68222c5d",
+      pageSize: 2,
+    },
+  ],
+});
+
+console.log(response);

examples/onchain_rpc-client/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@examples/onchain_rpc-client",
+  "private": true,
+  "module": "index.ts",
+  "type": "module",
+  "dependencies": {
+    "@coinbase-platform/onchain": "workspace:*"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

examples/onchain_rpc-client/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}

packages/onchain/package.json

@@ -20,10 +20,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "keywords": [
-    "coinbase",
-    "coinbase platform"
-  ],
+  "keywords": ["coinbase", "coinbase platform"],
   "scripts": {
     "build": "pnpm clean && tsup",
     "clean": "rimraf ./dist",
@@ -49,10 +46,7 @@
     },
     "./package.json": "./package.json"
   },
-  "files": [
-    "src",
-    "dist"
-  ],
+  "files": ["src", "dist"],
   "engine": {
     "node": "^18.0.0 || >=20.0.0"
   }

pnpm-workspace.yaml

@@ -1,2 +1,3 @@
 packages:
   - 'packages/*'
+  - 'examples/*'