@agglayer/sdk 1.0.0-beta.28 → 1.0.0-beta.29

package/README.md

@@ -215,6 +215,7 @@ const bridgeAssetTx = await bridge.buildBridgeAsset(
 const claimAssetTx = await bridge.buildClaimAssetFromHash(
   '0xBridgeTxHash123456789012345678901234567890123456789012345678',
   11155111, // source network where bridge tx occurred
+  10000, // leaf index for the claim proof
   0, // bridge event index in tx (usually 0)
   '0xFromAddress12345678901234567890123456789012345' // claimer address
 );
@@ -250,6 +251,7 @@ const bridgeMessageTx = await bridge.buildBridgeMessage(
 const claimMessageTx = await bridge.buildClaimMessageFromHash(
   '0xBridgeMessageTxHash12345678901234567890123456789012345678901234',
   11155111, // source network
+  10000, // leaf index for the claim proof
   0, // message event index
   '0xFromAddress12345678901234567890123456789012345' // claimer
 );

package/dist/index.d.mts

@@ -283,7 +283,8 @@ declare enum TransactionStatus {
     CLAIMED = "CLAIMED",
     REFUND_IN_PROGRESS = "REFUND_IN_PROGRESS",
     REFUNDED = "REFUNDED",
-    FAILED = "FAILED"
+    FAILED = "FAILED",
+    PARTIAL = "PARTIAL"
 }
 interface Token {
     name: string;
@@ -733,7 +734,7 @@ declare abstract class BaseContract {
     /**
      * Estimate gas for transaction
      */
-    protected estimateGas(data: Hex, to: string, from?: string): Promise<string>;
+    protected estimateGas(data: Hex, to: string, from?: string, value?: bigint): Promise<string>;
 }
 
 declare class ERC20 extends BaseContract {
@@ -773,19 +774,21 @@ declare class ERC20 extends BaseContract {
      *
      * @param transactionHash - Hash of the bridge transaction on the source network
      * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+     * @param leafIndex - Leaf index for the claim proof
      * @param bridgeIndex - Index of bridge event in transaction (default: 0)
      * @param from - From address for the claim transaction
      */
-    claimAsset(transactionHash: string, sourceNetworkId: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
+    claimAsset(transactionHash: string, sourceNetworkId: number, leafIndex: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
     /**
      * Claim message from bridge transaction hash
      *
      * @param transactionHash - Hash of the bridge transaction on the source network
      * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+     * @param leafIndex - Leaf index for the claim proof
      * @param bridgeIndex - Index of bridge event in transaction (default: 0)
      * @param from - From address for the claim transaction
      */
-    claimMessage(transactionHash: string, sourceNetworkId: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
+    claimMessage(transactionHash: string, sourceNetworkId: number, leafIndex: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
     /**
      * Get bridge event info from transaction hash
      *
@@ -845,19 +848,21 @@ declare class Bridge extends BaseContract {
      *
      * @param transactionHash - Hash of the bridge transaction on the source network
      * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+     * @param leafIndex - Leaf index for the claim proof
      * @param bridgeIndex - Index of bridge event in transaction (default: 0)
      * @param from - From address for the claim transaction
      */
-    buildClaimAssetFromHash(transactionHash: string, sourceNetworkId: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
+    buildClaimAssetFromHash(transactionHash: string, sourceNetworkId: number, leafIndex: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
     /**
      * Build claim message transaction from bridge transaction hash
      *
      * @param transactionHash - Hash of the bridge transaction on the source network
      * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+     * @param leafIndex - Leaf index for the claim proof
      * @param bridgeIndex - Index of bridge event in transaction (default: 0)
      * @param from - From address for the claim transaction
      */
-    buildClaimMessageFromHash(transactionHash: string, sourceNetworkId: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
+    buildClaimMessageFromHash(transactionHash: string, sourceNetworkId: number, leafIndex: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
     /**
      * Get bridge event info from transaction hash
      *

package/dist/index.d.ts

@@ -283,7 +283,8 @@ declare enum TransactionStatus {
     CLAIMED = "CLAIMED",
     REFUND_IN_PROGRESS = "REFUND_IN_PROGRESS",
     REFUNDED = "REFUNDED",
-    FAILED = "FAILED"
+    FAILED = "FAILED",
+    PARTIAL = "PARTIAL"
 }
 interface Token {
     name: string;
@@ -733,7 +734,7 @@ declare abstract class BaseContract {
     /**
      * Estimate gas for transaction
      */
-    protected estimateGas(data: Hex, to: string, from?: string): Promise<string>;
+    protected estimateGas(data: Hex, to: string, from?: string, value?: bigint): Promise<string>;
 }
 
 declare class ERC20 extends BaseContract {
@@ -773,19 +774,21 @@ declare class ERC20 extends BaseContract {
      *
      * @param transactionHash - Hash of the bridge transaction on the source network
      * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+     * @param leafIndex - Leaf index for the claim proof
      * @param bridgeIndex - Index of bridge event in transaction (default: 0)
      * @param from - From address for the claim transaction
      */
-    claimAsset(transactionHash: string, sourceNetworkId: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
+    claimAsset(transactionHash: string, sourceNetworkId: number, leafIndex: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
     /**
      * Claim message from bridge transaction hash
      *
      * @param transactionHash - Hash of the bridge transaction on the source network
      * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+     * @param leafIndex - Leaf index for the claim proof
      * @param bridgeIndex - Index of bridge event in transaction (default: 0)
      * @param from - From address for the claim transaction
      */
-    claimMessage(transactionHash: string, sourceNetworkId: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
+    claimMessage(transactionHash: string, sourceNetworkId: number, leafIndex: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
     /**
      * Get bridge event info from transaction hash
      *
@@ -845,19 +848,21 @@ declare class Bridge extends BaseContract {
      *
      * @param transactionHash - Hash of the bridge transaction on the source network
      * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+     * @param leafIndex - Leaf index for the claim proof
      * @param bridgeIndex - Index of bridge event in transaction (default: 0)
      * @param from - From address for the claim transaction
      */
-    buildClaimAssetFromHash(transactionHash: string, sourceNetworkId: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
+    buildClaimAssetFromHash(transactionHash: string, sourceNetworkId: number, leafIndex: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
     /**
      * Build claim message transaction from bridge transaction hash
      *
      * @param transactionHash - Hash of the bridge transaction on the source network
      * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+     * @param leafIndex - Leaf index for the claim proof
      * @param bridgeIndex - Index of bridge event in transaction (default: 0)
      * @param from - From address for the claim transaction
      */
-    buildClaimMessageFromHash(transactionHash: string, sourceNetworkId: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
+    buildClaimMessageFromHash(transactionHash: string, sourceNetworkId: number, leafIndex: number, bridgeIndex?: number, from?: string): Promise<TransactionParams>;
     /**
      * Get bridge event info from transaction hash
      *

package/dist/index.js

@@ -22,7 +22,8 @@ var index_exports = {};
 __export(index_exports, {
   AggLayerSDK: () => AggLayerSDK,
   ApiError: () => ApiError,
-  SDK_MODES: () => SDK_MODES
+  SDK_MODES: () => SDK_MODES,
+  TransactionStatus: () => TransactionStatus
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -49,7 +50,7 @@ var ChainRegistry = class _ChainRegistry {
       nativeCurrency: { name: "Ether", symbol: "ETH", decimals: 18 },
       blockExplorer: { name: "Etherscan", url: "https://etherscan.io" },
       bridgeAddress: "",
-      proofApiUrl: "https://api-gateway.polygon.technology/api/v3/proof/mainnet/",
+      proofApiUrl: "https://bridge-hub-api.polygon.technology/mainnet/",
       isTestnet: false
     });
     this.registerChain({
@@ -63,7 +64,7 @@ var ChainRegistry = class _ChainRegistry {
         url: "https://katanascan.com"
       },
       bridgeAddress: "",
-      proofApiUrl: "https://api-gateway.polygon.technology/api/v3/proof/mainnet/",
+      proofApiUrl: "https://bridge-hub-api.polygon.technology/mainnet/",
       isTestnet: false
     });
     this.registerChain({
@@ -77,7 +78,7 @@ var ChainRegistry = class _ChainRegistry {
         url: "https://sepolia.etherscan.io"
       },
       bridgeAddress: "0x528e26b25a34a4A5d0dbDa1d57D318153d2ED582",
-      proofApiUrl: "https://api-gateway.polygon.technology/api/v3/proof/testnet/",
+      proofApiUrl: "https://bridge-hub-api.polygon.technology/testnet/",
       isTestnet: true
     });
   }
@@ -276,11 +277,12 @@ var BaseContract = class {
   /**
    * Estimate gas for transaction
    */
-  async estimateGas(data, to, from) {
+  async estimateGas(data, to, from, value) {
     const gasEstimate = await this.client.estimateGas({
       account: from,
       to,
-      data
+      data,
+      value
     });
     return gasEstimate.toString();
   }
@@ -637,6 +639,21 @@ var bridgeAbi = [
   }
 ];
 
+// src/constants.ts
+var ARC_API_BASE_URL = "https://arc-api.polygon.technology";
+var ARC_API_DEFAULT_TIMEOUT = 3e4;
+var LIFI_API_BASE_URL = "https://li.quest";
+var LIFI_API_DEFAULT_TIMEOUT = 5e3;
+var DEFAULT_CHAINS_PER_PAGE = 100;
+var DEFAULT_CHAINS_WITH_TOKENS_PER_PAGE = 1;
+var MAX_TRANSACTIONS_PER_PAGE = 100;
+var NETWORKS = {
+  ETHEREUM: 1,
+  KATANA: 747474
+};
+var DEFAULT_NETWORK = NETWORKS.ETHEREUM;
+var ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+
 // src/native/bridge/build.ts
 async function buildBridgeAsset(ctx, destinationNetwork, destinationAddress, amount, token, forceUpdateGlobalExitRoot, permitData = "0x", from) {
   const data = (0, import_viem3.encodeFunctionData)({
@@ -651,17 +668,23 @@ async function buildBridgeAsset(ctx, destinationNetwork, destinationAddress, amo
       permitData
     ]
   });
+  const isNativeETH = token.toLowerCase() === ZERO_ADDRESS;
+  const value = isNativeETH ? amount : void 0;
   const [nonce, gas] = await Promise.all([
     ctx.getNonce(from),
-    ctx.estimateGas(data, ctx.bridgeAddress, from)
+    ctx.estimateGas(data, ctx.bridgeAddress, from, value)
   ]);
-  return {
+  const result = {
     from,
     to: ctx.bridgeAddress,
     data,
     gas,
     nonce
   };
+  if (isNativeETH) {
+    result.value = amount.toString();
+  }
+  return result;
 }
 async function buildClaimAsset(ctx, smtProofLocalExitRoot, smtProofRollupExitRoot, globalIndex, mainnetExitRoot, rollupExitRoot, originNetwork, originTokenAddress, destinationNetwork, destinationAddress, amount, metadata, from) {
   const data = (0, import_viem3.encodeFunctionData)({
@@ -856,12 +879,12 @@ var BridgeUtil = class _BridgeUtil {
     }
   }
   /**
-   * Fetch merkle proof from Polygon's proof API
+   * Fetch merkle proof from Polygon's hub API
    */
-  async fetchMerkleProof(networkId, depositCount) {
+  async fetchMerkleProof(networkId, depositCount, leafIndex) {
     try {
       const baseUrl = this.proofApiUrl.endsWith("/") ? this.proofApiUrl : `${this.proofApiUrl}/`;
-      const url = `${baseUrl}merkle-proof?networkId=${networkId}&depositCount=${depositCount}`;
+      const url = `${baseUrl}claim-proof?sourceNetworkId=${networkId}&depositCount=${depositCount}&leafIndex=${leafIndex}`;
       const response = await fetch(url);
       if (!response.ok) {
         throw new Error(
@@ -869,10 +892,10 @@ var BridgeUtil = class _BridgeUtil {
         );
       }
       const data = await response.json();
-      if (!data.proof) {
+      if (data.status !== "success" || !data.data) {
         throw new Error("Invalid response format: missing proof data");
       }
-      return data.proof;
+      return data.data;
     } catch (error) {
       if (error instanceof Error) {
         throw new Error(`Failed to fetch merkle proof: ${error.message}`);
@@ -894,7 +917,7 @@ var BridgeUtil = class _BridgeUtil {
   /**
    * Build claim payload from transaction hash (user-friendly method)
    */
-  async buildPayloadForClaim(transactionHash, sourceNetworkId, bridgeIndex = 0) {
+  async buildPayloadForClaim(transactionHash, sourceNetworkId, leafIndex, bridgeIndex = 0) {
     const bridgeEvent = await this.extractBridgeEvent(
       transactionHash,
       sourceNetworkId,
@@ -902,18 +925,19 @@ var BridgeUtil = class _BridgeUtil {
     );
     const proof = await this.fetchMerkleProof(
       sourceNetworkId,
-      bridgeEvent.depositCount
+      bridgeEvent.depositCount,
+      leafIndex
     );
     const globalIndex = this.computeGlobalIndex(
       bridgeEvent.depositCount,
       sourceNetworkId
     );
     return {
-      smtProof: proof.merkle_proof,
-      smtProofRollup: proof.rollup_merkle_proof,
+      smtProof: proof.proof_local_exit_root,
+      smtProofRollup: proof.proof_rollup_exit_root,
       globalIndex: globalIndex.toString(),
-      mainnetExitRoot: proof.main_exit_root,
-      rollupExitRoot: proof.rollup_exit_root,
+      mainnetExitRoot: proof.l1_info_tree_leaf.mainnet_exit_root,
+      rollupExitRoot: proof.l1_info_tree_leaf.rollup_exit_root,
       originNetwork: bridgeEvent.originNetwork,
       originTokenAddress: bridgeEvent.originTokenAddress,
       destinationNetwork: bridgeEvent.destinationNetwork,
@@ -925,10 +949,11 @@ var BridgeUtil = class _BridgeUtil {
   /**
    * Build claim asset parameters from transaction hash
    */
-  async buildClaimAssetParams(transactionHash, sourceNetworkId, bridgeIndex = 0) {
+  async buildClaimAssetParams(transactionHash, sourceNetworkId, leafIndex, bridgeIndex = 0) {
     const payload = await this.buildPayloadForClaim(
       transactionHash,
       sourceNetworkId,
+      leafIndex,
       bridgeIndex
     );
     return {
@@ -948,10 +973,11 @@ var BridgeUtil = class _BridgeUtil {
   /**
    * Build claim message parameters from transaction hash
    */
-  async buildClaimMessageParams(transactionHash, sourceNetworkId, bridgeIndex = 0) {
+  async buildClaimMessageParams(transactionHash, sourceNetworkId, leafIndex, bridgeIndex = 0) {
     const payload = await this.buildPayloadForClaim(
       transactionHash,
       sourceNetworkId,
+      leafIndex,
       bridgeIndex
     );
     return {
@@ -998,7 +1024,7 @@ var Bridge = class extends BaseContract {
     return buildBridgeAsset(
       {
         bridgeAddress: this.bridgeAddress,
-        estimateGas: (data, to, from2) => this.estimateGas(data, to, from2),
+        estimateGas: (data, to, from2, value) => this.estimateGas(data, to, from2, value),
         getNonce: (address) => this.getNonce(address)
       },
       params.destinationNetwork,
@@ -1025,7 +1051,7 @@ var Bridge = class extends BaseContract {
     return buildClaimAsset(
       {
         bridgeAddress: this.bridgeAddress,
-        estimateGas: (data, to, from2) => this.estimateGas(data, to, from2),
+        estimateGas: (data, to, from2, value) => this.estimateGas(data, to, from2, value),
         getNonce: (address) => this.getNonce(address)
       },
       params.smtProofLocalExitRoot,
@@ -1099,7 +1125,7 @@ var Bridge = class extends BaseContract {
     return buildBridgeMessage(
       {
         bridgeAddress: this.bridgeAddress,
-        estimateGas: (data, to, from2) => this.estimateGas(data, to, from2),
+        estimateGas: (data, to, from2, value) => this.estimateGas(data, to, from2, value),
         getNonce: (address) => this.getNonce(address)
       },
       params.destinationNetwork,
@@ -1124,7 +1150,7 @@ var Bridge = class extends BaseContract {
     return buildClaimMessage(
       {
         bridgeAddress: this.bridgeAddress,
-        estimateGas: (data, to, from2) => this.estimateGas(data, to, from2),
+        estimateGas: (data, to, from2, value) => this.estimateGas(data, to, from2, value),
         getNonce: (address) => this.getNonce(address)
       },
       params.smtProofLocalExitRoot,
@@ -1178,14 +1204,16 @@ var Bridge = class extends BaseContract {
    *
    * @param transactionHash - Hash of the bridge transaction on the source network
    * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+   * @param leafIndex - Leaf index for the claim proof
    * @param bridgeIndex - Index of bridge event in transaction (default: 0)
    * @param from - From address for the claim transaction
    */
-  async buildClaimAssetFromHash(transactionHash, sourceNetworkId, bridgeIndex = 0, from) {
+  async buildClaimAssetFromHash(transactionHash, sourceNetworkId, leafIndex, bridgeIndex = 0, from) {
     const bridgeUtil = await BridgeUtil.fromNetworkId(sourceNetworkId);
     const params = await bridgeUtil.buildClaimAssetParams(
       transactionHash,
       sourceNetworkId,
+      leafIndex,
       bridgeIndex
     );
     return this.buildClaimAsset(params, from);
@@ -1195,14 +1223,16 @@ var Bridge = class extends BaseContract {
    *
    * @param transactionHash - Hash of the bridge transaction on the source network
    * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+   * @param leafIndex - Leaf index for the claim proof
    * @param bridgeIndex - Index of bridge event in transaction (default: 0)
    * @param from - From address for the claim transaction
    */
-  async buildClaimMessageFromHash(transactionHash, sourceNetworkId, bridgeIndex = 0, from) {
+  async buildClaimMessageFromHash(transactionHash, sourceNetworkId, leafIndex, bridgeIndex = 0, from) {
     const bridgeUtil = await BridgeUtil.fromNetworkId(sourceNetworkId);
     const params = await bridgeUtil.buildClaimMessageParams(
       transactionHash,
       sourceNetworkId,
+      leafIndex,
       bridgeIndex
     );
     return this.buildClaimMessage(params, from);
@@ -1360,14 +1390,16 @@ var ERC20 = class extends BaseContract {
    *
    * @param transactionHash - Hash of the bridge transaction on the source network
    * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+   * @param leafIndex - Leaf index for the claim proof
    * @param bridgeIndex - Index of bridge event in transaction (default: 0)
    * @param from - From address for the claim transaction
    */
-  async claimAsset(transactionHash, sourceNetworkId, bridgeIndex = 0, from) {
+  async claimAsset(transactionHash, sourceNetworkId, leafIndex, bridgeIndex = 0, from) {
     const bridge = this.getBridge();
     return bridge.buildClaimAssetFromHash(
       transactionHash,
       sourceNetworkId,
+      leafIndex,
       bridgeIndex,
       from
     );
@@ -1377,14 +1409,16 @@ var ERC20 = class extends BaseContract {
    *
    * @param transactionHash - Hash of the bridge transaction on the source network
    * @param sourceNetworkId - Network ID of the source network (where bridge tx happened)
+   * @param leafIndex - Leaf index for the claim proof
    * @param bridgeIndex - Index of bridge event in transaction (default: 0)
    * @param from - From address for the claim transaction
    */
-  async claimMessage(transactionHash, sourceNetworkId, bridgeIndex = 0, from) {
+  async claimMessage(transactionHash, sourceNetworkId, leafIndex, bridgeIndex = 0, from) {
     const bridge = this.getBridge();
     return bridge.buildClaimMessageFromHash(
       transactionHash,
       sourceNetworkId,
+      leafIndex,
       bridgeIndex,
       from
     );
@@ -1421,22 +1455,6 @@ var ERC20 = class extends BaseContract {
 
 // src/native/index.ts
 var import_viem6 = require("viem");
-
-// src/constants.ts
-var ARC_API_BASE_URL = "https://arc-api.polygon.technology";
-var ARC_API_DEFAULT_TIMEOUT = 3e4;
-var LIFI_API_BASE_URL = "https://li.quest";
-var LIFI_API_DEFAULT_TIMEOUT = 5e3;
-var DEFAULT_CHAINS_PER_PAGE = 100;
-var DEFAULT_CHAINS_WITH_TOKENS_PER_PAGE = 1;
-var MAX_TRANSACTIONS_PER_PAGE = 100;
-var NETWORKS = {
-  ETHEREUM: 1,
-  KATANA: 747474
-};
-var DEFAULT_NETWORK = NETWORKS.ETHEREUM;
-
-// src/native/index.ts
 var NativeClient = class {
   constructor(config) {
     this.config = config;
@@ -1540,6 +1558,19 @@ var SDK_MODES = {
   NATIVE: "NATIVE"
 };
 
+// src/types/core/arcApi/arcApiTransactions.ts
+var TransactionStatus = /* @__PURE__ */ ((TransactionStatus2) => {
+  TransactionStatus2["BRIDGED"] = "BRIDGED";
+  TransactionStatus2["LEAF_INCLUDED"] = "LEAF_INCLUDED";
+  TransactionStatus2["READY_TO_CLAIM"] = "READY_TO_CLAIM";
+  TransactionStatus2["CLAIMED"] = "CLAIMED";
+  TransactionStatus2["REFUND_IN_PROGRESS"] = "REFUND_IN_PROGRESS";
+  TransactionStatus2["REFUNDED"] = "REFUNDED";
+  TransactionStatus2["FAILED"] = "FAILED";
+  TransactionStatus2["PARTIAL"] = "PARTIAL";
+  return TransactionStatus2;
+})(TransactionStatus || {});
+
 // src/core/utils/httpClient.ts
 var HttpClient = class {
   constructor(config) {
@@ -2180,6 +2211,7 @@ var AggLayerSDK = class {
 0 && (module.exports = {
   AggLayerSDK,
   ApiError,
-  SDK_MODES
+  SDK_MODES,
+  TransactionStatus
 });
 //# sourceMappingURL=index.js.map