@agglayer/sdk 1.0.0-beta.16 → 1.0.0-beta.17

package/dist/index.d.mts

@@ -78,6 +78,11 @@ interface IChain {
         name: string;
         symbol: string;
         decimals: number;
+        address: string;
+        logoURI: string;
+        priceUSD: string;
+        originTokenAddress?: string;
+        originChainId?: number;
     };
     networkId?: number;
     bridgeAddress?: string;
@@ -328,6 +333,18 @@ type TransactionsResponse = {
 type BuildTransactionRequestBody = Step;
 type BuildTransactionResponse = UnsignedTransaction;
 
+/**
+ * Arc API Build Claim Transaction Types
+ *
+ * Defines the core request and response types for the build claim transaction endpoint.
+ */
+
+type BuildClaimTransactionRequestParam = {
+    sourceNetworkId: number;
+    depositCount: number;
+};
+type BuildClaimTransactionResponse = UnsignedTransaction;
+
 /**
  * Chain Types
  *
@@ -803,6 +820,16 @@ declare class CoreClient {
      * Otherwise, call buildTransaction on route.steps[0] and return that as calldata
      */
     getUnsignedTransaction(route: Route): Promise<UnsignedTransaction>;
+    /**
+     * Get calldata for claim step
+     * Needs to be called separately as claim step is not part of route.
+     *
+     * @developer Note: Do not misinterpret network ID as chain ID.
+     *
+     * @param sourceNetworkId - The source network ID where the transfer was initiated.
+     * @param depositCount - The deposit count associated with the transfer.
+     */
+    getClaimUnsignedTransaction(buildClaimTxParams: BuildClaimTransactionRequestParam): Promise<UnsignedTransaction>;
     /**
      * Get all transactions via web sockets
      */
@@ -830,4 +857,4 @@ declare class AggLayerSDK {
     getNative(): NativeClient;
 }
 
-export { AggLayerSDK, type ApiResponse, type BaseContractConfig, type BridgeAssetParams, type BridgeConfig, type BridgeMessageParams, type BridgeOptions, type BuildTransactionRequestBody, type BuildTransactionResponse, type ChainConfig, type ChainsQueryParams, type ChainsResponse, type ClaimAssetParams, type ClaimMessageParams, type CoreConfig, type CursorPagination, type CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type Pagination, type PrecalculatedWrapperParams, type ProviderMetadata, type RiskFactors, type RiskLevel, type Route, type RoutePreferences, type RouteStep, type RoutesRequestParams, type RoutesResponse, type SDKConfig, type SDKMode, SDK_MODES, type Step, type StepAction, type StepEstimate, type StepType, type SuccessResponse, type TokenInfo, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };
+export { AggLayerSDK, type ApiResponse, type BaseContractConfig, type BridgeAssetParams, type BridgeConfig, type BridgeMessageParams, type BridgeOptions, type BuildClaimTransactionRequestParam, type BuildClaimTransactionResponse, type BuildTransactionRequestBody, type BuildTransactionResponse, type ChainConfig, type ChainsQueryParams, type ChainsResponse, type ClaimAssetParams, type ClaimMessageParams, type CoreConfig, type CursorPagination, type CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type Pagination, type PrecalculatedWrapperParams, type ProviderMetadata, type RiskFactors, type RiskLevel, type Route, type RoutePreferences, type RouteStep, type RoutesRequestParams, type RoutesResponse, type SDKConfig, type SDKMode, SDK_MODES, type Step, type StepAction, type StepEstimate, type StepType, type SuccessResponse, type TokenInfo, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };

package/dist/index.d.ts

@@ -78,6 +78,11 @@ interface IChain {
         name: string;
         symbol: string;
         decimals: number;
+        address: string;
+        logoURI: string;
+        priceUSD: string;
+        originTokenAddress?: string;
+        originChainId?: number;
     };
     networkId?: number;
     bridgeAddress?: string;
@@ -328,6 +333,18 @@ type TransactionsResponse = {
 type BuildTransactionRequestBody = Step;
 type BuildTransactionResponse = UnsignedTransaction;
 
+/**
+ * Arc API Build Claim Transaction Types
+ *
+ * Defines the core request and response types for the build claim transaction endpoint.
+ */
+
+type BuildClaimTransactionRequestParam = {
+    sourceNetworkId: number;
+    depositCount: number;
+};
+type BuildClaimTransactionResponse = UnsignedTransaction;
+
 /**
  * Chain Types
  *
@@ -803,6 +820,16 @@ declare class CoreClient {
      * Otherwise, call buildTransaction on route.steps[0] and return that as calldata
      */
     getUnsignedTransaction(route: Route): Promise<UnsignedTransaction>;
+    /**
+     * Get calldata for claim step
+     * Needs to be called separately as claim step is not part of route.
+     *
+     * @developer Note: Do not misinterpret network ID as chain ID.
+     *
+     * @param sourceNetworkId - The source network ID where the transfer was initiated.
+     * @param depositCount - The deposit count associated with the transfer.
+     */
+    getClaimUnsignedTransaction(buildClaimTxParams: BuildClaimTransactionRequestParam): Promise<UnsignedTransaction>;
     /**
      * Get all transactions via web sockets
      */
@@ -830,4 +857,4 @@ declare class AggLayerSDK {
     getNative(): NativeClient;
 }
 
-export { AggLayerSDK, type ApiResponse, type BaseContractConfig, type BridgeAssetParams, type BridgeConfig, type BridgeMessageParams, type BridgeOptions, type BuildTransactionRequestBody, type BuildTransactionResponse, type ChainConfig, type ChainsQueryParams, type ChainsResponse, type ClaimAssetParams, type ClaimMessageParams, type CoreConfig, type CursorPagination, type CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type Pagination, type PrecalculatedWrapperParams, type ProviderMetadata, type RiskFactors, type RiskLevel, type Route, type RoutePreferences, type RouteStep, type RoutesRequestParams, type RoutesResponse, type SDKConfig, type SDKMode, SDK_MODES, type Step, type StepAction, type StepEstimate, type StepType, type SuccessResponse, type TokenInfo, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };
+export { AggLayerSDK, type ApiResponse, type BaseContractConfig, type BridgeAssetParams, type BridgeConfig, type BridgeMessageParams, type BridgeOptions, type BuildClaimTransactionRequestParam, type BuildClaimTransactionResponse, type BuildTransactionRequestBody, type BuildTransactionResponse, type ChainConfig, type ChainsQueryParams, type ChainsResponse, type ClaimAssetParams, type ClaimMessageParams, type CoreConfig, type CursorPagination, type CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type Pagination, type PrecalculatedWrapperParams, type ProviderMetadata, type RiskFactors, type RiskLevel, type Route, type RoutePreferences, type RouteStep, type RoutesRequestParams, type RoutesResponse, type SDKConfig, type SDKMode, SDK_MODES, type Step, type StepAction, type StepEstimate, type StepType, type SuccessResponse, type TokenInfo, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };

package/dist/index.js

@@ -1704,6 +1704,12 @@ var ArcApiService = class {
       builtTransactionRequestBody
     );
   }
+  async buildClaimTransaction(sourceNetworkId, depositCount) {
+    return this.httpClient.get("/routes/build-transaction-for-claim", {
+      sourceNetworkId,
+      depositCount
+    });
+  }
   // supports cursor based pagination only
   async transactions(transactionsRequestQueryParams) {
     return this.httpClient.get("/transactions", {
@@ -1853,6 +1859,25 @@ var CoreClient = class {
     }
     throw new Error(response.data.message);
   }
+  /**
+   * Get calldata for claim step
+   * Needs to be called separately as claim step is not part of route.
+   *
+   * @developer Note: Do not misinterpret network ID as chain ID.
+   *
+   * @param sourceNetworkId - The source network ID where the transfer was initiated.
+   * @param depositCount - The deposit count associated with the transfer.
+   */
+  async getClaimUnsignedTransaction(buildClaimTxParams) {
+    const response = await this.arcApiService.buildClaimTransaction(
+      buildClaimTxParams.sourceNetworkId,
+      buildClaimTxParams.depositCount
+    );
+    if (response.data.status === "success") {
+      return response.data.data;
+    }
+    throw new Error(response.data.message);
+  }
   /**
    * Get all transactions via web sockets
    */