@bigmaxwatermelon/sdk 0.4.0 → 0.4.2

package/README.md

@@ -1,8 +1,8 @@
-# @isometry/sdk
+# @bigmaxwatermelon/sdk
 
 > TypeScript SDK for the Isometry DeFi protocol — Ethereum Sepolia.
 
-**npm:** `@isometry/sdk`  
+**npm:** `@bigmaxwatermelon/sdk`  
 **version:** `0.4.0`  
 **network:** Ethereum Sepolia (chain ID 11155111)  
 **registry:** npm
@@ -12,17 +12,84 @@
 ## Installation
 
 ```bash
-npm install @isometry/sdk ethers
+# npm (recommended)
+npm install @bigmaxwatermelon/sdk
+
+# 国内镜像未同步时，使用 tarball 直装
+npm install https://registry.npmjs.org/@bigmaxwatermelon/sdk/-/sdk-0.4.0.tgz
+```
+
+**Requires:**  
+- Node.js ≥ 18  
+- ESM only (`type: module` in your project)  
+
+> ⚠️ This package is ESM-only. Use `import`, not `require`. If you use TypeScript, set `"module": "NodeNext"` or `"moduleResolution": "Bundler"`.
+
+---
+
+## Quick Start — SDK
+
+```typescript
+import { createClient } from '@bigmaxwatermelon/sdk'
+
+const client = createClient({
+  rpcUrl: process.env.SEPOLIA_RPC_URL ?? 'https://ethereum-sepolia.publicnode.com',
+  graphUrl: 'https://console.isometry.network/graph/subgraphs/name/isometry',
+  addresses: {
+    platform: '0x062B11C5Ed0F2b1f9B7dFaa7B95737dD221863F7',
+    factory:  '0x73D6BC64f4f54F9dF05851216F70F42135d56864',
+  },
+})
+
+// Read platform info
+const info = await client.rpc.platform.getPlatformInfo()
+console.log(info)
 ```
 
-Requires Node.js ≥ 20.
+---
+
+## Quick Start — CLI
+
+```bash
+# Check version / connectivity
+npx @bigmaxwatermelon/sdk isometry system version
+
+# Read data
+npx @bigmaxwatermelon/sdk isometry platform info --json
+npx @bigmaxwatermelon/sdk isometry token info <token-address> --json
+
+# Simulate a write (dry-run, no signer needed)
+npx @bigmaxwatermelon/sdk isometry token mint <token> <to> <amount> --simulate --json
+```
+
+> 💡 All CLI commands support `--json` for machine-readable output.
+
+---
+
+## Write Operations
+
+Write operations (mint, burn, pause, etc.) require a signer.
+
+**Environment variable:**
+```bash
+export ISOMETRY_PRIVATE_KEY=0x_your_private_key_here
+```
+
+**Always simulate before executing:**
+```bash
+isometry token mint <token> <to> <amount> --simulate --json
+# → Confirms the transaction looks correct, then:
+isometry token mint <token> <to> <amount> --json
+```
+
+---
 
 ---
 
 ## Quick Start
 
 ```typescript
-import { createClient } from '@isometry/sdk'
+import { createClient } from '@bigmaxwatermelon/sdk'
 
 const client = createClient({
   rpcUrl: process.env.SEPOLIA_RPC_URL,
@@ -42,7 +109,7 @@ console.log(info)
 ### Initialize Client
 
 ```typescript
-import { createClient } from '@isometry/sdk'
+import { createClient } from '@bigmaxwatermelon/sdk'
 
 const client = createClient({
   // Required for RPC calls
@@ -105,7 +172,7 @@ const platformStats = await client.graph.analytics.platformStats()
 ### Write — Simulate Before Execute
 
 ```typescript
-import { WriteExecutor } from '@isometry/sdk'
+import { WriteExecutor } from '@bigmaxwatermelon/sdk'
 
 // Create client with private key for signing
 const writeClient = createClient({
@@ -153,14 +220,14 @@ The CLI is included in the same package.
 ### Install globally
 
 ```bash
-npm install -g @isometry/sdk
+npm install -g @bigmaxwatermelon/sdk
 isometry --version
 ```
 
 ### Or run via npx
 
 ```bash
-npx @isometry/sdk token info 0xd0473e07c68797f387fbe6c23981f7997d3ed5e3
+npx @bigmaxwatermelon/sdk token info 0xd0473e07c68797f387fbe6c23981f7997d3ed5e3
 ```
 
 ### Or link locally
@@ -216,32 +283,32 @@ Full API reference at [docs/API.md](docs/API.md).
 
 ```typescript
 // Client
-import { createClient } from '@isometry/sdk'
-import type { IsometryClient, IsometryConfig } from '@isometry/sdk'
+import { createClient } from '@bigmaxwatermelon/sdk'
+import type { IsometryClient, IsometryConfig } from '@bigmaxwatermelon/sdk'
 
 // Wallet
-import { createWallet, ReadOnlyWallet, PrivateKeyWallet } from '@isometry/sdk'
-import type { IWallet, WalletMode } from '@isometry/sdk'
+import { createWallet, ReadOnlyWallet, PrivateKeyWallet } from '@bigmaxwatermelon/sdk'
+import type { IWallet, WalletMode } from '@bigmaxwatermelon/sdk'
 
 // Write executor
-import { WriteExecutor, makeWriteMeta } from '@isometry/sdk'
-import type { WriteResult, SimulateResult, ExecuteResult, WriteError, WriteOpts, WriteMeta, TxReceipt } from '@isometry/sdk'
+import { WriteExecutor, makeWriteMeta } from '@bigmaxwatermelon/sdk'
+import type { WriteResult, SimulateResult, ExecuteResult, WriteError, WriteOpts, WriteMeta, TxReceipt } from '@bigmaxwatermelon/sdk'
 
 // Error decoding
-import { decodeError, ERROR_SELECTOR_MAP } from '@isometry/sdk'
-import type { DecodedError } from '@isometry/sdk'
+import { decodeError, ERROR_SELECTOR_MAP } from '@bigmaxwatermelon/sdk'
+import type { DecodedError } from '@bigmaxwatermelon/sdk'
 
 // Graph
-import { createGraphClient, GraphClient, GraphError } from '@isometry/sdk'
-import type { IsometryGraphConfig } from '@isometry/sdk'
-import { TokenHistoryService, PlatformHistoryService, AnalyticsService } from '@isometry/sdk'
+import { createGraphClient, GraphClient, GraphError } from '@bigmaxwatermelon/sdk'
+import type { IsometryGraphConfig } from '@bigmaxwatermelon/sdk'
+import { TokenHistoryService, PlatformHistoryService, AnalyticsService } from '@bigmaxwatermelon/sdk'
 
 // Contract helpers
-import { getContracts, getStableCoin } from '@isometry/sdk'
-import type { ContractAddresses } from '@isometry/sdk'
+import { getContracts, getStableCoin } from '@bigmaxwatermelon/sdk'
+import type { ContractAddresses } from '@bigmaxwatermelon/sdk'
 
 // Types
-import type { PlatformInfo, PlatformRoles, TokenInfo, TokenStats, TokenRoles } from '@isometry/sdk'
+import type { PlatformInfo, PlatformRoles, TokenInfo, TokenStats, TokenRoles } from '@bigmaxwatermelon/sdk'
 ```
 
 ---
@@ -304,7 +371,7 @@ All write operations return a typed `WriteResult`:
 ## Architecture
 
 ```
-@isometry/sdk
+@bigmaxwatermelon/sdk
 ├── dist/index.js       # SDK entry
 ├── dist/cli.js         # CLI entry (bin: isometry)
 └── docs/