@agglayer/sdk 1.0.0-beta.19 → 1.0.0-beta.8

package/dist/index.d.mts

@@ -19,7 +19,6 @@ 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';
@@ -28,16 +27,6 @@ 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,11 +67,6 @@ interface IChain {
         name: string;
         symbol: string;
         decimals: number;
-        address: string;
-        logoURI: string;
-        priceUSD: string;
-        originTokenAddress?: string;
-        originChainId?: number;
     };
     networkId?: number;
     bridgeAddress?: string;
@@ -94,27 +78,13 @@ type ChainsQueryParams = {
     readonly withSupportedTokens?: boolean;
     readonly chainIds?: readonly number[];
     readonly limit?: number;
-    readonly offset?: number;
+    readonly startAfter?: 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
  *
@@ -196,14 +166,22 @@ 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;
         readonly transactionRequest?: unknown;
     };
     readonly agglayer?: {
-        readonly bridgeAddress: string | undefined;
-        readonly claimTransactionRequired: boolean | undefined;
+        readonly bridgeAddress: string | null;
     };
     readonly [key: string]: unknown;
 }
@@ -236,7 +214,7 @@ interface Route {
     readonly feeCosts: FeeCost[];
     readonly gasCosts: GasCost[];
     readonly steps: Step[];
-    readonly transactionRequest?: UnsignedTransaction | undefined;
+    readonly transactionRequest?: TransactionRequest;
     readonly providerMetadata: ProviderMetadata;
     readonly riskFactors: RiskFactors | null;
     readonly createdAt: number;
@@ -259,7 +237,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;
@@ -315,7 +293,7 @@ interface Transaction {
     };
 }
 interface TransactionsRequestQueryParams {
-    readonly address?: string;
+    readonly fromAddress?: string;
     readonly sorceNetworkIds?: string;
     readonly destinationNetworkIds?: string;
     readonly limit?: number;
@@ -323,6 +301,7 @@ interface TransactionsRequestQueryParams {
 }
 type TransactionsResponse = {
     transactions: Transaction[];
+    nextStartAfter?: number;
 };
 
 /**
@@ -332,34 +311,7 @@ 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;
-
-/**
- * Arc API Token Mapping Types
- *
- * Defines the request and response types for the token mapping endpoint.
- */
-type TokenMappingQueryParams = {
-    tokenAddress: string;
-};
-type TokenMappingResponse = Array<{
-    originTokenNetwork: number;
-    originTokenAddress: string;
-    wrappedTokenNetwork: number;
-    wrappedTokenAddress: string;
-}>;
+type BuildTransactionResponse = Route;
 
 /**
  * Chain Types
@@ -511,9 +463,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;
 }
 
 /**
@@ -794,33 +746,20 @@ declare class NativeClient {
 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;
+    constructor(config: CoreConfig);
     /**
      * 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.
      */
-    getAllTokens(): Promise<ChainsResponse>;
+    getTokens(): Promise<ChainsResponse>;
     /**
      * Get chain data and tokens by AggLayer API
      * @param ids - the ids of the chains to get data and tokens for
@@ -831,62 +770,13 @@ declare class CoreClient {
      */
     getRoutes(routesRequestParams: RoutesRequestParams): Promise<RoutesResponse>;
     /**
-     * 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
-     */
-    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.
+     * Build transaction from a step object
      */
-    getClaimUnsignedTransaction(buildClaimTxParams: BuildClaimTransactionRequestParam): Promise<UnsignedTransaction>;
+    buildTransaction(builtTransactionRequestBody: BuildTransactionRequestBody): Promise<BuildTransactionResponse>;
     /**
      * Get all transactions via web sockets
      */
     getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<TransactionsResponse>;
-    /**
-     * Get token mappings by token address
-     * @developer Note: Do not misinterpret network ID as chain ID.
-     *
-     * @param tokenAddress
-     */
-    getTokenMappings(tokenMappingQueryParams: TokenMappingQueryParams): Promise<TokenMappingResponse>;
-}
-
-/**
- * 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;
-    };
 }
 
 /**
@@ -899,7 +789,7 @@ declare class AggLayerSDK {
     private config;
     private core?;
     private native?;
-    constructor(config?: SDKConfig);
+    constructor(config: SDKConfig);
     /**
      * Get core submodule
      */
@@ -910,4 +800,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, 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 };

package/dist/index.d.ts

@@ -19,7 +19,6 @@ 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';
@@ -28,16 +27,6 @@ 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,11 +67,6 @@ interface IChain {
         name: string;
         symbol: string;
         decimals: number;
-        address: string;
-        logoURI: string;
-        priceUSD: string;
-        originTokenAddress?: string;
-        originChainId?: number;
     };
     networkId?: number;
     bridgeAddress?: string;
@@ -94,27 +78,13 @@ type ChainsQueryParams = {
     readonly withSupportedTokens?: boolean;
     readonly chainIds?: readonly number[];
     readonly limit?: number;
-    readonly offset?: number;
+    readonly startAfter?: 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
  *
@@ -196,14 +166,22 @@ 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;
         readonly transactionRequest?: unknown;
     };
     readonly agglayer?: {
-        readonly bridgeAddress: string | undefined;
-        readonly claimTransactionRequired: boolean | undefined;
+        readonly bridgeAddress: string | null;
     };
     readonly [key: string]: unknown;
 }
@@ -236,7 +214,7 @@ interface Route {
     readonly feeCosts: FeeCost[];
     readonly gasCosts: GasCost[];
     readonly steps: Step[];
-    readonly transactionRequest?: UnsignedTransaction | undefined;
+    readonly transactionRequest?: TransactionRequest;
     readonly providerMetadata: ProviderMetadata;
     readonly riskFactors: RiskFactors | null;
     readonly createdAt: number;
@@ -259,7 +237,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;
@@ -315,7 +293,7 @@ interface Transaction {
     };
 }
 interface TransactionsRequestQueryParams {
-    readonly address?: string;
+    readonly fromAddress?: string;
     readonly sorceNetworkIds?: string;
     readonly destinationNetworkIds?: string;
     readonly limit?: number;
@@ -323,6 +301,7 @@ interface TransactionsRequestQueryParams {
 }
 type TransactionsResponse = {
     transactions: Transaction[];
+    nextStartAfter?: number;
 };
 
 /**
@@ -332,34 +311,7 @@ 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;
-
-/**
- * Arc API Token Mapping Types
- *
- * Defines the request and response types for the token mapping endpoint.
- */
-type TokenMappingQueryParams = {
-    tokenAddress: string;
-};
-type TokenMappingResponse = Array<{
-    originTokenNetwork: number;
-    originTokenAddress: string;
-    wrappedTokenNetwork: number;
-    wrappedTokenAddress: string;
-}>;
+type BuildTransactionResponse = Route;
 
 /**
  * Chain Types
@@ -511,9 +463,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;
 }
 
 /**
@@ -794,33 +746,20 @@ declare class NativeClient {
 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;
+    constructor(config: CoreConfig);
     /**
      * 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.
      */
-    getAllTokens(): Promise<ChainsResponse>;
+    getTokens(): Promise<ChainsResponse>;
     /**
      * Get chain data and tokens by AggLayer API
      * @param ids - the ids of the chains to get data and tokens for
@@ -831,62 +770,13 @@ declare class CoreClient {
      */
     getRoutes(routesRequestParams: RoutesRequestParams): Promise<RoutesResponse>;
     /**
-     * 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
-     */
-    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.
+     * Build transaction from a step object
      */
-    getClaimUnsignedTransaction(buildClaimTxParams: BuildClaimTransactionRequestParam): Promise<UnsignedTransaction>;
+    buildTransaction(builtTransactionRequestBody: BuildTransactionRequestBody): Promise<BuildTransactionResponse>;
     /**
      * Get all transactions via web sockets
      */
     getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<TransactionsResponse>;
-    /**
-     * Get token mappings by token address
-     * @developer Note: Do not misinterpret network ID as chain ID.
-     *
-     * @param tokenAddress
-     */
-    getTokenMappings(tokenMappingQueryParams: TokenMappingQueryParams): Promise<TokenMappingResponse>;
-}
-
-/**
- * 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;
-    };
 }
 
 /**
@@ -899,7 +789,7 @@ declare class AggLayerSDK {
     private config;
     private core?;
     private native?;
-    constructor(config?: SDKConfig);
+    constructor(config: SDKConfig);
     /**
      * Get core submodule
      */
@@ -910,4 +800,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, 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 };