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

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;
@@ -197,7 +202,8 @@ interface ProviderMetadata {
         readonly transactionRequest?: unknown;
     };
     readonly agglayer?: {
-        readonly bridgeAddress: string | null;
+        readonly bridgeAddress: string | undefined;
+        readonly claimTransactionRequired: boolean | undefined;
     };
     readonly [key: string]: unknown;
 }
@@ -230,7 +236,7 @@ interface Route {
     readonly feeCosts: FeeCost[];
     readonly gasCosts: GasCost[];
     readonly steps: Step[];
-    readonly transactionRequest?: UnsignedTransaction;
+    readonly transactionRequest?: UnsignedTransaction | undefined;
     readonly providerMetadata: ProviderMetadata;
     readonly riskFactors: RiskFactors | null;
     readonly createdAt: number;
@@ -253,7 +259,7 @@ interface RoutesRequestParams {
     readonly fromTokenAddress: string;
     readonly toTokenAddress: string;
     readonly amount: string;
-    readonly fromAddress: string;
+    readonly fromAddress?: string;
     readonly toAddress?: string;
     readonly slippage?: number;
     readonly preferences?: RoutePreferences;
@@ -328,6 +334,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
  *
@@ -478,9 +496,9 @@ declare const SDK_MODES: {
 type SDKMode = (typeof SDK_MODES)[keyof typeof SDK_MODES];
 
 interface SDKConfig {
-    mode: SDKMode[];
-    core: CoreConfig;
-    native: NativeConfig;
+    mode?: SDKMode[];
+    core?: CoreConfig;
+    native?: NativeConfig;
 }
 
 /**
@@ -761,7 +779,7 @@ declare class NativeClient {
 declare class CoreClient {
     private config;
     private arcApiService;
-    constructor(config: CoreConfig);
+    constructor(config?: CoreConfig);
     /**
      * Generic pagination helper for chains API calls (limit and offset based pagination)
      * Handles automatic pagination to fetch all available data
@@ -803,12 +821,52 @@ 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
      */
     getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<TransactionsResponse>;
 }
 
+/**
+ * API Error Class
+ *
+ * Custom error class to preserve API error details
+ */
+
+declare class ApiError extends Error {
+    readonly code: number;
+    readonly name: string;
+    readonly details?: Record<string, unknown> | undefined;
+    constructor(errorResponse: ErrorResponse);
+    /**
+     * Create API error from error response
+     */
+    static fromErrorResponse(errorResponse: ErrorResponse): ApiError;
+    /**
+     * Create fallback error when API completely fails
+     */
+    static createFallbackError(originalError: Error, operation: string): ApiError;
+    /**
+     * Convert to plain object for serialization
+     */
+    toJSON(): {
+        name: string;
+        message: string;
+        code: number;
+        details: Record<string, unknown> | undefined;
+    };
+}
+
 /**
  * AggLayer SDK - Main SDK
  *
@@ -819,7 +877,7 @@ declare class AggLayerSDK {
     private config;
     private core?;
     private native?;
-    constructor(config: SDKConfig);
+    constructor(config?: SDKConfig);
     /**
      * Get core submodule
      */
@@ -830,4 +888,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, ApiError, 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;
@@ -197,7 +202,8 @@ interface ProviderMetadata {
         readonly transactionRequest?: unknown;
     };
     readonly agglayer?: {
-        readonly bridgeAddress: string | null;
+        readonly bridgeAddress: string | undefined;
+        readonly claimTransactionRequired: boolean | undefined;
     };
     readonly [key: string]: unknown;
 }
@@ -230,7 +236,7 @@ interface Route {
     readonly feeCosts: FeeCost[];
     readonly gasCosts: GasCost[];
     readonly steps: Step[];
-    readonly transactionRequest?: UnsignedTransaction;
+    readonly transactionRequest?: UnsignedTransaction | undefined;
     readonly providerMetadata: ProviderMetadata;
     readonly riskFactors: RiskFactors | null;
     readonly createdAt: number;
@@ -253,7 +259,7 @@ interface RoutesRequestParams {
     readonly fromTokenAddress: string;
     readonly toTokenAddress: string;
     readonly amount: string;
-    readonly fromAddress: string;
+    readonly fromAddress?: string;
     readonly toAddress?: string;
     readonly slippage?: number;
     readonly preferences?: RoutePreferences;
@@ -328,6 +334,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
  *
@@ -478,9 +496,9 @@ declare const SDK_MODES: {
 type SDKMode = (typeof SDK_MODES)[keyof typeof SDK_MODES];
 
 interface SDKConfig {
-    mode: SDKMode[];
-    core: CoreConfig;
-    native: NativeConfig;
+    mode?: SDKMode[];
+    core?: CoreConfig;
+    native?: NativeConfig;
 }
 
 /**
@@ -761,7 +779,7 @@ declare class NativeClient {
 declare class CoreClient {
     private config;
     private arcApiService;
-    constructor(config: CoreConfig);
+    constructor(config?: CoreConfig);
     /**
      * Generic pagination helper for chains API calls (limit and offset based pagination)
      * Handles automatic pagination to fetch all available data
@@ -803,12 +821,52 @@ 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
      */
     getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<TransactionsResponse>;
 }
 
+/**
+ * API Error Class
+ *
+ * Custom error class to preserve API error details
+ */
+
+declare class ApiError extends Error {
+    readonly code: number;
+    readonly name: string;
+    readonly details?: Record<string, unknown> | undefined;
+    constructor(errorResponse: ErrorResponse);
+    /**
+     * Create API error from error response
+     */
+    static fromErrorResponse(errorResponse: ErrorResponse): ApiError;
+    /**
+     * Create fallback error when API completely fails
+     */
+    static createFallbackError(originalError: Error, operation: string): ApiError;
+    /**
+     * Convert to plain object for serialization
+     */
+    toJSON(): {
+        name: string;
+        message: string;
+        code: number;
+        details: Record<string, unknown> | undefined;
+    };
+}
+
 /**
  * AggLayer SDK - Main SDK
  *
@@ -819,7 +877,7 @@ declare class AggLayerSDK {
     private config;
     private core?;
     private native?;
-    constructor(config: SDKConfig);
+    constructor(config?: SDKConfig);
     /**
      * Get core submodule
      */
@@ -830,4 +888,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, ApiError, 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 };