@tapforce/pod-bridge-sdk 2.1.1 → 2.2.1

package/README.md

@@ -6,7 +6,7 @@ TypeScript SDK for bridging tokens between POD and EVM chains (e.g., ETH Mainnet
 
 ```
 ETH -> Pod: Deposit on ETH, AUTO-CLAIM on Pod (no claim TX needed)
-Pod -> ETH: Deposit on Pod, claim on ETH with proof from pod_getBridgeClaimProof RPC
+Pod -> ETH: Withdraw on Pod, claim on ETH with proof from pod_getBridgeClaimProof RPC
 ```
 
 **Key points:**
@@ -120,7 +120,7 @@ const receipt = await tx.wait();
 
 ### Pod -> ETH (Claim with proof)
 
-Deposits on Pod require claiming on ETH with a proof from `pod_getBridgeClaimProof`.
+Withdrawals on Pod require claiming on ETH with a proof from `pod_getBridgeClaimProof`.
 
 ```typescript
 import {
@@ -131,17 +131,18 @@ import {
 
 const client = new PodToSourceChainActionClient(actionConfig);
 
-// Step 1: Deposit on Pod
-const depositTx = client.deposit({
+// Step 1: Withdraw on Pod (specify target chain ID)
+const withdrawTx = client.withdraw({
   token: '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE', // Native token on Pod
-  amount: ethers.parseUnits('1', 6),  // Use ETH-side decimals (1 USDC = 1e6)
+  amount: ethers.parseUnits('1', 6),  // Target chain units (1 USDC = 1e6)
   destinationWalletAddress: '0x...',
+  chainId: 1,  // Target chain ID (e.g. 1 for ETH mainnet)
   from: '0x...',
 });
 
 // Pod requires EIP-1559 gas params (all zeros for free transactions)
 const tx = await podSigner.sendTransaction({
-  ...depositTx,
+  ...withdrawTx,
   maxFeePerGas: 0n,
   maxPriorityFeePerGas: 0n,
   gasLimit: 0n,
@@ -153,7 +154,7 @@ const { proof, auxTxSuffix } = await getBridgeClaimProof(podProvider, tx.hash);
 // Step 3: Claim on ETH
 const claimData: ClaimProofData = {
   ethTokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // USDC on ETH
-  amount: ethers.parseUnits('1', 6),  // Must match deposited amount
+  amount: ethers.parseUnits('1', 6),  // Must match withdrawn amount
   to: '0x...',
   proof,
   auxTxSuffix,
@@ -211,17 +212,15 @@ deposit(args: {
 
 ### PodToSourceChainActionClient
 
-For Pod -> ETH deposits and claims.
+For Pod -> ETH withdrawals and claims.
 
 ```typescript
-// Deposit tokens on Pod
-deposit(args: {
+// Withdraw tokens on Pod
+withdraw(args: {
   token: string;                    // Use 0xEeee...EEeE for native token
-  amount: string | bigint;          // Use ETH-side decimals
+  amount: string | bigint;          // Target chain units (e.g. 1e6 for USDC)
   destinationWalletAddress: string;
-  callContract?: string;            // Contract to call after deposit (default: address(0))
-  reserveBalance?: string | bigint; // Amount to reserve when using callContract (default: 0)
-  permit?: string;                  // Optional permit bytes (default: '0x')
+  chainId: number | bigint;         // Target chain ID for claiming
   from?: string;
 }): UnsignedTransaction
 
@@ -282,8 +281,9 @@ interface BridgeRequest {
     destination: string;
     token: string;
     amount: string;
-    callContract?: string;   // Contract called after deposit (address(0) for simple bridge)
-    reserveBalance?: string; // Amount reserved when using callContract ('0' for simple bridge)
+    callContract?: string;   // Contract called after deposit (address(0) for simple bridge) — ETH only
+    reserveBalance?: string; // Amount reserved when using callContract ('0' for simple bridge) — ETH only
+    targetChainId?: number;  // Target chain ID for claiming (Pod→ETH direction)
     chainId: number;
     blockNumber: number;
     timestamp: number;       // Unix timestamp (seconds)
@@ -305,7 +305,7 @@ interface BridgeRequest {
 
 ## Events
 
-The bridge contracts emit different events per chain (id type differs):
+The bridge contracts emit different events per chain:
 
 ```solidity
 // ETH (Source Chain)
@@ -313,7 +313,7 @@ event Deposit(uint256 indexed id, address indexed from, address indexed to, addr
 event Claim(bytes32 indexed txHash, address token, address mirrorToken, uint256 amount, address indexed to);
 
 // Pod
-event Deposit(bytes32 indexed id, address indexed from, address indexed to, address token, uint256 amount, address callContract, uint256 reserveBalance);
+event Withdraw(bytes32 indexed id, address indexed from, address indexed to, address token, uint256 amount, uint256 chainId);
 ```
 
 ## ABIs
@@ -321,7 +321,7 @@ event Deposit(bytes32 indexed id, address indexed from, address indexed to, addr
 The SDK exports separate ABIs for each chain:
 
 - `SOURCE_CHAIN_BRIDGE_ABI` - ETH bridge (6-param deposit with callContract/reserveBalance/permit, claim with proof)
-- `POD_BRIDGE_ABI` - Pod bridge (6-param deposit, bytes32 id events)
+- `POD_BRIDGE_ABI` - Pod bridge (withdraw with chainId, Withdraw events with bytes32 id)
 - `BRIDGE_ABI` - Alias for `SOURCE_CHAIN_BRIDGE_ABI`
 
 ## Pod-specific Notes

package/dist/clients/action/pod-to-source-chain-client.d.ts

@@ -2,13 +2,13 @@ import { UnsignedTransaction, ClaimProofData, PodBridgeActionsClientConfig } fro
 /**
  * PodToSourceChainActionClient - Handles Pod -> ETH bridging
  *
- * - User deposits tokens on Pod
- * - Call pod_getBridgeClaimProof(depositTxHash) to get proof
+ * - User withdraws tokens on Pod (specifying target chainId)
+ * - Call pod_getBridgeClaimProof(withdrawTxHash) to get proof
  * - User claims on ETH with proof + auxTxSuffix
  *
  * Important notes:
- * - Token addresses on Pod and ETH are different (deposit AAAA on Pod, claim BBBB on ETH)
- * - For USDC-like tokens, use ETH-side decimals (e.g. parseUnits('1', 6) for USDC)
+ * - Token addresses on Pod and ETH are different (withdraw AAAA on Pod, claim BBBB on ETH)
+ * - Amount is in target chain units (e.g. parseUnits('1', 6) for USDC with 6 decimals)
  * - Pod system contract handles balance internally - do NOT set tx value
  */
 export declare class PodToSourceChainActionClient {
@@ -17,32 +17,38 @@ export declare class PodToSourceChainActionClient {
     private readonly sourceChainIface;
     constructor(config: PodBridgeActionsClientConfig);
     /**
-     * Create unsigned transaction for depositing tokens from Pod to ETH
+     * Create unsigned transaction for withdrawing tokens from Pod to ETH
      *
-     * After deposit:
-     * - Call pod_getBridgeClaimProof(depositTxHash) on Pod RPC
+     * After withdraw:
+     * - Call pod_getBridgeClaimProof(withdrawTxHash) on Pod RPC
      * - Call claim() on ETH with the proof
      *
      * Note: Pod system contract handles balance deduction internally.
-     * Do NOT set transaction value - even for native token (0xEeee...EEeE) deposits.
-     * Use ETH-side decimals for amount (e.g. 1e6 for 1 USDC, not 1e18).
+     * Do NOT set transaction value - even for native token (0xEeee...EEeE) withdrawals.
+     * Amount is in target chain units (e.g. 1e6 for 1 USDC with 6 decimals).
      *
-     * @param args.token Token address on Pod to deposit (use 0xEeee...EEeE for native)
-     * @param args.amount Amount to deposit (in ETH-side decimals)
+     * @param args.token Token address on Pod to withdraw (use 0xEeee...EEeE for native)
+     * @param args.amount Amount to withdraw (in target chain decimals)
      * @param args.destinationWalletAddress Recipient address on ETH
-     * @param args.callContract Optional: contract to call after deposit (default: address(0) for simple bridge)
-     * @param args.reserveBalance Optional: amount to keep as reserve when using callContract (default: 0)
-     * @param args.permit Optional permit bytes (default '0x')
+     * @param args.chainId Target chain ID where the claim will happen
      * @param args.from Optional sender address
-     * @returns Unsigned transaction template with encoded deposit call
+     * @returns Unsigned transaction template with encoded withdraw call
+     */
+    withdraw(args: {
+        token: string;
+        amount: string | bigint;
+        destinationWalletAddress: string;
+        chainId: number | bigint;
+        from?: string;
+    }): UnsignedTransaction;
+    /**
+     * @deprecated Use withdraw() instead. deposit() on Pod has been renamed to withdraw().
      */
     deposit(args: {
         token: string;
         amount: string | bigint;
         destinationWalletAddress: string;
-        callContract?: string;
-        reserveBalance?: string | bigint;
-        permit?: string;
+        chainId: number | bigint;
         from?: string;
     }): UnsignedTransaction;
     /**

package/dist/clients/action/pod-to-source-chain-client.js

@@ -6,13 +6,13 @@ const bridge_abi_1 = require("../../libs/abi/bridge.abi");
 /**
  * PodToSourceChainActionClient - Handles Pod -> ETH bridging
  *
- * - User deposits tokens on Pod
- * - Call pod_getBridgeClaimProof(depositTxHash) to get proof
+ * - User withdraws tokens on Pod (specifying target chainId)
+ * - Call pod_getBridgeClaimProof(withdrawTxHash) to get proof
  * - User claims on ETH with proof + auxTxSuffix
  *
  * Important notes:
- * - Token addresses on Pod and ETH are different (deposit AAAA on Pod, claim BBBB on ETH)
- * - For USDC-like tokens, use ETH-side decimals (e.g. parseUnits('1', 6) for USDC)
+ * - Token addresses on Pod and ETH are different (withdraw AAAA on Pod, claim BBBB on ETH)
+ * - Amount is in target chain units (e.g. parseUnits('1', 6) for USDC with 6 decimals)
  * - Pod system contract handles balance internally - do NOT set tx value
  */
 class PodToSourceChainActionClient {
@@ -22,33 +22,29 @@ class PodToSourceChainActionClient {
         this.sourceChainIface = new ethers_1.Interface(bridge_abi_1.SOURCE_CHAIN_BRIDGE_ABI);
     }
     /**
-     * Create unsigned transaction for depositing tokens from Pod to ETH
+     * Create unsigned transaction for withdrawing tokens from Pod to ETH
      *
-     * After deposit:
-     * - Call pod_getBridgeClaimProof(depositTxHash) on Pod RPC
+     * After withdraw:
+     * - Call pod_getBridgeClaimProof(withdrawTxHash) on Pod RPC
      * - Call claim() on ETH with the proof
      *
      * Note: Pod system contract handles balance deduction internally.
-     * Do NOT set transaction value - even for native token (0xEeee...EEeE) deposits.
-     * Use ETH-side decimals for amount (e.g. 1e6 for 1 USDC, not 1e18).
+     * Do NOT set transaction value - even for native token (0xEeee...EEeE) withdrawals.
+     * Amount is in target chain units (e.g. 1e6 for 1 USDC with 6 decimals).
      *
-     * @param args.token Token address on Pod to deposit (use 0xEeee...EEeE for native)
-     * @param args.amount Amount to deposit (in ETH-side decimals)
+     * @param args.token Token address on Pod to withdraw (use 0xEeee...EEeE for native)
+     * @param args.amount Amount to withdraw (in target chain decimals)
      * @param args.destinationWalletAddress Recipient address on ETH
-     * @param args.callContract Optional: contract to call after deposit (default: address(0) for simple bridge)
-     * @param args.reserveBalance Optional: amount to keep as reserve when using callContract (default: 0)
-     * @param args.permit Optional permit bytes (default '0x')
+     * @param args.chainId Target chain ID where the claim will happen
      * @param args.from Optional sender address
-     * @returns Unsigned transaction template with encoded deposit call
+     * @returns Unsigned transaction template with encoded withdraw call
      */
-    deposit(args) {
-        const data = this.podIface.encodeFunctionData('deposit', [
+    withdraw(args) {
+        const data = this.podIface.encodeFunctionData('withdraw', [
             args.token,
             args.amount,
             args.destinationWalletAddress,
-            args.callContract ?? ethers_1.ZeroAddress,
-            args.reserveBalance ?? 0,
-            args.permit ?? '0x',
+            args.chainId,
         ]);
         return {
             to: this.config.pod.contractAddress,
@@ -57,6 +53,12 @@ class PodToSourceChainActionClient {
             from: args?.from
         };
     }
+    /**
+     * @deprecated Use withdraw() instead. deposit() on Pod has been renamed to withdraw().
+     */
+    deposit(args) {
+        return this.withdraw(args);
+    }
     /**
      * Create unsigned transaction for claiming tokens on ETH (source chain)
      *

package/dist/clients/tracker/pod-tracker.service.d.ts

@@ -3,7 +3,7 @@ import { BridgeRequest, PodBridgeChainConfig } from '../../libs/types/pod-bridge
  * PodTrackerService - Handles tracking on the POD Chain
  *
  * Responsibilities:
- * - Fetch deposits made on POD (Pod -> ETH direction)
+ * - Fetch withdrawals made on POD (Pod -> ETH direction)
  *
  * Note: POD returns logs with blockNumber: null which ethers.js can't parse.
  * We use raw eth_getLogs RPC calls and parse logs manually.
@@ -12,26 +12,21 @@ export declare class PodTrackerService {
     private readonly config;
     private readonly provider;
     private readonly iface;
-    /** Interface with uint256 id variant — Pod system contract may emit either bytes32 or uint256 id */
-    private readonly ifaceUint256Id;
     private chainId;
     constructor(config: PodBridgeChainConfig);
     private initChainId;
     ensureChainId(): Promise<void>;
     /**
-     * Get deposits sent by an address on POD
+     * Get withdrawals sent by an address on POD
      */
     getDepositsSentBy(address: string): Promise<BridgeRequest[]>;
     /**
-     * Get deposits received by an address on POD
+     * Get withdrawals received by an address on POD
      */
     getDepositsReceivedBy(address: string): Promise<BridgeRequest[]>;
     /**
-     * Fetch deposits from POD using raw eth_getLogs RPC.
+     * Fetch withdrawals from POD using raw eth_getLogs RPC.
      * Pod returns logs with blockNumber: null, so we can't use ethers queryFilter.
-     *
-     * Queries both bytes32 and uint256 id event topics since Pod system contract
-     * may emit either variant.
      */
-    private getDeposits;
+    private getWithdrawals;
 }

package/dist/clients/tracker/pod-tracker.service.js

@@ -8,7 +8,7 @@ const bridge_abi_1 = require("../../libs/abi/bridge.abi");
  * PodTrackerService - Handles tracking on the POD Chain
  *
  * Responsibilities:
- * - Fetch deposits made on POD (Pod -> ETH direction)
+ * - Fetch withdrawals made on POD (Pod -> ETH direction)
  *
  * Note: POD returns logs with blockNumber: null which ethers.js can't parse.
  * We use raw eth_getLogs RPC calls and parse logs manually.
@@ -19,7 +19,6 @@ class PodTrackerService {
         this.chainId = null;
         this.provider = config.provider;
         this.iface = new ethers_1.Interface(bridge_abi_1.POD_BRIDGE_ABI);
-        this.ifaceUint256Id = new ethers_1.Interface(bridge_abi_1.SOURCE_CHAIN_BRIDGE_ABI);
         this.initChainId();
     }
     async initChainId() {
@@ -37,36 +36,30 @@ class PodTrackerService {
         }
     }
     /**
-     * Get deposits sent by an address on POD
+     * Get withdrawals sent by an address on POD
      */
     async getDepositsSentBy(address) {
-        // Filter by 'from' (second indexed param): Deposit(id, from, to, token, amount)
+        // Filter by 'from' (second indexed param): Withdraw(id, from, to, token, amount, chainId)
         const fromTopic = ethers_1.ethers.zeroPadValue(address, 32);
-        return this.getDeposits([null, fromTopic, null]);
+        return this.getWithdrawals([null, fromTopic, null]);
     }
     /**
-     * Get deposits received by an address on POD
+     * Get withdrawals received by an address on POD
      */
     async getDepositsReceivedBy(address) {
-        // Filter by 'to' (third indexed param): Deposit(id, from, to, token, amount)
+        // Filter by 'to' (third indexed param): Withdraw(id, from, to, token, amount, chainId)
         const toTopic = ethers_1.ethers.zeroPadValue(address, 32);
-        return this.getDeposits([null, null, toTopic]);
+        return this.getWithdrawals([null, null, toTopic]);
     }
     /**
-     * Fetch deposits from POD using raw eth_getLogs RPC.
+     * Fetch withdrawals from POD using raw eth_getLogs RPC.
      * Pod returns logs with blockNumber: null, so we can't use ethers queryFilter.
-     *
-     * Queries both bytes32 and uint256 id event topics since Pod system contract
-     * may emit either variant.
      */
-    async getDeposits(topicFilters) {
+    async getWithdrawals(topicFilters) {
         const deposits = [];
-        // Pod may emit Deposit with bytes32 id or uint256 id — query both topics
-        const bytes32IdTopic = this.iface.getEvent('Deposit').topicHash;
-        const uint256IdTopic = this.ifaceUint256Id.getEvent('Deposit').topicHash;
-        // Use array in first topic position for OR matching (standard EVM eth_getLogs)
+        const withdrawTopic = this.iface.getEvent('Withdraw').topicHash;
         const topics = [
-            [bytes32IdTopic, uint256IdTopic],
+            withdrawTopic,
             ...topicFilters,
         ];
         // Use raw RPC to avoid ethers.js blockNumber validation
@@ -84,10 +77,7 @@ class PodTrackerService {
         for (let i = 0; i < rawLogs.length; i++) {
             const log = rawLogs[i];
             const receipt = receipts[i];
-            // Parse with the matching interface based on which topic was emitted
-            const isUint256Id = log.topics[0] === uint256IdTopic;
-            const parseIface = isUint256Id ? this.ifaceUint256Id : this.iface;
-            const parsed = parseIface.parseLog({
+            const parsed = this.iface.parseLog({
                 topics: log.topics,
                 data: log.data
             });
@@ -103,8 +93,7 @@ class PodTrackerService {
                         destination: parsed.args.to,
                         token: parsed.args.token,
                         amount: parsed.args.amount.toString(),
-                        callContract: parsed.args.callContract,
-                        reserveBalance: parsed.args.reserveBalance.toString(),
+                        targetChainId: Number(parsed.args.chainId),
                         chainId: this.chainId,
                         blockNumber: timestamp,
                         timestamp,

package/dist/libs/abi/bridge.abi.d.ts

@@ -2,7 +2,7 @@
  * ABI for Bridge contract on Source Chain (ETH/Mainnet)
  *
  * ETH -> Pod: deposit on ETH (6-param with callContract, reserveBalance, permit), auto-claim on Pod
- * Pod -> ETH: deposit on Pod, claim on ETH with proof from pod_getBridgeClaimProof RPC
+ * Pod -> ETH: withdraw on Pod, claim on ETH with proof from pod_getBridgeClaimProof RPC
  *
  * New deposit params (callContract, reserveBalance) enable depositing to CLOB orderbook in one TX.
  * For simple bridge deposits: callContract=address(0), reserveBalance=0.
@@ -10,8 +10,8 @@
 export declare const SOURCE_CHAIN_BRIDGE_ABI: string[];
 /**
  * ABI for Bridge system contract on Pod chain.
- * Pod uses bytes32 indexed id in Deposit events (different from ETH's uint256).
- * Same 6-param deposit as source chain.
+ * Pod uses bytes32 indexed id in Withdraw events.
+ * withdraw(token, amount, to, chainId) — chainId is the target chain for claiming.
  */
 export declare const POD_BRIDGE_ABI: string[];
 export declare const BRIDGE_ABI: string[];

package/dist/libs/abi/bridge.abi.js

@@ -5,7 +5,7 @@ exports.BRIDGE_ABI = exports.POD_BRIDGE_ABI = exports.SOURCE_CHAIN_BRIDGE_ABI =
  * ABI for Bridge contract on Source Chain (ETH/Mainnet)
  *
  * ETH -> Pod: deposit on ETH (6-param with callContract, reserveBalance, permit), auto-claim on Pod
- * Pod -> ETH: deposit on Pod, claim on ETH with proof from pod_getBridgeClaimProof RPC
+ * Pod -> ETH: withdraw on Pod, claim on ETH with proof from pod_getBridgeClaimProof RPC
  *
  * New deposit params (callContract, reserveBalance) enable depositing to CLOB orderbook in one TX.
  * For simple bridge deposits: callContract=address(0), reserveBalance=0.
@@ -25,14 +25,14 @@ exports.SOURCE_CHAIN_BRIDGE_ABI = [
 ];
 /**
  * ABI for Bridge system contract on Pod chain.
- * Pod uses bytes32 indexed id in Deposit events (different from ETH's uint256).
- * Same 6-param deposit as source chain.
+ * Pod uses bytes32 indexed id in Withdraw events.
+ * withdraw(token, amount, to, chainId) — chainId is the target chain for claiming.
  */
 exports.POD_BRIDGE_ABI = [
     // Events
-    "event Deposit(bytes32 indexed id, address indexed from, address indexed to, address token, uint256 amount, address callContract, uint256 reserveBalance)",
-    // Deposit function (6-param, same as source chain)
-    "function deposit(address token, uint256 amount, address to, address callContract, uint256 reserveBalance, bytes permit) returns (uint256)",
+    "event Withdraw(bytes32 indexed id, address indexed from, address indexed to, address token, uint256 amount, uint256 chainId)",
+    // Withdraw function (4-param: token, amount, to, chainId)
+    "function withdraw(address token, uint256 amount, address to, uint256 chainId) returns (bytes32)",
 ];
 // Backward compatibility alias
 exports.BRIDGE_ABI = exports.SOURCE_CHAIN_BRIDGE_ABI;

package/dist/libs/types/pod-bridge.types.d.ts

@@ -36,6 +36,7 @@ export interface BridgeRequest {
         amount: string;
         callContract?: string;
         reserveBalance?: string;
+        targetChainId?: number;
         chainId: number;
         blockNumber: number;
         timestamp: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tapforce/pod-bridge-sdk",
-  "version": "2.1.1",
+  "version": "2.2.1",
   "description": "SDK for interacting with Bridges between pod and other chains",
   "keywords": [
     "pod",