@lifi/sdk 1.0.0

package/dist/execution/bridges/bridge.execute.js

@@ -0,0 +1,218 @@
+"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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BridgeExecutionManager = void 0;
+var ethers_1 = require("ethers");
+var ApiService_1 = __importDefault(require("../../services/ApiService"));
+var ChainsService_1 = __importDefault(require("../../services/ChainsService"));
+var errors_1 = require("../../utils/errors");
+var getProvider_1 = require("../../utils/getProvider");
+var parseError_1 = require("../../utils/parseError");
+var utils_1 = require("../../utils/utils");
+var allowance_execute_1 = require("../allowance.execute");
+var balanceCheck_execute_1 = require("../balanceCheck.execute");
+var switchChain_1 = require("../switchChain");
+var utils_2 = require("../utils");
+var BridgeExecutionManager = /** @class */ (function () {
+    function BridgeExecutionManager() {
+        var _this = this;
+        this.shouldContinue = true;
+        this.setShouldContinue = function (val) {
+            _this.shouldContinue = val;
+        };
+        this.execute = function (_a) {
+            var signer = _a.signer, step = _a.step, statusManager = _a.statusManager, settings = _a.settings;
+            return __awaiter(_this, void 0, void 0, function () {
+                var action, estimate, chainsService, fromChain, toChain, oldCrossProcess, crossChainProcess, tx, personalizedStep, transactionRequest, updatedSigner, e_1, error, receivingChainProcess, statusResponse, e_2;
+                var _b, _c, _d, _e;
+                return __generator(this, function (_f) {
+                    switch (_f.label) {
+                        case 0:
+                            action = step.action, estimate = step.estimate;
+                            step.execution = statusManager.initExecutionObject(step);
+                            chainsService = ChainsService_1.default.getInstance();
+                            return [4 /*yield*/, chainsService.getChainById(action.fromChainId)];
+                        case 1:
+                            fromChain = _f.sent();
+                            return [4 /*yield*/, chainsService.getChainById(action.toChainId)
+                                // STEP 1: Check Allowance ////////////////////////////////////////////////
+                                // approval still needed?
+                            ];
+                        case 2:
+                            toChain = _f.sent();
+                            oldCrossProcess = step.execution.process.find(function (p) { return p.type === 'CROSS_CHAIN'; });
+                            if (!!(oldCrossProcess === null || oldCrossProcess === void 0 ? void 0 : oldCrossProcess.txHash)) return [3 /*break*/, 4];
+                            if (!(action.fromToken.address !== ethers_1.constants.AddressZero)) return [3 /*break*/, 4];
+                            // Check Token Approval only if fromToken is not the native token => no approval needed in that case
+                            return [4 /*yield*/, (0, allowance_execute_1.checkAllowance)(signer, step, fromChain, action.fromToken, action.fromAmount, estimate.approvalAddress, statusManager, settings.infiniteApproval, this.shouldContinue)];
+                        case 3:
+                            // Check Token Approval only if fromToken is not the native token => no approval needed in that case
+                            _f.sent();
+                            _f.label = 4;
+                        case 4:
+                            crossChainProcess = statusManager.findOrCreateProcess('CROSS_CHAIN', step);
+                            _f.label = 5;
+                        case 5:
+                            _f.trys.push([5, 15, , 19]);
+                            tx = void 0;
+                            if (!crossChainProcess.txHash) return [3 /*break*/, 7];
+                            return [4 /*yield*/, (0, getProvider_1.getProvider)(signer).getTransaction(crossChainProcess.txHash)];
+                        case 6:
+                            // load exiting transaction
+                            tx = _f.sent();
+                            return [3 /*break*/, 13];
+                        case 7: 
+                        // check balance
+                        return [4 /*yield*/, (0, balanceCheck_execute_1.balanceCheck)(signer, step)
+                            // create new transaction
+                        ];
+                        case 8:
+                            // check balance
+                            _f.sent();
+                            return [4 /*yield*/, (0, utils_1.personalizeStep)(signer, step)];
+                        case 9:
+                            personalizedStep = _f.sent();
+                            return [4 /*yield*/, ApiService_1.default.getStepTransaction(personalizedStep)];
+                        case 10:
+                            transactionRequest = (_f.sent()).transactionRequest;
+                            if (!transactionRequest) {
+                                throw new errors_1.TransactionError(errors_1.LifiErrorCode.TransactionUnprepared, 'Unable to prepare transaction.');
+                            }
+                            return [4 /*yield*/, (0, switchChain_1.switchChain)(signer, statusManager, step, settings.switchChainHook, this.shouldContinue)];
+                        case 11:
+                            updatedSigner = _f.sent();
+                            if (!updatedSigner) {
+                                // chain switch was not successful, stop execution here
+                                return [2 /*return*/, step.execution];
+                            }
+                            signer = updatedSigner;
+                            statusManager.updateProcess(step, crossChainProcess.type, 'ACTION_REQUIRED');
+                            if (!this.shouldContinue) {
+                                return [2 /*return*/, step.execution];
+                            }
+                            return [4 /*yield*/, signer.sendTransaction(transactionRequest)
+                                // STEP 4: Wait for Transaction ///////////////////////////////////////////
+                            ];
+                        case 12:
+                            tx = _f.sent();
+                            // STEP 4: Wait for Transaction ///////////////////////////////////////////
+                            statusManager.updateProcess(step, crossChainProcess.type, 'PENDING', {
+                                txHash: tx.hash,
+                                txLink: fromChain.metamask.blockExplorerUrls[0] + 'tx/' + tx.hash,
+                            });
+                            _f.label = 13;
+                        case 13: return [4 /*yield*/, tx.wait()];
+                        case 14:
+                            _f.sent();
+                            return [3 /*break*/, 19];
+                        case 15:
+                            e_1 = _f.sent();
+                            if (!(e_1.code === 'TRANSACTION_REPLACED' && e_1.replacement)) return [3 /*break*/, 16];
+                            statusManager.updateProcess(step, crossChainProcess.type, 'PENDING', {
+                                txHash: e_1.replacement.hash,
+                                txLink: fromChain.metamask.blockExplorerUrls[0] +
+                                    'tx/' +
+                                    e_1.replacement.hash,
+                            });
+                            return [3 /*break*/, 18];
+                        case 16: return [4 /*yield*/, (0, parseError_1.parseError)(e_1, step, crossChainProcess)];
+                        case 17:
+                            error = _f.sent();
+                            statusManager.updateProcess(step, crossChainProcess.type, 'FAILED', {
+                                error: {
+                                    message: error.message,
+                                    htmlMessage: error.htmlMessage,
+                                    code: error.code,
+                                },
+                            });
+                            statusManager.updateExecution(step, 'FAILED');
+                            throw error;
+                        case 18: return [3 /*break*/, 19];
+                        case 19:
+                            statusManager.updateProcess(step, crossChainProcess.type, 'DONE');
+                            receivingChainProcess = statusManager.findOrCreateProcess('RECEIVING_CHAIN', step, 'PENDING');
+                            _f.label = 20;
+                        case 20:
+                            _f.trys.push([20, 22, , 23]);
+                            if (!crossChainProcess.txHash) {
+                                throw new Error('Transaction hash is undefined.');
+                            }
+                            return [4 /*yield*/, (0, utils_2.waitForReceivingTransaction)(crossChainProcess.txHash, statusManager, receivingChainProcess.type, step)];
+                        case 21:
+                            statusResponse = _f.sent();
+                            return [3 /*break*/, 23];
+                        case 22:
+                            e_2 = _f.sent();
+                            statusManager.updateProcess(step, receivingChainProcess.type, 'FAILED', {
+                                error: {
+                                    code: errors_1.LifiErrorCode.TransactionFailed,
+                                    message: 'Failed while waiting for receiving chain.',
+                                    htmlMessage: (0, parseError_1.getTransactionFailedMessage)(step, crossChainProcess.txLink),
+                                },
+                            });
+                            statusManager.updateExecution(step, 'FAILED');
+                            throw e_2;
+                        case 23:
+                            statusManager.updateProcess(step, receivingChainProcess.type, 'DONE', {
+                                substatus: statusResponse.substatus,
+                                substatusMessage: statusResponse.substatusMessage ||
+                                    (0, utils_2.getSubstatusMessage)(statusResponse.status, statusResponse.substatus),
+                                txHash: (_b = statusResponse.receiving) === null || _b === void 0 ? void 0 : _b.txHash,
+                                txLink: toChain.metamask.blockExplorerUrls[0] +
+                                    'tx/' +
+                                    ((_c = statusResponse.receiving) === null || _c === void 0 ? void 0 : _c.txHash),
+                            });
+                            statusManager.updateExecution(step, 'DONE', {
+                                fromAmount: statusResponse.sending.amount,
+                                toAmount: (_d = statusResponse.receiving) === null || _d === void 0 ? void 0 : _d.amount,
+                                toToken: (_e = statusResponse.receiving) === null || _e === void 0 ? void 0 : _e.token,
+                                // gasUsed: statusResponse.gasUsed,
+                            });
+                            // DONE
+                            return [2 /*return*/, step.execution];
+                    }
+                });
+            });
+        };
+    }
+    return BridgeExecutionManager;
+}());
+exports.BridgeExecutionManager = BridgeExecutionManager;

package/dist/execution/exchanges/swap.execute.d.ts

@@ -0,0 +1,7 @@
+import { Execution } from '@lifi/types';
+import { ExecuteSwapParams } from '../../types';
+export declare class SwapExecutionManager {
+    shouldContinue: boolean;
+    setShouldContinue: (val: boolean) => void;
+    execute: ({ signer, step, statusManager, settings, }: ExecuteSwapParams) => Promise<Execution>;
+}

package/dist/execution/exchanges/swap.execute.js

@@ -0,0 +1,222 @@
+"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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwapExecutionManager = void 0;
+var ethers_1 = require("ethers");
+var ApiService_1 = __importDefault(require("../../services/ApiService"));
+var ChainsService_1 = __importDefault(require("../../services/ChainsService"));
+var errors_1 = require("../../utils/errors");
+var getProvider_1 = require("../../utils/getProvider");
+var parseError_1 = require("../../utils/parseError");
+var utils_1 = require("../../utils/utils");
+var allowance_execute_1 = require("../allowance.execute");
+var balanceCheck_execute_1 = require("../balanceCheck.execute");
+var switchChain_1 = require("../switchChain");
+var utils_2 = require("../utils");
+var SwapExecutionManager = /** @class */ (function () {
+    function SwapExecutionManager() {
+        var _this = this;
+        this.shouldContinue = true;
+        this.setShouldContinue = function (val) {
+            _this.shouldContinue = val;
+        };
+        this.execute = function (_a) {
+            var signer = _a.signer, step = _a.step, statusManager = _a.statusManager, settings = _a.settings;
+            return __awaiter(_this, void 0, void 0, function () {
+                var action, estimate, chainsService, fromChain, swapProcess, tx, personalizedStep, transactionRequest, updatedSigner, e_1, error, receipt, e_2, error, statusResponse, e_3;
+                var _b, _c, _d, _e;
+                return __generator(this, function (_f) {
+                    switch (_f.label) {
+                        case 0:
+                            action = step.action, estimate = step.estimate;
+                            step.execution = statusManager.initExecutionObject(step);
+                            chainsService = ChainsService_1.default.getInstance();
+                            return [4 /*yield*/, chainsService.getChainById(action.fromChainId)
+                                // Approval
+                            ];
+                        case 1:
+                            fromChain = _f.sent();
+                            if (!(action.fromToken.address !== ethers_1.constants.AddressZero)) return [3 /*break*/, 3];
+                            return [4 /*yield*/, (0, allowance_execute_1.checkAllowance)(signer, step, fromChain, action.fromToken, action.fromAmount, estimate.approvalAddress, statusManager, settings.infiniteApproval, this.shouldContinue)];
+                        case 2:
+                            _f.sent();
+                            _f.label = 3;
+                        case 3:
+                            swapProcess = statusManager.findOrCreateProcess('SWAP', step);
+                            _f.label = 4;
+                        case 4:
+                            _f.trys.push([4, 13, , 15]);
+                            if (!swapProcess.txHash) return [3 /*break*/, 6];
+                            return [4 /*yield*/, (0, getProvider_1.getProvider)(signer).getTransaction(swapProcess.txHash)];
+                        case 5:
+                            // -> restore existing tx
+                            tx = _f.sent();
+                            return [3 /*break*/, 12];
+                        case 6: 
+                        // -> check balance
+                        return [4 /*yield*/, (0, balanceCheck_execute_1.balanceCheck)(signer, step)
+                            // -> get tx from backend
+                        ];
+                        case 7:
+                            // -> check balance
+                            _f.sent();
+                            return [4 /*yield*/, (0, utils_1.personalizeStep)(signer, step)];
+                        case 8:
+                            personalizedStep = _f.sent();
+                            return [4 /*yield*/, ApiService_1.default.getStepTransaction(personalizedStep)];
+                        case 9:
+                            transactionRequest = (_f.sent()).transactionRequest;
+                            if (!transactionRequest) {
+                                throw new errors_1.TransactionError(errors_1.LifiErrorCode.TransactionUnprepared, 'Unable to prepare transaction.');
+                            }
+                            return [4 /*yield*/, (0, switchChain_1.switchChain)(signer, statusManager, step, settings.switchChainHook, this.shouldContinue)];
+                        case 10:
+                            updatedSigner = _f.sent();
+                            if (!updatedSigner) {
+                                // chain switch was not successful, stop execution here
+                                return [2 /*return*/, step.execution];
+                            }
+                            signer = updatedSigner;
+                            // -> set step.execution
+                            statusManager.updateProcess(step, swapProcess.type, 'ACTION_REQUIRED');
+                            if (!this.shouldContinue) {
+                                return [2 /*return*/, step.execution]; // stop before user interaction is needed
+                            }
+                            return [4 /*yield*/, signer.sendTransaction(transactionRequest)];
+                        case 11:
+                            // -> submit tx
+                            tx = _f.sent();
+                            _f.label = 12;
+                        case 12: return [3 /*break*/, 15];
+                        case 13:
+                            e_1 = _f.sent();
+                            return [4 /*yield*/, (0, parseError_1.parseError)(e_1, step, swapProcess)];
+                        case 14:
+                            error = _f.sent();
+                            statusManager.updateProcess(step, swapProcess.type, 'FAILED', {
+                                error: {
+                                    message: error.message,
+                                    htmlMessage: error.htmlMessage,
+                                    code: error.code,
+                                },
+                            });
+                            statusManager.updateExecution(step, 'FAILED');
+                            throw error;
+                        case 15:
+                            // Wait for Transaction
+                            statusManager.updateProcess(step, swapProcess.type, 'PENDING', {
+                                txLink: fromChain.metamask.blockExplorerUrls[0] + 'tx/' + tx.hash,
+                                txHash: tx.hash,
+                            });
+                            _f.label = 16;
+                        case 16:
+                            _f.trys.push([16, 18, , 22]);
+                            return [4 /*yield*/, tx.wait()];
+                        case 17:
+                            receipt = _f.sent();
+                            return [3 /*break*/, 22];
+                        case 18:
+                            e_2 = _f.sent();
+                            if (!(e_2.code === 'TRANSACTION_REPLACED' && e_2.replacement)) return [3 /*break*/, 19];
+                            receipt = e_2.replacement;
+                            statusManager.updateProcess(step, swapProcess.type, 'PENDING', {
+                                txHash: e_2.replacement.hash,
+                                txLink: fromChain.metamask.blockExplorerUrls[0] +
+                                    'tx/' +
+                                    e_2.replacement.hash,
+                            });
+                            return [3 /*break*/, 21];
+                        case 19: return [4 /*yield*/, (0, parseError_1.parseError)(e_2)];
+                        case 20:
+                            error = _f.sent();
+                            statusManager.updateProcess(step, swapProcess.type, 'FAILED', {
+                                error: {
+                                    message: error.message,
+                                    htmlMessage: error.htmlMessage,
+                                    code: error.code,
+                                },
+                            });
+                            statusManager.updateExecution(step, 'FAILED');
+                            throw error;
+                        case 21: return [3 /*break*/, 22];
+                        case 22:
+                            _f.trys.push([22, 24, , 25]);
+                            if (!swapProcess.txHash) {
+                                throw new Error('Transaction hash is undefined.');
+                            }
+                            return [4 /*yield*/, (0, utils_2.waitForReceivingTransaction)(swapProcess.txHash, statusManager, swapProcess.type, step)];
+                        case 23:
+                            statusResponse = _f.sent();
+                            return [3 /*break*/, 25];
+                        case 24:
+                            e_3 = _f.sent();
+                            statusManager.updateProcess(step, swapProcess.type, 'FAILED', {
+                                error: {
+                                    code: errors_1.LifiErrorCode.TransactionFailed,
+                                    message: 'Failed while waiting for receiving chain.',
+                                    htmlMessage: (0, parseError_1.getTransactionFailedMessage)(step, swapProcess.txLink),
+                                },
+                            });
+                            statusManager.updateExecution(step, 'FAILED');
+                            throw e_3;
+                        case 25:
+                            statusManager.updateProcess(step, swapProcess.type, 'DONE', {
+                                txHash: (_b = statusResponse.receiving) === null || _b === void 0 ? void 0 : _b.txHash,
+                                txLink: fromChain.metamask.blockExplorerUrls[0] +
+                                    'tx/' +
+                                    ((_c = statusResponse.receiving) === null || _c === void 0 ? void 0 : _c.txHash),
+                            });
+                            statusManager.updateExecution(step, 'DONE', {
+                                fromAmount: statusResponse.sending.amount,
+                                toAmount: (_d = statusResponse.receiving) === null || _d === void 0 ? void 0 : _d.amount,
+                                toToken: (_e = statusResponse.receiving) === null || _e === void 0 ? void 0 : _e.token,
+                                // gasUsed: statusResponse.gasUsed,
+                            });
+                            // DONE
+                            return [2 /*return*/, step.execution];
+                    }
+                });
+            });
+        };
+    }
+    return SwapExecutionManager;
+}());
+exports.SwapExecutionManager = SwapExecutionManager;

package/dist/execution/index.d.ts

@@ -0,0 +1 @@
+export * from './StatusManager';

package/dist/execution/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./StatusManager"), exports);

package/dist/execution/switchChain.d.ts

@@ -0,0 +1,16 @@
+import { Step } from '@lifi/types';
+import { Signer } from 'ethers';
+import { SwitchChainHook } from '../types';
+import { StatusManager } from './StatusManager';
+/**
+ * This method checks whether the signer is configured for the correct chain.
+ * If yes it returns the signer.
+ * If no and if user interaction is allowed it triggers the switchChainHook. If no user interaction is allowed it aborts.
+ *
+ * @param signer
+ * @param statusManager
+ * @param step
+ * @param switchChainHook
+ * @param allowUserInteraction
+ */
+export declare const switchChain: (signer: Signer, statusManager: StatusManager, step: Step, switchChainHook: SwitchChainHook, allowUserInteraction: boolean) => Promise<Signer | undefined>;

package/dist/execution/switchChain.js

@@ -0,0 +1,102 @@
+"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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.switchChain = void 0;
+var errors_1 = require("../utils/errors");
+/**
+ * This method checks whether the signer is configured for the correct chain.
+ * If yes it returns the signer.
+ * If no and if user interaction is allowed it triggers the switchChainHook. If no user interaction is allowed it aborts.
+ *
+ * @param signer
+ * @param statusManager
+ * @param step
+ * @param switchChainHook
+ * @param allowUserInteraction
+ */
+var switchChain = function (signer, statusManager, step, switchChainHook, allowUserInteraction) { return __awaiter(void 0, void 0, void 0, function () {
+    var switchProcess, updatedSigner, _a, error_1;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, signer.getChainId()];
+            case 1:
+                // if we are already on the correct chain we can proceed directly
+                if ((_b.sent()) === step.action.fromChainId) {
+                    return [2 /*return*/, signer];
+                }
+                // -> set status message
+                step.execution = statusManager.initExecutionObject(step);
+                statusManager.updateExecution(step, 'CHAIN_SWITCH_REQUIRED');
+                switchProcess = statusManager.findOrCreateProcess('SWITCH_CHAIN', step, 'PENDING');
+                if (!allowUserInteraction) {
+                    return [2 /*return*/];
+                }
+                _b.label = 2;
+            case 2:
+                _b.trys.push([2, 6, , 7]);
+                return [4 /*yield*/, switchChainHook(step.action.fromChainId)];
+            case 3:
+                updatedSigner = _b.sent();
+                _a = !updatedSigner;
+                if (_a) return [3 /*break*/, 5];
+                return [4 /*yield*/, updatedSigner.getChainId()];
+            case 4:
+                _a = (_b.sent()) !== step.action.fromChainId;
+                _b.label = 5;
+            case 5:
+                if (_a) {
+                    throw new errors_1.ProviderError(errors_1.LifiErrorCode.ChainSwitchError, 'Chain switch required.');
+                }
+                statusManager.updateProcess(step, switchProcess.type, 'DONE');
+                statusManager.updateExecution(step, 'PENDING');
+                return [2 /*return*/, updatedSigner];
+            case 6:
+                error_1 = _b.sent();
+                statusManager.updateProcess(step, switchProcess.type, 'FAILED', {
+                    error: {
+                        message: error_1.message,
+                        code: error_1.code,
+                    },
+                });
+                statusManager.updateExecution(step, 'FAILED');
+                throw error_1;
+            case 7: return [2 /*return*/];
+        }
+    });
+}); };
+exports.switchChain = switchChain;

package/dist/execution/utils.d.ts

@@ -0,0 +1,5 @@
+import { ProcessType, Status, StatusMessage, StatusResponse, Step, Substatus } from '@lifi/types';
+import { StatusManager } from '..';
+export declare function waitForReceivingTransaction(txHash: string, statusManager: StatusManager, processType: ProcessType, step: Step): Promise<StatusResponse>;
+export declare function getProcessMessage(type: ProcessType, status: Status): string | undefined;
+export declare function getSubstatusMessage(status: StatusMessage, substatus?: Substatus): string | undefined;