@lifi/sdk 1.4.1 → 1.6.0

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

@@ -7,13 +7,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { constants } from 'ethers';
 import ApiService from '../../services/ApiService';
 import ChainsService from '../../services/ChainsService';
 import { LifiErrorCode, TransactionError } from '../../utils/errors';
 import { getProvider } from '../../utils/getProvider';
 import { getTransactionFailedMessage, parseError } from '../../utils/parseError';
-import { personalizeStep } from '../../utils/utils';
+import { isZeroAddress, personalizeStep } from '../../utils/utils';
 import { checkAllowance } from '../allowance.execute';
 import { balanceCheck } from '../balanceCheck.execute';
 import { stepComparison } from '../stepComparison';
@@ -21,86 +20,72 @@ import { switchChain } from '../switchChain';
 import { waitForReceivingTransaction } from '../utils';
 export class SwapExecutionManager {
     constructor() {
-        this.shouldContinue = true;
-        this.setShouldContinue = (val) => {
-            this.shouldContinue = val;
+        this.allowUserInteraction = true;
+        this.allowInteraction = (value) => {
+            this.allowUserInteraction = value;
         };
         this.execute = ({ signer, step, statusManager, settings, }) => __awaiter(this, void 0, void 0, function* () {
-            // setup
             var _a, _b, _c, _d;
-            const { action, estimate } = step;
             step.execution = statusManager.initExecutionObject(step);
             const chainsService = ChainsService.getInstance();
-            const fromChain = yield chainsService.getChainById(action.fromChainId);
-            // Approval
-            if (action.fromToken.address !== constants.AddressZero) {
-                yield checkAllowance(signer, step, fromChain, action.fromToken, action.fromAmount, estimate.approvalAddress, statusManager, settings.infiniteApproval, this.shouldContinue);
+            const fromChain = yield chainsService.getChainById(step.action.fromChainId);
+            // STEP 1: Check allowance
+            if (!isZeroAddress(step.action.fromToken.address)) {
+                yield checkAllowance(signer, step, statusManager, settings, fromChain, this.allowUserInteraction);
             }
-            // Start Swap
-            // -> set step.execution
-            let swapProcess = statusManager.findOrCreateProcess('SWAP', step);
-            // -> swapping
-            let tx;
+            // STEP 2: Get transaction
+            let swapProcess = statusManager.findOrCreateProcess(step, 'SWAP');
+            let transaction;
             try {
                 if (swapProcess.txHash) {
-                    // -> restore existing tx
-                    tx = yield getProvider(signer).getTransaction(swapProcess.txHash);
+                    // Make sure that the chain is still correct
+                    const updatedSigner = yield switchChain(signer, statusManager, step, settings.switchChainHook, this.allowUserInteraction);
+                    if (!updatedSigner) {
+                        // Chain switch was not successful, stop execution here
+                        return step.execution;
+                    }
+                    signer = updatedSigner;
+                    // Load exiting transaction
+                    transaction = yield getProvider(signer).getTransaction(swapProcess.txHash);
                 }
                 else {
-                    // -> check balance
+                    swapProcess = statusManager.updateProcess(step, swapProcess.type, 'STARTED');
+                    // Check balance
                     yield balanceCheck(signer, step);
-                    // -> get tx from backend
+                    // Create new transaction
                     if (!step.transactionRequest) {
                         const personalizedStep = yield personalizeStep(signer, step);
                         const updatedStep = yield ApiService.getStepTransaction(personalizedStep);
-                        step = Object.assign(Object.assign({}, (yield stepComparison(statusManager, personalizedStep, updatedStep, settings.acceptSlippageUpdateHook, this.shouldContinue))), { execution: step.execution });
+                        step = Object.assign(Object.assign({}, (yield stepComparison(statusManager, personalizedStep, updatedStep, settings.acceptSlippageUpdateHook, this.allowUserInteraction))), { execution: step.execution });
                     }
                     const { transactionRequest } = step;
                     if (!transactionRequest) {
                         throw new TransactionError(LifiErrorCode.TransactionUnprepared, 'Unable to prepare transaction.');
                     }
-                    // make sure that chain is still correct
-                    const updatedSigner = yield switchChain(signer, statusManager, step, settings.switchChainHook, this.shouldContinue);
+                    // STEP 3: Send the transaction
+                    // Make sure that the chain is still correct
+                    const updatedSigner = yield switchChain(signer, statusManager, step, settings.switchChainHook, this.allowUserInteraction);
                     if (!updatedSigner) {
-                        // chain switch was not successful, stop execution here
+                        // Chain switch was not successful, stop execution here
                         return step.execution;
                     }
                     signer = updatedSigner;
-                    // -> set step.execution
-                    swapProcess = swapProcess = statusManager.updateProcess(step, swapProcess.type, 'ACTION_REQUIRED');
-                    if (!this.shouldContinue) {
-                        return step.execution; // stop before user interaction is needed
+                    swapProcess = statusManager.updateProcess(step, swapProcess.type, 'ACTION_REQUIRED');
+                    if (!this.allowUserInteraction) {
+                        return step.execution;
                     }
-                    // -> submit tx
-                    tx = yield signer.sendTransaction(transactionRequest);
+                    // Submit the transaction
+                    transaction = yield signer.sendTransaction(transactionRequest);
                 }
-            }
-            catch (e) {
-                const error = yield parseError(e, step, swapProcess);
-                swapProcess = statusManager.updateProcess(step, swapProcess.type, 'FAILED', {
-                    error: {
-                        message: error.message,
-                        htmlMessage: error.htmlMessage,
-                        code: error.code,
-                    },
+                // STEP 4: Wait for the transaction
+                swapProcess = statusManager.updateProcess(step, swapProcess.type, 'PENDING', {
+                    txLink: fromChain.metamask.blockExplorerUrls[0] + 'tx/' + transaction.hash,
+                    txHash: transaction.hash,
                 });
-                statusManager.updateExecution(step, 'FAILED');
-                throw error;
-            }
-            // Wait for Transaction
-            swapProcess = statusManager.updateProcess(step, swapProcess.type, 'PENDING', {
-                txLink: fromChain.metamask.blockExplorerUrls[0] + 'tx/' + tx.hash,
-                txHash: tx.hash,
-            });
-            // -> waiting
-            let receipt;
-            try {
-                receipt = yield tx.wait();
+                yield transaction.wait();
             }
             catch (e) {
-                // -> set status
                 if (e.code === 'TRANSACTION_REPLACED' && e.replacement) {
-                    receipt = e.replacement;
                     swapProcess = statusManager.updateProcess(step, swapProcess.type, 'PENDING', {
                         txHash: e.replacement.hash,
                         txLink: fromChain.metamask.blockExplorerUrls[0] +
@@ -121,6 +106,7 @@ export class SwapExecutionManager {
                     throw error;
                 }
             }
+            // STEP 5: Wait for the receiving chain
             let statusResponse;
             try {
                 if (!swapProcess.txHash) {

package/dist/execution/switchChain.js

@@ -26,8 +26,8 @@ export const switchChain = (signer, statusManager, step, switchChainHook, allowU
     }
     // -> set status message
     step.execution = statusManager.initExecutionObject(step);
-    statusManager.updateExecution(step, 'CHAIN_SWITCH_REQUIRED');
-    let switchProcess = statusManager.findOrCreateProcess('SWITCH_CHAIN', step, 'PENDING');
+    statusManager.updateExecution(step, 'ACTION_REQUIRED');
+    let switchProcess = statusManager.findOrCreateProcess(step, 'SWITCH_CHAIN', 'ACTION_REQUIRED');
     if (!allowUserInteraction) {
         return;
     }
@@ -45,7 +45,7 @@ export const switchChain = (signer, statusManager, step, switchChainHook, allowU
         switchProcess = statusManager.updateProcess(step, switchProcess.type, 'FAILED', {
             error: {
                 message: error.message,
-                code: error.code,
+                code: LifiErrorCode.ChainSwitchError,
             },
         });
         statusManager.updateExecution(step, 'FAILED');

package/dist/execution/utils.js

@@ -32,11 +32,10 @@ export function waitForReceivingTransaction(txHash, statusManager, processType,
                 case 'DONE':
                     return resolve(statusResponse);
                 case 'PENDING':
-                    statusManager === null || statusManager === void 0 ? void 0 : statusManager.updateProcess(step, processType, 'PENDING', {
-                        substatus: statusResponse.substatus,
-                        substatusMessage: statusResponse.substatusMessage ||
-                            getSubstatusMessage(statusResponse.status, statusResponse.substatus),
-                    });
+                    statusManager === null || statusManager === void 0 ? void 0 : statusManager.updateProcess(step, processType, 'PENDING', Object.assign({ substatus: statusResponse.substatus, substatusMessage: statusResponse.substatusMessage ||
+                            getSubstatusMessage(statusResponse.status, statusResponse.substatus) }, (statusResponse.bridgeExplorerLink && {
+                        txLink: statusResponse.bridgeExplorerLink,
+                    })));
                     return resolve(undefined);
                 case 'NOT_FOUND':
                     return resolve(undefined);

package/dist/helpers.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { name, version } from './version';
 const ethereumRequest = (method, params) => __awaiter(void 0, void 0, void 0, function* () {
     // If ethereum.request() exists, the provider is probably EIP-1193 compliant.
-    if (!ethereum || !ethereum.request) {
+    if (!(ethereum === null || ethereum === void 0 ? void 0 : ethereum.request)) {
         throw new Error('Provider not available.');
     }
     return ethereum.request({

package/dist/services/ConfigService.js

@@ -14,6 +14,7 @@ const DefaultExecutionSettings = {
     switchChainHook: () => Promise.resolve(undefined),
     acceptSlippageUpdateHook: () => Promise.resolve(undefined),
     infiniteApproval: false,
+    executeInBackground: false,
 };
 export default class ConfigService {
     constructor() {

package/dist/types/internal.types.d.ts

@@ -64,12 +64,14 @@ export interface ExecutionSettings {
     switchChainHook?: SwitchChainHook;
     acceptSlippageUpdateHook?: AcceptSlippageUpdateHook;
     infiniteApproval?: boolean;
+    executeInBackground?: boolean;
 }
 export interface InternalExecutionSettings extends ExecutionSettings {
     updateCallback: CallbackFunction;
     switchChainHook: SwitchChainHook;
     acceptSlippageUpdateHook: AcceptSlippageUpdateHook;
     infiniteApproval: boolean;
+    executeInBackground: boolean;
 }
 export declare type EnforcedObjectProperties<T> = T & {
     [P in keyof T]-?: T[P];
@@ -81,7 +83,9 @@ export declare type RevokeTokenData = {
     token: Token;
     approvalAddress: string;
 };
-export interface HaltingSettings {
+export interface InteractionSettings {
+    allowInteraction?: boolean;
     allowUpdates?: boolean;
+    stopExecution?: boolean;
 }
 export {};

package/dist/utils/parseError.js

@@ -69,7 +69,7 @@ export const getTransactionFailedMessage = (step, txLink) => {
         : baseString;
 };
 export const parseError = (e, step, process) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
+    var _a, _b, _c;
     if (e instanceof LifiError) {
         return e;
     }
@@ -80,12 +80,11 @@ export const parseError = (e, step, process) => __awaiter(void 0, void 0, void 0
                 // rpc errors
                 // underpriced errors are sent as internal errors, so we need to parse the message manually
                 if (e.code === MetaMaskErrorCodes.rpc.internal &&
-                    e.message &&
-                    e.message.includes('underpriced')) {
+                    ((_a = e.message) === null || _a === void 0 ? void 0 : _a.includes('underpriced'))) {
                     return new RPCError(LifiErrorCode.TransactionUnderpriced, 'Transaction is underpriced.', yield getTransactionNotSentMessage(step, process), e.stack);
                 }
-                if (((_a = e.message) === null || _a === void 0 ? void 0 : _a.includes('intrinsic gas too low')) ||
-                    ((_b = e.message) === null || _b === void 0 ? void 0 : _b.includes('out of gas'))) {
+                if (((_b = e.message) === null || _b === void 0 ? void 0 : _b.includes('intrinsic gas too low')) ||
+                    ((_c = e.message) === null || _c === void 0 ? void 0 : _c.includes('out of gas'))) {
                     return new TransactionError(LifiErrorCode.GasLimitError, 'Gas limit is too low.', yield getTransactionNotSentMessage(step, process), e.stack);
                 }
                 return new RPCError(e.code, getMessageFromCode(e.code), yield getTransactionNotSentMessage(step, process), e.stack);

package/dist/utils/preRestart.js

@@ -23,7 +23,7 @@ const handleErrorType = (route, index) => {
 };
 const deleteFailedProcesses = (route, index) => {
     if (route.steps[index].execution) {
-        route.steps[index].execution.process = route.steps[index].execution.process.filter((process) => process.status !== 'FAILED');
+        route.steps[index].execution.process = route.steps[index].execution.process.filter((process) => process.status === 'DONE');
     }
 };
 const deleteTransactionData = (route, index) => {

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 export declare const name = "@lifi/sdk";
-export declare const version = "1.4.1";
+export declare const version = "1.6.0";

package/dist/version.js

@@ -1,2 +1,2 @@
 export const name = '@lifi/sdk';
-export const version = '1.4.1';
+export const version = '1.6.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/sdk",
-  "version": "1.4.1",
+  "version": "1.6.0",
   "description": "LI.FI Any-to-Any Cross-Chain-Swap SDK",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
@@ -76,35 +76,35 @@
   "dependencies": {
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/contracts": "^5.7.0",
-    "@lifi/types": "^1.6.0",
+    "@lifi/types": "^1.7.0",
     "axios": "^0.27.2",
     "bignumber.js": "^9.1.0",
     "eth-rpc-errors": "^4.0.3",
-    "ethers": "^5.7.0"
+    "ethers": "^5.7.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.0.3",
-    "@commitlint/config-conventional": "^17.0.3",
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
     "@types/bip39": "^3.0.0",
     "@types/chai": "^4.3.3",
     "@types/hdkey": "^2.0.0",
-    "@types/jest": "^28.1.8",
+    "@types/jest": "^29.0.2",
     "@types/websocket": "^1.0.4",
-    "@typescript-eslint/eslint-plugin": "^5.34.0",
-    "@typescript-eslint/parser": "^5.34.0",
-    "eslint": "^8.22.0",
+    "@typescript-eslint/eslint-plugin": "^5.37.0",
+    "@typescript-eslint/parser": "^5.37.0",
+    "eslint": "^8.23.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.1",
-    "jest": "^28.1.2",
+    "jest": "^29.0.3",
     "lint-staged": "^13.0.3",
     "npm-run-all": "^4.1.5",
     "pinst": "^3.0.0",
     "prettier": "^2.7.1",
     "standard-version": "^9.5.0",
-    "ts-jest": "^28.0.8",
+    "ts-jest": "^29.0.1",
     "ts-loader": "^9.3.1",
-    "typescript": "^4.7.4",
+    "typescript": "^4.8.3",
     "webpack": "^5.73.0",
     "webpack-cli": "^4.10.0"
   },