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

package/dist/index.d.mts

@@ -19,6 +19,7 @@ type ApiResponse<T = unknown> = SuccessResponse<T> | ErrorResponse;
 interface SuccessResponse<T = unknown> {
     readonly status: 'success';
     readonly data: T;
+    readonly pagination?: OffsetPagination | CursorPagination;
 }
 interface ErrorResponse {
     readonly status: 'error';
@@ -27,6 +28,16 @@ interface ErrorResponse {
     readonly code: number;
     readonly details?: Record<string, unknown>;
 }
+interface Pagination {
+    readonly total?: number;
+    readonly limit?: number;
+}
+interface OffsetPagination extends Pagination {
+    readonly offset?: number;
+}
+interface CursorPagination extends Pagination {
+    readonly nextStartAfterCursor?: string;
+}
 
 /**
  * Arc API Tokens Types
@@ -78,13 +89,27 @@ type ChainsQueryParams = {
     readonly withSupportedTokens?: boolean;
     readonly chainIds?: readonly number[];
     readonly limit?: number;
-    readonly startAfter?: number;
+    readonly offset?: number;
 };
 type ChainsResponse = {
     readonly chains: IChain[];
-    readonly nextStartAfter?: 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 Routes Types
  *
@@ -166,15 +191,6 @@ interface Step {
     readonly includedSteps: Step[] | null;
     readonly relatedSteps: string[] | null;
 }
-interface TransactionRequest {
-    readonly to: string;
-    readonly data: string;
-    readonly value: string;
-    readonly gasLimit: string;
-    readonly gasPrice?: string;
-    readonly chainId: number;
-    readonly from?: string;
-}
 interface ProviderMetadata {
     readonly lifi?: {
         readonly integrator: string | null;
@@ -214,7 +230,7 @@ interface Route {
     readonly feeCosts: FeeCost[];
     readonly gasCosts: GasCost[];
     readonly steps: Step[];
-    readonly transactionRequest?: TransactionRequest;
+    readonly transactionRequest?: UnsignedTransaction;
     readonly providerMetadata: ProviderMetadata;
     readonly riskFactors: RiskFactors | null;
     readonly createdAt: number;
@@ -293,7 +309,7 @@ interface Transaction {
     };
 }
 interface TransactionsRequestQueryParams {
-    readonly fromAddress?: string;
+    readonly address?: string;
     readonly sorceNetworkIds?: string;
     readonly destinationNetworkIds?: string;
     readonly limit?: number;
@@ -301,7 +317,6 @@ interface TransactionsRequestQueryParams {
 }
 type TransactionsResponse = {
     transactions: Transaction[];
-    nextStartAfter?: number;
 };
 
 /**
@@ -311,7 +326,7 @@ type TransactionsResponse = {
  */
 
 type BuildTransactionRequestBody = Step;
-type BuildTransactionResponse = Route;
+type BuildTransactionResponse = UnsignedTransaction;
 
 /**
  * Chain Types
@@ -747,19 +762,32 @@ declare class CoreClient {
     private config;
     private arcApiService;
     constructor(config: CoreConfig);
+    /**
+     * Generic pagination helper for chains API calls (limit and offset based pagination)
+     * Handles automatic pagination to fetch all available data
+     * @param params - Parameters for the chains API call
+     * @param pageSize - Number of items per page (defaults to DEFAULT_CHAINS_PER_PAGE)
+     */
+    private getAllChainsPaginated;
     /**
      * Get all chains metadata from AggLayer API
+     * Handles pagination automatically to fetch all available chains
      */
     getAllChains(): Promise<ChainsResponse>;
     /**
      * Get chain metadata by id from AggLayer API
+     * Handles pagination automatically to fetch all available chain metadata
      * @param ids - the ids of the chains to get metadata for
      */
     getChainMetadataByChainIds(ids: number[]): Promise<ChainsResponse>;
     /**
      * Get all tokens from AggLayer API
+     *
+     * Developer Note: This method is not recommended to use frequently or from frontend.
+     * As it can be very slow and resource intensive.
+     * It is recommended to use getChainDataAndTokensByChainIds instead.
      */
-    getTokens(): Promise<ChainsResponse>;
+    getAllTokens(): Promise<ChainsResponse>;
     /**
      * Get chain data and tokens by AggLayer API
      * @param ids - the ids of the chains to get data and tokens for
@@ -770,9 +798,11 @@ declare class CoreClient {
      */
     getRoutes(routesRequestParams: RoutesRequestParams): Promise<RoutesResponse>;
     /**
-     * Build transaction from a step object
+     * Get calldata from a route
+     * If route has transactionRequest field, return it directly as calldata
+     * Otherwise, call buildTransaction on route.steps[0] and return that as calldata
      */
-    buildTransaction(builtTransactionRequestBody: BuildTransactionRequestBody): Promise<BuildTransactionResponse>;
+    getUnsignedTransaction(route: Route): Promise<UnsignedTransaction>;
     /**
      * Get all transactions via web sockets
      */
@@ -800,4 +830,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 CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OriginTokenInfoParams, 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 TransactionRequest, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };
+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 };

package/dist/index.d.ts

@@ -19,6 +19,7 @@ type ApiResponse<T = unknown> = SuccessResponse<T> | ErrorResponse;
 interface SuccessResponse<T = unknown> {
     readonly status: 'success';
     readonly data: T;
+    readonly pagination?: OffsetPagination | CursorPagination;
 }
 interface ErrorResponse {
     readonly status: 'error';
@@ -27,6 +28,16 @@ interface ErrorResponse {
     readonly code: number;
     readonly details?: Record<string, unknown>;
 }
+interface Pagination {
+    readonly total?: number;
+    readonly limit?: number;
+}
+interface OffsetPagination extends Pagination {
+    readonly offset?: number;
+}
+interface CursorPagination extends Pagination {
+    readonly nextStartAfterCursor?: string;
+}
 
 /**
  * Arc API Tokens Types
@@ -78,13 +89,27 @@ type ChainsQueryParams = {
     readonly withSupportedTokens?: boolean;
     readonly chainIds?: readonly number[];
     readonly limit?: number;
-    readonly startAfter?: number;
+    readonly offset?: number;
 };
 type ChainsResponse = {
     readonly chains: IChain[];
-    readonly nextStartAfter?: 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 Routes Types
  *
@@ -166,15 +191,6 @@ interface Step {
     readonly includedSteps: Step[] | null;
     readonly relatedSteps: string[] | null;
 }
-interface TransactionRequest {
-    readonly to: string;
-    readonly data: string;
-    readonly value: string;
-    readonly gasLimit: string;
-    readonly gasPrice?: string;
-    readonly chainId: number;
-    readonly from?: string;
-}
 interface ProviderMetadata {
     readonly lifi?: {
         readonly integrator: string | null;
@@ -214,7 +230,7 @@ interface Route {
     readonly feeCosts: FeeCost[];
     readonly gasCosts: GasCost[];
     readonly steps: Step[];
-    readonly transactionRequest?: TransactionRequest;
+    readonly transactionRequest?: UnsignedTransaction;
     readonly providerMetadata: ProviderMetadata;
     readonly riskFactors: RiskFactors | null;
     readonly createdAt: number;
@@ -293,7 +309,7 @@ interface Transaction {
     };
 }
 interface TransactionsRequestQueryParams {
-    readonly fromAddress?: string;
+    readonly address?: string;
     readonly sorceNetworkIds?: string;
     readonly destinationNetworkIds?: string;
     readonly limit?: number;
@@ -301,7 +317,6 @@ interface TransactionsRequestQueryParams {
 }
 type TransactionsResponse = {
     transactions: Transaction[];
-    nextStartAfter?: number;
 };
 
 /**
@@ -311,7 +326,7 @@ type TransactionsResponse = {
  */
 
 type BuildTransactionRequestBody = Step;
-type BuildTransactionResponse = Route;
+type BuildTransactionResponse = UnsignedTransaction;
 
 /**
  * Chain Types
@@ -747,19 +762,32 @@ declare class CoreClient {
     private config;
     private arcApiService;
     constructor(config: CoreConfig);
+    /**
+     * Generic pagination helper for chains API calls (limit and offset based pagination)
+     * Handles automatic pagination to fetch all available data
+     * @param params - Parameters for the chains API call
+     * @param pageSize - Number of items per page (defaults to DEFAULT_CHAINS_PER_PAGE)
+     */
+    private getAllChainsPaginated;
     /**
      * Get all chains metadata from AggLayer API
+     * Handles pagination automatically to fetch all available chains
      */
     getAllChains(): Promise<ChainsResponse>;
     /**
      * Get chain metadata by id from AggLayer API
+     * Handles pagination automatically to fetch all available chain metadata
      * @param ids - the ids of the chains to get metadata for
      */
     getChainMetadataByChainIds(ids: number[]): Promise<ChainsResponse>;
     /**
      * Get all tokens from AggLayer API
+     *
+     * Developer Note: This method is not recommended to use frequently or from frontend.
+     * As it can be very slow and resource intensive.
+     * It is recommended to use getChainDataAndTokensByChainIds instead.
      */
-    getTokens(): Promise<ChainsResponse>;
+    getAllTokens(): Promise<ChainsResponse>;
     /**
      * Get chain data and tokens by AggLayer API
      * @param ids - the ids of the chains to get data and tokens for
@@ -770,9 +798,11 @@ declare class CoreClient {
      */
     getRoutes(routesRequestParams: RoutesRequestParams): Promise<RoutesResponse>;
     /**
-     * Build transaction from a step object
+     * Get calldata from a route
+     * If route has transactionRequest field, return it directly as calldata
+     * Otherwise, call buildTransaction on route.steps[0] and return that as calldata
      */
-    buildTransaction(builtTransactionRequestBody: BuildTransactionRequestBody): Promise<BuildTransactionResponse>;
+    getUnsignedTransaction(route: Route): Promise<UnsignedTransaction>;
     /**
      * Get all transactions via web sockets
      */
@@ -800,4 +830,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 CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OriginTokenInfoParams, 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 TransactionRequest, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };
+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 };

package/dist/index.js

@@ -1415,6 +1415,9 @@ var NETWORKS = {
   CARDONA: 2442
 };
 var DEFAULT_NETWORK = NETWORKS.SEPOLIA;
+var DEFAULT_CHAINS_PER_PAGE = 100;
+var DEFAULT_CHAINS_WITH_TOKENS_PER_PAGE = 1;
+var MAX_TRANSACTIONS_PER_PAGE = 100;
 
 // src/native/index.ts
 var NativeClient = class {
@@ -1643,11 +1646,12 @@ var HttpClient = class {
         continue;
       }
       if (Array.isArray(value)) {
-        value.forEach((item, index) => {
-          if (item !== void 0 && item !== null) {
-            result[`${fullKey}[${index}]`] = String(item);
-          }
-        });
+        const filteredValues = value.filter(
+          (item) => item !== void 0 && item !== null
+        );
+        if (filteredValues.length > 0) {
+          result[fullKey] = filteredValues.join(",");
+        }
       } else if (typeof value === "object") {
         Object.assign(
           result,
@@ -1677,16 +1681,17 @@ var ArcApiService = class {
     this.httpClient = new HttpClient({ baseUrl, timeout });
   }
   // responsible for both chains metadata and tokens
+  // supports limit/offset based pagination
   async chains({
     withSupportedTokens = false,
-    limit = 20,
-    startAfter,
+    limit = 10,
+    offset,
     chainIds
   } = {}) {
     return this.httpClient.get("/metadata/chains", {
       withSupportedTokens,
       limit,
-      startAfter,
+      offset,
       chainIds
     });
   }
@@ -1699,6 +1704,7 @@ var ArcApiService = class {
       builtTransactionRequestBody
     );
   }
+  // supports cursor based pagination only
   async transactions(transactionsRequestQueryParams) {
     return this.httpClient.get("/transactions", {
       transactionsRequestQueryParams
@@ -1722,52 +1728,102 @@ var CoreClient = class {
       timeout: apiTimeout ?? 3e4
     });
   }
+  /**
+   * Generic pagination helper for chains API calls (limit and offset based pagination)
+   * Handles automatic pagination to fetch all available data
+   * @param params - Parameters for the chains API call
+   * @param pageSize - Number of items per page (defaults to DEFAULT_CHAINS_PER_PAGE)
+   */
+  async getAllChainsPaginated(params, pageSize = DEFAULT_CHAINS_PER_PAGE) {
+    const firstResponse = await this.arcApiService.chains({
+      ...params,
+      limit: pageSize
+    });
+    if (firstResponse.data.status !== "success") {
+      throw new Error(firstResponse.data.message);
+    }
+    const firstPageData = firstResponse.data.data;
+    const pagination = firstResponse.data.pagination;
+    const firstPageChains = Array.isArray(firstPageData) ? firstPageData : [];
+    if (!pagination?.total || pagination.total <= pageSize) {
+      return {
+        chains: firstPageChains
+      };
+    }
+    const totalPages = Math.ceil(pagination.total / pageSize);
+    const remainingPages = totalPages - 1;
+    if (remainingPages === 0) {
+      return {
+        chains: firstPageChains
+      };
+    }
+    const remainingPagePromises = Array.from(
+      { length: remainingPages },
+      (_, index) => {
+        const offset = (index + 1) * pageSize;
+        return this.arcApiService.chains({
+          ...params,
+          limit: pageSize,
+          offset
+        });
+      }
+    );
+    const remainingResponses = await Promise.all(remainingPagePromises);
+    for (const response of remainingResponses) {
+      if (response.data.status !== "success") {
+        throw new Error(response.data.message);
+      }
+    }
+    const allChains = [
+      ...firstPageChains,
+      ...remainingResponses.flatMap((response) => {
+        if (response.data.status === "success") {
+          return Array.isArray(response.data.data) ? response.data.data : [];
+        }
+        return [];
+      })
+    ];
+    return {
+      chains: allChains
+    };
+  }
   /**
    * Get all chains metadata from AggLayer API
+   * Handles pagination automatically to fetch all available chains
    */
   async getAllChains() {
-    const response = await this.arcApiService.chains();
-    if (response.data.status === "success") {
-      return response.data.data;
-    }
-    throw new Error(response.data.message);
+    return this.getAllChainsPaginated({});
   }
   /**
    * Get chain metadata by id from AggLayer API
+   * Handles pagination automatically to fetch all available chain metadata
    * @param ids - the ids of the chains to get metadata for
    */
   async getChainMetadataByChainIds(ids) {
-    const response = await this.arcApiService.chains({ chainIds: ids });
-    if (response.data.status === "success") {
-      return response.data.data;
-    }
-    throw new Error(response.data.message);
+    return this.getAllChainsPaginated({ chainIds: ids });
   }
   /**
    * Get all tokens from AggLayer API
-   */
-  async getTokens() {
-    const response = await this.arcApiService.chains({
-      withSupportedTokens: true
-    });
-    if (response.data.status === "success") {
-      return response.data.data;
-    }
-    throw new Error(response.data.message);
+   *
+   * Developer Note: This method is not recommended to use frequently or from frontend.
+   * As it can be very slow and resource intensive.
+   * It is recommended to use getChainDataAndTokensByChainIds instead.
+   */
+  async getAllTokens() {
+    return this.getAllChainsPaginated(
+      { withSupportedTokens: true },
+      DEFAULT_CHAINS_WITH_TOKENS_PER_PAGE
+    );
   }
   /**
    * Get chain data and tokens by AggLayer API
    * @param ids - the ids of the chains to get data and tokens for
    */
   async getChainDataAndTokensByChainIds(ids) {
-    const response = await this.arcApiService.chains({
+    return this.getAllChainsPaginated({
       chainIds: ids,
       withSupportedTokens: true
     });
-    if (response.data.status === "success") {
-      return response.data.data;
-    }
-    throw new Error(response.data.message);
   }
   /**
    * Get all routes from AggLayer API
@@ -1780,12 +1836,18 @@ var CoreClient = class {
     throw new Error(response.data.message);
   }
   /**
-   * Build transaction from a step object
+   * Get calldata from a route
+   * If route has transactionRequest field, return it directly as calldata
+   * Otherwise, call buildTransaction on route.steps[0] and return that as calldata
    */
-  async buildTransaction(builtTransactionRequestBody) {
-    const response = await this.arcApiService.buildTransaction(
-      builtTransactionRequestBody
-    );
+  async getUnsignedTransaction(route) {
+    if (route.transactionRequest) {
+      return route.transactionRequest;
+    }
+    if (route.steps.length === 0 || !route.steps[0]) {
+      throw new Error("Route has no steps to build transaction from");
+    }
+    const response = await this.arcApiService.buildTransaction(route.steps[0]);
     if (response.data.status === "success") {
       return response.data.data;
     }
@@ -1795,6 +1857,11 @@ var CoreClient = class {
    * Get all transactions via web sockets
    */
   async getTransactions(transactionsRequestQueryParams) {
+    if (transactionsRequestQueryParams.limit && transactionsRequestQueryParams.limit > MAX_TRANSACTIONS_PER_PAGE) {
+      throw new Error(
+        `Limit cannot be greater than ${MAX_TRANSACTIONS_PER_PAGE}`
+      );
+    }
     const response = await this.arcApiService.transactions(
       transactionsRequestQueryParams
     );