zerc20-client-sdk 0.2.1 → 0.3.0

package/README.md

@@ -94,6 +94,7 @@ src/
 │   ├── invoice.ts      # Invoice creation
 │   ├── teleport.ts     # Single teleport proof
 │   ├── teleportProof.ts # Batch teleport proof (Nova + Decider)
+│   ├── relay/          # Relay node HTTP client (redeem/swap)
 │   ├── liquidityManager/ # Wrap/unwrap with slippage protection
 │   └── layerzeroScan/   # LayerZero message tracking & decoding
 ├── wasm/         # WASM runtime & bindings
@@ -170,6 +171,39 @@ const quote = await buildCrossUnwrapQuote({
 });
 ```
 
+### Relay Operations
+
+Interact with a relay node for relayer-based redeem and token-to-native swap flows:
+
+```typescript
+import {
+  estimateRelayFee,
+  fetchSwapQuote,
+  submitRelaySwap,
+  submitRelayTeleport,
+} from "zerc20-client-sdk";
+
+const fee = await estimateRelayFee("https://relay.example", 1);
+
+const quote = await fetchSwapQuote("https://relay.example", { chainId: 1, amount: 1_000_000n });
+if (quote.priceFallback) {
+  console.warn("Relay is using fallback oracle prices");
+}
+
+await submitRelaySwap("https://relay.example", {
+  chainId: 1,
+  tokenAmount: 1_000_000n,
+  minNativeAmount: 900_000n,
+  maxNativeAmount: quote.nativeAmount,
+  recipient: "0x...",
+  owner: "0x...",
+  permitDeadline: 1_700_000_000n,
+  permitV: 27,
+  permitR: "0x...",
+  permitS: "0x...",
+});
+```
+
 ### Adaptor Withdraw (Stuck Fund Recovery)
 
 When a cross-chain unwrap fails (e.g. due to Stargate liquidity shortage), user funds may remain in the destination chain's Adaptor contract. The SDK provides functions to detect and recover these stuck funds:
@@ -445,15 +479,6 @@ npm test
 npm run typecheck
 ```
 
-## Tests
-
-```bash
-npm test
-```
-
-**Current (as of 2026-03-05): 943 passed, 2 skipped**
-Note: This number will drift over time; treat `npm test` output as the source of truth.
-
 ### Skipped Tests
 
 1. **`src/zkp/__tests__/runNovaProver.test.ts`**