@lifi/sdk 4.0.1-alpha.0 → 4.1.0

package/dist/esm/utils/withTimeout.d.ts

@@ -0,0 +1,26 @@
+//#region src/utils/withTimeout.d.ts
+/**
+* Wraps a function in a timeout.
+* Based on viem's withTimeout implementation.
+* @param fn - The function to wrap.
+* @param timeout - The timeout in milliseconds.
+* @param errorInstance - The error instance to throw when the timeout is reached.
+* @param signal - Whether or not the timeout should use an abort signal.
+* @returns The result of the function.
+*/
+declare function withTimeout<T>(fn: ({
+  signal
+}: {
+  signal: AbortController["signal"] | null;
+}) => Promise<T>, {
+  errorInstance,
+  timeout,
+  signal
+}: {
+  errorInstance?: Error | undefined;
+  timeout: number;
+  signal?: boolean | undefined;
+}): Promise<T>;
+//#endregion
+export { withTimeout };
+//# sourceMappingURL=withTimeout.d.ts.map

package/dist/esm/utils/withTimeout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withTimeout.d.ts","names":[],"sources":["../../../src/utils/withTimeout.ts"],"mappings":";;AASA;;;;;;;;iBAAgB,WAAA,IACd,EAAA;EAAO;AAAA;EAAY,MAAA,EAAQ,eAAA;AAAA,MAAuC,OAAA,CAAQ,CAAA;EAExE,aAAA;EACA,OAAA;EACA;AAAA;EAGA,aAAA,GAAgB,KAAA;EAEhB,OAAA;EAEA,MAAA;AAAA,IAED,OAAA,CAAQ,CAAA"}

package/dist/esm/utils/withTimeout.js

@@ -0,0 +1,34 @@
+//#region src/utils/withTimeout.ts
+/**
+* Wraps a function in a timeout.
+* Based on viem's withTimeout implementation.
+* @param fn - The function to wrap.
+* @param timeout - The timeout in milliseconds.
+* @param errorInstance - The error instance to throw when the timeout is reached.
+* @param signal - Whether or not the timeout should use an abort signal.
+* @returns The result of the function.
+*/
+function withTimeout(fn, { errorInstance = /* @__PURE__ */ new Error("Timed out after waiting for too long."), timeout, signal }) {
+	return new Promise((resolve, reject) => {
+		(async () => {
+			let timeoutId;
+			try {
+				const controller = new AbortController();
+				if (timeout > 0) timeoutId = setTimeout(() => {
+					if (signal) controller.abort();
+					else reject(errorInstance);
+				}, timeout);
+				resolve(await fn({ signal: controller?.signal || null }));
+			} catch (err) {
+				if (err?.name === "AbortError") reject(errorInstance);
+				reject(err);
+			} finally {
+				clearTimeout(timeoutId);
+			}
+		})();
+	});
+}
+//#endregion
+export { withTimeout };
+
+//# sourceMappingURL=withTimeout.js.map

package/dist/esm/utils/withTimeout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withTimeout.js","names":[],"sources":["../../../src/utils/withTimeout.ts"],"sourcesContent":["/**\n * Wraps a function in a timeout.\n * Based on viem's withTimeout implementation.\n * @param fn - The function to wrap.\n * @param timeout - The timeout in milliseconds.\n * @param errorInstance - The error instance to throw when the timeout is reached.\n * @param signal - Whether or not the timeout should use an abort signal.\n * @returns The result of the function.\n */\nexport function withTimeout<T>(\n  fn: ({ signal }: { signal: AbortController['signal'] | null }) => Promise<T>,\n  {\n    errorInstance = new Error('Timed out after waiting for too long.'),\n    timeout,\n    signal,\n  }: {\n    // The error instance to throw when the timeout is reached.\n    errorInstance?: Error | undefined\n    // The timeout (in ms).\n    timeout: number\n    // Whether or not the timeout should use an abort signal.\n    signal?: boolean | undefined\n  }\n): Promise<T> {\n  return new Promise((resolve, reject) => {\n    ;(async () => {\n      let timeoutId!: NodeJS.Timeout\n      try {\n        const controller = new AbortController()\n        if (timeout > 0) {\n          timeoutId = setTimeout(() => {\n            if (signal) {\n              controller.abort()\n            } else {\n              reject(errorInstance)\n            }\n          }, timeout) as NodeJS.Timeout // need to cast because bun globals.d.ts overrides @types/node\n        }\n        resolve(await fn({ signal: controller?.signal || null }))\n      } catch (err) {\n        if ((err as Error)?.name === 'AbortError') {\n          reject(errorInstance)\n        }\n        reject(err)\n      } finally {\n        clearTimeout(timeoutId)\n      }\n    })()\n  })\n}\n"],"mappings":";;;;;;;;;;AASA,SAAgB,YACd,IACA,EACE,gCAAgB,IAAI,MAAM,uCAAuC,GACjE,SACA,UASU;CACZ,OAAO,IAAI,SAAS,SAAS,WAAW;EACrC,CAAC,YAAY;GACZ,IAAI;GACJ,IAAI;IACF,MAAM,aAAa,IAAI,gBAAgB;IACvC,IAAI,UAAU,GACZ,YAAY,iBAAiB;KAC3B,IAAI,QACF,WAAW,MAAM;UAEjB,OAAO,aAAa;IAExB,GAAG,OAAO;IAEZ,QAAQ,MAAM,GAAG,EAAE,QAAQ,YAAY,UAAU,KAAK,CAAC,CAAC;GAC1D,SAAS,KAAK;IACZ,IAAK,KAAe,SAAS,cAC3B,OAAO,aAAa;IAEtB,OAAO,GAAG;GACZ,UAAU;IACR,aAAa,SAAS;GACxB;EACF,EAAA,CAAG;CACL,CAAC;AACH"}

package/dist/esm/version.d.ts

@@ -1,2 +1,6 @@
-export declare const name = "@lifi/sdk";
-export declare const version = "4.0.1-alpha.0";
+//#region src/version.d.ts
+declare const name = "@lifi/sdk";
+declare const version = "4.1.0";
+//#endregion
+export { name, version };
+//# sourceMappingURL=version.d.ts.map

package/dist/esm/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","names":[],"sources":["../../src/version.ts"],"mappings":";cAAa,IAAA;AAAA,cACA,OAAA"}

package/dist/esm/version.js

@@ -1,3 +1,7 @@
-export const name = '@lifi/sdk';
-export const version = '4.0.1-alpha.0';
+//#region src/version.ts
+const name = "@lifi/sdk";
+const version = "4.1.0";
+//#endregion
+export { name, version };
+
 //# sourceMappingURL=version.js.map

package/dist/esm/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,WAAW,CAAA;AAC/B,MAAM,CAAC,MAAM,OAAO,GAAG,eAAe,CAAA"}
+{"version":3,"file":"version.js","names":[],"sources":["../../src/version.ts"],"sourcesContent":["export const name = '@lifi/sdk'\nexport const version = '4.1.0'\n"],"mappings":";AAAA,MAAa,OAAO;AACpB,MAAa,UAAU"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/sdk",
-  "version": "4.0.1-alpha.0",
+  "version": "4.1.0",
   "description": "LI.FI SDK for Any-to-Any Cross-Chain-Swap",
   "homepage": "https://github.com/lifinance/sdk",
   "bugs": {
@@ -17,23 +17,24 @@
   "sideEffects": false,
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
-  "typings": "./dist/types/index.d.ts",
+  "types": "./dist/esm/index.d.ts",
+  "typings": "./dist/esm/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/esm/index.d.ts",
       "import": "./dist/esm/index.js",
       "default": "./dist/cjs/index.js"
     },
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@lifi/types": "^17.58.0"
+    "@lifi/types": "17.85.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "files": [
+    "CHANGELOG.md",
     "dist/**",
     "!dist/**/*.tsbuildinfo",
     "src/**/*.ts",

package/src/actions/getChains.ts

@@ -31,7 +31,8 @@ export const _getChains = async (
 ): Promise<ExtendedChain[]> => {
   if (params) {
     for (const key of Object.keys(params)) {
-      if (!params[key as keyof ChainsRequest]) {
+      const value = params[key as keyof ChainsRequest]
+      if (value === undefined || value === null) {
         delete params[key as keyof ChainsRequest]
       }
     }

package/src/actions/getQuote.ts

@@ -8,6 +8,7 @@ import type {
 } from '../types/actions.js'
 import type { SDKClient } from '../types/core.js'
 import { request } from '../utils/request.js'
+import { toQueryString } from '../utils/toQueryString.js'
 
 /**
  * Get a quote for a token transfer
@@ -85,15 +86,18 @@ export async function getQuote(
   params.preferExchanges ??= client.config.routeOptions?.exchanges?.prefer
 
   for (const key of Object.keys(params)) {
-    if (!params[key as keyof QuoteRequest]) {
+    if (
+      params[key as keyof QuoteRequest] === undefined ||
+      params[key as keyof QuoteRequest] === null
+    ) {
       delete params[key as keyof QuoteRequest]
     }
   }
 
   return await request<LiFiStep>(
     client.config,
-    `${client.config.apiUrl}/${isFromAmountRequest ? 'quote' : 'quote/toAmount'}?${new URLSearchParams(
-      params as unknown as Record<string, string>
+    `${client.config.apiUrl}/${isFromAmountRequest ? 'quote' : 'quote/toAmount'}?${toQueryString(
+      params as Record<string, unknown>
     )}`,
     {
       signal: options?.signal,

package/src/actions/getRelayedTransactionStatus.ts

@@ -39,7 +39,7 @@ export const getRelayedTransactionStatus = async (
 
   const decodedTaskId = decodeTaskId(taskId)
   // Temporary solution during the transition between status endpoints
-  if (decodedTaskId.length === 3) {
+  if (decodedTaskId.length >= 3) {
     return (await getStatus(
       client,
       params,

package/src/actions/getRelayerQuote.ts

@@ -56,7 +56,10 @@ export const getRelayerQuote = async (
   params.preferExchanges ??= client.config.routeOptions?.exchanges?.prefer
 
   for (const key of Object.keys(params)) {
-    if (!params[key as keyof QuoteRequest]) {
+    if (
+      params[key as keyof QuoteRequest] === undefined ||
+      params[key as keyof QuoteRequest] === null
+    ) {
       delete params[key as keyof QuoteRequest]
     }
   }

package/src/actions/getRoutes.ts

@@ -1,6 +1,7 @@
-import type { RequestOptions, RoutesRequest, RoutesResponse } from '@lifi/types'
+import type { RequestOptions, RoutesResponse } from '@lifi/types'
 import { ValidationError } from '../errors/errors.js'
 import { SDKError } from '../errors/SDKError.js'
+import type { RoutesRequest } from '../types/actions.js'
 import type { SDKClient } from '../types/core.js'
 import { isRoutesRequest } from '../utils/isRoutesRequest.js'
 import { request } from '../utils/request.js'

package/src/actions/getStepTransaction.ts

@@ -1,5 +1,6 @@
-import type { LiFiStep, RequestOptions, SignedLiFiStep } from '@lifi/types'
+import type { LiFiStep, RequestOptions } from '@lifi/types'
 import { ChainId } from '@lifi/types'
+import type { LiFiStepRequest } from '../types/actions.js'
 import type { SDKClient } from '../types/core.js'
 import { isStep } from '../utils/isStep.js'
 import { request } from '../utils/request.js'
@@ -14,7 +15,7 @@ import { request } from '../utils/request.js'
  */
 export const getStepTransaction = async (
   client: SDKClient,
-  step: LiFiStep | SignedLiFiStep,
+  step: LiFiStepRequest,
   options?: RequestOptions
 ): Promise<LiFiStep> => {
   if (!isStep(step)) {
@@ -25,12 +26,20 @@ export const getStepTransaction = async (
   const { config } = client
 
   let requestUrl = `${config.apiUrl}/advanced/stepTransaction`
-  const isJitoBundleEnabled = Boolean(config.routeOptions?.jitoBundle)
+  const jitoBundle = config.routeOptions?.jitoBundle
+  const svmSponsor = config.routeOptions?.svmSponsor
 
-  if (isJitoBundleEnabled && step.action.fromChainId === ChainId.SOL) {
-    // add jitoBundle param to url if from chain is SVM and jitoBundle is enabled in config
-    const queryParams = new URLSearchParams({ jitoBundle: 'true' })
-    requestUrl = `${requestUrl}?${queryParams}`
+  if (step.action.fromChainId === ChainId.SOL) {
+    const queryParams = new URLSearchParams()
+    if (jitoBundle) {
+      queryParams.set('jitoBundle', jitoBundle.toString())
+    }
+    if (svmSponsor) {
+      queryParams.set('svmSponsor', svmSponsor)
+    }
+    if (queryParams.size > 0) {
+      requestUrl = `${requestUrl}?${queryParams}`
+    }
   }
 
   return await request<LiFiStep>(config, requestUrl, {

package/src/actions/getTokens.ts

@@ -32,7 +32,8 @@ export async function getTokens(
 ): Promise<TokensResponse> {
   if (params) {
     for (const key of Object.keys(params)) {
-      if (!params[key as keyof TokensRequest]) {
+      const value = params[key as keyof TokensRequest]
+      if (value === undefined || value === null) {
         delete params[key as keyof TokensRequest]
       }
     }
@@ -40,11 +41,13 @@ export async function getTokens(
   const urlSearchParams = new URLSearchParams(
     params as Record<string, string>
   ).toString()
-  const isExtended = params?.extended === true
+  const _isExtended = params?.extended === true
   const response = await withDedupe(
     () =>
       request<
-        typeof isExtended extends true ? TokensExtendedResponse : TokensResponse
+        typeof _isExtended extends true
+          ? TokensExtendedResponse
+          : TokensResponse
       >(client.config, `${client.config.apiUrl}/tokens?${urlSearchParams}`, {
         signal: options?.signal,
       }),

package/src/actions/getTools.ts

@@ -16,7 +16,8 @@ export const getTools = async (
 ): Promise<ToolsResponse> => {
   if (params) {
     for (const key of Object.keys(params)) {
-      if (!params[key as keyof ToolsRequest]) {
+      const value = params[key as keyof ToolsRequest]
+      if (value === undefined || value === null) {
         delete params[key as keyof ToolsRequest]
       }
     }

package/src/actions/index.ts

@@ -16,9 +16,7 @@ import type {
   RelayStatusRequest,
   RelayStatusResponseData,
   RequestOptions,
-  RoutesRequest,
   RoutesResponse,
-  SignedLiFiStep,
   StatusResponse,
   Token,
   TokenAmount,
@@ -34,7 +32,9 @@ import type {
 } from '@lifi/types'
 import type {
   GetStatusRequestExtended,
+  LiFiStepRequest,
   QuoteRequestFromAmount,
+  RoutesRequest,
 } from '../types/actions.js'
 import type { SDKClient } from '../types/core.js'
 import { getChains } from './getChains.js'
@@ -152,7 +152,9 @@ export type Actions = {
   ) => Promise<LiFiStep>
 
   /**
-   * Get a set of routes for a request that describes a transfer of tokens
+   * 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
@@ -174,13 +176,14 @@ export type Actions = {
   ) => Promise<StatusResponse>
 
   /**
-   * Get a 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: LiFiStep | SignedLiFiStep,
+    params: LiFiStepRequest,
     options?: RequestOptions
   ) => Promise<LiFiStep>
 

package/src/client/createClient.ts

@@ -20,16 +20,18 @@ export function createClient(options: SDKConfig): SDKClient {
     checkPackageUpdates(name, version)
   }
 
+  const { providers, ...configOptions } = options
+
   const _config: SDKBaseConfig = {
-    ...options,
-    apiUrl: options?.apiUrl ?? 'https://li.quest/v1',
-    rpcUrls: options?.rpcUrls ?? {},
-    debug: options?.debug ?? false,
-    preloadChains: options?.preloadChains ?? true,
-    integrator: options?.integrator ?? 'lifi-sdk',
+    ...configOptions,
+    apiUrl: configOptions?.apiUrl ?? 'https://li.quest/v1',
+    rpcUrls: configOptions?.rpcUrls ?? {},
+    debug: configOptions?.debug ?? false,
+    preloadChains: configOptions?.preloadChains ?? true,
+    integrator: configOptions?.integrator ?? 'lifi-sdk',
   }
 
-  let _providers: SDKProvider[] = []
+  let _providers: SDKProvider[] = providers ?? []
   const _storage = getClientStorage(_config)
 
   const client: SDKClient = {

package/src/client/getClientStorage.ts

@@ -6,7 +6,14 @@ import type { RPCUrls, SDKBaseConfig } from '../types/core.js'
 // 6 hours in milliseconds
 const chainsRefreshInterval = 1000 * 60 * 60 * 6
 
-export const getClientStorage = (config: SDKBaseConfig) => {
+export interface ClientStorage {
+  readonly needReset: boolean
+  setChains(chains: ExtendedChain[]): void
+  getChains(): Promise<ExtendedChain[]>
+  getRpcUrls(): Promise<RPCUrls>
+}
+
+export const getClientStorage = (config: SDKBaseConfig): ClientStorage => {
   let _chains = [] as ExtendedChain[]
   let _rpcUrls = { ...config.rpcUrls } as RPCUrls
   let _chainsUpdatedAt: number | undefined
@@ -42,6 +49,7 @@ export const getClientStorage = (config: SDKBaseConfig) => {
             ChainType.SVM,
             ChainType.UTXO,
             ChainType.MVM,
+            ChainType.TVM,
           ],
         })
         _chainsUpdatedAt = Date.now()

package/src/core/BaseStepExecutionTask.ts

@@ -0,0 +1,9 @@
+import type { StepExecutorContext, TaskResult } from '../types/execution.js'
+
+export abstract class BaseStepExecutionTask {
+  shouldRun(_context: StepExecutorContext): Promise<boolean> {
+    return Promise.resolve(true)
+  }
+
+  abstract run(context: StepExecutorContext): Promise<TaskResult>
+}

package/src/core/BaseStepExecutor.ts

@@ -1,12 +1,21 @@
-import type { LiFiStep } from '@lifi/types'
+import { ExecuteStepRetryError } from '../errors/errors.js'
+import type { SDKError } from '../errors/SDKError.js'
 import type {
+  ExecuteStepRetryParams,
+  ExecutionAction,
   ExecutionOptions,
   InteractionSettings,
+  LiFiStepExtended,
   SDKClient,
   StepExecutor,
   StepExecutorOptions,
 } from '../types/core.js'
+import type {
+  StepExecutorBaseContext,
+  StepExecutorContext,
+} from '../types/execution.js'
 import { StatusManager } from './StatusManager.js'
+import type { TaskPipeline } from './TaskPipeline.js'
 
 // Please be careful when changing the defaults as it may break the behavior (e.g., background execution)
 const defaultInteractionSettings = {
@@ -37,5 +46,84 @@ export abstract class BaseStepExecutor implements StepExecutor {
     this.allowExecution = interactionSettings.allowExecution
   }
 
-  abstract executeStep(client: SDKClient, step: LiFiStep): Promise<LiFiStep>
+  private createBaseContext = async (
+    client: SDKClient,
+    step: LiFiStepExtended,
+    retryParams?: ExecuteStepRetryParams
+  ): Promise<StepExecutorBaseContext> => {
+    const fromChain = await client.getChainById(step.action.fromChainId)
+    const toChain = await client.getChainById(step.action.toChainId)
+
+    const isBridgeExecution = fromChain.id !== toChain.id
+
+    return {
+      client,
+      step,
+      fromChain,
+      toChain,
+      isBridgeExecution,
+      retryParams,
+      statusManager: this.statusManager,
+      executionOptions: this.executionOptions,
+      allowUserInteraction: this.allowUserInteraction,
+    }
+  }
+
+  abstract createContext(
+    baseContext: StepExecutorBaseContext
+  ): Promise<StepExecutorContext>
+
+  abstract createPipeline(context: StepExecutorContext): TaskPipeline
+
+  abstract parseErrors(
+    error: Error,
+    step?: LiFiStepExtended,
+    action?: ExecutionAction,
+    retryParams?: ExecuteStepRetryParams
+  ): Promise<SDKError | ExecuteStepRetryError>
+
+  executeStep = async (
+    client: SDKClient,
+    step: LiFiStepExtended,
+    retryParams?: ExecuteStepRetryParams
+  ): Promise<LiFiStepExtended> => {
+    try {
+      step.execution = this.statusManager.initializeExecution(step)
+
+      const baseContext = await this.createBaseContext(
+        client,
+        step,
+        retryParams
+      )
+      const context = await this.createContext(baseContext)
+      const pipeline = this.createPipeline(context)
+
+      await pipeline.run(context)
+
+      return step
+    } catch (error: any) {
+      // Derive failing action from last in execution.actions
+      const action = step.execution?.actions?.at(-1)
+      const parsed = await this.parseErrors(error, step, action, retryParams)
+      if (!(parsed instanceof ExecuteStepRetryError)) {
+        if (action) {
+          this.statusManager.updateAction(step, action.type, 'FAILED', {
+            error: {
+              message: parsed.cause?.message,
+              code: parsed.code,
+            },
+          })
+        } else {
+          this.statusManager.updateExecution(step, {
+            status: 'FAILED',
+            error: {
+              message: parsed.cause?.message,
+              code: parsed.code,
+            },
+          })
+        }
+      }
+      throw parsed
+    }
+  }
 }