@lifi/sdk 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.1.0](https://github.com/lifinance/sdk/compare/v1.0.2...v1.1.0) (2022-08-02)
+
+
+### Features
+
+* add fee parameter and getContractCallQuote endpoint ([#92](https://github.com/lifinance/sdk/issues/92)) ([56695d6](https://github.com/lifinance/sdk/commit/56695d6026e99951a4518e45d1a4965f7546d204))
+* add gasinformation to execution object ([#91](https://github.com/lifinance/sdk/issues/91)) ([f3a13b4](https://github.com/lifinance/sdk/commit/f3a13b4458db4c5dea245ae56f205a58b6cd00ed))
+* expose get getRpcProvider ([#89](https://github.com/lifinance/sdk/issues/89)) ([750b675](https://github.com/lifinance/sdk/commit/750b675a6dbca0ae18361ee150f292a9ec820dfd))
+* increase gasLimit or gasPrice on restart if necessary ([#90](https://github.com/lifinance/sdk/issues/90)) ([6f947d3](https://github.com/lifinance/sdk/commit/6f947d3b0b326f821fcee448636b65a10ee4f38a))
+
+
+### Bug Fixes
+
+* build error ([#94](https://github.com/lifinance/sdk/issues/94)) ([810028e](https://github.com/lifinance/sdk/commit/810028e0d2fb7d09dd5b9d5829faab983df5ae5a))
+* failing tests ([#93](https://github.com/lifinance/sdk/issues/93)) ([318ec7b](https://github.com/lifinance/sdk/commit/318ec7ba3bbe21dbcad38baba09ef9fcc38469bd))
+* update execution state ([#88](https://github.com/lifinance/sdk/issues/88)) ([d974263](https://github.com/lifinance/sdk/commit/d9742636f5aeb77a3b4c1db5eecc6c6625812430))
+
 ### [1.0.2](https://github.com/lifinance/sdk/compare/v1.0.1...v1.0.2) (2022-07-15)
 
 ### [1.0.1](https://github.com/lifinance/sdk/compare/v1.0.0...v1.0.1) (2022-07-14)

package/dist/Lifi.d.ts

@@ -1,5 +1,6 @@
-import { Chain, ChainId, ChainKey, GetStatusRequest, PossibilitiesRequest, PossibilitiesResponse, QuoteRequest, RequestOptions, Route, RoutesRequest, RoutesResponse, StatusResponse, Step, Token, TokenAmount, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse } from '@lifi/types';
+import { Chain, ChainId, ChainKey, ContractCallQuoteRequest, GetStatusRequest, PossibilitiesRequest, PossibilitiesResponse, QuoteRequest, RequestOptions, Route, RoutesRequest, RoutesResponse, StatusResponse, Step, Token, TokenAmount, TokensRequest, TokensResponse, ToolsRequest, ToolsResponse } from '@lifi/types';
 import { Signer } from 'ethers';
+import { FallbackProvider } from '@ethersproject/providers';
 import { ApproveTokenRequest, RevokeApprovalRequest } from './allowance';
 import { Config, ConfigUpdate, ExecutionSettings, RevokeTokenData } from './types';
 export default class LIFI {
@@ -17,6 +18,13 @@ export default class LIFI {
      * @return {Promise<Config>} - The config object
      */
     getConfigAsync: () => Promise<Config>;
+    /**
+     * Get an instance of a provider for a specific cahin
+     * @param {number} chainId - Id of the chain the provider is for
+     * @param {boolean} archive - Whether to use an archive provider that is based on a default rpc or not. defaults to false
+     * @return {FallbackProvider} The provider for the given chain
+     */
+    getRpcProvider: (chainId: number, archive?: boolean) => Promise<FallbackProvider>;
     /**
      * Set a new confuration for the SDK
      * @param {ConfigUpdate} configUpdate - An object containing the configuration fields that should be updated.
@@ -43,6 +51,12 @@ export default class LIFI {
      * @throws {LifiError} - Throws a LifiError if request fails
      */
     getQuote: (request: QuoteRequest, options?: RequestOptions) => Promise<Step>;
+    /**
+     * Get a quote for a destination contract call
+     * @param {ContractCallQuoteRequest} request - The configuration of the requested destination call
+     * @throws {LifiError} - Throws a LifiError if request fails
+     */
+    getContractCallQuote: (request: ContractCallQuoteRequest, options?: RequestOptions) => Promise<Step>;
     /**
      * Check the status of a transfer. For cross chain transfers, the "bridge" parameter is required.
      * @param {GetStatusRequest} request - Configuration of the requested status

package/dist/Lifi.js

@@ -52,6 +52,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var allowance_1 = require("./allowance");
 var balances_1 = __importDefault(require("./balances"));
+var connectors_1 = require("./connectors");
 var StatusManager_1 = require("./execution/StatusManager");
 var StepExecutor_1 = require("./execution/StepExecutor");
 var ApiService_1 = __importDefault(require("./services/ApiService"));
@@ -59,6 +60,7 @@ var ChainsService_1 = __importDefault(require("./services/ChainsService"));
 var ConfigService_1 = __importDefault(require("./services/ConfigService"));
 var typeguards_1 = require("./typeguards");
 var errors_1 = require("./utils/errors");
+var preRestart_1 = require("./utils/preRestart");
 var utils_1 = require("./utils/utils");
 var LIFI = /** @class */ (function () {
     function LIFI(configUpdate) {
@@ -78,6 +80,16 @@ var LIFI = /** @class */ (function () {
         this.getConfigAsync = function () {
             return _this.configService.getConfigAsync();
         };
+        /**
+         * Get an instance of a provider for a specific cahin
+         * @param {number} chainId - Id of the chain the provider is for
+         * @param {boolean} archive - Whether to use an archive provider that is based on a default rpc or not. defaults to false
+         * @return {FallbackProvider} The provider for the given chain
+         */
+        this.getRpcProvider = function (chainId, archive) {
+            if (archive === void 0) { archive = false; }
+            return (0, connectors_1.getRpcProvider)(chainId, archive);
+        };
         /**
          * Set a new confuration for the SDK
          * @param {ConfigUpdate} configUpdate - An object containing the configuration fields that should be updated.
@@ -118,6 +130,16 @@ var LIFI = /** @class */ (function () {
                 return [2 /*return*/, ApiService_1.default.getQuote(request, options)];
             });
         }); };
+        /**
+         * Get a quote for a destination contract call
+         * @param {ContractCallQuoteRequest} request - The configuration of the requested destination call
+         * @throws {LifiError} - Throws a LifiError if request fails
+         */
+        this.getContractCallQuote = function (request, options) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, ApiService_1.default.getContractCallQuote(request, options)];
+            });
+        }); };
         /**
          * Check the status of a transfer. For cross chain transfers, the "bridge" parameter is required.
          * @param {GetStatusRequest} request - Configuration of the requested status
@@ -239,9 +261,8 @@ var LIFI = /** @class */ (function () {
          * @throws {LifiError} Throws a LifiError if the execution fails.
          */
         this.resumeRoute = function (signer, route, settings) { return __awaiter(_this, void 0, void 0, function () {
-            var clonedRoute, activeRoute, executionHalted, index, stepHasFailed;
-            var _a, _b;
-            return __generator(this, function (_c) {
+            var clonedRoute, activeRoute, executionHalted;
+            return __generator(this, function (_a) {
                 clonedRoute = (0, utils_1.deepClone)(route) // deep clone to prevent side effects
                 ;
                 activeRoute = this.activeRouteDictionary[clonedRoute.id];
@@ -251,13 +272,7 @@ var LIFI = /** @class */ (function () {
                         return [2 /*return*/, clonedRoute];
                     }
                 }
-                // remove last (failed) process
-                for (index = 0; index < clonedRoute.steps.length; index++) {
-                    stepHasFailed = ((_a = clonedRoute.steps[index].execution) === null || _a === void 0 ? void 0 : _a.status) === 'FAILED';
-                    if (stepHasFailed) {
-                        (_b = clonedRoute.steps[index].execution) === null || _b === void 0 ? void 0 : _b.process.pop();
-                    }
-                }
+                (0, preRestart_1.handlePreRestart)(clonedRoute);
                 return [2 /*return*/, this.executeSteps(signer, clonedRoute, settings)];
             });
         }); };

package/dist/execution/StatusManager.d.ts

@@ -3,6 +3,8 @@ 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'>>;
@@ -57,7 +59,7 @@ export declare class StatusManager {
      * @return {void}
      */
     removeProcess: (step: Step, type: ProcessType) => void;
-    private updateStepInRoute;
+    updateStepInRoute: (step: Step) => Step;
     setShouldUpdate(value: boolean): void;
 }
 export {};

package/dist/execution/StatusManager.js

@@ -24,6 +24,7 @@ var StatusManager = /** @class */ (function () {
             var currentExecution = step.execution || (0, utils_1.deepClone)(types_1.emptyExecution);
             if (!step.execution) {
                 step.execution = currentExecution;
+                step.execution.status = 'PENDING';
                 _this.updateStepInRoute(step);
             }
             return currentExecution;
@@ -63,6 +64,9 @@ var StatusManager = /** @class */ (function () {
          */
         this.updateProcess = function (step, type, status, params) {
             var _a;
+            if (!step.execution) {
+                throw new Error("Can't update an empty step execution.");
+            }
             var currentProcess = (_a = step === null || step === void 0 ? void 0 : step.execution) === null || _a === void 0 ? void 0 : _a.process.find(function (p) { return p.type === type; });
             if (!currentProcess) {
                 throw new Error("Can't find a process for the given type.");
@@ -73,10 +77,20 @@ var StatusManager = /** @class */ (function () {
                     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;
             }
@@ -108,7 +122,7 @@ var StatusManager = /** @class */ (function () {
         };
         this.updateStepInRoute = function (step) {
             if (!_this.shouldUpdate) {
-                return;
+                return step;
             }
             var stepIndex = _this.route.steps.findIndex(function (routeStep) { return routeStep.id === step.id; });
             if (stepIndex === -1) {
@@ -117,6 +131,7 @@ var StatusManager = /** @class */ (function () {
             _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;

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

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 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) {
@@ -49,6 +60,7 @@ 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 stepComparison_1 = require("../stepComparison");
 var switchChain_1 = require("../switchChain");
 var utils_2 = require("../utils");
 var BridgeExecutionManager = /** @class */ (function () {
@@ -61,23 +73,23 @@ var BridgeExecutionManager = /** @class */ (function () {
         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) {
+                var action, estimate, chainsService, fromChain, toChain, oldCrossProcess, crossChainProcess, tx, personalizedStep, updatedStep, _b, transactionRequest, updatedSigner, e_1, error, receivingChainProcess, statusResponse, e_2;
+                var _c, _d, _e, _f;
+                return __generator(this, function (_g) {
+                    switch (_g.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();
+                            fromChain = _g.sent();
                             return [4 /*yield*/, chainsService.getChainById(action.toChainId)
                                 // STEP 1: Check Allowance ////////////////////////////////////////////////
                                 // approval still needed?
                             ];
                         case 2:
-                            toChain = _f.sent();
+                            toChain = _g.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];
@@ -85,20 +97,20 @@ var BridgeExecutionManager = /** @class */ (function () {
                             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;
+                            _g.sent();
+                            _g.label = 4;
                         case 4:
                             crossChainProcess = statusManager.findOrCreateProcess('CROSS_CHAIN', step);
-                            _f.label = 5;
+                            _g.label = 5;
                         case 5:
-                            _f.trys.push([5, 15, , 19]);
+                            _g.trys.push([5, 16, , 20]);
                             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];
+                            tx = _g.sent();
+                            return [3 /*break*/, 14];
                         case 7: 
                         // check balance
                         return [4 /*yield*/, (0, balanceCheck_execute_1.balanceCheck)(signer, step)
@@ -106,19 +118,24 @@ var BridgeExecutionManager = /** @class */ (function () {
                         ];
                         case 8:
                             // check balance
-                            _f.sent();
+                            _g.sent();
                             return [4 /*yield*/, (0, utils_1.personalizeStep)(signer, step)];
                         case 9:
-                            personalizedStep = _f.sent();
+                            personalizedStep = _g.sent();
                             return [4 /*yield*/, ApiService_1.default.getStepTransaction(personalizedStep)];
                         case 10:
-                            transactionRequest = (_f.sent()).transactionRequest;
+                            updatedStep = _g.sent();
+                            _b = [{}];
+                            return [4 /*yield*/, (0, stepComparison_1.stepComparison)(statusManager, personalizedStep, updatedStep, settings.acceptSlippageUpdateHook, this.shouldContinue)];
+                        case 11:
+                            step = __assign.apply(void 0, [__assign.apply(void 0, _b.concat([(_g.sent())])), { execution: step.execution }]);
+                            transactionRequest = step.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();
+                        case 12:
+                            updatedSigner = _g.sent();
                             if (!updatedSigner) {
                                 // chain switch was not successful, stop execution here
                                 return [2 /*return*/, step.execution];
@@ -131,31 +148,31 @@ var BridgeExecutionManager = /** @class */ (function () {
                             return [4 /*yield*/, signer.sendTransaction(transactionRequest)
                                 // STEP 4: Wait for Transaction ///////////////////////////////////////////
                             ];
-                        case 12:
-                            tx = _f.sent();
+                        case 13:
+                            tx = _g.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];
+                            _g.label = 14;
+                        case 14: return [4 /*yield*/, tx.wait()];
                         case 15:
-                            e_1 = _f.sent();
-                            if (!(e_1.code === 'TRANSACTION_REPLACED' && e_1.replacement)) return [3 /*break*/, 16];
+                            _g.sent();
+                            return [3 /*break*/, 20];
+                        case 16:
+                            e_1 = _g.sent();
+                            if (!(e_1.code === 'TRANSACTION_REPLACED' && e_1.replacement)) return [3 /*break*/, 17];
                             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();
+                            return [3 /*break*/, 19];
+                        case 17: return [4 /*yield*/, (0, parseError_1.parseError)(e_1, step, crossChainProcess)];
+                        case 18:
+                            error = _g.sent();
                             statusManager.updateProcess(step, crossChainProcess.type, 'FAILED', {
                                 error: {
                                     message: error.message,
@@ -165,22 +182,22 @@ var BridgeExecutionManager = /** @class */ (function () {
                             });
                             statusManager.updateExecution(step, 'FAILED');
                             throw error;
-                        case 18: return [3 /*break*/, 19];
-                        case 19:
+                        case 19: return [3 /*break*/, 20];
+                        case 20:
                             statusManager.updateProcess(step, crossChainProcess.type, 'DONE');
                             receivingChainProcess = statusManager.findOrCreateProcess('RECEIVING_CHAIN', step, 'PENDING');
-                            _f.label = 20;
-                        case 20:
-                            _f.trys.push([20, 22, , 23]);
+                            _g.label = 21;
+                        case 21:
+                            _g.trys.push([21, 23, , 24]);
                             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();
+                            statusResponse = _g.sent();
+                            return [3 /*break*/, 24];
+                        case 23:
+                            e_2 = _g.sent();
                             statusManager.updateProcess(step, receivingChainProcess.type, 'FAILED', {
                                 error: {
                                     code: errors_1.LifiErrorCode.TransactionFailed,
@@ -190,21 +207,22 @@ var BridgeExecutionManager = /** @class */ (function () {
                             });
                             statusManager.updateExecution(step, 'FAILED');
                             throw e_2;
-                        case 23:
+                        case 24:
                             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,
+                                txHash: (_c = statusResponse.receiving) === null || _c === void 0 ? void 0 : _c.txHash,
                                 txLink: toChain.metamask.blockExplorerUrls[0] +
                                     'tx/' +
-                                    ((_c = statusResponse.receiving) === null || _c === void 0 ? void 0 : _c.txHash),
+                                    ((_d = statusResponse.receiving) === null || _d === void 0 ? void 0 : _d.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,
+                                toAmount: (_e = statusResponse.receiving) === null || _e === void 0 ? void 0 : _e.amount,
+                                toToken: (_f = statusResponse.receiving) === null || _f === void 0 ? void 0 : _f.token,
+                                gasUsed: statusResponse.sending.gasUsed,
+                                gasPrice: statusResponse.sending.gasPrice,
                             });
                             // DONE
                             return [2 /*return*/, step.execution];