@lifi/sdk 2.0.0-beta.1 → 2.0.0-beta.11

package/dist/cjs/{Lifi.js → LiFi.js}

@@ -26,22 +26,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConnections = exports.LiFi = void 0;
 const allowance_1 = require("./allowance");
 const balance = __importStar(require("./balance"));
 const connectors_1 = require("./connectors");
-const StatusManager_1 = require("./execution/StatusManager");
-const StepExecutor_1 = require("./execution/StepExecutor");
+const RouteExecutionManager_1 = require("./execution/RouteExecutionManager");
 const helpers_1 = require("./helpers");
 const ApiService_1 = __importDefault(require("./services/ApiService"));
 const ChainsService_1 = __importDefault(require("./services/ChainsService"));
-const ConfigService_1 = __importDefault(require("./services/ConfigService"));
 const typeguards_1 = require("./typeguards");
 const errors_1 = require("./utils/errors");
-const preRestart_1 = require("./utils/preRestart");
 const version_1 = require("./version");
-class LIFI {
+class LiFi extends RouteExecutionManager_1.RouteExecutionManager {
     constructor(configUpdate) {
-        this.activeRouteDictionary = {};
+        super(configUpdate);
         /**
          * Get the current configuration of the SDK
          * @return {Config} - The config object
@@ -141,7 +139,7 @@ class LIFI {
         };
         /**
          * Get a set of routes for a request that describes a transfer of tokens.
-         * @param {RoutesRequest} routesRequest - A description of the transfer.
+         * @param {RoutesRequest} request - A description of the transfer.
          * @return {Promise<RoutesResponse>} The resulting routes that can be used to realize the described transfer of tokens.
          * @throws {LifiError} Throws a LifiError if request fails.
          */
@@ -150,7 +148,7 @@ class LIFI {
         };
         /**
          * Get the transaction data for a single step of a route
-         * @param {Step} step - The step object.
+         * @param {LifiStep} step - The step object.
          * @return {Promise<Step>} The step populated with the transaction data.
          * @throws {LifiError} Throws a LifiError if request fails.
          */
@@ -158,206 +156,12 @@ class LIFI {
             return ApiService_1.default.getStepTransaction(step, options);
         };
         /**
-         * Stops the execution of an active route.
-         * @param {Route} route - A route that is currently in execution.
-         * @return {Route} The stopped route.
-         */
-        this.stopExecution = (route) => {
-            if (!this.activeRouteDictionary[route.id]) {
-                return route;
-            }
-            const { executionData } = this.activeRouteDictionary[route.id];
-            for (const executor of executionData.executors) {
-                executor.setInteraction({
-                    allowInteraction: false,
-                    allowUpdates: false,
-                    stopExecution: true,
-                });
-            }
-            delete this.activeRouteDictionary[route.id];
-            return route;
-        };
-        /**
-         * Executes a route until a user interaction is necessary (signing transactions, etc.) and then halts until the route is resumed.
-         * @param {Route} route - A route that is currently in execution.
-         * @deprecated use updateRouteExecution instead.
-         */
-        this.moveExecutionToBackground = (route) => {
-            const { executionData } = this.activeRouteDictionary[route.id];
-            if (!executionData) {
-                return;
-            }
-            for (const executor of executionData.executors) {
-                executor.setInteraction({ allowInteraction: false, allowUpdates: true });
-            }
-            executionData.settings = {
-                ...executionData.settings,
-                executeInBackground: true,
-            };
-        };
-        /**
-         * Updates route execution to background or foreground state.
-         * @param {Route} route - A route that is currently in execution.
-         * @param {boolean} settings - An object with execution settings.
-         */
-        this.updateRouteExecution = (route, settings) => {
-            const { executionData } = this.activeRouteDictionary[route.id];
-            if (!executionData) {
-                return;
-            }
-            for (const executor of executionData.executors) {
-                executor.setInteraction({
-                    allowInteraction: !settings.executeInBackground,
-                    allowUpdates: true,
-                });
-            }
-            // Update active route settings so we know what the current state of execution is
-            executionData.settings = {
-                ...executionData.settings,
-                ...settings,
-            };
-        };
-        /**
-         * Execute a route.
-         * @param {Signer} signer - The signer required to send the transactions.
-         * @param {Route} route - The route that should be executed. Cannot be an active route.
-         * @param {ExecutionSettings} settings - An object containing settings and callbacks.
-         * @return {Promise<Route>} The executed route.
-         * @throws {LifiError} Throws a LifiError if the execution fails.
-         */
-        this.executeRoute = async (signer, route, settings) => {
-            // Deep clone to prevent side effects
-            const clonedRoute = structuredClone(route);
-            // Check if route is already running
-            if (this.activeRouteDictionary[clonedRoute.id]) {
-                // TODO: maybe inform user why nothing happens?
-                return this.activeRouteDictionary[clonedRoute.id].executionPromise;
-            }
-            const executionPromise = this.executeSteps(signer, clonedRoute, settings);
-            this.activeRouteDictionary[clonedRoute.id] = {
-                ...this.activeRouteDictionary[clonedRoute.id],
-                executionPromise,
-            };
-            return executionPromise;
-        };
-        /**
-         * Resume the execution of a route that has been stopped or had an error while executing.
-         * @param {Signer} signer - The signer required to send the transactions.
-         * @param {Route} route - The route that is to be executed. Cannot be an active route.
-         * @param {ExecutionSettings} settings - An object containing settings and callbacks.
-         * @return {Promise<Route>} The executed route.
-         * @throws {LifiError} Throws a LifiError if the execution fails.
-         */
-        this.resumeRoute = async (signer, route, settings) => {
-            // Deep clone to prevent side effects
-            const clonedRoute = structuredClone(route);
-            const { executionData, executionPromise } = this.activeRouteDictionary[clonedRoute.id];
-            if (executionData) {
-                const executionHalted = executionData.executors.some((executor) => executor.executionStopped);
-                if (!executionHalted) {
-                    // Check if we want to resume route execution in the background
-                    this.updateRouteExecution(route, {
-                        executeInBackground: settings?.executeInBackground,
-                    });
-                    return executionPromise;
-                }
-            }
-            (0, preRestart_1.handlePreRestart)(clonedRoute);
-            const newExecutionPromise = this.executeSteps(signer, clonedRoute, settings);
-            this.activeRouteDictionary[clonedRoute.id] = {
-                ...this.activeRouteDictionary[clonedRoute.id],
-                executionPromise: newExecutionPromise,
-            };
-            return newExecutionPromise;
-        };
-        this.executeSteps = async (signer, route, settings) => {
-            const config = this.configService.getConfig();
-            const updatedExecutionData = {
-                route,
-                executors: [],
-                settings: { ...config.defaultExecutionSettings, ...settings },
-            };
-            this.activeRouteDictionary[route.id].executionData = {
-                ...updatedExecutionData,
-            };
-            const { executionData } = this.activeRouteDictionary[route.id];
-            const statusManager = new StatusManager_1.StatusManager(route, executionData.settings, (route) => {
-                if (this.activeRouteDictionary[route.id]) {
-                    executionData.route = route;
-                }
-            });
-            // Loop over steps and execute them
-            for (let index = 0; index < route.steps.length; index++) {
-                const { executionData } = this.activeRouteDictionary[route.id];
-                // Check if execution has stopped in the meantime
-                if (!executionData) {
-                    break;
-                }
-                const step = route.steps[index];
-                const previousStep = route.steps[index - 1];
-                // Check if the step is already done
-                //
-                if (step.execution?.status === 'DONE') {
-                    continue;
-                }
-                // Update amount using output of previous execution. In the future this should be handled by calling `updateRoute`
-                if (previousStep?.execution?.toAmount) {
-                    step.action.fromAmount = previousStep.execution.toAmount;
-                }
-                try {
-                    const stepExecutor = new StepExecutor_1.StepExecutor(statusManager, executionData.settings);
-                    executionData.executors.push(stepExecutor);
-                    // Check if we want to execute this step in the background
-                    this.updateRouteExecution(route, executionData.settings);
-                    const executedStep = await stepExecutor.executeStep(signer, step);
-                    // We may reach this point if user interaction isn't allowed. We want to stop execution until we resume it
-                    if (executedStep.execution?.status !== 'DONE') {
-                        this.stopExecution(route);
-                    }
-                    // Execution stopped during the current step, we don't want to continue to the next step so we return already
-                    if (stepExecutor.executionStopped) {
-                        return route;
-                    }
-                }
-                catch (e) {
-                    this.stopExecution(route);
-                    throw e;
-                }
-            }
-            // Clean up after the execution
-            delete this.activeRouteDictionary[route.id];
-            return route;
-        };
-        /**
-         * Update the ExecutionSettings for an active route.
-         * @param {ExecutionSettings} settings - An object with execution settings.
-         * @param {Route} route - The active route that gets the new execution settings.
-         * @throws {ValidationError} Throws a ValidationError if parameters are invalid.
-         */
-        this.updateExecutionSettings = (settings, route) => {
-            if (!this.activeRouteDictionary[route.id]) {
-                throw new errors_1.ValidationError("Can't set ExecutionSettings for the inactive route.");
-            }
-            const config = this.configService.getConfig();
-            this.activeRouteDictionary[route.id].executionData.settings = {
-                ...config.defaultExecutionSettings,
-                ...settings,
-            };
-        };
-        /**
-         * Get the list of active routes.
-         * @return {Route[]} A list of routes.
-         */
-        this.getActiveRoutes = () => {
-            return Object.values(this.activeRouteDictionary).map((dict) => dict.executionData.route);
-        };
-        /**
-         * Return the current route information for given route. The route has to be active.
-         * @param {Route} route - A route object.
-         * @return {Route} The updated route.
+         * Get gas recommendation for a certain chain
+         * @param {GasRecommendationRequest} request - Configuration of the requested recommendation.
+         * @throws {LifiError} Throws a LifiError if request fails.
          */
-        this.getActiveRoute = (route) => {
-            return this.activeRouteDictionary[route.id]?.executionData.route;
+        this.getGasRecommendation = async (request, options) => {
+            return ApiService_1.default.getGasRecommendation(request, options);
         };
         /**
          * Returns the balances of a specific token a wallet holds across all aggregated chains.
@@ -441,11 +245,6 @@ class LIFI {
         this.revokeTokenApproval = (request) => {
             return (0, allowance_1.revokeTokenApproval)(request);
         };
-        this.configService = ConfigService_1.default.getInstance();
-        if (configUpdate) {
-            // Update API urls before we request chains
-            this.configService.updateConfig(configUpdate);
-        }
         this.chainsService = ChainsService_1.default.getInstance();
         this.chainsService.getChains().then((chains) => {
             this.configService.updateChains(chains);
@@ -453,4 +252,14 @@ class LIFI {
         (0, helpers_1.checkPackageUpdates)(version_1.name, version_1.version, configUpdate?.disableVersionCheck);
     }
 }
-exports.default = LIFI;
+exports.LiFi = LiFi;
+/**
+ * Get all the available connections for swap/bridging tokens
+ * @param connectionRequest ConnectionsRequest
+ * @returns ConnectionsResponse
+ */
+const getConnections = async (connectionRequest) => {
+    const connections = await ApiService_1.default.getAvailableConnections(connectionRequest);
+    return connections;
+};
+exports.getConnections = getConnections;

package/dist/cjs/allowance/checkAllowance.d.ts

@@ -1,4 +1,4 @@
 import { Signer } from 'ethers';
 import { StatusManager } from '../execution/StatusManager';
-import { Chain, InternalExecutionSettings, Step } from '../types';
-export declare const checkAllowance: (signer: Signer, step: Step, statusManager: StatusManager, settings: InternalExecutionSettings, chain: Chain, allowUserInteraction?: boolean) => Promise<void>;
+import { Chain, InternalExecutionSettings, LifiStep } from '../types';
+export declare const checkAllowance: (signer: Signer, step: LifiStep, statusManager: StatusManager, settings: InternalExecutionSettings, chain: Chain, allowUserInteraction?: boolean) => Promise<void>;

package/dist/cjs/allowance/checkAllowance.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkAllowance = void 0;
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const ethers_1 = require("ethers");
 const utils_1 = require("../allowance/utils");
@@ -23,7 +22,22 @@ const checkAllowance = async (signer, step, statusManager, settings, chain, allo
             allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'DONE');
         }
         else {
-            const approved = await (0, utils_1.getApproved)(signer, step.action.fromToken.address, step.estimate.approvalAddress);
+            const approvalRequest = {
+                from: step.action.fromToken.address,
+                to: step.estimate.approvalAddress,
+            };
+            if (settings.updateTransactionRequest) {
+                const config = await settings.updateTransactionRequest(approvalRequest);
+                approvalRequest.gasLimit = config.gasLimit;
+                approvalRequest.gasPrice = config.gasPrice;
+            }
+            if (!approvalRequest.from) {
+                throw new Error('Missing Signer address');
+            }
+            if (!approvalRequest.to) {
+                throw new Error('Missing ERC20 contract address');
+            }
+            const approved = await (0, utils_1.getApproved)(signer, approvalRequest.from, approvalRequest.to, approvalRequest);
             if (new bignumber_js_1.default(step.action.fromAmount).gt(approved)) {
                 if (!allowUserInteraction) {
                     return;

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

@@ -1,8 +1,9 @@
+import { TransactionRequest } from '@ethersproject/abstract-provider';
 import { ChainId, Token } from '@lifi/types';
 import BigNumber from 'bignumber.js';
 import { ContractTransaction, Signer } from 'ethers';
 import { RevokeTokenData } from '../types';
-export declare const getApproved: (signer: Signer, tokenAddress: string, contractAddress: string) => Promise<BigNumber>;
+export declare const getApproved: (signer: Signer, tokenAddress: string, contractAddress: string, transactionRequest?: TransactionRequest) => Promise<BigNumber>;
 export declare const setApproval: (signer: Signer, tokenAddress: string, contractAddress: string, amount: string) => Promise<ContractTransaction>;
 export declare const getAllowanceViaMulticall: (signer: Signer, chainId: ChainId, tokenData: RevokeTokenData[]) => Promise<{
     token: Token;

package/dist/cjs/allowance/utils.js

@@ -10,11 +10,16 @@ const ChainsService_1 = __importDefault(require("../services/ChainsService"));
 const types_1 = require("../types");
 const errors_1 = require("../utils/errors");
 const multicall_1 = require("../utils/multicall");
-const getApproved = async (signer, tokenAddress, contractAddress) => {
+const getApproved = async (signer, tokenAddress, contractAddress, transactionRequest) => {
     const signerAddress = await signer.getAddress();
     const erc20 = new ethers_1.Contract(tokenAddress, types_1.ERC20_ABI, signer);
     try {
-        const approved = await erc20.allowance(signerAddress, contractAddress);
+        const approved = await erc20.allowance(signerAddress, contractAddress, {
+            gasLimit: transactionRequest?.gasLimit,
+            gasPrice: transactionRequest?.gasPrice,
+            maxFeePerGas: transactionRequest?.maxFeePerGas,
+            maxPriorityFeePerGas: transactionRequest?.maxPriorityFeePerGas,
+        });
         return new bignumber_js_1.default(approved.toString());
     }
     catch (e) {

package/dist/cjs/balance/checkBalance.d.ts

@@ -1,3 +1,3 @@
 import { ethers } from 'ethers';
-import { Step } from '..';
-export declare const checkBalance: (signer: ethers.Signer, step: Step, depth?: number) => Promise<void>;
+import { LifiStep } from '..';
+export declare const checkBalance: (signer: ethers.Signer, step: LifiStep, depth?: number) => Promise<void>;

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

@@ -1,7 +1,7 @@
 export * from './checkBalance';
 export * from './getTokenBalance';
 declare const _default: {
-    checkBalance: (signer: import("ethers").Signer, step: import("@lifi/types").Step, depth?: number) => Promise<void>;
+    checkBalance: (signer: import("ethers").Signer, step: import("@lifi/types").LifiStep, depth?: number) => Promise<void>;
     getTokenBalance: (walletAddress: string, token: import("@lifi/types").Token) => Promise<import("@lifi/types").TokenAmount | null>;
     getTokenBalances: (walletAddress: string, tokens: import("@lifi/types").Token[]) => Promise<import("@lifi/types").TokenAmount[]>;
     getTokenBalancesForChains: (walletAddress: string, tokensByChain: {

package/dist/cjs/connectors.d.ts

@@ -1,5 +1,5 @@
-import { ChainId } from './types';
 import { FallbackProvider } from '@ethersproject/providers';
+import { ChainId } from './types';
 export declare const getRpcUrl: (chainId: ChainId, archive?: boolean) => Promise<string>;
 export declare const getRpcUrls: (chainId: ChainId, archive?: boolean) => Promise<string[]>;
 export declare const getRpcProvider: (chainId: number, archive?: boolean) => Promise<FallbackProvider>;

package/dist/cjs/connectors.js

@@ -4,10 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMulticallAddress = exports.getRpcProvider = exports.getRpcUrls = exports.getRpcUrl = void 0;
-const ethers_1 = require("ethers");
-const types_1 = require("./types");
-const ConfigService_1 = __importDefault(require("./services/ConfigService"));
+const providers_1 = require("@ethersproject/providers");
 const helpers_1 = require("./helpers");
+const ConfigService_1 = __importDefault(require("./services/ConfigService"));
+const types_1 = require("./types");
 const errors_1 = require("./utils/errors");
 // cached providers
 const chainProviders = {};
@@ -41,17 +41,15 @@ const getRandomProvider = (providerList) => {
 const getRpcProvider = async (chainId, archive = false) => {
     if (archive && archiveRpcs[chainId]) {
         // return archive PRC, but don't cache it
-        return new ethers_1.providers.FallbackProvider([
-            new ethers_1.providers.StaticJsonRpcProvider(await (0, exports.getRpcUrl)(chainId, archive), chainId),
+        return new providers_1.FallbackProvider([
+            new providers_1.StaticJsonRpcProvider(await (0, exports.getRpcUrl)(chainId, archive), chainId),
         ]);
     }
-    if (!chainProviders[chainId]) {
+    if (!chainProviders[chainId]?.length) {
         chainProviders[chainId] = [];
         const urls = await (0, exports.getRpcUrls)(chainId, archive);
         urls.forEach((url) => {
-            chainProviders[chainId].push(new ethers_1.providers.FallbackProvider([
-                new ethers_1.providers.StaticJsonRpcProvider(url, chainId),
-            ]));
+            chainProviders[chainId].push(new providers_1.FallbackProvider([new providers_1.StaticJsonRpcProvider(url, chainId)]));
         });
     }
     if (!chainProviders[chainId].length) {

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

@@ -0,0 +1,65 @@
+import { Route } from '@lifi/types';
+import { Signer } from 'ethers';
+import ConfigService from '../services/ConfigService';
+import { ConfigUpdate, ExecutionSettings } from '../types';
+export declare class RouteExecutionManager {
+    private executionDictionary;
+    private executionPromiseDictionary;
+    protected configService: ConfigService;
+    constructor(configUpdate?: ConfigUpdate);
+    /**
+     * Execute a route.
+     * @param {Signer} signer - The signer required to send the transactions.
+     * @param {Route} route - The route that should be executed. Cannot be an active route.
+     * @param {ExecutionSettings} settings - An object containing settings and callbacks.
+     * @return {Promise<Route>} The executed route.
+     * @throws {LifiError} Throws a LifiError if the execution fails.
+     */
+    executeRoute: (signer: Signer, route: Route, settings?: ExecutionSettings) => Promise<Route>;
+    /**
+     * Resume the execution of a route that has been stopped or had an error while executing.
+     * @param {Signer} signer - The signer required to send the transactions.
+     * @param {Route} route - The route that is to be executed. Cannot be an active route.
+     * @param {ExecutionSettings} settings - An object containing settings and callbacks.
+     * @return {Promise<Route>} The executed route.
+     * @throws {LifiError} Throws a LifiError if the execution fails.
+     */
+    resumeRoute: (signer: Signer, route: Route, settings?: ExecutionSettings) => Promise<Route>;
+    private executeSteps;
+    /**
+     * Updates route execution to background or foreground state.
+     * @param {Route} route - A route that is currently in execution.
+     * @param {boolean} settings - An object with execution settings.
+     */
+    updateRouteExecution: (route: Route, settings: Pick<ExecutionSettings, 'executeInBackground'>) => void;
+    /**
+     * Update the ExecutionSettings for an active route.
+     * @param {ExecutionSettings} settings - An object with execution settings.
+     * @param {Route} route - The active route that gets the new execution settings.
+     * @throws {ValidationError} Throws a ValidationError if parameters are invalid.
+     */
+    updateExecutionSettings: (settings: ExecutionSettings, route: Route) => void;
+    /**
+     * Executes a route until a user interaction is necessary (signing transactions, etc.) and then halts until the route is resumed.
+     * @param {Route} route - A route that is currently in execution.
+     * @deprecated use updateRouteExecution instead.
+     */
+    moveExecutionToBackground: (route: Route) => void;
+    /**
+     * Stops the execution of an active route.
+     * @param {Route} route - A route that is currently in execution.
+     * @return {Route} The stopped route.
+     */
+    stopExecution: (route: Route) => Route;
+    /**
+     * Get the list of active routes.
+     * @return {Route[]} A list of routes.
+     */
+    getActiveRoutes: () => Route[];
+    /**
+     * Return the current route information for given route. The route has to be active.
+     * @param {Route} route - A route object.
+     * @return {Route} The updated route.
+     */
+    getActiveRoute: (route: Route) => Route | undefined;
+}