@agglayer/sdk 1.0.0-beta.24 → 1.0.0-beta.25

package/dist/index.d.mts

@@ -61,6 +61,21 @@ interface TokenReference {
     readonly chainId: number;
 }
 
+/**
+ * Arc API Unsigned Transaction Types
+ *
+ * Defines the core request and response types for the tokens.
+ */
+interface UnsignedTransaction {
+    readonly to: string;
+    readonly data: string;
+    readonly value: string;
+    readonly gasLimit: string;
+    readonly gasPrice?: string;
+    readonly chainId: number;
+    readonly from?: string;
+}
+
 /**
  * Arc API Chains Types
  *
@@ -100,21 +115,6 @@ type ChainsResponse = {
     readonly chains: IChain[];
 };
 
-/**
- * Arc API Unsigned Transaction Types
- *
- * Defines the core request and response types for the tokens.
- */
-interface UnsignedTransaction {
-    readonly to: string;
-    readonly data: string;
-    readonly value: string;
-    readonly gasLimit: string;
-    readonly gasPrice?: string;
-    readonly chainId: number;
-    readonly from?: string;
-}
-
 /**
  * Arc API Routes Types
  *
@@ -317,7 +317,7 @@ interface Transaction {
 }
 interface TransactionsRequestQueryParams {
     readonly address?: string;
-    readonly sorceNetworkIds?: string;
+    readonly sourceNetworkIds?: string;
     readonly destinationNetworkIds?: string;
     readonly limit?: number;
     readonly startAfter?: number;
@@ -382,6 +382,88 @@ type TokenMetadataResponse = {
     decimals: number;
 };
 
+/**
+ * LiFi API Status Types
+ *
+ * Defines the request and response types for the LiFi status endpoint.
+ */
+interface LiFiToken {
+    readonly address: string;
+    readonly chainId: number;
+    readonly symbol: string;
+    readonly decimals: number;
+    readonly name: string;
+    readonly coinKey: string;
+    readonly logoURI: string;
+    readonly priceUSD: string;
+}
+interface LiFiStep {
+    readonly tool: string;
+    readonly toolDetails: {
+        readonly key: string;
+        readonly name: string;
+        readonly logoURI: string;
+    };
+    readonly fromAmount: string;
+    readonly fromToken: LiFiToken;
+    readonly toToken: LiFiToken;
+    readonly toAmount: string;
+    readonly bridgedAmount: string;
+}
+interface LiFiTransaction {
+    readonly txHash: string;
+    readonly txLink: string;
+    readonly amount: string;
+    readonly token: LiFiToken;
+    readonly chainId: number;
+    readonly gasPrice: string;
+    readonly gasUsed: string;
+    readonly gasToken: LiFiToken;
+    readonly gasAmount: string;
+    readonly gasAmountUSD: string;
+    readonly amountUSD: string;
+    readonly value: string;
+    readonly includedSteps: LiFiStep[];
+    readonly timestamp: number;
+}
+interface LiFiFeeCost {
+    readonly name: string;
+    readonly description: string;
+    readonly percentage: string;
+    readonly token: LiFiToken;
+    readonly amount: string;
+    readonly amountUSD: string;
+    readonly included: boolean;
+}
+interface LiFiMetadata {
+    readonly integrator: string;
+    readonly [key: string]: unknown;
+}
+type LiFiTransferStatus = 'NOT_FOUND' | 'INVALID' | 'PENDING' | 'DONE' | 'FAILED';
+type LiFiTransferSubstatus = 'WAIT_SOURCE_CONFIRMATIONS' | 'WAIT_DESTINATION_TRANSACTION' | 'BRIDGE_NOT_AVAILABLE' | 'CHAIN_NOT_AVAILABLE' | 'REFUND_IN_PROGRESS' | 'UNKNOWN_ERROR' | 'COMPLETED' | 'PARTIAL' | 'REFUNDED';
+type LiFiBridge = 'hop' | 'cbridge' | 'celercircle' | 'optimism' | 'polygon' | 'arbitrum' | 'avalanche' | 'across' | 'gnosis' | 'omni' | 'relay' | 'celerim' | 'symbiosis' | 'thorswap' | 'squid' | 'allbridge' | 'mayan' | 'debridge' | 'chainflip';
+interface LiFiStatusRequestParams {
+    readonly txHash: string;
+    readonly bridge?: LiFiBridge;
+    readonly fromChain?: string;
+    readonly toChain?: string;
+}
+interface LiFiStatusResponse {
+    readonly transactionId: string;
+    readonly sending: LiFiTransaction;
+    readonly receiving?: LiFiTransaction;
+    readonly feeCosts: LiFiFeeCost[];
+    readonly lifiExplorerLink: string;
+    readonly fromAddress: string;
+    readonly toAddress: string;
+    readonly tool: string;
+    readonly status: LiFiTransferStatus;
+    readonly substatus?: LiFiTransferSubstatus;
+    readonly substatusMessage?: string;
+    readonly metadata: LiFiMetadata;
+    readonly bridgeExplorerLink?: string;
+}
+
 /**
  * Chain Types
  *
@@ -815,6 +897,7 @@ declare class NativeClient {
 declare class CoreClient {
     private config;
     private arcApiService;
+    private lifiApiService;
     constructor(config?: CoreConfig);
     /**
      * Generic pagination helper for chains API calls (limit and offset based pagination)
@@ -884,6 +967,16 @@ declare class CoreClient {
      * @param tokenAddress
      */
     getTokenMappings(tokenMappingQueryParams: TokenMappingQueryParams): Promise<TokenMappingResponse>;
+    /**
+     * Check the status of a LiFi cross-chain transfer
+     *
+     * @param lifiStatusRequestParams - Status request parameters
+     * @param lifiStatusRequestParams.txHash - The transaction hash on the sending chain, destination chain or lifi step id
+     * @param lifiStatusRequestParams.bridge - Optional: The bridging tool used for the transfer
+     * @param lifiStatusRequestParams.fromChain - Optional: The sending chain (chain id or chain key)
+     * @param lifiStatusRequestParams.toChain - Optional: The receiving chain (chain id or chain key)
+     */
+    getLiFiTransferStatus(lifiStatusRequestParams: LiFiStatusRequestParams): Promise<LiFiStatusResponse>;
 }
 
 /**
@@ -937,4 +1030,4 @@ declare class AggLayerSDK {
     getNative(): NativeClient;
 }
 
-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 PaginatedTransactionsResponse, 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 TokenMappingQueryParams, type TokenMappingResponse, type TokenMetadataRequestParam, type TokenMetadataResponse, 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 LiFiBridge, type LiFiFeeCost, type LiFiMetadata, type LiFiStatusRequestParams, type LiFiStatusResponse, type LiFiStep, type LiFiToken, type LiFiTransaction, type LiFiTransferStatus, type LiFiTransferSubstatus, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type PaginatedTransactionsResponse, 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 TokenMappingQueryParams, type TokenMappingResponse, type TokenMetadataRequestParam, type TokenMetadataResponse, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type UnsignedTransaction, type WrappedTokenParams };

package/dist/index.d.ts

@@ -61,6 +61,21 @@ interface TokenReference {
     readonly chainId: number;
 }
 
+/**
+ * Arc API Unsigned Transaction Types
+ *
+ * Defines the core request and response types for the tokens.
+ */
+interface UnsignedTransaction {
+    readonly to: string;
+    readonly data: string;
+    readonly value: string;
+    readonly gasLimit: string;
+    readonly gasPrice?: string;
+    readonly chainId: number;
+    readonly from?: string;
+}
+
 /**
  * Arc API Chains Types
  *
@@ -100,21 +115,6 @@ type ChainsResponse = {
     readonly chains: IChain[];
 };
 
-/**
- * Arc API Unsigned Transaction Types
- *
- * Defines the core request and response types for the tokens.
- */
-interface UnsignedTransaction {
-    readonly to: string;
-    readonly data: string;
-    readonly value: string;
-    readonly gasLimit: string;
-    readonly gasPrice?: string;
-    readonly chainId: number;
-    readonly from?: string;
-}
-
 /**
  * Arc API Routes Types
  *
@@ -317,7 +317,7 @@ interface Transaction {
 }
 interface TransactionsRequestQueryParams {
     readonly address?: string;
-    readonly sorceNetworkIds?: string;
+    readonly sourceNetworkIds?: string;
     readonly destinationNetworkIds?: string;
     readonly limit?: number;
     readonly startAfter?: number;
@@ -382,6 +382,88 @@ type TokenMetadataResponse = {
     decimals: number;
 };
 
+/**
+ * LiFi API Status Types
+ *
+ * Defines the request and response types for the LiFi status endpoint.
+ */
+interface LiFiToken {
+    readonly address: string;
+    readonly chainId: number;
+    readonly symbol: string;
+    readonly decimals: number;
+    readonly name: string;
+    readonly coinKey: string;
+    readonly logoURI: string;
+    readonly priceUSD: string;
+}
+interface LiFiStep {
+    readonly tool: string;
+    readonly toolDetails: {
+        readonly key: string;
+        readonly name: string;
+        readonly logoURI: string;
+    };
+    readonly fromAmount: string;
+    readonly fromToken: LiFiToken;
+    readonly toToken: LiFiToken;
+    readonly toAmount: string;
+    readonly bridgedAmount: string;
+}
+interface LiFiTransaction {
+    readonly txHash: string;
+    readonly txLink: string;
+    readonly amount: string;
+    readonly token: LiFiToken;
+    readonly chainId: number;
+    readonly gasPrice: string;
+    readonly gasUsed: string;
+    readonly gasToken: LiFiToken;
+    readonly gasAmount: string;
+    readonly gasAmountUSD: string;
+    readonly amountUSD: string;
+    readonly value: string;
+    readonly includedSteps: LiFiStep[];
+    readonly timestamp: number;
+}
+interface LiFiFeeCost {
+    readonly name: string;
+    readonly description: string;
+    readonly percentage: string;
+    readonly token: LiFiToken;
+    readonly amount: string;
+    readonly amountUSD: string;
+    readonly included: boolean;
+}
+interface LiFiMetadata {
+    readonly integrator: string;
+    readonly [key: string]: unknown;
+}
+type LiFiTransferStatus = 'NOT_FOUND' | 'INVALID' | 'PENDING' | 'DONE' | 'FAILED';
+type LiFiTransferSubstatus = 'WAIT_SOURCE_CONFIRMATIONS' | 'WAIT_DESTINATION_TRANSACTION' | 'BRIDGE_NOT_AVAILABLE' | 'CHAIN_NOT_AVAILABLE' | 'REFUND_IN_PROGRESS' | 'UNKNOWN_ERROR' | 'COMPLETED' | 'PARTIAL' | 'REFUNDED';
+type LiFiBridge = 'hop' | 'cbridge' | 'celercircle' | 'optimism' | 'polygon' | 'arbitrum' | 'avalanche' | 'across' | 'gnosis' | 'omni' | 'relay' | 'celerim' | 'symbiosis' | 'thorswap' | 'squid' | 'allbridge' | 'mayan' | 'debridge' | 'chainflip';
+interface LiFiStatusRequestParams {
+    readonly txHash: string;
+    readonly bridge?: LiFiBridge;
+    readonly fromChain?: string;
+    readonly toChain?: string;
+}
+interface LiFiStatusResponse {
+    readonly transactionId: string;
+    readonly sending: LiFiTransaction;
+    readonly receiving?: LiFiTransaction;
+    readonly feeCosts: LiFiFeeCost[];
+    readonly lifiExplorerLink: string;
+    readonly fromAddress: string;
+    readonly toAddress: string;
+    readonly tool: string;
+    readonly status: LiFiTransferStatus;
+    readonly substatus?: LiFiTransferSubstatus;
+    readonly substatusMessage?: string;
+    readonly metadata: LiFiMetadata;
+    readonly bridgeExplorerLink?: string;
+}
+
 /**
  * Chain Types
  *
@@ -815,6 +897,7 @@ declare class NativeClient {
 declare class CoreClient {
     private config;
     private arcApiService;
+    private lifiApiService;
     constructor(config?: CoreConfig);
     /**
      * Generic pagination helper for chains API calls (limit and offset based pagination)
@@ -884,6 +967,16 @@ declare class CoreClient {
      * @param tokenAddress
      */
     getTokenMappings(tokenMappingQueryParams: TokenMappingQueryParams): Promise<TokenMappingResponse>;
+    /**
+     * Check the status of a LiFi cross-chain transfer
+     *
+     * @param lifiStatusRequestParams - Status request parameters
+     * @param lifiStatusRequestParams.txHash - The transaction hash on the sending chain, destination chain or lifi step id
+     * @param lifiStatusRequestParams.bridge - Optional: The bridging tool used for the transfer
+     * @param lifiStatusRequestParams.fromChain - Optional: The sending chain (chain id or chain key)
+     * @param lifiStatusRequestParams.toChain - Optional: The receiving chain (chain id or chain key)
+     */
+    getLiFiTransferStatus(lifiStatusRequestParams: LiFiStatusRequestParams): Promise<LiFiStatusResponse>;
 }
 
 /**
@@ -937,4 +1030,4 @@ declare class AggLayerSDK {
     getNative(): NativeClient;
 }
 
-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 PaginatedTransactionsResponse, 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 TokenMappingQueryParams, type TokenMappingResponse, type TokenMetadataRequestParam, type TokenMetadataResponse, 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 LiFiBridge, type LiFiFeeCost, type LiFiMetadata, type LiFiStatusRequestParams, type LiFiStatusResponse, type LiFiStep, type LiFiToken, type LiFiTransaction, type LiFiTransferStatus, type LiFiTransferSubstatus, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type PaginatedTransactionsResponse, 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 TokenMappingQueryParams, type TokenMappingResponse, type TokenMetadataRequestParam, type TokenMetadataResponse, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type UnsignedTransaction, type WrappedTokenParams };

package/dist/index.js

@@ -1425,6 +1425,8 @@ 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;
@@ -1745,6 +1747,39 @@ var ArcApiService = class {
   }
 };
 
+// src/core/services/lifiApi.ts
+var LiFiApiService = class {
+  constructor({ baseUrl, timeout }) {
+    this.httpClient = new HttpClient({ baseUrl, timeout });
+  }
+  /**
+   * Check the status of a cross-chain transfer
+   *
+   * @param params - Status request parameters
+   * @param params.txHash - The transaction hash on the sending chain, destination chain or lifi step id
+   * @param params.bridge - Optional: The bridging tool used for the transfer
+   * @param params.fromChain - Optional: The sending chain (chain id or chain key)
+   * @param params.toChain - Optional: The receiving chain (chain id or chain key)
+   * @returns Promise containing the transfer status response
+   */
+  async getStatus(params) {
+    const { txHash, bridge, fromChain, toChain } = params;
+    const queryParams = {
+      txHash
+    };
+    if (bridge) {
+      queryParams["bridge"] = bridge;
+    }
+    if (fromChain) {
+      queryParams["fromChain"] = fromChain;
+    }
+    if (toChain) {
+      queryParams["toChain"] = toChain;
+    }
+    return this.httpClient.get("/v1/status", queryParams);
+  }
+};
+
 // src/core/utils/apiError.ts
 var ApiError = class _ApiError extends Error {
   constructor(errorResponse) {
@@ -1803,6 +1838,10 @@ var CoreClient = class {
       baseUrl: apiBaseUrl || ARC_API_BASE_URL,
       timeout: apiTimeout || ARC_API_DEFAULT_TIMEOUT
     });
+    this.lifiApiService = new LiFiApiService({
+      baseUrl: LIFI_API_BASE_URL,
+      timeout: LIFI_API_DEFAULT_TIMEOUT
+    });
   }
   /**
    * Generic pagination helper for chains API calls (limit and offset based pagination)
@@ -2063,6 +2102,31 @@ var CoreClient = class {
       );
     }
   }
+  /**
+   * Check the status of a LiFi cross-chain transfer
+   *
+   * @param lifiStatusRequestParams - Status request parameters
+   * @param lifiStatusRequestParams.txHash - The transaction hash on the sending chain, destination chain or lifi step id
+   * @param lifiStatusRequestParams.bridge - Optional: The bridging tool used for the transfer
+   * @param lifiStatusRequestParams.fromChain - Optional: The sending chain (chain id or chain key)
+   * @param lifiStatusRequestParams.toChain - Optional: The receiving chain (chain id or chain key)
+   */
+  async getLiFiTransferStatus(lifiStatusRequestParams) {
+    try {
+      const response = await this.lifiApiService.getStatus(
+        lifiStatusRequestParams
+      );
+      return response.data;
+    } catch (error) {
+      if (error instanceof ApiError) {
+        throw error;
+      }
+      throw ApiError.createFallbackError(
+        error,
+        "Get LiFi transfer status"
+      );
+    }
+  }
 };
 
 // src/index.ts