@lifi/sdk 1.1.2 → 1.1.5

package/dist/cjs/balances/utils.js

@@ -0,0 +1,150 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const ethers_1 = require("ethers");
+const connectors_1 = require("../connectors");
+const multicall_1 = require("../utils/multicall");
+const utils_1 = require("../utils/utils");
+const balanceAbi = [
+    {
+        constant: true,
+        inputs: [{ name: 'who', type: 'address' }],
+        name: 'balanceOf',
+        outputs: [{ name: '', type: 'uint256' }],
+        payable: false,
+        stateMutability: 'view',
+        type: 'function',
+    },
+    {
+        constant: true,
+        inputs: [{ name: 'addr', type: 'address' }],
+        name: 'getEthBalance',
+        outputs: [{ name: 'balance', type: 'uint256' }],
+        payable: false,
+        stateMutability: 'view',
+        type: 'function',
+    },
+];
+const getBalances = (walletAddress, tokens) => __awaiter(void 0, void 0, void 0, function* () {
+    if (tokens.length === 0) {
+        return [];
+    }
+    const { chainId } = tokens[0];
+    tokens.forEach((token) => {
+        if (token.chainId !== chainId) {
+            // eslint-disable-next-line no-console
+            console.warn(`Requested tokens have to be on same chain.`);
+            return [];
+        }
+    });
+    if ((yield (0, connectors_1.getMulticallAddress)(chainId)) && tokens.length > 1) {
+        return getBalancesFromProviderUsingMulticall(walletAddress, tokens);
+    }
+    else {
+        return getBalancesFromProvider(walletAddress, tokens);
+    }
+});
+const getBalancesFromProviderUsingMulticall = (walletAddress, tokens) => __awaiter(void 0, void 0, void 0, function* () {
+    // Configuration
+    const { chainId } = tokens[0];
+    const multicallAddress = yield (0, connectors_1.getMulticallAddress)(chainId);
+    if (!multicallAddress) {
+        throw new Error('No multicallAddress found for the given chain.');
+    }
+    return executeMulticall(walletAddress, tokens, multicallAddress, chainId);
+});
+const executeMulticall = (walletAddress, tokens, multicallAddress, chainId) => __awaiter(void 0, void 0, void 0, function* () {
+    // Collect calls we want to make
+    const calls = [];
+    tokens.map((token) => {
+        if ((0, utils_1.isZeroAddress)(token.address)) {
+            calls.push({
+                address: multicallAddress,
+                name: 'getEthBalance',
+                params: [walletAddress],
+            });
+        }
+        else {
+            calls.push({
+                address: token.address,
+                name: 'balanceOf',
+                params: [walletAddress],
+            });
+        }
+    });
+    const res = yield fetchViaMulticall(calls, balanceAbi, chainId, multicallAddress);
+    if (!res.length) {
+        return [];
+    }
+    return tokens.map((token, i) => {
+        const amount = new bignumber_js_1.default(res[i].amount.toString() || '0')
+            .shiftedBy(-token.decimals)
+            .toFixed();
+        return Object.assign(Object.assign({}, token), { amount: amount || '0', blockNumber: res[i].blockNumber });
+    });
+});
+const fetchViaMulticall = (calls, abi, chainId, multicallAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, multicall_1.fetchDataUsingMulticall)(calls, abi, chainId, multicallAddress);
+    return result.map(({ data, blockNumber }) => ({
+        amount: data ? data : new bignumber_js_1.default(0),
+        blockNumber,
+    }));
+});
+const getBalancesFromProvider = (walletAddress, tokens) => __awaiter(void 0, void 0, void 0, function* () {
+    const chainId = tokens[0].chainId;
+    const rpc = yield (0, connectors_1.getRpcProvider)(chainId);
+    const tokenAmountPromises = tokens.map((token) => __awaiter(void 0, void 0, void 0, function* () {
+        let amount = '0';
+        let blockNumber;
+        try {
+            const balance = yield getBalanceFromProvider(walletAddress, token.address, chainId, rpc);
+            amount = new bignumber_js_1.default(balance.amount.toString())
+                .shiftedBy(-token.decimals)
+                .toString();
+            blockNumber = balance.blockNumber;
+        }
+        catch (e) {
+            // eslint-disable-next-line no-console
+            console.warn(e);
+        }
+        return Object.assign(Object.assign({}, token), { amount,
+            blockNumber });
+    }));
+    return Promise.all(tokenAmountPromises);
+});
+const getBalanceFromProvider = (walletAddress, assetId, chainId, provider) => __awaiter(void 0, void 0, void 0, function* () {
+    const blockNumber = yield getCurrentBlockNumber(chainId);
+    let balance;
+    if ((0, utils_1.isZeroAddress)(assetId)) {
+        balance = yield provider.getBalance(walletAddress, blockNumber);
+    }
+    else {
+        const contract = new ethers_1.ethers.Contract(assetId, ['function balanceOf(address owner) view returns (uint256)'], provider);
+        balance = yield contract.balanceOf(walletAddress, {
+            blockTag: blockNumber,
+        });
+    }
+    return {
+        amount: balance,
+        blockNumber,
+    };
+});
+const getCurrentBlockNumber = (chainId) => __awaiter(void 0, void 0, void 0, function* () {
+    const rpc = yield (0, connectors_1.getRpcProvider)(chainId);
+    return rpc.getBlockNumber();
+});
+exports.default = {
+    getBalances,
+};

package/dist/cjs/connectors.d.ts

@@ -0,0 +1,6 @@
+import { ChainId } from './types';
+import { FallbackProvider } from '@ethersproject/providers';
+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>;
+export declare const getMulticallAddress: (chainId: ChainId) => Promise<string | undefined>;

package/dist/cjs/connectors.js

@@ -0,0 +1,77 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMulticallAddress = exports.getRpcProvider = exports.getRpcUrls = exports.getRpcUrl = void 0;
+const ethers_1 = require("ethers");
+const _1 = require(".");
+const types_1 = require("./types");
+const ConfigService_1 = __importDefault(require("./services/ConfigService"));
+// cached providers
+const chainProviders = {};
+// Archive RPC Provider
+const archiveRpcs = {
+    [types_1.ChainId.ETH]: 'https://speedy-nodes-nyc.moralis.io/5ed6053dc39eba789ff466c9/eth/mainnet/archive',
+    [types_1.ChainId.BSC]: 'https://speedy-nodes-nyc.moralis.io/5ed6053dc39eba789ff466c9/bsc/mainnet/archive',
+    [types_1.ChainId.POL]: 'https://speedy-nodes-nyc.moralis.io/5ed6053dc39eba789ff466c9/polygon/mainnet/archive',
+    [types_1.ChainId.FTM]: 'https://speedy-nodes-nyc.moralis.io/5ed6053dc39eba789ff466c9/fantom/mainnet',
+};
+// RPC Urls
+const getRpcUrl = (chainId, archive = false) => __awaiter(void 0, void 0, void 0, function* () {
+    const rpcUrls = yield (0, exports.getRpcUrls)(chainId, archive);
+    return rpcUrls[0];
+});
+exports.getRpcUrl = getRpcUrl;
+const getRpcUrls = (chainId, archive = false) => __awaiter(void 0, void 0, void 0, function* () {
+    if (archive && archiveRpcs[chainId]) {
+        return [archiveRpcs[chainId]];
+    }
+    const configService = ConfigService_1.default.getInstance();
+    const config = yield configService.getConfigAsync();
+    return config.rpcs[chainId];
+});
+exports.getRpcUrls = getRpcUrls;
+const getRandomProvider = (providerList) => {
+    const index = (0, _1.getRandomNumber)(0, providerList.length - 1);
+    return providerList[index];
+};
+// Provider
+const getRpcProvider = (chainId, archive = false) => __awaiter(void 0, void 0, void 0, function* () {
+    if (archive && archiveRpcs[chainId]) {
+        // return archive PRC, but don't cache it
+        return new ethers_1.providers.FallbackProvider([
+            new ethers_1.providers.StaticJsonRpcProvider(yield (0, exports.getRpcUrl)(chainId, archive), chainId),
+        ]);
+    }
+    if (!chainProviders[chainId]) {
+        chainProviders[chainId] = [];
+        const urls = yield (0, exports.getRpcUrls)(chainId, archive);
+        urls.forEach((url) => {
+            chainProviders[chainId].push(new ethers_1.providers.FallbackProvider([
+                new ethers_1.providers.StaticJsonRpcProvider(url, chainId),
+            ]));
+        });
+    }
+    if (!chainProviders[chainId].length) {
+        throw new _1.ServerError(`Unable to configure provider for chain ${chainId}`);
+    }
+    return getRandomProvider(chainProviders[chainId]);
+});
+exports.getRpcProvider = getRpcProvider;
+// Multicall
+const getMulticallAddress = (chainId) => __awaiter(void 0, void 0, void 0, function* () {
+    const configService = ConfigService_1.default.getInstance();
+    const config = yield configService.getConfigAsync();
+    return config.multicallAddresses[chainId];
+});
+exports.getMulticallAddress = getMulticallAddress;

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

@@ -0,0 +1,65 @@
+import { Execution, InternalExecutionSettings, Process, ProcessType, Route, Status, Step, Token } from '../types';
+interface Receipt {
+    fromAmount?: string;
+    toAmount?: string;
+    toToken?: Token;
+    gasUsed?: string;
+    gasPrice?: string;
+}
+declare type InternalUpdateRouteCallback = (route: Route) => void;
+declare type OptionalParameters = Partial<Pick<Process, 'doneAt' | 'failedAt' | 'txHash' | 'txLink' | 'error' | 'substatus' | 'substatusMessage'>>;
+/**
+ * Manages status updates of a route and provides various functions for tracking processes
+ * @param  {Route} route  The route this StatusManger belongs to.
+ * @param  {InternalExecutionSettings} settings   The ExecutionSettings for this route.
+ * @param  {InternalUpdateRouteCallback} internalUpdateRouteCallback  Internal callback to propage route changes.
+ * @return {StatusManager}       An instance of StatusManager.
+ */
+export declare class StatusManager {
+    private readonly route;
+    private readonly settings;
+    private readonly internalUpdateRouteCallback;
+    private shouldUpdate;
+    constructor(route: Route, settings: InternalExecutionSettings, internalUpdateRouteCallback: InternalUpdateRouteCallback);
+    /**
+     * Initializes the execution object of a Step.
+     * @param  {Step} step  The current step in execution
+     * @return {Execution}       The initialized execution object for this step and a function to update this step
+     */
+    initExecutionObject: (step: Step) => Execution;
+    /**
+     * Updates the execution object of a Step.
+     * @param  {Step} step  The current step in execution
+     * @param  {Status} status  The status for the execution
+     * @param  {Receipt} receipt Optional. Information about received tokens
+     * @return {Step}       The step with the updated execution object
+     */
+    updateExecution(step: Step, status: Status, receipt?: Receipt): Step;
+    /**
+     * Create and push a new process into the execution.
+     * @param  {ProcessType} type Type of the process. Used to identify already existing processes.
+     * @param  {Step} step The step that should contain the new process.
+     * @param  {Status} status By default created procces is set to the STARTED status. We can override new process with the needed status.
+     * @return {Process}
+     */
+    findOrCreateProcess: (type: ProcessType, step: Step, status?: Status) => Process;
+    /**
+     * Update a process object.
+     * @param  {Step} step The step where the process should be updated
+     * @param  {ProcessType} type  The process type to update
+     * @param  {Status} status The status the process gets.
+     * @param  {object} [params]   Additional parameters to append to the process.
+     * @return {Process} The update process
+     */
+    updateProcess: (step: Step, type: ProcessType, status: Status, params?: OptionalParameters) => Process;
+    /**
+     * Remove a process from the execution
+     * @param  {Step} step The step where the process should be removed from
+     * @param  {ProcessType} type  The process type to remove
+     * @return {void}
+     */
+    removeProcess: (step: Step, type: ProcessType) => void;
+    updateStepInRoute: (step: Step) => Step;
+    setShouldUpdate(value: boolean): void;
+}
+export {};

package/dist/cjs/execution/StatusManager.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatusManager = void 0;
+const types_1 = require("../types");
+const utils_1 = require("../utils/utils");
+const utils_2 = require("./utils");
+/**
+ * Manages status updates of a route and provides various functions for tracking processes
+ * @param  {Route} route  The route this StatusManger belongs to.
+ * @param  {InternalExecutionSettings} settings   The ExecutionSettings for this route.
+ * @param  {InternalUpdateRouteCallback} internalUpdateRouteCallback  Internal callback to propage route changes.
+ * @return {StatusManager}       An instance of StatusManager.
+ */
+class StatusManager {
+    constructor(route, settings, internalUpdateRouteCallback) {
+        this.shouldUpdate = true;
+        /**
+         * Initializes the execution object of a Step.
+         * @param  {Step} step  The current step in execution
+         * @return {Execution}       The initialized execution object for this step and a function to update this step
+         */
+        this.initExecutionObject = (step) => {
+            const currentExecution = step.execution || (0, utils_1.deepClone)(types_1.emptyExecution);
+            if (!step.execution) {
+                step.execution = currentExecution;
+                step.execution.status = 'PENDING';
+                this.updateStepInRoute(step);
+            }
+            // Change status to PENDING after resuming from FAILED
+            if (currentExecution.status === 'FAILED') {
+                currentExecution.status = 'PENDING';
+                this.updateStepInRoute(step);
+            }
+            return currentExecution;
+        };
+        /**
+         * Create and push a new process into the execution.
+         * @param  {ProcessType} type Type of the process. Used to identify already existing processes.
+         * @param  {Step} step The step that should contain the new process.
+         * @param  {Status} status By default created procces is set to the STARTED status. We can override new process with the needed status.
+         * @return {Process}
+         */
+        this.findOrCreateProcess = (type, step, status) => {
+            if (!step.execution || !step.execution.process) {
+                throw new Error("Execution hasn't been initialized.");
+            }
+            const process = step.execution.process.find((p) => p.type === type);
+            if (process) {
+                return process;
+            }
+            const newProcess = {
+                type: type,
+                startedAt: Date.now(),
+                message: (0, utils_2.getProcessMessage)(type, status !== null && status !== void 0 ? status : 'STARTED'),
+                status: status !== null && status !== void 0 ? status : 'STARTED',
+            };
+            step.execution.process.push(newProcess);
+            this.updateStepInRoute(step);
+            return newProcess;
+        };
+        /**
+         * Update a process object.
+         * @param  {Step} step The step where the process should be updated
+         * @param  {ProcessType} type  The process type to update
+         * @param  {Status} status The status the process gets.
+         * @param  {object} [params]   Additional parameters to append to the process.
+         * @return {Process} The update process
+         */
+        this.updateProcess = (step, type, status, params) => {
+            var _a;
+            if (!step.execution) {
+                throw new Error("Can't update an empty step execution.");
+            }
+            const currentProcess = (_a = step === null || step === void 0 ? void 0 : step.execution) === null || _a === void 0 ? void 0 : _a.process.find((p) => p.type === type);
+            if (!currentProcess) {
+                throw new Error("Can't find a process for the given type.");
+            }
+            switch (status) {
+                case 'CANCELLED':
+                    currentProcess.doneAt = Date.now();
+                    break;
+                case 'FAILED':
+                    currentProcess.doneAt = Date.now();
+                    step.execution.status = 'FAILED';
+                    break;
+                case 'DONE':
+                    currentProcess.doneAt = Date.now();
+                    break;
+                case 'PENDING':
+                    step.execution.status = 'PENDING';
+                    break;
+                case 'ACTION_REQUIRED':
+                    step.execution.status = 'ACTION_REQUIRED';
+                    break;
+                case 'CHAIN_SWITCH_REQUIRED':
+                    step.execution.status = 'CHAIN_SWITCH_REQUIRED';
+                    break;
+                default:
+                    break;
+            }
+            currentProcess.status = status;
+            currentProcess.message = (0, utils_2.getProcessMessage)(type, status);
+            // set extra parameters or overwritte the standard params set in the switch statement
+            if (params) {
+                for (const [key, value] of Object.entries(params)) {
+                    currentProcess[key] = value;
+                }
+            }
+            this.updateStepInRoute(step); // updates the step in the route
+            return currentProcess;
+        };
+        /**
+         * Remove a process from the execution
+         * @param  {Step} step The step where the process should be removed from
+         * @param  {ProcessType} type  The process type to remove
+         * @return {void}
+         */
+        this.removeProcess = (step, type) => {
+            if (!step.execution) {
+                throw new Error("Execution hasn't been initialized.");
+            }
+            const index = step.execution.process.findIndex((p) => p.type === type);
+            step.execution.process.splice(index, 1);
+            this.updateStepInRoute(step);
+        };
+        this.updateStepInRoute = (step) => {
+            if (!this.shouldUpdate) {
+                return step;
+            }
+            const stepIndex = this.route.steps.findIndex((routeStep) => routeStep.id === step.id);
+            if (stepIndex === -1) {
+                throw new Error("Couldn't find a step to update.");
+            }
+            this.route.steps[stepIndex] = Object.assign(this.route.steps[stepIndex], step);
+            this.settings.updateCallback(this.route);
+            this.internalUpdateRouteCallback(this.route);
+            return this.route.steps[stepIndex];
+        };
+        this.route = route;
+        this.settings = settings;
+        this.internalUpdateRouteCallback = internalUpdateRouteCallback;
+    }
+    /**
+     * Updates the execution object of a Step.
+     * @param  {Step} step  The current step in execution
+     * @param  {Status} status  The status for the execution
+     * @param  {Receipt} receipt Optional. Information about received tokens
+     * @return {Step}       The step with the updated execution object
+     */
+    updateExecution(step, status, receipt) {
+        if (!step.execution) {
+            throw Error("Can't update empty execution.");
+        }
+        step.execution.status = status;
+        if (receipt) {
+            step.execution.fromAmount = receipt.fromAmount;
+            step.execution.toAmount = receipt.toAmount;
+            step.execution.toToken = receipt.toToken;
+        }
+        this.updateStepInRoute(step);
+        return step;
+    }
+    setShouldUpdate(value) {
+        this.shouldUpdate = value;
+    }
+}
+exports.StatusManager = StatusManager;

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

@@ -0,0 +1,15 @@
+import { Signer } from 'ethers';
+import { HaltingSettings, InternalExecutionSettings, Step } from '../types';
+import { StatusManager } from './StatusManager';
+export declare class StepExecutor {
+    settings: InternalExecutionSettings;
+    statusManager: StatusManager;
+    private swapExecutionManager;
+    private bridgeExecutionManager;
+    executionStopped: boolean;
+    constructor(statusManager: StatusManager, settings: InternalExecutionSettings);
+    stopStepExecution: (settings?: HaltingSettings) => void;
+    executeStep: (signer: Signer, step: Step) => Promise<Step>;
+    private executeSwap;
+    private executeCross;
+}

package/dist/cjs/execution/StepExecutor.js

@@ -0,0 +1,74 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StepExecutor = void 0;
+const bridge_execute_1 = require("./bridges/bridge.execute");
+const swap_execute_1 = require("./exchanges/swap.execute");
+const switchChain_1 = require("./switchChain");
+const defaultExecutionHaltSettings = {
+    allowUpdates: true,
+};
+class StepExecutor {
+    constructor(statusManager, settings) {
+        this.swapExecutionManager = new swap_execute_1.SwapExecutionManager();
+        this.bridgeExecutionManager = new bridge_execute_1.BridgeExecutionManager();
+        this.executionStopped = false;
+        this.stopStepExecution = (settings) => {
+            const haltingSettings = Object.assign(Object.assign({}, defaultExecutionHaltSettings), settings);
+            this.swapExecutionManager.setShouldContinue(false);
+            this.bridgeExecutionManager.setShouldContinue(false);
+            this.statusManager.setShouldUpdate(haltingSettings.allowUpdates);
+            this.executionStopped = true;
+        };
+        this.executeStep = (signer, step) => __awaiter(this, void 0, void 0, function* () {
+            // check if signer is for correct chain
+            const updatedSigner = yield (0, switchChain_1.switchChain)(signer, this.statusManager, step, this.settings.switchChainHook, !this.executionStopped);
+            if (!updatedSigner) {
+                // chain switch was not successful, stop execution here
+                return step;
+            }
+            signer = updatedSigner;
+            switch (step.type) {
+                case 'lifi':
+                case 'cross':
+                    yield this.executeCross(signer, step);
+                    break;
+                case 'swap':
+                    yield this.executeSwap(signer, step);
+                    break;
+                default:
+                    throw new Error('Unsupported step type.');
+            }
+            return step;
+        });
+        this.executeSwap = (signer, step) => __awaiter(this, void 0, void 0, function* () {
+            const swapParams = {
+                signer,
+                step,
+                settings: this.settings,
+                statusManager: this.statusManager,
+            };
+            return yield this.swapExecutionManager.execute(swapParams);
+        });
+        this.executeCross = (signer, step) => __awaiter(this, void 0, void 0, function* () {
+            const crossParams = {
+                signer,
+                step,
+                settings: this.settings,
+                statusManager: this.statusManager,
+            };
+            return yield this.bridgeExecutionManager.execute(crossParams);
+        });
+        this.statusManager = statusManager;
+        this.settings = settings;
+    }
+}
+exports.StepExecutor = StepExecutor;

package/dist/cjs/execution/allowance.execute.d.ts

@@ -0,0 +1,4 @@
+import { Signer } from 'ethers';
+import { Chain, Step, Token } from '../types';
+import { StatusManager } from './StatusManager';
+export declare const checkAllowance: (signer: Signer, step: Step, chain: Chain, token: Token, amount: string, spenderAddress: string, statusManager: StatusManager, infiniteApproval?: boolean, allowUserInteraction?: boolean) => Promise<void>;

package/dist/cjs/execution/allowance.execute.js

@@ -0,0 +1,97 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkAllowance = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const ethers_1 = require("ethers");
+const utils_1 = require("../allowance/utils");
+const getProvider_1 = require("../utils/getProvider");
+const parseError_1 = require("../utils/parseError");
+const checkAllowance = (signer, step, chain, token, amount, spenderAddress, statusManager, infiniteApproval = false, allowUserInteraction = false
+// eslint-disable-next-line max-params
+) => __awaiter(void 0, void 0, void 0, function* () {
+    // Ask user to set allowance
+    // -> set currentExecution
+    let allowanceProcess = statusManager.findOrCreateProcess('TOKEN_ALLOWANCE', step);
+    // -> check allowance
+    try {
+        if (allowanceProcess.txHash) {
+            allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'PENDING');
+            yield (0, getProvider_1.getProvider)(signer).waitForTransaction(allowanceProcess.txHash);
+            allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'DONE');
+            // TODO: Do we need this check?
+        }
+        else if (allowanceProcess.status === 'DONE') {
+            allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'DONE');
+        }
+        else {
+            const approved = yield (0, utils_1.getApproved)(signer, token.address, spenderAddress);
+            if (new bignumber_js_1.default(amount).gt(approved)) {
+                if (!allowUserInteraction) {
+                    return;
+                }
+                const approvalAmount = infiniteApproval
+                    ? ethers_1.constants.MaxUint256.toString()
+                    : amount;
+                const approveTx = yield (0, utils_1.setApproval)(signer, token.address, spenderAddress, approvalAmount);
+                // update currentExecution
+                allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'PENDING', {
+                    txHash: approveTx.hash,
+                    txLink: chain.metamask.blockExplorerUrls[0] + 'tx/' + approveTx.hash,
+                });
+                // wait for transcation
+                yield approveTx.wait();
+                allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'DONE');
+            }
+            else {
+                allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'DONE');
+            }
+        }
+    }
+    catch (e) {
+        // -> set status
+        if (e.code === 'TRANSACTION_REPLACED' && e.replacement) {
+            yield transactionReplaced(e.replacement, allowanceProcess, step, chain, statusManager);
+        }
+        else {
+            const error = yield (0, parseError_1.parseError)(e, step, allowanceProcess);
+            allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'FAILED', {
+                error: {
+                    message: error.message,
+                    htmlMessage: error.htmlMessage,
+                    code: error.code,
+                },
+            });
+            statusManager.updateExecution(step, 'FAILED');
+            throw error;
+        }
+    }
+});
+exports.checkAllowance = checkAllowance;
+const transactionReplaced = (replacementTx, allowanceProcess, step, chain, statusManager) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'PENDING', {
+            txHash: replacementTx.hash,
+            txLink: chain.metamask.blockExplorerUrls[0] + 'tx/' + replacementTx.hash,
+        });
+        yield replacementTx.wait();
+        allowanceProcess = statusManager.updateProcess(step, allowanceProcess.type, 'DONE');
+    }
+    catch (e) {
+        if (e.code === 'TRANSACTION_REPLACED' && e.replacement) {
+            yield transactionReplaced(e.replacement, allowanceProcess, step, chain, statusManager);
+        }
+        throw e;
+    }
+});

package/dist/cjs/execution/balanceCheck.execute.d.ts

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