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

package/dist/index.d.mts

@@ -271,6 +271,7 @@ type RoutesResponse = readonly Route[];
  *
  * Defines the core request and response types for the transactions endpoint.
  */
+
 interface Transaction {
     id: string;
     transactionHash: string;
@@ -321,9 +322,11 @@ interface TransactionsRequestQueryParams {
     readonly limit?: number;
     readonly startAfter?: number;
 }
-type TransactionsResponse = {
-    transactions: Transaction[];
-};
+type TransactionsResponse = Transaction[];
+interface PaginatedTransactionsResponse {
+    readonly transactions: TransactionsResponse;
+    readonly pagination?: CursorPagination;
+}
 
 /**
  * Arc API Built Transaction Types
@@ -361,6 +364,24 @@ type TokenMappingResponse = Array<{
     wrappedTokenAddress: string;
 }>;
 
+/**
+ * Arc API Token Metadata Types
+ *
+ * Defines the core request and response types for the token metadata endpoint.
+ */
+type TokenMetadataRequestParam = {
+    tokenAddress: string;
+};
+type TokenMetadataResponse = {
+    originTokenNetwork: number;
+    originTokenAddress: string;
+    wrappedTokenAddressV1: string;
+    wrappedTokenAddressV2: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+};
+
 /**
  * Chain Types
  *
@@ -826,6 +847,11 @@ declare class CoreClient {
      * @param ids - the ids of the chains to get data and tokens for
      */
     getChainDataAndTokensByChainIds(ids: number[]): Promise<ChainsResponse>;
+    /**
+     * Get token metadata by token address from ARC API
+     * @param tokenMetadataRequestParam - Object containing the token address
+     */
+    getTokenMetadata(tokenMetadataRequestParam: TokenMetadataRequestParam): Promise<TokenMetadataResponse>;
     /**
      * Get all routes from AggLayer API
      */
@@ -847,9 +873,10 @@ declare class CoreClient {
      */
     getClaimUnsignedTransaction(buildClaimTxParams: BuildClaimTransactionRequestParam): Promise<UnsignedTransaction>;
     /**
-     * Get all transactions via web sockets
+     * Get all transactions with pagination information
+     * @param transactionsRequestQueryParams - Parameters for the transactions API call
      */
-    getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<TransactionsResponse>;
+    getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<PaginatedTransactionsResponse>;
     /**
      * Get token mappings by token address
      * @developer Note: Do not misinterpret network ID as chain ID.
@@ -910,4 +937,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 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 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 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 };

package/dist/index.d.ts

@@ -271,6 +271,7 @@ type RoutesResponse = readonly Route[];
  *
  * Defines the core request and response types for the transactions endpoint.
  */
+
 interface Transaction {
     id: string;
     transactionHash: string;
@@ -321,9 +322,11 @@ interface TransactionsRequestQueryParams {
     readonly limit?: number;
     readonly startAfter?: number;
 }
-type TransactionsResponse = {
-    transactions: Transaction[];
-};
+type TransactionsResponse = Transaction[];
+interface PaginatedTransactionsResponse {
+    readonly transactions: TransactionsResponse;
+    readonly pagination?: CursorPagination;
+}
 
 /**
  * Arc API Built Transaction Types
@@ -361,6 +364,24 @@ type TokenMappingResponse = Array<{
     wrappedTokenAddress: string;
 }>;
 
+/**
+ * Arc API Token Metadata Types
+ *
+ * Defines the core request and response types for the token metadata endpoint.
+ */
+type TokenMetadataRequestParam = {
+    tokenAddress: string;
+};
+type TokenMetadataResponse = {
+    originTokenNetwork: number;
+    originTokenAddress: string;
+    wrappedTokenAddressV1: string;
+    wrappedTokenAddressV2: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+};
+
 /**
  * Chain Types
  *
@@ -826,6 +847,11 @@ declare class CoreClient {
      * @param ids - the ids of the chains to get data and tokens for
      */
     getChainDataAndTokensByChainIds(ids: number[]): Promise<ChainsResponse>;
+    /**
+     * Get token metadata by token address from ARC API
+     * @param tokenMetadataRequestParam - Object containing the token address
+     */
+    getTokenMetadata(tokenMetadataRequestParam: TokenMetadataRequestParam): Promise<TokenMetadataResponse>;
     /**
      * Get all routes from AggLayer API
      */
@@ -847,9 +873,10 @@ declare class CoreClient {
      */
     getClaimUnsignedTransaction(buildClaimTxParams: BuildClaimTransactionRequestParam): Promise<UnsignedTransaction>;
     /**
-     * Get all transactions via web sockets
+     * Get all transactions with pagination information
+     * @param transactionsRequestQueryParams - Parameters for the transactions API call
      */
-    getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<TransactionsResponse>;
+    getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<PaginatedTransactionsResponse>;
     /**
      * Get token mappings by token address
      * @developer Note: Do not misinterpret network ID as chain ID.
@@ -910,4 +937,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 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 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 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 };

package/dist/index.js

@@ -1713,6 +1713,11 @@ var ArcApiService = class {
       chainIds
     });
   }
+  async tokenMetadata(tokenMetadataRequestParam) {
+    return this.httpClient.get(
+      `/metadata/tokens/${tokenMetadataRequestParam.tokenAddress}`
+    );
+  }
   async routes(routesRequestParams) {
     return this.httpClient.post("/routes", routesRequestParams);
   }
@@ -1731,7 +1736,7 @@ var ArcApiService = class {
   // supports cursor based pagination only
   async transactions(transactionsRequestQueryParams) {
     return this.httpClient.get("/transactions", {
-      transactionsRequestQueryParams
+      ...transactionsRequestQueryParams
     });
   }
   async tokenMappings(tokenMappingQueryParams) {
@@ -1903,6 +1908,26 @@ var CoreClient = class {
       withSupportedTokens: true
     });
   }
+  /**
+   * Get token metadata by token address from ARC API
+   * @param tokenMetadataRequestParam - Object containing the token address
+   */
+  async getTokenMetadata(tokenMetadataRequestParam) {
+    try {
+      const response = await this.arcApiService.tokenMetadata(
+        tokenMetadataRequestParam
+      );
+      if (response.data.status === "success") {
+        return response.data.data;
+      }
+      throw ApiError.fromErrorResponse(response.data);
+    } catch (error) {
+      if (error instanceof ApiError) {
+        throw error;
+      }
+      throw ApiError.createFallbackError(error, "Get token metadata");
+    }
+  }
   /**
    * Get all routes from AggLayer API
    */
@@ -1983,7 +2008,8 @@ var CoreClient = class {
     }
   }
   /**
-   * Get all transactions via web sockets
+   * Get all transactions with pagination information
+   * @param transactionsRequestQueryParams - Parameters for the transactions API call
    */
   async getTransactions(transactionsRequestQueryParams) {
     if (transactionsRequestQueryParams.limit && transactionsRequestQueryParams.limit > MAX_TRANSACTIONS_PER_PAGE) {
@@ -1997,7 +2023,12 @@ var CoreClient = class {
         transactionsRequestQueryParams
       );
       if (response.data.status === "success") {
-        return response.data.data;
+        return {
+          transactions: response.data.data,
+          ...response.data.pagination && {
+            pagination: response.data.pagination
+          }
+        };
       }
       throw ApiError.fromErrorResponse(response.data);
     } catch (error) {