@lifi/sdk 0.0.0-preview-f5cf9f8

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

@@ -0,0 +1,10 @@
+import { StepExecutorContext, TaskResult } from "../types/execution.js";
+
+//#region src/core/BaseStepExecutionTask.d.ts
+declare abstract class BaseStepExecutionTask {
+  shouldRun(_context: StepExecutorContext): Promise<boolean>;
+  abstract run(context: StepExecutorContext): Promise<TaskResult>;
+}
+//#endregion
+export { BaseStepExecutionTask };
+//# sourceMappingURL=BaseStepExecutionTask.d.ts.map

package/dist/cjs/core/BaseStepExecutionTask.js

@@ -0,0 +1,11 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/core/BaseStepExecutionTask.ts
+var BaseStepExecutionTask = class {
+	shouldRun(_context) {
+		return Promise.resolve(true);
+	}
+};
+//#endregion
+exports.BaseStepExecutionTask = BaseStepExecutionTask;
+
+//# sourceMappingURL=BaseStepExecutionTask.js.map

package/dist/cjs/core/BaseStepExecutionTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseStepExecutionTask.js","names":[],"sources":["../../../src/core/BaseStepExecutionTask.ts"],"sourcesContent":["import type { StepExecutorContext, TaskResult } from '../types/execution.js'\n\nexport abstract class BaseStepExecutionTask {\n  shouldRun(_context: StepExecutorContext): Promise<boolean> {\n    return Promise.resolve(true)\n  }\n\n  abstract run(context: StepExecutorContext): Promise<TaskResult>\n}\n"],"mappings":";;AAEA,IAAsB,wBAAtB,MAA4C;CAC1C,UAAU,UAAiD;EACzD,OAAO,QAAQ,QAAQ,IAAI;CAC7B;AAGF"}

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

@@ -0,0 +1,24 @@
+import { ExecuteStepRetryParams, ExecutionAction, ExecutionOptions, InteractionSettings, LiFiStepExtended, SDKClient, StepExecutor, StepExecutorOptions } from "../types/core.js";
+import { StatusManager } from "./StatusManager.js";
+import { StepExecutorBaseContext, StepExecutorContext } from "../types/execution.js";
+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;
+  protected statusManager: StatusManager;
+  allowUserInteraction: boolean;
+  allowExecution: boolean;
+  constructor(options: StepExecutorOptions);
+  setInteraction: (settings?: InteractionSettings) => void;
+  private createBaseContext;
+  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: (client: SDKClient, step: LiFiStepExtended, retryParams?: ExecuteStepRetryParams) => Promise<LiFiStepExtended>;
+}
+//#endregion
+export { BaseStepExecutor };
+//# sourceMappingURL=BaseStepExecutor.d.ts.map

package/dist/cjs/core/BaseStepExecutor.js

@@ -0,0 +1,71 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errors_errors = require("../errors/errors.js");
+const require_core_StatusManager = require("./StatusManager.js");
+//#region src/core/BaseStepExecutor.ts
+const defaultInteractionSettings = {
+	allowInteraction: true,
+	allowUpdates: true,
+	allowExecution: true
+};
+var BaseStepExecutor = class {
+	executionOptions;
+	statusManager;
+	allowUserInteraction = true;
+	allowExecution = true;
+	constructor(options) {
+		this.statusManager = new require_core_StatusManager.StatusManager(options.routeId);
+		this.executionOptions = options.executionOptions;
+	}
+	setInteraction = (settings) => {
+		const interactionSettings = {
+			...defaultInteractionSettings,
+			...settings
+		};
+		this.allowUserInteraction = interactionSettings.allowInteraction;
+		this.statusManager.allowUpdates(interactionSettings.allowUpdates);
+		this.allowExecution = interactionSettings.allowExecution;
+	};
+	createBaseContext = async (client, step, retryParams) => {
+		const fromChain = await client.getChainById(step.action.fromChainId);
+		const toChain = await client.getChainById(step.action.toChainId);
+		return {
+			client,
+			step,
+			fromChain,
+			toChain,
+			isBridgeExecution: fromChain.id !== toChain.id,
+			retryParams,
+			statusManager: this.statusManager,
+			executionOptions: this.executionOptions,
+			allowUserInteraction: this.allowUserInteraction
+		};
+	};
+	executeStep = async (client, step, retryParams) => {
+		try {
+			step.execution = this.statusManager.initializeExecution(step);
+			const baseContext = await this.createBaseContext(client, step, retryParams);
+			const context = await this.createContext(baseContext);
+			await this.createPipeline(context).run(context);
+			return step;
+		} catch (error) {
+			const action = step.execution?.actions?.at(-1);
+			const parsed = await this.parseErrors(error, step, action, retryParams);
+			if (!(parsed instanceof require_errors_errors.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;
+		}
+	};
+};
+//#endregion
+exports.BaseStepExecutor = BaseStepExecutor;
+
+//# sourceMappingURL=BaseStepExecutor.js.map

package/dist/cjs/core/BaseStepExecutor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseStepExecutor.js","names":["StatusManager","ExecuteStepRetryError"],"sources":["../../../src/core/BaseStepExecutor.ts"],"sourcesContent":["import { ExecuteStepRetryError } from '../errors/errors.js'\nimport type { SDKError } from '../errors/SDKError.js'\nimport type {\n  ExecuteStepRetryParams,\n  ExecutionAction,\n  ExecutionOptions,\n  InteractionSettings,\n  LiFiStepExtended,\n  SDKClient,\n  StepExecutor,\n  StepExecutorOptions,\n} from '../types/core.js'\nimport type {\n  StepExecutorBaseContext,\n  StepExecutorContext,\n} from '../types/execution.js'\nimport { StatusManager } from './StatusManager.js'\nimport type { TaskPipeline } from './TaskPipeline.js'\n\n// Please be careful when changing the defaults as it may break the behavior (e.g., background execution)\nconst defaultInteractionSettings = {\n  allowInteraction: true,\n  allowUpdates: true,\n  allowExecution: true,\n}\n\nexport abstract class BaseStepExecutor implements StepExecutor {\n  protected executionOptions?: ExecutionOptions\n  protected statusManager: StatusManager\n\n  public allowUserInteraction = true\n  public allowExecution = true\n\n  constructor(options: StepExecutorOptions) {\n    this.statusManager = new StatusManager(options.routeId)\n    this.executionOptions = options.executionOptions\n  }\n\n  setInteraction = (settings?: InteractionSettings): void => {\n    const interactionSettings = {\n      ...defaultInteractionSettings,\n      ...settings,\n    }\n    this.allowUserInteraction = interactionSettings.allowInteraction\n    this.statusManager.allowUpdates(interactionSettings.allowUpdates)\n    this.allowExecution = interactionSettings.allowExecution\n  }\n\n  private createBaseContext = async (\n    client: SDKClient,\n    step: LiFiStepExtended,\n    retryParams?: ExecuteStepRetryParams\n  ): Promise<StepExecutorBaseContext> => {\n    const fromChain = await client.getChainById(step.action.fromChainId)\n    const toChain = await client.getChainById(step.action.toChainId)\n\n    const isBridgeExecution = fromChain.id !== toChain.id\n\n    return {\n      client,\n      step,\n      fromChain,\n      toChain,\n      isBridgeExecution,\n      retryParams,\n      statusManager: this.statusManager,\n      executionOptions: this.executionOptions,\n      allowUserInteraction: this.allowUserInteraction,\n    }\n  }\n\n  abstract createContext(\n    baseContext: StepExecutorBaseContext\n  ): Promise<StepExecutorContext>\n\n  abstract createPipeline(context: StepExecutorContext): TaskPipeline\n\n  abstract parseErrors(\n    error: Error,\n    step?: LiFiStepExtended,\n    action?: ExecutionAction,\n    retryParams?: ExecuteStepRetryParams\n  ): Promise<SDKError | ExecuteStepRetryError>\n\n  executeStep = async (\n    client: SDKClient,\n    step: LiFiStepExtended,\n    retryParams?: ExecuteStepRetryParams\n  ): Promise<LiFiStepExtended> => {\n    try {\n      step.execution = this.statusManager.initializeExecution(step)\n\n      const baseContext = await this.createBaseContext(\n        client,\n        step,\n        retryParams\n      )\n      const context = await this.createContext(baseContext)\n      const pipeline = this.createPipeline(context)\n\n      await pipeline.run(context)\n\n      return step\n    } catch (error: any) {\n      // Derive failing action from last in execution.actions\n      const action = step.execution?.actions?.at(-1)\n      const parsed = await this.parseErrors(error, step, action, retryParams)\n      if (!(parsed instanceof ExecuteStepRetryError)) {\n        if (action) {\n          this.statusManager.updateAction(step, action.type, 'FAILED', {\n            error: {\n              message: parsed.cause?.message,\n              code: parsed.code,\n            },\n          })\n        } else {\n          this.statusManager.updateExecution(step, {\n            status: 'FAILED',\n            error: {\n              message: parsed.cause?.message,\n              code: parsed.code,\n            },\n          })\n        }\n      }\n      throw parsed\n    }\n  }\n}\n"],"mappings":";;;;AAoBA,MAAM,6BAA6B;CACjC,kBAAkB;CAClB,cAAc;CACd,gBAAgB;AAClB;AAEA,IAAsB,mBAAtB,MAA+D;CAC7D;CACA;CAEA,uBAA8B;CAC9B,iBAAwB;CAExB,YAAY,SAA8B;EACxC,KAAK,gBAAgB,IAAIA,2BAAAA,cAAc,QAAQ,OAAO;EACtD,KAAK,mBAAmB,QAAQ;CAClC;CAEA,kBAAkB,aAAyC;EACzD,MAAM,sBAAsB;GAC1B,GAAG;GACH,GAAG;EACL;EACA,KAAK,uBAAuB,oBAAoB;EAChD,KAAK,cAAc,aAAa,oBAAoB,YAAY;EAChE,KAAK,iBAAiB,oBAAoB;CAC5C;CAEA,oBAA4B,OAC1B,QACA,MACA,gBACqC;EACrC,MAAM,YAAY,MAAM,OAAO,aAAa,KAAK,OAAO,WAAW;EACnE,MAAM,UAAU,MAAM,OAAO,aAAa,KAAK,OAAO,SAAS;EAI/D,OAAO;GACL;GACA;GACA;GACA;GACA,mBAPwB,UAAU,OAAO,QAAQ;GAQjD;GACA,eAAe,KAAK;GACpB,kBAAkB,KAAK;GACvB,sBAAsB,KAAK;EAC7B;CACF;CAeA,cAAc,OACZ,QACA,MACA,gBAC8B;EAC9B,IAAI;GACF,KAAK,YAAY,KAAK,cAAc,oBAAoB,IAAI;GAE5D,MAAM,cAAc,MAAM,KAAK,kBAC7B,QACA,MACA,WACF;GACA,MAAM,UAAU,MAAM,KAAK,cAAc,WAAW;GAGpD,MAFiB,KAAK,eAAe,OAExB,EAAE,IAAI,OAAO;GAE1B,OAAO;EACT,SAAS,OAAY;GAEnB,MAAM,SAAS,KAAK,WAAW,SAAS,GAAG,EAAE;GAC7C,MAAM,SAAS,MAAM,KAAK,YAAY,OAAO,MAAM,QAAQ,WAAW;GACtE,IAAI,EAAE,kBAAkBC,sBAAAA,wBACtB,IAAI,QACF,KAAK,cAAc,aAAa,MAAM,OAAO,MAAM,UAAU,EAC3D,OAAO;IACL,SAAS,OAAO,OAAO;IACvB,MAAM,OAAO;GACf,EACF,CAAC;QAED,KAAK,cAAc,gBAAgB,MAAM;IACvC,QAAQ;IACR,OAAO;KACL,SAAS,OAAO,OAAO;KACvB,MAAM,OAAO;IACf;GACF,CAAC;GAGL,MAAM;EACR;CACF;AACF"}

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

@@ -0,0 +1,83 @@
+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;
+  type: ExecutionActionType;
+  chainId: ChainId;
+  status: ExecutionActionStatus;
+};
+/**
+* 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
+  */
+  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
+  */
+  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
+  */
+  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;
+  /**
+  * 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
+  */
+  updateAction: (step: LiFiStepExtended, type: ExecutionActionType, status: ExecutionActionStatus, params?: Partial<ExecutionAction & {
+    signedAt?: number;
+  }>) => ExecutionAction;
+  updateStepInRoute: (step: LiFiStep) => LiFiStep;
+  allowUpdates(value: boolean): void;
+}
+//#endregion
+export { StatusManager };
+//# sourceMappingURL=StatusManager.d.ts.map

package/dist/cjs/core/StatusManager.js

@@ -0,0 +1,160 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_core_actionMessages = require("./actionMessages.js");
+const require_core_executionState = require("./executionState.js");
+//#region src/core/StatusManager.ts
+/**
+* Manages status updates of a route and provides various functions for tracking actions.
+*/
+var StatusManager = class {
+	routeId;
+	shouldUpdate = true;
+	constructor(routeId) {
+		this.routeId = routeId;
+	}
+	/**
+	* Initializes the execution object of a Step.
+	* @param step The current step in execution
+	* @returns The initialized execution object for this step
+	*/
+	initializeExecution = (step) => {
+		if (!step.execution) {
+			step.execution = {
+				startedAt: Date.now(),
+				status: "PENDING",
+				actions: []
+			};
+			this.updateStepInRoute(step);
+		}
+		if (step.execution.status === "FAILED") {
+			step.execution.startedAt = Date.now();
+			step.execution.status = "PENDING";
+			step.execution.signedAt = void 0;
+			step.execution.error = void 0;
+			this.updateStepInRoute(step);
+		}
+		return step.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
+	*/
+	updateExecution(step, execution) {
+		if (!step.execution) throw Error("Can't update empty execution.");
+		step.execution = {
+			...step.execution,
+			...execution
+		};
+		this.updateStepInRoute(step);
+		return step;
+	}
+	/**
+	* 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, type) {
+		if (!step.execution?.actions) throw new Error("Execution hasn't been initialized.");
+		return step.execution.actions.find((p) => p.type === type);
+	}
+	/**
+	* 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 }) => {
+		if (!step.execution) throw new Error("Execution hasn't been initialized.");
+		const newAction = {
+			type,
+			message: require_core_actionMessages.getActionMessage(type, status),
+			status,
+			chainId
+		};
+		step.execution.actions.push(newAction);
+		this.updateStepInRoute(step);
+		return newAction;
+	};
+	/**
+	* 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 }) => {
+		if (this.findAction(step, type)) return this.updateAction(step, type, status, { error: void 0 });
+		return this.createAction({
+			step,
+			type,
+			chainId,
+			status
+		});
+	};
+	/**
+	* 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, type, status, params) => {
+		if (!step.execution) throw new Error("Can't update an empty step execution.");
+		const currentAction = this.findAction(step, type);
+		if (!currentAction) throw new Error("Can't find an action for the given type.");
+		switch (status) {
+			case "CANCELLED": break;
+			case "FAILED":
+				step.execution.status = "FAILED";
+				if (params?.error) step.execution.error = params.error;
+				break;
+			case "DONE": break;
+			case "PENDING":
+				step.execution.status = "PENDING";
+				if (params?.signedAt) step.execution.signedAt = params.signedAt;
+				break;
+			case "RESET_REQUIRED":
+			case "MESSAGE_REQUIRED":
+			case "ACTION_REQUIRED":
+				step.execution.status = "ACTION_REQUIRED";
+				break;
+			default: break;
+		}
+		currentAction.status = status;
+		currentAction.message = require_core_actionMessages.getActionMessage(type, status);
+		if (params) {
+			const { signedAt: _signedAt, ...rest } = params;
+			Object.assign(currentAction, rest);
+		}
+		step.execution.actions = [...step.execution.actions.filter((action) => action.status === "DONE"), ...step.execution.actions.filter((action) => action.status !== "DONE")];
+		this.updateStepInRoute(step);
+		return currentAction;
+	};
+	updateStepInRoute = (step) => {
+		if (!this.shouldUpdate) return step;
+		const data = require_core_executionState.executionState.get(this.routeId);
+		if (!data) throw new Error("Execution data not found.");
+		const stepIndex = data.route.steps.findIndex((routeStep) => routeStep.id === step.id);
+		if (stepIndex === -1) throw new Error("Couldn't find a step to update.");
+		data.route.steps[stepIndex] = {
+			...data.route.steps[stepIndex],
+			...step
+		};
+		data.executionOptions?.updateRouteHook?.(data.route);
+		return data.route.steps[stepIndex];
+	};
+	allowUpdates(value) {
+		this.shouldUpdate = value;
+	}
+};
+//#endregion
+exports.StatusManager = StatusManager;
+
+//# sourceMappingURL=StatusManager.js.map

package/dist/cjs/core/StatusManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatusManager.js","names":["getActionMessage","executionState"],"sources":["../../../src/core/StatusManager.ts"],"sourcesContent":["import type { ChainId, LiFiStep } from '@lifi/types'\nimport type {\n  Execution,\n  ExecutionAction,\n  ExecutionActionStatus,\n  ExecutionActionType,\n  LiFiStepExtended,\n} from '../types/core.js'\nimport { getActionMessage } from './actionMessages.js'\nimport { executionState } from './executionState.js'\n\ntype ActionProps = {\n  step: LiFiStepExtended\n  type: ExecutionActionType\n  chainId: ChainId\n  status: ExecutionActionStatus\n}\n\n/**\n * Manages status updates of a route and provides various functions for tracking actions.\n */\nexport class StatusManager {\n  private readonly routeId: string\n  private shouldUpdate = true\n\n  constructor(routeId: string) {\n    this.routeId = routeId\n  }\n\n  /**\n   * Initializes the execution object of a Step.\n   * @param step The current step in execution\n   * @returns The initialized execution object for this step\n   */\n  initializeExecution = (step: LiFiStepExtended): Execution => {\n    if (!step.execution) {\n      step.execution = {\n        startedAt: Date.now(),\n        status: 'PENDING',\n        actions: [],\n      }\n      this.updateStepInRoute(step)\n    }\n\n    // Change status to PENDING after resuming from FAILED\n    if (step.execution.status === 'FAILED') {\n      step.execution.startedAt = Date.now()\n      step.execution.status = 'PENDING'\n      step.execution.signedAt = undefined\n      step.execution.error = undefined\n      this.updateStepInRoute(step)\n    }\n\n    return step.execution\n  }\n\n  /**\n   * Updates the execution object of a Step.\n   * @param step The current step in execution\n   * @param execution Partial execution data to merge\n   * @returns The step with the updated execution object\n   */\n  updateExecution(\n    step: LiFiStepExtended,\n    execution: Partial<Execution>\n  ): LiFiStep {\n    if (!step.execution) {\n      throw Error(\"Can't update empty execution.\")\n    }\n    step.execution = {\n      ...step.execution,\n      ...execution,\n    }\n    this.updateStepInRoute(step)\n    return step\n  }\n\n  /**\n   * Finds an action of the specified type in the step's execution\n   * @param step The step to search in\n   * @param type The action type to find\n   * @returns The found action or undefined if not found\n   */\n  findAction(\n    step: LiFiStepExtended,\n    type: ExecutionActionType\n  ): ExecutionAction | undefined {\n    if (!step.execution?.actions) {\n      throw new Error(\"Execution hasn't been initialized.\")\n    }\n\n    const action = step.execution.actions.find((p) => p.type === type)\n\n    return action\n  }\n\n  /**\n   * Create and push a new action into the execution.\n   * Caller is responsible for ensuring an action of this type does not already exist.\n   * @param step The step that should contain the new action.\n   * @param type Type of the action.\n   * @param chainId Chain Id of the action.\n   * @param status The initial status for the new action.\n   * @returns The created action.\n   */\n  createAction = ({\n    step,\n    type,\n    chainId,\n    status,\n  }: ActionProps): ExecutionAction => {\n    if (!step.execution) {\n      throw new Error(\"Execution hasn't been initialized.\")\n    }\n\n    const newAction: ExecutionAction = {\n      type,\n      message: getActionMessage(type, status),\n      status,\n      chainId,\n    }\n\n    step.execution.actions.push(newAction)\n    this.updateStepInRoute(step)\n    return newAction\n  }\n\n  /**\n   * Find an existing action by type and update it, or create a new one if none exists.\n   * @param step The step that should contain the action.\n   * @param type Type of the action. Used to identify already existing actions.\n   * @param chainId Chain Id of the action (used when creating).\n   * @param status The status to set on the found or newly created action.\n   * @returns The updated or newly created action.\n   */\n  initializeAction = ({\n    step,\n    type,\n    chainId,\n    status,\n  }: ActionProps): ExecutionAction => {\n    const action = this.findAction(step, type)\n\n    if (action) {\n      return this.updateAction(step, type, status, {\n        error: undefined,\n      })\n    }\n\n    return this.createAction({ step, type, chainId, status })\n  }\n\n  /**\n   * Update an action object.\n   * @param step The step where the action should be updated\n   * @param type  The action type to update\n   * @param status The status the action gets.\n   * @param [params] Additional parameters to append to the action.\n   * @returns The updated action\n   */\n  updateAction = (\n    step: LiFiStepExtended,\n    type: ExecutionActionType,\n    status: ExecutionActionStatus,\n    params?: Partial<ExecutionAction & { signedAt?: number }>\n  ): ExecutionAction => {\n    if (!step.execution) {\n      throw new Error(\"Can't update an empty step execution.\")\n    }\n    const currentAction = this.findAction(step, type)\n\n    if (!currentAction) {\n      throw new Error(\"Can't find an action for the given type.\")\n    }\n\n    switch (status) {\n      case 'CANCELLED':\n        break\n      case 'FAILED':\n        step.execution.status = 'FAILED'\n        if (params?.error) {\n          step.execution.error = params.error\n        }\n        break\n      case 'DONE':\n        break\n      case 'PENDING':\n        step.execution.status = 'PENDING'\n        if (params?.signedAt) {\n          step.execution.signedAt = params.signedAt\n        }\n        break\n      case 'RESET_REQUIRED':\n      case 'MESSAGE_REQUIRED':\n      case 'ACTION_REQUIRED':\n        step.execution.status = 'ACTION_REQUIRED'\n        break\n      default:\n        break\n    }\n\n    currentAction.status = status\n    currentAction.message = getActionMessage(type, status)\n    // set extra parameters or overwrite the standard params set in the switch statement\n    if (params) {\n      const { signedAt: _signedAt, ...rest } = params\n      Object.assign(currentAction, rest)\n    }\n    // Sort actions, the ones with DONE status go first\n    step.execution.actions = [\n      ...step.execution.actions.filter((action) => action.status === 'DONE'),\n      ...step.execution.actions.filter((action) => action.status !== 'DONE'),\n    ]\n    this.updateStepInRoute(step) // updates the step in the route\n    return currentAction\n  }\n\n  updateStepInRoute = (step: LiFiStep): LiFiStep => {\n    if (!this.shouldUpdate) {\n      return step\n    }\n    const data = executionState.get(this.routeId)\n\n    if (!data) {\n      throw new Error('Execution data not found.')\n    }\n\n    const stepIndex = data.route.steps.findIndex(\n      (routeStep) => routeStep.id === step.id\n    )\n\n    if (stepIndex === -1) {\n      throw new Error(\"Couldn't find a step to update.\")\n    }\n\n    data.route.steps[stepIndex] = { ...data.route.steps[stepIndex], ...step }\n\n    data.executionOptions?.updateRouteHook?.(data.route)\n    return data.route.steps[stepIndex]\n  }\n\n  allowUpdates(value: boolean): void {\n    this.shouldUpdate = value\n  }\n}\n"],"mappings":";;;;;;;AAqBA,IAAa,gBAAb,MAA2B;CACzB;CACA,eAAuB;CAEvB,YAAY,SAAiB;EAC3B,KAAK,UAAU;CACjB;;;;;;CAOA,uBAAuB,SAAsC;EAC3D,IAAI,CAAC,KAAK,WAAW;GACnB,KAAK,YAAY;IACf,WAAW,KAAK,IAAI;IACpB,QAAQ;IACR,SAAS,CAAC;GACZ;GACA,KAAK,kBAAkB,IAAI;EAC7B;EAGA,IAAI,KAAK,UAAU,WAAW,UAAU;GACtC,KAAK,UAAU,YAAY,KAAK,IAAI;GACpC,KAAK,UAAU,SAAS;GACxB,KAAK,UAAU,WAAW,KAAA;GAC1B,KAAK,UAAU,QAAQ,KAAA;GACvB,KAAK,kBAAkB,IAAI;EAC7B;EAEA,OAAO,KAAK;CACd;;;;;;;CAQA,gBACE,MACA,WACU;EACV,IAAI,CAAC,KAAK,WACR,MAAM,MAAM,+BAA+B;EAE7C,KAAK,YAAY;GACf,GAAG,KAAK;GACR,GAAG;EACL;EACA,KAAK,kBAAkB,IAAI;EAC3B,OAAO;CACT;;;;;;;CAQA,WACE,MACA,MAC6B;EAC7B,IAAI,CAAC,KAAK,WAAW,SACnB,MAAM,IAAI,MAAM,oCAAoC;EAKtD,OAFe,KAAK,UAAU,QAAQ,MAAM,MAAM,EAAE,SAAS,IAEjD;CACd;;;;;;;;;;CAWA,gBAAgB,EACd,MACA,MACA,SACA,aACkC;EAClC,IAAI,CAAC,KAAK,WACR,MAAM,IAAI,MAAM,oCAAoC;EAGtD,MAAM,YAA6B;GACjC;GACA,SAASA,4BAAAA,iBAAiB,MAAM,MAAM;GACtC;GACA;EACF;EAEA,KAAK,UAAU,QAAQ,KAAK,SAAS;EACrC,KAAK,kBAAkB,IAAI;EAC3B,OAAO;CACT;;;;;;;;;CAUA,oBAAoB,EAClB,MACA,MACA,SACA,aACkC;EAGlC,IAFe,KAAK,WAAW,MAAM,IAE5B,GACP,OAAO,KAAK,aAAa,MAAM,MAAM,QAAQ,EAC3C,OAAO,KAAA,EACT,CAAC;EAGH,OAAO,KAAK,aAAa;GAAE;GAAM;GAAM;GAAS;EAAO,CAAC;CAC1D;;;;;;;;;CAUA,gBACE,MACA,MACA,QACA,WACoB;EACpB,IAAI,CAAC,KAAK,WACR,MAAM,IAAI,MAAM,uCAAuC;EAEzD,MAAM,gBAAgB,KAAK,WAAW,MAAM,IAAI;EAEhD,IAAI,CAAC,eACH,MAAM,IAAI,MAAM,0CAA0C;EAG5D,QAAQ,QAAR;GACE,KAAK,aACH;GACF,KAAK;IACH,KAAK,UAAU,SAAS;IACxB,IAAI,QAAQ,OACV,KAAK,UAAU,QAAQ,OAAO;IAEhC;GACF,KAAK,QACH;GACF,KAAK;IACH,KAAK,UAAU,SAAS;IACxB,IAAI,QAAQ,UACV,KAAK,UAAU,WAAW,OAAO;IAEnC;GACF,KAAK;GACL,KAAK;GACL,KAAK;IACH,KAAK,UAAU,SAAS;IACxB;GACF,SACE;EACJ;EAEA,cAAc,SAAS;EACvB,cAAc,UAAUA,4BAAAA,iBAAiB,MAAM,MAAM;EAErD,IAAI,QAAQ;GACV,MAAM,EAAE,UAAU,WAAW,GAAG,SAAS;GACzC,OAAO,OAAO,eAAe,IAAI;EACnC;EAEA,KAAK,UAAU,UAAU,CACvB,GAAG,KAAK,UAAU,QAAQ,QAAQ,WAAW,OAAO,WAAW,MAAM,GACrE,GAAG,KAAK,UAAU,QAAQ,QAAQ,WAAW,OAAO,WAAW,MAAM,CACvE;EACA,KAAK,kBAAkB,IAAI;EAC3B,OAAO;CACT;CAEA,qBAAqB,SAA6B;EAChD,IAAI,CAAC,KAAK,cACR,OAAO;EAET,MAAM,OAAOC,4BAAAA,eAAe,IAAI,KAAK,OAAO;EAE5C,IAAI,CAAC,MACH,MAAM,IAAI,MAAM,2BAA2B;EAG7C,MAAM,YAAY,KAAK,MAAM,MAAM,WAChC,cAAc,UAAU,OAAO,KAAK,EACvC;EAEA,IAAI,cAAc,IAChB,MAAM,IAAI,MAAM,iCAAiC;EAGnD,KAAK,MAAM,MAAM,aAAa;GAAE,GAAG,KAAK,MAAM,MAAM;GAAY,GAAG;EAAK;EAExE,KAAK,kBAAkB,kBAAkB,KAAK,KAAK;EACnD,OAAO,KAAK,MAAM,MAAM;CAC1B;CAEA,aAAa,OAAsB;EACjC,KAAK,eAAe;CACtB;AACF"}

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

@@ -0,0 +1,12 @@
+import { StepExecutorContext, TaskResult } from "../types/execution.js";
+import { BaseStepExecutionTask } from "./BaseStepExecutionTask.js";
+
+//#region src/core/TaskPipeline.d.ts
+declare class TaskPipeline {
+  private readonly tasks;
+  constructor(tasks: BaseStepExecutionTask[]);
+  run(context: StepExecutorContext): Promise<TaskResult>;
+}
+//#endregion
+export { TaskPipeline };
+//# sourceMappingURL=TaskPipeline.d.ts.map

package/dist/cjs/core/TaskPipeline.js

@@ -0,0 +1,21 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/core/TaskPipeline.ts
+var TaskPipeline = class {
+	tasks;
+	constructor(tasks) {
+		this.tasks = tasks;
+	}
+	async run(context) {
+		for (const task of this.tasks) {
+			if (!await task.shouldRun(context)) continue;
+			const result = await task.run(context);
+			if (result.status === "PAUSED") return { status: "PAUSED" };
+			if (result.context && typeof result.context === "object") Object.assign(context, result.context);
+		}
+		return { status: "COMPLETED" };
+	}
+};
+//#endregion
+exports.TaskPipeline = TaskPipeline;
+
+//# sourceMappingURL=TaskPipeline.js.map

package/dist/cjs/core/TaskPipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaskPipeline.js","names":[],"sources":["../../../src/core/TaskPipeline.ts"],"sourcesContent":["import type { StepExecutorContext, TaskResult } from '../types/execution.js'\nimport type { BaseStepExecutionTask } from './BaseStepExecutionTask.js'\n\nexport class TaskPipeline {\n  private readonly tasks: BaseStepExecutionTask[]\n\n  constructor(tasks: BaseStepExecutionTask[]) {\n    this.tasks = tasks\n  }\n\n  async run(context: StepExecutorContext): Promise<TaskResult> {\n    for (const task of this.tasks) {\n      const shouldRun = await task.shouldRun(context)\n      if (!shouldRun) {\n        continue\n      }\n      const result = await task.run(context)\n      if (result.status === 'PAUSED') {\n        return { status: 'PAUSED' }\n      }\n      if (result.context && typeof result.context === 'object') {\n        Object.assign(context, result.context)\n      }\n    }\n\n    return { status: 'COMPLETED' }\n  }\n}\n"],"mappings":";;AAGA,IAAa,eAAb,MAA0B;CACxB;CAEA,YAAY,OAAgC;EAC1C,KAAK,QAAQ;CACf;CAEA,MAAM,IAAI,SAAmD;EAC3D,KAAK,MAAM,QAAQ,KAAK,OAAO;GAE7B,IAAI,CAAC,MADmB,KAAK,UAAU,OAAO,GAE5C;GAEF,MAAM,SAAS,MAAM,KAAK,IAAI,OAAO;GACrC,IAAI,OAAO,WAAW,UACpB,OAAO,EAAE,QAAQ,SAAS;GAE5B,IAAI,OAAO,WAAW,OAAO,OAAO,YAAY,UAC9C,OAAO,OAAO,SAAS,OAAO,OAAO;EAEzC;EAEA,OAAO,EAAE,QAAQ,YAAY;CAC/B;AACF"}

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

@@ -0,0 +1,9 @@
+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;
+//#endregion
+export { getActionMessage, getSubstatusMessage };
+//# sourceMappingURL=actionMessages.d.ts.map

package/dist/cjs/core/actionMessages.js

@@ -0,0 +1,81 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/core/actionMessages.ts
+const actionMessages = {
+	CHECK_ALLOWANCE: {
+		STARTED: "Checking token allowance",
+		PENDING: "Waiting for token allowance check",
+		DONE: "Token allowance checked"
+	},
+	RESET_ALLOWANCE: {
+		STARTED: "Resetting token allowance",
+		RESET_REQUIRED: "Resetting token allowance",
+		PENDING: "Waiting for token allowance reset",
+		DONE: "Token allowance reset"
+	},
+	SET_ALLOWANCE: {
+		STARTED: "Setting token allowance",
+		ACTION_REQUIRED: "Set token allowance",
+		PENDING: "Waiting for token allowance",
+		DONE: "Token allowance set"
+	},
+	SWAP: {
+		STARTED: "Preparing swap transaction",
+		ACTION_REQUIRED: "Sign swap transaction",
+		MESSAGE_REQUIRED: "Sign swap message",
+		PENDING: "Waiting for swap transaction",
+		DONE: "Swap completed"
+	},
+	CROSS_CHAIN: {
+		STARTED: "Preparing bridge transaction",
+		ACTION_REQUIRED: "Sign bridge transaction",
+		MESSAGE_REQUIRED: "Sign bridge message",
+		PENDING: "Waiting for bridge transaction",
+		DONE: "Bridge transaction confirmed"
+	},
+	RECEIVING_CHAIN: {
+		STARTED: "Waiting for destination chain",
+		PENDING: "Waiting for destination chain",
+		DONE: "Bridge completed"
+	},
+	PERMIT: {
+		STARTED: "Preparing transaction",
+		ACTION_REQUIRED: "Sign permit message",
+		PENDING: "Waiting for permit message",
+		DONE: "Permit message signed"
+	},
+	NATIVE_PERMIT: {
+		STARTED: "Preparing transaction",
+		ACTION_REQUIRED: "Sign permit message",
+		PENDING: "Waiting for permit message",
+		DONE: "Permit message signed"
+	}
+};
+const substatusMessages = {
+	PENDING: {
+		BRIDGE_NOT_AVAILABLE: "Bridge communication is temporarily unavailable.",
+		CHAIN_NOT_AVAILABLE: "RPC communication is temporarily unavailable.",
+		UNKNOWN_ERROR: "An unexpected error occurred. Please seek assistance in the LI.FI discord server.",
+		WAIT_SOURCE_CONFIRMATIONS: "The bridge deposit has been received. The bridge is waiting for more confirmations to start the off-chain logic.",
+		WAIT_DESTINATION_TRANSACTION: "The bridge off-chain logic is being executed. Wait for the transaction to appear on the destination chain."
+	},
+	DONE: {
+		PARTIAL: "Some of the received tokens are not the requested destination tokens.",
+		REFUNDED: "The tokens were refunded to the sender address.",
+		COMPLETED: "The transfer is complete."
+	},
+	FAILED: {},
+	INVALID: {},
+	NOT_FOUND: {}
+};
+function getActionMessage(type, status) {
+	return actionMessages[type][status];
+}
+function getSubstatusMessage(status, substatus) {
+	if (!substatus) return;
+	return substatusMessages[status][substatus];
+}
+//#endregion
+exports.getActionMessage = getActionMessage;
+exports.getSubstatusMessage = getSubstatusMessage;
+
+//# sourceMappingURL=actionMessages.js.map

package/dist/cjs/core/actionMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actionMessages.js","names":[],"sources":["../../../src/core/actionMessages.ts"],"sourcesContent":["import type { StatusMessage, Substatus } from '@lifi/types'\nimport type {\n  ExecutionActionStatus,\n  ExecutionActionType,\n} from '../types/core.js'\n\nconst actionMessages: Record<\n  ExecutionActionType,\n  Partial<Record<ExecutionActionStatus, string>>\n> = {\n  CHECK_ALLOWANCE: {\n    STARTED: 'Checking token allowance',\n    PENDING: 'Waiting for token allowance check',\n    DONE: 'Token allowance checked',\n  },\n  RESET_ALLOWANCE: {\n    STARTED: 'Resetting token allowance',\n    RESET_REQUIRED: 'Resetting token allowance',\n    PENDING: 'Waiting for token allowance reset',\n    DONE: 'Token allowance reset',\n  },\n  SET_ALLOWANCE: {\n    STARTED: 'Setting token allowance',\n    ACTION_REQUIRED: 'Set token allowance',\n    PENDING: 'Waiting for token allowance',\n    DONE: 'Token allowance set',\n  },\n  SWAP: {\n    STARTED: 'Preparing swap transaction',\n    ACTION_REQUIRED: 'Sign swap transaction',\n    MESSAGE_REQUIRED: 'Sign swap message',\n    PENDING: 'Waiting for swap transaction',\n    DONE: 'Swap completed',\n  },\n  CROSS_CHAIN: {\n    STARTED: 'Preparing bridge transaction',\n    ACTION_REQUIRED: 'Sign bridge transaction',\n    MESSAGE_REQUIRED: 'Sign bridge message',\n    PENDING: 'Waiting for bridge transaction',\n    DONE: 'Bridge transaction confirmed',\n  },\n  RECEIVING_CHAIN: {\n    STARTED: 'Waiting for destination chain',\n    PENDING: 'Waiting for destination chain',\n    DONE: 'Bridge completed',\n  },\n  PERMIT: {\n    STARTED: 'Preparing transaction',\n    ACTION_REQUIRED: 'Sign permit message',\n    PENDING: 'Waiting for permit message',\n    DONE: 'Permit message signed',\n  },\n  NATIVE_PERMIT: {\n    STARTED: 'Preparing transaction',\n    ACTION_REQUIRED: 'Sign permit message',\n    PENDING: 'Waiting for permit message',\n    DONE: 'Permit message signed',\n  },\n}\n\nconst substatusMessages: Record<\n  StatusMessage,\n  Partial<Record<Substatus, string>>\n> = {\n  PENDING: {\n    BRIDGE_NOT_AVAILABLE: 'Bridge communication is temporarily unavailable.',\n    CHAIN_NOT_AVAILABLE: 'RPC communication is temporarily unavailable.',\n    UNKNOWN_ERROR:\n      'An unexpected error occurred. Please seek assistance in the LI.FI discord server.',\n    WAIT_SOURCE_CONFIRMATIONS:\n      'The bridge deposit has been received. The bridge is waiting for more confirmations to start the off-chain logic.',\n    WAIT_DESTINATION_TRANSACTION:\n      'The bridge off-chain logic is being executed. Wait for the transaction to appear on the destination chain.',\n  },\n  DONE: {\n    PARTIAL:\n      'Some of the received tokens are not the requested destination tokens.',\n    REFUNDED: 'The tokens were refunded to the sender address.',\n    COMPLETED: 'The transfer is complete.',\n  },\n  FAILED: {},\n  INVALID: {},\n  NOT_FOUND: {},\n}\n\nexport function getActionMessage(\n  type: ExecutionActionType,\n  status: ExecutionActionStatus\n): string | undefined {\n  const actionMessage = actionMessages[type][status]\n  return actionMessage\n}\n\nexport function getSubstatusMessage(\n  status: StatusMessage,\n  substatus?: Substatus\n): string | undefined {\n  if (!substatus) {\n    return\n  }\n  const message = substatusMessages[status][substatus]\n  return message\n}\n"],"mappings":";;AAMA,MAAM,iBAGF;CACF,iBAAiB;EACf,SAAS;EACT,SAAS;EACT,MAAM;CACR;CACA,iBAAiB;EACf,SAAS;EACT,gBAAgB;EAChB,SAAS;EACT,MAAM;CACR;CACA,eAAe;EACb,SAAS;EACT,iBAAiB;EACjB,SAAS;EACT,MAAM;CACR;CACA,MAAM;EACJ,SAAS;EACT,iBAAiB;EACjB,kBAAkB;EAClB,SAAS;EACT,MAAM;CACR;CACA,aAAa;EACX,SAAS;EACT,iBAAiB;EACjB,kBAAkB;EAClB,SAAS;EACT,MAAM;CACR;CACA,iBAAiB;EACf,SAAS;EACT,SAAS;EACT,MAAM;CACR;CACA,QAAQ;EACN,SAAS;EACT,iBAAiB;EACjB,SAAS;EACT,MAAM;CACR;CACA,eAAe;EACb,SAAS;EACT,iBAAiB;EACjB,SAAS;EACT,MAAM;CACR;AACF;AAEA,MAAM,oBAGF;CACF,SAAS;EACP,sBAAsB;EACtB,qBAAqB;EACrB,eACE;EACF,2BACE;EACF,8BACE;CACJ;CACA,MAAM;EACJ,SACE;EACF,UAAU;EACV,WAAW;CACb;CACA,QAAQ,CAAC;CACT,SAAS,CAAC;CACV,WAAW,CAAC;AACd;AAEA,SAAgB,iBACd,MACA,QACoB;CAEpB,OADsB,eAAe,MAAM;AAE7C;AAEA,SAAgB,oBACd,QACA,WACoB;CACpB,IAAI,CAAC,WACH;CAGF,OADgB,kBAAkB,QAAQ;AAE5C"}

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

@@ -0,0 +1,48 @@
+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.
+*/
+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.
+*/
+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.
+*/
+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.
+*/
+declare const stopRouteExecution: (route: Route) => Route;
+/**
+* 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.
+*/
+declare const getActiveRoute: (routeId: string) => RouteExtended | undefined;
+//#endregion
+export { executeRoute, getActiveRoute, getActiveRoutes, resumeRoute, stopRouteExecution, updateRouteExecution };
+//# sourceMappingURL=execution.d.ts.map