@tapforce/pod-bridge-sdk 1.1.13 → 1.1.15

package/README.md

@@ -9,6 +9,7 @@ TypeScript SDK for interacting with Bridges between POD and other chains - enabl
 - ✅ **Claim Status Tracking**: Monitor claim status and finality of bridge requests
 - 📝 **Transaction Building**: Generate unsigned transactions ready for signing
 - 🔐 **Type-Safe**: Full TypeScript support with comprehensive type definitions
+- 🔗 **Dual Architecture Support**: Handles both certificate-based (Source Chain) and precompile-based (POD) claim verification
 
 ## Installation
 
@@ -37,7 +38,9 @@ import {
   SourceChainToPodActionClient,
   PodToSourceChainActionClient,
   PodBridgeTrackerClient,
-  PodBridgeConfig 
+  PodBridgeConfig,
+  POD_BRIDGE_ABI,
+  SOURCE_CHAIN_BRIDGE_ABI
 } from '@tapforce/pod-bridge-sdk';
 ```
 
@@ -149,12 +152,25 @@ const unsignedNativeTx = podToSourceChainClient.depositNative({
 
 #### Claim on Source Chain from POD Deposits
 
-For claiming on Source chain from POD deposits, use certificate-based claims. First, get the certified log from the POD deposit transaction:
+For claiming on Source chain from POD deposits, use certificate-based claims. You'll need to get the certified log from an external indexer service:
 
 ```typescript
+import { PodIndexerHttpClient } from '@tapforce/pod-indexer-sdk';
+
+// Initialize the POD indexer client
+const indexerClient = new PodIndexerHttpClient({
+  apiUrl: 'YOUR_INDEXER_API_URL',
+  apiKey: 'YOUR_INDEXER_API_KEY'
+});
+
 // Get certified log from POD deposit transaction
-const depositTxHash = '0x...'; // Transaction hash of deposit on POD
-const certifiedLog = await trackerClient.getDepositCertifiedLog(depositTxHash);
+const certifiedLogResponse = await indexerClient.getBridgeCertifiedLog({
+  transactionHash: '0x...', // Transaction hash of deposit on POD
+  bridgeContractAddress: config.pod.contractAddress,
+  rpcUrl: config.pod.rpcUrl
+});
+
+const certifiedLog = certifiedLogResponse.result;
 
 // Create unsigned claim transaction for ERC20 on Source chain
 const unsignedTx = podToSourceChainClient.claimWithCertificate({
@@ -337,9 +353,36 @@ new PodToSourceChainActionClient(config: PodBridgeActionsClientConfig)
 - **`areRequestsProcessed(deposits)`**: Batch check if requests are processed
   - Returns: `Promise<boolean[]>`
 
-- **`getDepositCertifiedLog(txHash)`**: Get certified log for claiming on Source chain from POD deposit
-  - `txHash`: Transaction hash of deposit on POD
-  - Returns: `Promise<CertifiedLog>` with attestations and merkle proof
+## ABIs
+
+The SDK exports two separate ABIs for the different bridge contract types:
+
+### POD_BRIDGE_ABI
+
+Used for the **BridgeMintBurn** contract on POD Chain:
+- Deposit functions: `deposit()`, `depositNative()`
+- Claim functions: `claim(uint256 id, address token, uint256 blockNumber)`, `claimNative(uint256 id, uint256 blockNumber)`
+- Claims use block number verification via POD precompiles
+- Events: `Deposit`, `DepositNative`, `Claim`, `ClaimNative`
+
+### SOURCE_CHAIN_BRIDGE_ABI
+
+Used for the **BridgeDepositWithdraw** contract on Source Chain (e.g., Sepolia):
+- Deposit functions: `deposit()`, `depositNative()`
+- Claim functions: `claim(CertifiedLog)`, `claimNative(CertifiedLog)`
+- Claims use POD certificate system with attestations and merkle proofs
+- Events: `Deposit`, `DepositNative`, `Claim`, `ClaimNative`
+
+Both are exported from the package and can be used with ethers.js:
+
+```typescript
+import { POD_BRIDGE_ABI, SOURCE_CHAIN_BRIDGE_ABI } from '@tapforce/pod-bridge-sdk';
+import { ethers } from 'ethers';
+
+// Create contract interface
+const podBridge = new ethers.Contract(podAddress, POD_BRIDGE_ABI, provider);
+const sourceChainBridge = new ethers.Contract(sepoliaAddress, SOURCE_CHAIN_BRIDGE_ABI, provider);
+```
 
 ## Types
 
@@ -405,13 +448,13 @@ interface CertifiedLog {
     topics: string[];
     data: string;
   };
-  logIndex: bigint | string;
+  log_index: bigint | string;
   certificate: {
     leaf: string;
-    certifiedReceipt: {
-      receiptRoot: string;
-      aggregateSignature: string;
-      sortedAttestationTimestamps: bigint[] | string[];
+    certified_receipt: {
+      receipt_root: string;
+      aggregate_signature: string;
+      sorted_attestation_timestamps: bigint[] | string[];
     };
     proof: {
       path: string[];
@@ -424,15 +467,19 @@ interface CertifiedLog {
 
 The SDK supports two bridge implementations:
 
-1. **BridgeDepositWithdraw** (Certificate-based)
+1. **BridgeDepositWithdraw** (Certificate-based) - Source Chain
    - Used for claiming on Source chain from POD deposits
-   - Requires certified logs from POD's certificate system
+   - Requires certified logs from POD's certificate system via indexer
+   - Uses `SOURCE_CHAIN_BRIDGE_ABI`
    - Methods: `claimWithCertificate`, `claimNativeWithCertificate`
+   - Certified logs include attestations, receipt root, aggregate signatures, and merkle proofs
 
-2. **BridgeMintBurn** (Precompile-based)
+2. **BridgeMintBurn** (Precompile-based) - POD Chain
    - Used for claiming on POD from Source chain deposits
-   - Uses block number verification via precompiles
+   - Uses block number verification via POD precompiles
+   - Uses `POD_BRIDGE_ABI`
    - Methods: `claimWithBlockNumber`, `claimNativeWithBlockNumber`
+   - POD has instant finality (single-block architecture)
 
 ## Examples
 
@@ -505,6 +552,7 @@ if (canClaim) {
 ```typescript
 import { ethers } from 'ethers';
 import { PodToSourceChainActionClient, PodBridgeTrackerClient } from '@tapforce/pod-bridge-sdk';
+import { PodIndexerHttpClient } from '@tapforce/pod-indexer-sdk';
 
 // Setup
 const trackerConfig = {
@@ -528,6 +576,12 @@ const trackerClient = new PodBridgeTrackerClient(trackerConfig);
 const podProvider = new ethers.JsonRpcProvider(trackerConfig.pod.rpcUrl);
 const podSigner = new ethers.Wallet('PRIVATE_KEY', podProvider);
 
+// Initialize indexer client for getting certified logs
+const indexerClient = new PodIndexerHttpClient({
+  apiUrl: 'YOUR_INDEXER_API_URL',
+  apiKey: 'YOUR_INDEXER_API_KEY'
+});
+
 // Step 1: Deposit tokens on POD
 const depositTx = actionClient.depositToken({
   token: '0xTokenAddress',
@@ -539,13 +593,23 @@ const tx = await podSigner.sendTransaction(depositTx);
 const receipt = await tx.wait();
 console.log(`Deposit tx on POD: ${tx.hash}`);
 
-// Step 2: Get certified log from POD transaction
-const certifiedLog = await trackerClient.getDepositCertifiedLog(tx.hash);
+// Step 2: Get certified log from POD transaction using indexer
+const certifiedLogResponse = await indexerClient.getBridgeCertifiedLog({
+  transactionHash: tx.hash,
+  bridgeContractAddress: trackerConfig.pod.contractAddress,
+  rpcUrl: trackerConfig.pod.rpcUrl
+});
+
+const certifiedLog = certifiedLogResponse.result;
+if (!certifiedLog) {
+  throw new Error('Certified log not found');
+}
 console.log('Got certified log with attestations');
 
 // Step 3: Claim on Sepolia using certified log
 const claimTx = actionClient.claimWithCertificate({
-  certifiedLog
+  certifiedLog,
+  from: await podSigner.getAddress()
 });
 
 const sepoliaProvider = new ethers.JsonRpcProvider(trackerConfig.sourceChain.rpcUrl);
@@ -574,6 +638,16 @@ npm run clean
 - **ethers**: ^6.15.0 - Ethereum library for interacting with contracts
 - **typescript**: ^5.8.3 - TypeScript support
 
+### External Dependencies for Claims
+
+To claim tokens on Source Chain from POD deposits, you'll need:
+
+- **@tapforce/pod-indexer-sdk**: For retrieving certified logs from POD transactions
+
+```bash
+npm install @tapforce/pod-indexer-sdk
+```
+
 ## License
 
 ISC

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PodToSourceChainActionClient = void 0;
 const ethers_1 = require("ethers");
 const bridge_abi_1 = require("../../libs/abi/bridge.abi");
+const convert_certified_log_helper_1 = require("../../libs/helpers/convert-certified-log.helper");
 class PodToSourceChainActionClient {
     constructor(config) {
         this.config = config;
@@ -72,7 +73,7 @@ class PodToSourceChainActionClient {
      */
     claimNativeWithCertificate(args) {
         // Use source chain interface which has the certificate-based claimNative function
-        const data = this.sourceChainIface.encodeFunctionData('claimNative', [args.certifiedLog]);
+        const data = this.sourceChainIface.encodeFunctionData('claimNative', [(0, convert_certified_log_helper_1.convertFFICertifiedLog)(args.certifiedLog)]);
         return {
             to: this.config.sourceChain.contractAddress,
             data,

package/package.json

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