@lifi/sdk 4.1.0 → 4.2.0

package/dist/cjs/actions/index.d.ts

@@ -3,128 +3,127 @@ import { GetStatusRequestExtended, LiFiStepRequest, QuoteRequestFromAmount, Rout
 import { getQuote } from "./getQuote.js";
 import { PatchContractCallsResponse } from "./patchContractCalls.js";
 import { ChainId, ChainKey, ChainType, ChainsRequest, ConnectionsRequest, ConnectionsResponse, ContractCallsQuoteRequest, ExtendedChain, GasRecommendationRequest, GasRecommendationResponse, LiFiStep, PatchCallDataRequest, RelayRequest, RelayResponseData, RelayStatusRequest, RelayStatusResponseData, RequestOptions, RoutesResponse, StatusResponse, Token, TokenAmount, TokenExtended, TokensExtendedResponse, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse, TransactionAnalyticsRequest, TransactionAnalyticsResponse, WalletTokenExtended } from "@lifi/types";
-
 //#region src/actions/index.d.ts
 type Actions = {
   /**
-  * Get all available chains
-  * @param params - The configuration of the requested chains
-  * @param options - Request options
-  * @returns A list of all available chains
-  */
+   * Get all available chains
+   * @param params - The configuration of the requested chains
+   * @param options - Request options
+   * @returns A list of all available chains
+   */
   getChains: (params?: ChainsRequest, options?: RequestOptions) => Promise<ExtendedChain[]>;
   /**
-  * Get connections between chains
-  * @param params - The configuration of the requested connections
-  * @param options - Request options
-  * @returns A list of connections
-  */
+   * Get connections between chains
+   * @param params - The configuration of the requested connections
+   * @param options - Request options
+   * @returns A list of connections
+   */
   getConnections: (params: ConnectionsRequest, options?: RequestOptions) => Promise<ConnectionsResponse>;
   /**
-  * Get a quote for contract calls
-  * @param params - The configuration of the requested contract calls quote
-  * @param options - Request options
-  * @returns Quote for contract calls
-  */
+   * Get a quote for contract calls
+   * @param params - The configuration of the requested contract calls quote
+   * @param options - Request options
+   * @returns Quote for contract calls
+   */
   getContractCallsQuote: (params: ContractCallsQuoteRequest, options?: RequestOptions) => Promise<LiFiStep>;
   /**
-  * Get gas recommendation for a chain
-  * @param params - The configuration of the requested gas recommendation
-  * @param options - Request options
-  * @returns Gas recommendation
-  */
+   * Get gas recommendation for a chain
+   * @param params - The configuration of the requested gas recommendation
+   * @param options - Request options
+   * @returns Gas recommendation
+   */
   getGasRecommendation: (params: GasRecommendationRequest, options?: RequestOptions) => Promise<GasRecommendationResponse>;
   /**
-  * Get the address of a name service
-  * @param name - The name to resolve
-  * @param chainType - The chain type to resolve the name on
-  * @returns The address of the name service
-  */
+   * Get the address of a name service
+   * @param name - The name to resolve
+   * @param chainType - The chain type to resolve the name on
+   * @returns The address of the name service
+   */
   getNameServiceAddress: (name: string, chainType?: ChainType) => Promise<string | undefined>;
   /**
-  * Get a quote for a token transfer
-  * @param params - The configuration of the requested quote
-  * @param options - Request options
-  * @returns Quote for a token transfer
-  */
+   * Get a quote for a token transfer
+   * @param params - The configuration of the requested quote
+   * @param options - Request options
+   * @returns Quote for a token transfer
+   */
   getQuote: (params: Parameters<typeof getQuote>[1], options?: RequestOptions) => Promise<LiFiStep>;
   /**
-  * Get the status of a relayed transaction
-  * @param params - The configuration of the requested relay status
-  * @param options - Request options
-  * @returns Status of the relayed transaction
-  */
+   * Get the status of a relayed transaction
+   * @param params - The configuration of the requested relay status
+   * @param options - Request options
+   * @returns Status of the relayed transaction
+   */
   getRelayedTransactionStatus: (params: RelayStatusRequest, options?: RequestOptions) => Promise<RelayStatusResponseData>;
   /**
-  * Get a quote from a relayer
-  * @param params - The configuration of the requested relayer quote
-  * @param options - Request options
-  * @returns Quote from a relayer
-  */
+   * Get a quote from a relayer
+   * @param params - The configuration of the requested relayer quote
+   * @param options - Request options
+   * @returns Quote from a relayer
+   */
   getRelayerQuote: (params: QuoteRequestFromAmount, options?: RequestOptions) => Promise<LiFiStep>;
   /**
-  * Get a set of routes for a request that describes a transfer of tokens.
-  * Optional limit-order fields (`toAmount`, `validUntil`, `partiallyFillable`)
-  * may be supplied and are resolved on the backend.
-  * @param params - A description of the transfer
-  * @param options - Request options
-  * @returns The resulting routes that can be used to realize the described transfer
-  */
+   * Get a set of routes for a request that describes a transfer of tokens.
+   * Optional limit-order fields (`toAmount`, `validUntil`, `partiallyFillable`)
+   * may be supplied and are resolved on the backend.
+   * @param params - A description of the transfer
+   * @param options - Request options
+   * @returns The resulting routes that can be used to realize the described transfer
+   */
   getRoutes: (params: RoutesRequest$1, options?: RequestOptions) => Promise<RoutesResponse>;
   /**
-  * Get the status of a transaction
-  * @param params - The configuration of the requested status
-  * @param options - Request options
-  * @returns Status of the transaction
-  */
+   * Get the status of a transaction
+   * @param params - The configuration of the requested status
+   * @param options - Request options
+   * @returns Status of the transaction
+   */
   getStatus: (params: GetStatusRequestExtended, options?: RequestOptions) => Promise<StatusResponse>;
   /**
-  * Get a step transaction. The step's `action` may carry the optional
-  * limit-order fields, which are resolved on the backend.
-  * @param params - The configuration of the requested step transaction
-  * @param options - Request options
-  * @returns Step transaction
-  */
+   * Get a step transaction. The step's `action` may carry the optional
+   * limit-order fields, which are resolved on the backend.
+   * @param params - The configuration of the requested step transaction
+   * @param options - Request options
+   * @returns Step transaction
+   */
   getStepTransaction: (params: LiFiStepRequest, options?: RequestOptions) => Promise<LiFiStep>;
   /**
-  * Get a specific token
-  * @param chain - Id or key of the chain that contains the token
-  * @param token - Address or symbol of the token on the requested chain
-  * @param options - Request options
-  * @returns Token information
-  */
+   * Get a specific token
+   * @param chain - Id or key of the chain that contains the token
+   * @param token - Address or symbol of the token on the requested chain
+   * @param options - Request options
+   * @returns Token information
+   */
   getToken: (chain: ChainKey | ChainId, token: string, options?: RequestOptions) => Promise<TokenExtended>;
   /**
-  * Get token balance for a specific token
-  * @param walletAddress - A wallet address
-  * @param token - A Token object
-  * @returns Token balance
-  */
+   * Get token balance for a specific token
+   * @param walletAddress - A wallet address
+   * @param token - A Token object
+   * @returns Token balance
+   */
   getTokenBalance: (walletAddress: string, token: Token) => Promise<TokenAmount | null>;
   /**
-  * Get token balances for multiple tokens
-  * @param walletAddress - A wallet address
-  * @param tokens - A list of Token objects
-  * @returns Token balances
-  */
+   * Get token balances for multiple tokens
+   * @param walletAddress - A wallet address
+   * @param tokens - A list of Token objects
+   * @returns Token balances
+   */
   getTokenBalances: (walletAddress: string, tokens: Token[]) => Promise<TokenAmount[]>;
   /**
-  * Get token balances by chain
-  * @param walletAddress - A wallet address
-  * @param tokensByChain - A list of token objects organized by chain ids
-  * @returns Token balances by chain
-  */
+   * Get token balances by chain
+   * @param walletAddress - A wallet address
+   * @param tokensByChain - A list of token objects organized by chain ids
+   * @returns Token balances by chain
+   */
   getTokenBalancesByChain: (walletAddress: string, tokensByChain: {
     [chainId: number]: Token[];
   }) => Promise<{
     [chainId: number]: TokenAmount[];
   }>;
   /**
-  * Get all available tokens
-  * @param params - The configuration of the requested tokens
-  * @param options - Request options
-  * @returns A list of all available tokens
-  */
+   * Get all available tokens
+   * @param params - The configuration of the requested tokens
+   * @param options - Request options
+   * @returns A list of all available tokens
+   */
   getTokens: {
     (params?: TokensRequest & {
       extended?: false | undefined;
@@ -134,39 +133,39 @@ type Actions = {
     }, options?: RequestOptions): Promise<TokensExtendedResponse>;
   };
   /**
-  * Get all available tools (bridges and exchanges)
-  * @param params - The configuration of the requested tools
-  * @param options - Request options
-  * @returns A list of all available tools
-  */
+   * Get all available tools (bridges and exchanges)
+   * @param params - The configuration of the requested tools
+   * @param options - Request options
+   * @returns A list of all available tools
+   */
   getTools: (params?: ToolsRequest, options?: RequestOptions) => Promise<ToolsResponse>;
   /**
-  * Get transaction history
-  * @param params - The configuration of the requested transaction history
-  * @param options - Request options
-  * @returns Transaction history
-  */
+   * Get transaction history
+   * @param params - The configuration of the requested transaction history
+   * @param options - Request options
+   * @returns Transaction history
+   */
   getTransactionHistory: (params: TransactionAnalyticsRequest, options?: RequestOptions) => Promise<TransactionAnalyticsResponse>;
   /**
-  * Get wallet balances
-  * @param params - The configuration of the requested wallet balances
-  * @param options - Request options
-  * @returns Wallet balances
-  */
+   * Get wallet balances
+   * @param params - The configuration of the requested wallet balances
+   * @param options - Request options
+   * @returns Wallet balances
+   */
   getWalletBalances: (walletAddress: string, options?: RequestOptions) => Promise<Record<number, WalletTokenExtended[]>>;
   /**
-  * Relay a transaction through the relayer service
-  * @param params - The configuration for the relay request
-  * @param options - Request options
-  * @returns Task ID and transaction link for the relayed transaction
-  */
+   * Relay a transaction through the relayer service
+   * @param params - The configuration for the relay request
+   * @param options - Request options
+   * @returns Task ID and transaction link for the relayed transaction
+   */
   relayTransaction: (params: RelayRequest, options?: RequestOptions) => Promise<RelayResponseData>;
   /**
-  * Patch contract calls
-  * @param params - The configuration for the patch contract calls request
-  * @param options - Request options
-  * @returns Patched contract calls
-  */
+   * Patch contract calls
+   * @param params - The configuration for the patch contract calls request
+   * @param options - Request options
+   * @returns Patched contract calls
+   */
   patchContractCalls: (params: PatchCallDataRequest, options?: RequestOptions) => Promise<PatchContractCallsResponse[]>;
 };
 declare function actions(client: SDKClient): Actions;

package/dist/cjs/actions/patchContractCalls.d.ts

@@ -1,6 +1,5 @@
 import { SDKClient } from "../types/core.js";
 import { PatchCallDataRequest, RequestOptions } from "@lifi/types";
-
 //#region src/actions/patchContractCalls.d.ts
 interface PatchContractCallsResponse {
   target: string;

package/dist/cjs/actions/relayTransaction.d.ts

@@ -1,15 +1,14 @@
 import { SDKClient } from "../types/core.js";
 import { RelayRequest, RelayResponseData, RequestOptions } from "@lifi/types";
-
 //#region src/actions/relayTransaction.d.ts
 /**
-* Relay a transaction through the relayer service
-* @param client - The SDK client
-* @param params - The configuration for the relay request
-* @param options - Request options
-* @throws {LiFiError} - Throws a LiFiError if request fails
-* @returns Task ID and transaction link for the relayed transaction
-*/
+ * Relay a transaction through the relayer service
+ * @param client - The SDK client
+ * @param params - The configuration for the relay request
+ * @param options - Request options
+ * @throws {LiFiError} - Throws a LiFiError if request fails
+ * @returns Task ID and transaction link for the relayed transaction
+ */
 declare const relayTransaction: (client: SDKClient, params: RelayRequest, options?: RequestOptions) => Promise<RelayResponseData>;
 //#endregion
 export { relayTransaction };

package/dist/cjs/client/createClient.d.ts

@@ -1,5 +1,4 @@
 import { SDKClient, SDKConfig } from "../types/core.js";
-
 //#region src/client/createClient.d.ts
 declare function createClient(options: SDKConfig): SDKClient;
 //#endregion

package/dist/cjs/client/getClientStorage.d.ts

@@ -1,6 +1,5 @@
 import { RPCUrls, SDKBaseConfig } from "../types/core.js";
 import { ExtendedChain } from "@lifi/types";
-
 //#region src/client/getClientStorage.d.ts
 interface ClientStorage {
   readonly needReset: boolean;

package/dist/cjs/core/BaseStepExecutionTask.d.ts

@@ -1,5 +1,4 @@
 import { StepExecutorContext, TaskResult } from "../types/execution.js";
-
 //#region src/core/BaseStepExecutionTask.d.ts
 declare abstract class BaseStepExecutionTask {
   shouldRun(_context: StepExecutorContext): Promise<boolean>;

package/dist/cjs/core/BaseStepExecutor.d.ts

@@ -4,7 +4,6 @@ import { StepExecutorBaseContext, StepExecutorContext } from "../types/execution
 import { ExecuteStepRetryError } from "../errors/errors.js";
 import { SDKError } from "../errors/SDKError.js";
 import { TaskPipeline } from "./TaskPipeline.js";
-
 //#region src/core/BaseStepExecutor.d.ts
 declare abstract class BaseStepExecutor implements StepExecutor {
   protected executionOptions?: ExecutionOptions;

package/dist/cjs/core/StatusManager.d.ts

@@ -1,6 +1,5 @@
 import { Execution, ExecutionAction, ExecutionActionStatus, ExecutionActionType, LiFiStepExtended } from "../types/core.js";
 import { ChainId, LiFiStep } from "@lifi/types";
-
 //#region src/core/StatusManager.d.ts
 type ActionProps = {
   step: LiFiStepExtended;
@@ -9,69 +8,59 @@ type ActionProps = {
   status: ExecutionActionStatus;
 };
 /**
-* Manages status updates of a route and provides various functions for tracking actions.
-*/
+ * Manages status updates of a route and provides various functions for tracking actions.
+ */
 declare class StatusManager {
   private readonly routeId;
   private shouldUpdate;
   constructor(routeId: string);
   /**
-  * Initializes the execution object of a Step.
-  * @param step The current step in execution
-  * @returns The initialized execution object for this step
-  */
+   * Initializes the execution object of a Step.
+   * @param step The current step in execution
+   * @returns The initialized execution object for this step
+   */
   initializeExecution: (step: LiFiStepExtended) => Execution;
   /**
-  * Updates the execution object of a Step.
-  * @param step The current step in execution
-  * @param execution Partial execution data to merge
-  * @returns The step with the updated execution object
-  */
+   * Updates the execution object of a Step.
+   * @param step The current step in execution
+   * @param execution Partial execution data to merge
+   * @returns The step with the updated execution object
+   */
   updateExecution(step: LiFiStepExtended, execution: Partial<Execution>): LiFiStep;
   /**
-  * Finds an action of the specified type in the step's execution
-  * @param step The step to search in
-  * @param type The action type to find
-  * @returns The found action or undefined if not found
-  */
+   * Finds an action of the specified type in the step's execution
+   * @param step The step to search in
+   * @param type The action type to find
+   * @returns The found action or undefined if not found
+   */
   findAction(step: LiFiStepExtended, type: ExecutionActionType): ExecutionAction | undefined;
   /**
-  * Create and push a new action into the execution.
-  * Caller is responsible for ensuring an action of this type does not already exist.
-  * @param step The step that should contain the new action.
-  * @param type Type of the action.
-  * @param chainId Chain Id of the action.
-  * @param status The initial status for the new action.
-  * @returns The created action.
-  */
-  createAction: ({
-    step,
-    type,
-    chainId,
-    status
-  }: ActionProps) => ExecutionAction;
+   * Create and push a new action into the execution.
+   * Caller is responsible for ensuring an action of this type does not already exist.
+   * @param step The step that should contain the new action.
+   * @param type Type of the action.
+   * @param chainId Chain Id of the action.
+   * @param status The initial status for the new action.
+   * @returns The created action.
+   */
+  createAction: ({ step, type, chainId, status }: ActionProps) => ExecutionAction;
   /**
-  * Find an existing action by type and update it, or create a new one if none exists.
-  * @param step The step that should contain the action.
-  * @param type Type of the action. Used to identify already existing actions.
-  * @param chainId Chain Id of the action (used when creating).
-  * @param status The status to set on the found or newly created action.
-  * @returns The updated or newly created action.
-  */
-  initializeAction: ({
-    step,
-    type,
-    chainId,
-    status
-  }: ActionProps) => ExecutionAction;
+   * Find an existing action by type and update it, or create a new one if none exists.
+   * @param step The step that should contain the action.
+   * @param type Type of the action. Used to identify already existing actions.
+   * @param chainId Chain Id of the action (used when creating).
+   * @param status The status to set on the found or newly created action.
+   * @returns The updated or newly created action.
+   */
+  initializeAction: ({ step, type, chainId, status }: ActionProps) => ExecutionAction;
   /**
-  * Update an action object.
-  * @param step The step where the action should be updated
-  * @param type  The action type to update
-  * @param status The status the action gets.
-  * @param [params] Additional parameters to append to the action.
-  * @returns The updated action
-  */
+   * Update an action object.
+   * @param step The step where the action should be updated
+   * @param type  The action type to update
+   * @param status The status the action gets.
+   * @param [params] Additional parameters to append to the action.
+   * @returns The updated action
+   */
   updateAction: (step: LiFiStepExtended, type: ExecutionActionType, status: ExecutionActionStatus, params?: Partial<ExecutionAction & {
     signedAt?: number;
   }>) => ExecutionAction;

package/dist/cjs/core/TaskPipeline.d.ts

@@ -1,6 +1,5 @@
 import { StepExecutorContext, TaskResult } from "../types/execution.js";
 import { BaseStepExecutionTask } from "./BaseStepExecutionTask.js";
-
 //#region src/core/TaskPipeline.d.ts
 declare class TaskPipeline {
   private readonly tasks;

package/dist/cjs/core/actionMessages.d.ts

@@ -1,6 +1,5 @@
 import { ExecutionActionStatus, ExecutionActionType } from "../types/core.js";
 import { StatusMessage, Substatus } from "@lifi/types";
-
 //#region src/core/actionMessages.d.ts
 declare function getActionMessage(type: ExecutionActionType, status: ExecutionActionStatus): string | undefined;
 declare function getSubstatusMessage(status: StatusMessage, substatus?: Substatus): string | undefined;

package/dist/cjs/core/execution.d.ts

@@ -1,47 +1,46 @@
 import { ExecutionOptions, RouteExtended, SDKClient } from "../types/core.js";
 import { Route } from "@lifi/types";
-
 //#region src/core/execution.d.ts
 /**
-* Execute a route.
-* @param client - The SDK client.
-* @param route - The route that should be executed. Cannot be an active route.
-* @param executionOptions - An object containing settings and callbacks.
-* @returns The executed route.
-* @throws {LiFiError} Throws a LiFiError if the execution fails.
-*/
+ * Execute a route.
+ * @param client - The SDK client.
+ * @param route - The route that should be executed. Cannot be an active route.
+ * @param executionOptions - An object containing settings and callbacks.
+ * @returns The executed route.
+ * @throws {LiFiError} Throws a LiFiError if the execution fails.
+ */
 declare const executeRoute: (client: SDKClient, route: Route, executionOptions?: ExecutionOptions) => Promise<RouteExtended>;
 /**
-* Resume the execution of a route that has been stopped or had an error while executing.
-* @param client - The SDK client.
-* @param route - The route that is to be executed. Cannot be an active route.
-* @param executionOptions - An object containing settings and callbacks.
-* @returns The executed route.
-* @throws {LiFiError} Throws a LiFiError if the execution fails.
-*/
+ * Resume the execution of a route that has been stopped or had an error while executing.
+ * @param client - The SDK client.
+ * @param route - The route that is to be executed. Cannot be an active route.
+ * @param executionOptions - An object containing settings and callbacks.
+ * @returns The executed route.
+ * @throws {LiFiError} Throws a LiFiError if the execution fails.
+ */
 declare const resumeRoute: (client: SDKClient, route: Route, executionOptions?: ExecutionOptions) => Promise<RouteExtended>;
 /**
-* Updates route execution to background or foreground state.
-* @param route - A route that is currently in execution.
-* @param options - An object with execution settings.
-*/
+ * Updates route execution to background or foreground state.
+ * @param route - A route that is currently in execution.
+ * @param options - An object with execution settings.
+ */
 declare const updateRouteExecution: (route: Route, options: ExecutionOptions) => void;
 /**
-* Stops the execution of an active route.
-* @param route - A route that is currently in execution.
-* @returns The stopped route.
-*/
+ * Stops the execution of an active route.
+ * @param route - A route that is currently in execution.
+ * @returns The stopped route.
+ */
 declare const stopRouteExecution: (route: Route) => Route;
 /**
-* Get the list of active routes.
-* @returns A list of routes.
-*/
+ * Get the list of active routes.
+ * @returns A list of routes.
+ */
 declare const getActiveRoutes: () => RouteExtended[];
 /**
-* Return the current route information for given route. The route has to be active.
-* @param routeId - A route id.
-* @returns The updated route.
-*/
+ * Return the current route information for given route. The route has to be active.
+ * @param routeId - A route id.
+ * @returns The updated route.
+ */
 declare const getActiveRoute: (routeId: string) => RouteExtended | undefined;
 //#endregion
 export { executeRoute, getActiveRoute, getActiveRoutes, resumeRoute, stopRouteExecution, updateRouteExecution };

package/dist/cjs/core/executionState.d.ts

@@ -1,5 +1,4 @@
 import { ExecutionOptions, RouteExtended, StepExecutor } from "../types/core.js";
-
 //#region src/core/executionState.d.ts
 interface ExecutionData {
   route: RouteExtended;

package/dist/cjs/core/prepareRestart.d.ts

@@ -1,5 +1,4 @@
 import { RouteExtended } from "../types/core.js";
-
 //#region src/core/prepareRestart.d.ts
 declare const prepareRestart: (route: RouteExtended) => void;
 //#endregion

package/dist/cjs/core/tasks/CheckBalanceTask.d.ts

@@ -1,16 +1,15 @@
 import { StepExecutorContext, TaskResult } from "../../types/execution.js";
 import { BaseStepExecutionTask } from "../BaseStepExecutionTask.js";
 import { CheckBalanceOptions } from "./helpers/checkBalance.js";
-
 //#region src/core/tasks/CheckBalanceTask.d.ts
 declare class CheckBalanceTask extends BaseStepExecutionTask {
   /**
-  * Per-step options hook for chain-specific subclasses (e.g. skip the
-  * gas check for smart-contract wallets or relayed steps). Default `{}`
-  * keeps behavior unchanged for every provider that doesn't override.
-  * Resolved lazily inside `run()` — pipelines that resume past
-  * `CheckBalance` pay no cost.
-  */
+   * Per-step options hook for chain-specific subclasses (e.g. skip the
+   * gas check for smart-contract wallets or relayed steps). Default `{}`
+   * keeps behavior unchanged for every provider that doesn't override.
+   * Resolved lazily inside `run()` — pipelines that resume past
+   * `CheckBalance` pay no cost.
+   */
   protected getCheckBalanceOptions(_context: StepExecutorContext): Promise<CheckBalanceOptions>;
   run(context: StepExecutorContext): Promise<TaskResult>;
 }

package/dist/cjs/core/tasks/PrepareTransactionTask.d.ts

@@ -1,6 +1,5 @@
 import { StepExecutorContext, TaskResult } from "../../types/execution.js";
 import { BaseStepExecutionTask } from "../BaseStepExecutionTask.js";
-
 //#region src/core/tasks/PrepareTransactionTask.d.ts
 declare class PrepareTransactionTask extends BaseStepExecutionTask {
   run(context: StepExecutorContext): Promise<TaskResult>;

package/dist/cjs/core/tasks/WaitForTransactionStatusTask.d.ts

@@ -1,7 +1,6 @@
 import { ExecutionActionType } from "../../types/core.js";
 import { StepExecutorContext, TaskResult } from "../../types/execution.js";
 import { BaseStepExecutionTask } from "../BaseStepExecutionTask.js";
-
 //#region src/core/tasks/WaitForTransactionStatusTask.d.ts
 declare class WaitForTransactionStatusTask extends BaseStepExecutionTask {
   readonly actionType: ExecutionActionType;