@lifi/sdk 4.0.1-alpha.0 → 4.0.1

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

@@ -1,167 +1,184 @@
-import type { ChainId, ChainType, CoinKey, ContractCall, ExtendedChain, FeeCost, GasCost, LiFiStep, Route, RouteOptions, Step, Substatus, Token, TokenAmount } from '@lifi/types';
-import type { ExtendedRequestInit } from './request.js';
-export type RequestInterceptor = (request: ExtendedRequestInit) => ExtendedRequestInit | Promise<ExtendedRequestInit>;
-export interface SDKBaseConfig {
-    apiKey?: string;
-    apiUrl: string;
-    integrator: string;
-    userId?: string;
-    routeOptions?: RouteOptions;
-    executionOptions?: ExecutionOptions;
-    rpcUrls: RPCUrls;
-    disableVersionCheck?: boolean;
-    widgetVersion?: string;
-    debug: boolean;
-    preloadChains?: boolean;
-    chainsRefetchInterval?: number;
-    requestInterceptor?: RequestInterceptor;
-}
-export interface SDKConfig extends Partial<Omit<SDKBaseConfig, 'integrator'>> {
-    integrator: string;
-}
-export type RPCUrls = Partial<Record<ChainId, string[]>>;
-export interface SDKProvider {
-    readonly type: ChainType;
-    isAddress(address: string): boolean;
-    resolveAddress(name: string, client: SDKClient, chainId?: ChainId, token?: CoinKey): Promise<string | undefined>;
-    getStepExecutor(options: StepExecutorOptions): Promise<StepExecutor>;
-    getBalance(client: SDKClient, walletAddress: string, tokens: Token[]): Promise<TokenAmount[]>;
-}
-export interface SDKClient {
-    config: SDKBaseConfig;
-    providers: SDKProvider[];
-    getProvider(type: ChainType): SDKProvider | undefined;
-    setProviders(providers: SDKProvider[]): void;
-    setChains(chains: ExtendedChain[]): void;
-    getChains(): Promise<ExtendedChain[]>;
-    getChainById(chainId: ChainId): Promise<ExtendedChain>;
-    getRpcUrls(): Promise<RPCUrls>;
-    getRpcUrlsByChainId(chainId: ChainId): Promise<string[]>;
-}
-export interface StepExecutorOptions {
-    routeId: string;
-    executionOptions?: ExecutionOptions;
-}
-export interface InteractionSettings {
-    allowInteraction?: boolean;
-    allowUpdates?: boolean;
-    allowExecution?: boolean;
-}
-export interface StepExecutor {
-    allowUserInteraction: boolean;
-    allowExecution: boolean;
-    setInteraction(settings?: InteractionSettings): void;
-    executeStep(client: SDKClient, step: LiFiStepExtended): Promise<LiFiStepExtended>;
-}
-export interface RouteExecutionData {
-    route: Route;
-    executors: StepExecutor[];
-    executionOptions?: ExecutionOptions;
-}
-export type RouteExecutionDataDictionary = Partial<Record<string, RouteExecutionData>>;
-export interface RouteExtended extends Omit<Route, 'steps'> {
-    steps: LiFiStepExtended[];
-}
-export interface LiFiStepExtended extends LiFiStep {
-    execution?: Execution;
-}
-export type StepExtended = Step & {
-    execution?: Execution;
+import { SDKStorage } from "../core/storage.js";
+import { ExtendedRequestInit } from "./request.js";
+import { ChainId, ChainType, CoinKey, ContractCall, ExtendedChain, FeeCost, GasCost, LiFiStep, Route, RouteOptions, Step, Substatus, Token, TokenAmount } from "@lifi/types";
+
+//#region src/types/core.d.ts
+type RequestInterceptor = (request: ExtendedRequestInit) => ExtendedRequestInit | Promise<ExtendedRequestInit>;
+interface SDKBaseConfig {
+  apiKey?: string;
+  apiUrl: string;
+  integrator: string;
+  userId?: string;
+  routeOptions?: RouteOptions;
+  executionOptions?: ExecutionOptions;
+  rpcUrls: RPCUrls;
+  disableVersionCheck?: boolean;
+  widgetVersion?: string;
+  debug: boolean;
+  preloadChains?: boolean;
+  chainsRefetchInterval?: number;
+  requestInterceptor?: RequestInterceptor;
+  storage?: SDKStorage;
+}
+interface SDKConfig extends Partial<Omit<SDKBaseConfig, "integrator">> {
+  integrator: string;
+  providers?: SDKProvider[];
+}
+type RPCUrls = Partial<Record<ChainId, string[]>>;
+interface SDKProvider {
+  readonly type: ChainType;
+  isAddress(address: string): boolean;
+  resolveAddress(name: string, client: SDKClient, chainId?: ChainId, token?: CoinKey): Promise<string | undefined>;
+  getStepExecutor(options: StepExecutorOptions): Promise<StepExecutor>;
+  getBalance(client: SDKClient, walletAddress: string, tokens: Token[]): Promise<TokenAmount[]>;
+}
+interface SDKClient {
+  config: SDKBaseConfig;
+  providers: SDKProvider[];
+  getProvider(type: ChainType): SDKProvider | undefined;
+  setProviders(providers: SDKProvider[]): void;
+  setChains(chains: ExtendedChain[]): void;
+  getChains(): Promise<ExtendedChain[]>;
+  getChainById(chainId: ChainId): Promise<ExtendedChain>;
+  getRpcUrls(): Promise<RPCUrls>;
+  getRpcUrlsByChainId(chainId: ChainId): Promise<string[]>;
+}
+interface StepExecutorOptions {
+  routeId: string;
+  executionOptions?: ExecutionOptions;
+}
+interface InteractionSettings {
+  allowInteraction?: boolean;
+  allowUpdates?: boolean;
+  allowExecution?: boolean;
+}
+/**
+* Params passed when retrying executeStep after an ExecuteStepRetryError.
+* Providers can use this to pass strategy-specific retry options (e.g. atomicityNotReady for Ethereum 7702).
+*/
+type ExecuteStepRetryParams = Record<string, unknown>;
+interface StepExecutor {
+  allowUserInteraction: boolean;
+  allowExecution: boolean;
+  setInteraction(settings?: InteractionSettings): void;
+  executeStep(client: SDKClient, step: LiFiStepExtended, retryParams?: ExecuteStepRetryParams): Promise<LiFiStepExtended>;
+}
+interface RouteExecutionData {
+  route: Route;
+  executors: StepExecutor[];
+  executionOptions?: ExecutionOptions;
+}
+type RouteExecutionDataDictionary = Partial<Record<string, RouteExecutionData>>;
+interface RouteExtended extends Omit<Route, "steps"> {
+  steps: LiFiStepExtended[];
+}
+interface LiFiStepExtended extends LiFiStep {
+  execution?: Execution;
+}
+type StepExtended = Step & {
+  execution?: Execution;
 };
-export type TransactionParameters = {
-    chainId?: number;
-    to?: string;
-    from?: string;
-    nonce?: number;
-    data?: string;
-    value?: bigint;
-    gas?: bigint;
-    gasPrice?: bigint;
-    maxFeePerGas?: bigint;
-    maxPriorityFeePerGas?: bigint;
+type TransactionParameters = {
+  chainId?: number;
+  to?: string;
+  from?: string;
+  nonce?: number;
+  data?: string;
+  value?: bigint;
+  gas?: bigint;
+  gasPrice?: bigint;
+  maxFeePerGas?: bigint;
+  maxPriorityFeePerGas?: bigint;
 };
-export type RouteExecutionDictionary = Partial<Record<string, Promise<Route>>>;
-export type UpdateRouteHook = (updatedRoute: RouteExtended) => void;
-export interface TransactionRequestParameters extends TransactionParameters {
-    requestType: 'approve' | 'transaction';
-}
-export type TransactionRequestUpdateHook = (updatedTxRequest: TransactionRequestParameters) => Promise<TransactionParameters>;
-export interface AcceptSlippageUpdateHookParams {
-    toToken: Token;
-    oldToAmount: string;
-    newToAmount: string;
-    oldSlippage: number;
-    newSlippage: number;
-}
-export type AcceptSlippageUpdateHook = (params: AcceptSlippageUpdateHookParams) => Promise<boolean | undefined>;
-export interface ExchangeRateUpdateParams {
-    toToken: Token;
-    oldToAmount: string;
-    newToAmount: string;
-}
-export type AcceptExchangeRateUpdateHook = (params: ExchangeRateUpdateParams) => Promise<boolean | undefined>;
-export interface ContractCallParams {
-    fromChainId: number;
-    toChainId: number;
-    fromTokenAddress: string;
-    toTokenAddress: string;
-    fromAddress: string;
-    toAddress?: string;
-    fromAmount: bigint;
-    toAmount: bigint;
-    slippage?: number;
-}
-export interface ContractTool {
-    name: string;
-    logoURI: string;
-}
-export interface GetContractCallsResult {
-    contractCalls: ContractCall[];
-    patcher?: boolean;
-    contractTool?: ContractTool;
-}
-export type GetContractCallsHook = (params: ContractCallParams) => Promise<GetContractCallsResult>;
-export interface ExecutionOptions {
-    acceptExchangeRateUpdateHook?: AcceptExchangeRateUpdateHook;
-    updateRouteHook?: UpdateRouteHook;
-    updateTransactionRequestHook?: TransactionRequestUpdateHook;
-    getContractCalls?: GetContractCallsHook;
-    adjustZeroOutputFromPreviousStep?: boolean;
-    executeInBackground?: boolean;
-    disableMessageSigning?: boolean;
-    infiniteApproval?: boolean;
-}
-export type ExecutionStatus = 'ACTION_REQUIRED' | 'PENDING' | 'FAILED' | 'DONE';
-export type ExecutionActionStatus = 'STARTED' | 'ACTION_REQUIRED' | 'MESSAGE_REQUIRED' | 'RESET_REQUIRED' | 'PENDING' | 'FAILED' | 'DONE' | 'CANCELLED';
-export type ExecutionActionType = 'TOKEN_ALLOWANCE' | 'PERMIT' | 'SWAP' | 'CROSS_CHAIN' | 'RECEIVING_CHAIN';
-export type ExecutionAction = {
-    type: ExecutionActionType;
-    status: ExecutionActionStatus;
-    substatus?: Substatus;
-    chainId?: number;
-    txHash?: string;
-    taskId?: string;
-    txLink?: string;
-    txType?: TransactionMethodType;
-    message?: string;
-    error?: {
-        code: string | number;
-        message: string;
-        htmlMessage?: string;
-    };
-    [key: string]: any;
+type RouteExecutionDictionary = Partial<Record<string, Promise<Route>>>;
+type UpdateRouteHook = (updatedRoute: RouteExtended) => void;
+interface TransactionRequestParameters extends TransactionParameters {
+  requestType: "approve" | "transaction";
+}
+type TransactionRequestUpdateHook = (updatedTxRequest: TransactionRequestParameters) => Promise<TransactionParameters>;
+interface AcceptSlippageUpdateHookParams {
+  toToken: Token;
+  oldToAmount: string;
+  newToAmount: string;
+  oldSlippage: number;
+  newSlippage: number;
+}
+type AcceptSlippageUpdateHook = (params: AcceptSlippageUpdateHookParams) => Promise<boolean | undefined>;
+interface ExchangeRateUpdateParams {
+  toToken: Token;
+  oldToAmount: string;
+  newToAmount: string;
+}
+type AcceptExchangeRateUpdateHook = (params: ExchangeRateUpdateParams) => Promise<boolean | undefined>;
+interface ContractCallParams {
+  fromChainId: number;
+  toChainId: number;
+  fromTokenAddress: string;
+  toTokenAddress: string;
+  fromAddress: string;
+  toAddress?: string;
+  fromAmount: bigint;
+  toAmount: bigint;
+  slippage?: number;
+}
+interface ContractTool {
+  name: string;
+  logoURI: string;
+}
+interface GetContractCallsResult {
+  contractCalls: ContractCall[];
+  patcher?: boolean;
+  contractTool?: ContractTool;
+}
+type GetContractCallsHook = (params: ContractCallParams) => Promise<GetContractCallsResult>;
+interface ExecutionOptions {
+  acceptExchangeRateUpdateHook?: AcceptExchangeRateUpdateHook;
+  updateRouteHook?: UpdateRouteHook;
+  updateTransactionRequestHook?: TransactionRequestUpdateHook;
+  getContractCalls?: GetContractCallsHook;
+  adjustZeroOutputFromPreviousStep?: boolean;
+  executeInBackground?: boolean;
+}
+type ExecutionStatus = "ACTION_REQUIRED" | "PENDING" | "FAILED" | "DONE";
+type ExecutionActionStatus = "STARTED" | "ACTION_REQUIRED" | "MESSAGE_REQUIRED" | "RESET_REQUIRED" | "PENDING" | "FAILED" | "DONE" | "CANCELLED";
+type ExecutionActionType = "PERMIT" | "CHECK_ALLOWANCE" | "NATIVE_PERMIT" | "RESET_ALLOWANCE" | "SET_ALLOWANCE" | "SWAP" | "CROSS_CHAIN" | "RECEIVING_CHAIN";
+type ExecutionAction = {
+  type: ExecutionActionType;
+  status: ExecutionActionStatus;
+  message?: string;
+  substatus?: Substatus;
+  substatusMessage?: string;
+  chainId?: number;
+  txHash?: string;
+  txLink?: string;
+  taskId?: string;
+  txType?: TransactionMethodType;
+  txHex?: string;
+  error?: {
+    code: string | number;
+    message: string;
+    htmlMessage?: string;
+  };
 };
-export interface Execution {
-    startedAt: number;
-    signedAt?: number;
-    status: ExecutionStatus;
-    actions: Array<ExecutionAction>;
-    fromAmount?: string;
-    toAmount?: string;
-    toToken?: Token;
-    feeCosts?: FeeCost[];
-    gasCosts?: GasCost[];
-    internalTxLink?: string;
-    externalTxLink?: string;
-}
-export type TransactionMethodType = 'standard' | 'relayed' | 'batched';
+interface Execution {
+  startedAt: number;
+  signedAt?: number;
+  status: ExecutionStatus;
+  actions: Array<ExecutionAction>;
+  fromAmount?: string;
+  toAmount?: string;
+  toToken?: Token;
+  feeCosts?: FeeCost[];
+  gasCosts?: GasCost[];
+  internalTxLink?: string;
+  externalTxLink?: string;
+  error?: {
+    code: string | number;
+    message: string;
+    htmlMessage?: string;
+  };
+}
+type TransactionMethodType = "standard" | "relayed" | "batched";
+//#endregion
+export { AcceptExchangeRateUpdateHook, AcceptSlippageUpdateHook, AcceptSlippageUpdateHookParams, ContractCallParams, ContractTool, ExchangeRateUpdateParams, ExecuteStepRetryParams, Execution, ExecutionAction, ExecutionActionStatus, ExecutionActionType, ExecutionOptions, ExecutionStatus, GetContractCallsHook, GetContractCallsResult, InteractionSettings, LiFiStepExtended, RPCUrls, RequestInterceptor, RouteExecutionData, RouteExecutionDataDictionary, RouteExecutionDictionary, RouteExtended, SDKBaseConfig, SDKClient, SDKConfig, SDKProvider, StepExecutor, StepExecutorOptions, StepExtended, TransactionMethodType, TransactionParameters, TransactionRequestParameters, TransactionRequestUpdateHook, UpdateRouteHook };
+//# sourceMappingURL=core.d.ts.map

package/dist/cjs/types/core.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=core.js.map

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

@@ -0,0 +1,28 @@
+import { ExecuteStepRetryParams, ExecutionOptions, LiFiStepExtended, SDKClient } from "./core.js";
+import { StatusManager } from "../core/StatusManager.js";
+import { ExtendedChain } from "@lifi/types";
+
+//#region src/types/execution.d.ts
+interface StepExecutorBaseContext {
+  statusManager: StatusManager;
+  executionOptions?: ExecutionOptions;
+  fromChain: ExtendedChain;
+  toChain: ExtendedChain;
+  isBridgeExecution: boolean;
+  client: SDKClient;
+  step: LiFiStepExtended;
+  allowUserInteraction: boolean;
+  retryParams?: ExecuteStepRetryParams;
+}
+interface StepExecutorContext extends StepExecutorBaseContext {
+  pollingIntervalMs?: number;
+}
+interface TaskResult<TContext = Record<string, unknown>> {
+  status: TaskStatus;
+  /** Optional: data produced for downstream tasks. Pipeline merges into the executor context. */
+  context?: TContext;
+}
+type TaskStatus = "COMPLETED" | "PAUSED";
+//#endregion
+export { StepExecutorBaseContext, StepExecutorContext, TaskResult, TaskStatus };
+//# sourceMappingURL=execution.d.ts.map

package/dist/cjs/types/request.d.ts

@@ -1,3 +1,7 @@
-export interface ExtendedRequestInit extends RequestInit {
-    retries?: number;
+//#region src/types/request.d.ts
+interface ExtendedRequestInit extends RequestInit {
+  retries?: number;
 }
+//#endregion
+export { ExtendedRequestInit };
+//# sourceMappingURL=request.d.ts.map

package/dist/cjs/types/request.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=request.js.map

package/dist/cjs/utils/checkPackageUpdates.d.ts

@@ -1 +1,5 @@
-export declare const checkPackageUpdates: (packageName?: string, packageVersion?: string) => Promise<void>;
+//#region src/utils/checkPackageUpdates.d.ts
+declare const checkPackageUpdates: (packageName?: string, packageVersion?: string) => Promise<void>;
+//#endregion
+export { checkPackageUpdates };
+//# sourceMappingURL=checkPackageUpdates.d.ts.map

package/dist/cjs/utils/checkPackageUpdates.js

@@ -1,20 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkPackageUpdates = void 0;
-const version_js_1 = require("../version.js");
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("../version.js");
+//#region src/utils/checkPackageUpdates.ts
 const checkPackageUpdates = async (packageName, packageVersion) => {
-    try {
-        const pkgName = packageName ?? version_js_1.name;
-        const response = await fetch(`https://registry.npmjs.org/${pkgName}/latest`);
-        const reponseBody = await response.json();
-        const latestVersion = reponseBody.version;
-        const currentVersion = packageVersion ?? version_js_1.version;
-        if (latestVersion > currentVersion) {
-            console.warn(`${pkgName}: new package version is available. Please update as soon as possible to enjoy the newest features. Current version: ${currentVersion}. Latest version: ${latestVersion}.`);
-        }
-    }
-    catch (_error) {
-    }
+	try {
+		const pkgName = packageName ?? "@lifi/sdk";
+		const latestVersion = (await (await fetch(`https://registry.npmjs.org/${pkgName}/latest`)).json()).version;
+		const currentVersion = packageVersion ?? "4.0.1";
+		if (latestVersion > currentVersion) console.warn(`${pkgName}: new package version is available. Please update as soon as possible to enjoy the newest features. Current version: ${currentVersion}. Latest version: ${latestVersion}.`);
+	} catch (_error) {}
 };
+//#endregion
 exports.checkPackageUpdates = checkPackageUpdates;
+
 //# sourceMappingURL=checkPackageUpdates.js.map

package/dist/cjs/utils/checkPackageUpdates.js.map

@@ -1 +1 @@
-{"version":3,"file":"checkPackageUpdates.js","sourceRoot":"","sources":["../../../src/utils/checkPackageUpdates.ts"],"names":[],"mappings":";;;AAAA,8CAA6C;AAEtC,MAAM,mBAAmB,GAAG,KAAK,EACtC,WAAoB,EACpB,cAAuB,EACvB,EAAE;IACF,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,WAAW,IAAI,iBAAI,CAAA;QACnC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,8BAA8B,OAAO,SAAS,CAAC,CAAA;QAC5E,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QACzC,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,CAAA;QACzC,MAAM,cAAc,GAAG,cAAc,IAAI,oBAAO,CAAA;QAEhD,IAAI,aAAa,GAAG,cAAc,EAAE,CAAC;YACnC,OAAO,CAAC,IAAI,CACV,GAAG,OAAO,wHAAwH,cAAc,qBAAqB,aAAa,GAAG,CACtL,CAAA;QACH,CAAC;IACH,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;IAElB,CAAC;AACH,CAAC,CAAA;AAnBY,QAAA,mBAAmB,uBAmB/B"}
+{"version":3,"file":"checkPackageUpdates.js","names":[],"sources":["../../../src/utils/checkPackageUpdates.ts"],"sourcesContent":["import { name, version } from '../version.js'\n\nexport const checkPackageUpdates = async (\n  packageName?: string,\n  packageVersion?: string\n): Promise<void> => {\n  try {\n    const pkgName = packageName ?? name\n    const response = await fetch(`https://registry.npmjs.org/${pkgName}/latest`)\n    const reponseBody = await response.json()\n    const latestVersion = reponseBody.version\n    const currentVersion = packageVersion ?? version\n\n    if (latestVersion > currentVersion) {\n      console.warn(\n        `${pkgName}: new package version is available. Please update as soon as possible to enjoy the newest features. Current version: ${currentVersion}. Latest version: ${latestVersion}.`\n      )\n    }\n  } catch (_error) {\n    // Cannot verify version, might be network error etc. We don't bother showing anything in that case\n  }\n}\n"],"mappings":";;;AAEA,MAAa,sBAAsB,OACjC,aACA,mBACkB;CAClB,IAAI;EACF,MAAM,UAAU,eAAA;EAGhB,MAAM,iBAAgB,OADI,MADH,MAAM,8BAA8B,QAAQ,QAAQ,EAAA,CACxC,KAAK,EAAA,CACN;EAClC,MAAM,iBAAiB,kBAAA;EAEvB,IAAI,gBAAgB,gBAClB,QAAQ,KACN,GAAG,QAAQ,uHAAuH,eAAe,oBAAoB,cAAc,EACrL;CAEJ,SAAS,QAAQ,CAEjB;AACF"}

package/dist/cjs/utils/convertQuoteToRoute.d.ts

@@ -1,7 +1,22 @@
-import type { LiFiStep, Route } from '@lifi/types';
+import { LiFiStep, Route } from "@lifi/types";
+
+//#region src/utils/convertQuoteToRoute.d.ts
 interface ConvertQuoteToRouteOptions {
-    adjustZeroOutputFromPreviousStep?: boolean;
+  /**
+  * When true, if the quote has zero output values (toAmount, toAmountMin, toAmountUSD),
+  * use the values from the previous included step that has non-zero output.
+  */
+  adjustZeroOutputFromPreviousStep?: boolean;
 }
-export declare function formatTokenPrice(amount?: string | bigint, price?: string, decimals?: number): number;
-export declare const convertQuoteToRoute: (quote: LiFiStep, options?: ConvertQuoteToRouteOptions) => Route;
-export {};
+declare function formatTokenPrice(amount?: string | bigint, price?: string, decimals?: number): number;
+/**
+* Converts a quote to Route
+* @param quote - Step returned from the quote endpoint.
+* @param options - Optional configuration for handling edge cases.
+* @returns - The route to be executed.
+* @throws {BaseError} Throws a ValidationError if the step has missing values.
+*/
+declare const convertQuoteToRoute: (quote: LiFiStep, options?: ConvertQuoteToRouteOptions) => Route;
+//#endregion
+export { convertQuoteToRoute, formatTokenPrice };
+//# sourceMappingURL=convertQuoteToRoute.d.ts.map