@lifi/sdk 1.0.2 → 1.1.0

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

@@ -1,4 +1,4 @@
-import { CrossStep, LifiStep, Route, RouteOptions, Step, SwapStep, Token } from '@lifi/types';
+import { Route, RouteOptions, Step, Token } from '@lifi/types';
 import BigNumber from 'bignumber.js';
 import { Signer } from 'ethers';
 import { ChainId } from '.';
@@ -23,10 +23,10 @@ interface ExecutionParams {
     settings: InternalExecutionSettings;
 }
 export interface ExecuteSwapParams extends ExecutionParams {
-    step: SwapStep;
+    step: Step;
 }
 export interface ExecuteCrossParams extends ExecutionParams {
-    step: CrossStep | LifiStep;
+    step: Step;
 }
 export declare type CallbackFunction = (updatedRoute: Route) => void;
 export declare type Config = {
@@ -44,6 +44,14 @@ export declare type ConfigUpdate = {
     defaultRouteOptions?: RouteOptions;
 };
 export declare type SwitchChainHook = (requiredChainId: number) => Promise<Signer | undefined>;
+export interface AcceptSlippageUpdateHookParams {
+    toToken: Token;
+    oldToAmount: string;
+    newToAmount: string;
+    oldSlippage: number;
+    newSlippage: number;
+}
+export declare type AcceptSlippageUpdateHook = (params: AcceptSlippageUpdateHookParams) => Promise<boolean | undefined>;
 export interface ExecutionData {
     route: Route;
     executors: StepExecutor[];
@@ -52,11 +60,13 @@ export interface ExecutionData {
 export interface ExecutionSettings {
     updateCallback?: CallbackFunction;
     switchChainHook?: SwitchChainHook;
+    acceptSlippageUpdateHook?: AcceptSlippageUpdateHook;
     infiniteApproval?: boolean;
 }
 export interface InternalExecutionSettings extends ExecutionSettings {
     updateCallback: CallbackFunction;
     switchChainHook: SwitchChainHook;
+    acceptSlippageUpdateHook: AcceptSlippageUpdateHook;
     infiniteApproval: boolean;
 }
 export declare type EnforcedObjectProperties<T> = T & {

package/dist/utils/errors.d.ts

@@ -18,7 +18,9 @@ export declare enum LifiErrorCode {
     ProviderUnavailable = 1005,
     NotFound = 1006,
     ChainSwitchError = 1007,
-    SlippageError = 1008
+    SlippageNotMet = 1008,
+    SlippageError = 1008,
+    GasLimitError = 1009
 }
 export declare enum MetaMaskRPCErrorCode {
     invalidInput = -32000,

package/dist/utils/errors.js

@@ -38,7 +38,9 @@ var LifiErrorCode;
     LifiErrorCode[LifiErrorCode["ProviderUnavailable"] = 1005] = "ProviderUnavailable";
     LifiErrorCode[LifiErrorCode["NotFound"] = 1006] = "NotFound";
     LifiErrorCode[LifiErrorCode["ChainSwitchError"] = 1007] = "ChainSwitchError";
+    LifiErrorCode[LifiErrorCode["SlippageNotMet"] = 1008] = "SlippageNotMet";
     LifiErrorCode[LifiErrorCode["SlippageError"] = 1008] = "SlippageError";
+    LifiErrorCode[LifiErrorCode["GasLimitError"] = 1009] = "GasLimitError";
 })(LifiErrorCode = exports.LifiErrorCode || (exports.LifiErrorCode = {}));
 var MetaMaskRPCErrorCode;
 (function (MetaMaskRPCErrorCode) {

package/dist/utils/parseError.d.ts

@@ -35,3 +35,4 @@ export declare const getTransactionNotSentMessage: (step?: Step, process?: Proce
 export declare const getTransactionFailedMessage: (step: Step, txLink?: string) => string;
 export declare const parseError: (e: any, step?: Step, process?: Process) => Promise<LifiError>;
 export declare const parseBackendError: (e: any) => LifiError;
+export declare const getSlippageNotMetMessage: (step: Step) => string;

package/dist/utils/parseError.js

@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseBackendError = exports.parseError = exports.getTransactionFailedMessage = exports.getTransactionNotSentMessage = void 0;
+exports.getSlippageNotMetMessage = exports.parseBackendError = exports.parseError = exports.getTransactionFailedMessage = exports.getTransactionNotSentMessage = void 0;
 var types_1 = require("@lifi/types");
 var eth_rpc_errors_1 = require("eth-rpc-errors");
 var ChainsService_1 = __importDefault(require("../services/ChainsService"));
@@ -110,16 +110,17 @@ var getTransactionFailedMessage = function (step, txLink) {
 };
 exports.getTransactionFailedMessage = getTransactionFailedMessage;
 var parseError = function (e, step, process) { return __awaiter(void 0, void 0, void 0, function () {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-    return __generator(this, function (_l) {
-        switch (_l.label) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    var _o, _p;
+    return __generator(this, function (_q) {
+        switch (_q.label) {
             case 0:
                 if (e instanceof errors_1.LifiError) {
                     return [2 /*return*/, e];
                 }
-                if (!e.code) return [3 /*break*/, 11];
-                if (!(typeof e.code === 'number')) return [3 /*break*/, 6];
-                if (!Object.values(eth_rpc_errors_1.errorCodes.rpc).includes(e.code)) return [3 /*break*/, 4];
+                if (!e.code) return [3 /*break*/, 13];
+                if (!(typeof e.code === 'number')) return [3 /*break*/, 8];
+                if (!Object.values(eth_rpc_errors_1.errorCodes.rpc).includes(e.code)) return [3 /*break*/, 6];
                 if (!(e.code === eth_rpc_errors_1.errorCodes.rpc.internal &&
                     e.message &&
                     e.message.includes('underpriced'))) return [3 /*break*/, 2];
@@ -127,40 +128,48 @@ var parseError = function (e, step, process) { return __awaiter(void 0, void 0,
                 _b = [void 0, errors_1.LifiErrorCode.TransactionUnderpriced,
                     'Transaction is underpriced.'];
                 return [4 /*yield*/, (0, exports.getTransactionNotSentMessage)(step, process)];
-            case 1: return [2 /*return*/, new (_a.apply(errors_1.RPCError, _b.concat([_l.sent(), e.stack])))()];
+            case 1: return [2 /*return*/, new (_a.apply(errors_1.RPCError, _b.concat([_q.sent(), e.stack])))()];
             case 2:
-                _c = errors_1.RPCError.bind;
-                _d = [void 0, e.code,
-                    (0, eth_rpc_errors_1.getMessageFromCode)(e.code)];
+                if (!(((_o = e.message) === null || _o === void 0 ? void 0 : _o.includes('intrinsic gas too low')) ||
+                    ((_p = e.message) === null || _p === void 0 ? void 0 : _p.includes('out of gas')))) return [3 /*break*/, 4];
+                _c = errors_1.TransactionError.bind;
+                _d = [void 0, errors_1.LifiErrorCode.GasLimitError,
+                    'Gas limit is too low.'];
                 return [4 /*yield*/, (0, exports.getTransactionNotSentMessage)(step, process)];
-            case 3: return [2 /*return*/, new (_c.apply(errors_1.RPCError, _d.concat([_l.sent(), e.stack])))()];
+            case 3: return [2 /*return*/, new (_c.apply(errors_1.TransactionError, _d.concat([_q.sent(), e.stack])))()];
             case 4:
-                if (!Object.values(eth_rpc_errors_1.errorCodes.provider).includes(e.code)) return [3 /*break*/, 6];
-                _e = errors_1.ProviderError.bind;
+                _e = errors_1.RPCError.bind;
                 _f = [void 0, e.code,
                     (0, eth_rpc_errors_1.getMessageFromCode)(e.code)];
                 return [4 /*yield*/, (0, exports.getTransactionNotSentMessage)(step, process)];
-            case 5: return [2 /*return*/, new (_e.apply(errors_1.ProviderError, _f.concat([_l.sent(), e.stack])))()];
+            case 5: return [2 /*return*/, new (_e.apply(errors_1.RPCError, _f.concat([_q.sent(), e.stack])))()];
             case 6:
-                if (!(e.code === 'CALL_EXCEPTION')) return [3 /*break*/, 8];
+                if (!Object.values(eth_rpc_errors_1.errorCodes.provider).includes(e.code)) return [3 /*break*/, 8];
                 _g = errors_1.ProviderError.bind;
-                _h = [void 0, errors_1.LifiErrorCode.TransactionFailed,
-                    e.reason];
+                _h = [void 0, e.code,
+                    (0, eth_rpc_errors_1.getMessageFromCode)(e.code)];
                 return [4 /*yield*/, (0, exports.getTransactionNotSentMessage)(step, process)];
-            case 7: return [2 /*return*/, new (_g.apply(errors_1.ProviderError, _h.concat([_l.sent(), e.stack])))()];
+            case 7: return [2 /*return*/, new (_g.apply(errors_1.ProviderError, _h.concat([_q.sent(), e.stack])))()];
             case 8:
-                if (!(e.code === errors_1.LifiErrorCode.TransactionUnprepared)) return [3 /*break*/, 10];
-                _j = errors_1.TransactionError.bind;
-                _k = [void 0, errors_1.LifiErrorCode.TransactionUnprepared,
-                    e.message];
+                if (!(e.code === 'CALL_EXCEPTION')) return [3 /*break*/, 10];
+                _j = errors_1.ProviderError.bind;
+                _k = [void 0, errors_1.LifiErrorCode.TransactionFailed,
+                    e.reason];
                 return [4 /*yield*/, (0, exports.getTransactionNotSentMessage)(step, process)];
-            case 9: return [2 /*return*/, new (_j.apply(errors_1.TransactionError, _k.concat([_l.sent(), e.stack])))()];
+            case 9: return [2 /*return*/, new (_j.apply(errors_1.ProviderError, _k.concat([_q.sent(), e.stack])))()];
             case 10:
+                if (!(e.code === errors_1.LifiErrorCode.TransactionUnprepared)) return [3 /*break*/, 12];
+                _l = errors_1.TransactionError.bind;
+                _m = [void 0, errors_1.LifiErrorCode.TransactionUnprepared,
+                    e.message];
+                return [4 /*yield*/, (0, exports.getTransactionNotSentMessage)(step, process)];
+            case 11: return [2 /*return*/, new (_l.apply(errors_1.TransactionError, _m.concat([_q.sent(), e.stack])))()];
+            case 12:
                 if (e.code === errors_1.LifiErrorCode.ValidationError) {
                     return [2 /*return*/, new errors_1.TransactionError(errors_1.LifiErrorCode.ValidationError, e.message, e.htmlMessage)];
                 }
-                _l.label = 11;
-            case 11: return [2 /*return*/, new errors_1.UnknownError(errors_1.LifiErrorCode.InternalError, e.message || 'Unknown error occurred.', undefined, e.stack)];
+                _q.label = 13;
+            case 13: return [2 /*return*/, new errors_1.UnknownError(errors_1.LifiErrorCode.InternalError, e.message || 'Unknown error occurred.', undefined, e.stack)];
         }
     });
 }); };
@@ -182,3 +191,8 @@ var parseBackendError = function (e) {
     return new errors_1.ServerError('Something went wrong.', undefined, e.stack);
 };
 exports.parseBackendError = parseBackendError;
+var getSlippageNotMetMessage = function (step) {
+    var slippage = step.action.slippage;
+    return "Transaction was not sent, your funds are still in your wallet.\n  The updated quote for the current transaction does not meet your set slippage of ".concat(slippage * 100, "%.");
+};
+exports.getSlippageNotMetMessage = getSlippageNotMetMessage;

package/dist/utils/preRestart.d.ts

@@ -0,0 +1,2 @@
+import { Route } from '../types';
+export declare const handlePreRestart: (route: Route) => void;

package/dist/utils/preRestart.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handlePreRestart = void 0;
+var errors_1 = require("./errors");
+var handlePreRestart = function (route) {
+    var _a;
+    for (var index = 0; index < route.steps.length; index++) {
+        var stepHasFailed = ((_a = route.steps[index].execution) === null || _a === void 0 ? void 0 : _a.status) === 'FAILED';
+        if (stepHasFailed) {
+            handleErrorType(route, index);
+            popLastProcess(route, index);
+        }
+    }
+};
+exports.handlePreRestart = handlePreRestart;
+var handleErrorType = function (route, index) {
+    var _a, _b, _c, _d;
+    var isGasLimitError = (_a = route.steps[index].execution) === null || _a === void 0 ? void 0 : _a.process.some(function (p) { var _a; return ((_a = p.error) === null || _a === void 0 ? void 0 : _a.code) === errors_1.LifiErrorCode.GasLimitError; });
+    var isGasPriceError = (_b = route.steps[index].execution) === null || _b === void 0 ? void 0 : _b.process.some(function (p) { var _a; return ((_a = p.error) === null || _a === void 0 ? void 0 : _a.code) === errors_1.LifiErrorCode.TransactionUnderpriced; });
+    if (isGasLimitError) {
+        (_c = route.steps[index].estimate.gasCosts) === null || _c === void 0 ? void 0 : _c.forEach(function (gasCost) {
+            return (gasCost.limit = "".concat(Math.round(Number(gasCost.limit) * 1.25)));
+        });
+    }
+    if (isGasPriceError) {
+        (_d = route.steps[index].estimate.gasCosts) === null || _d === void 0 ? void 0 : _d.forEach(function (gasCost) {
+            return (gasCost.price = "".concat(Math.round(Number(gasCost.price) * 1.25)));
+        });
+    }
+};
+var popLastProcess = function (route, index) {
+    var _a;
+    (_a = route.steps[index].execution) === null || _a === void 0 ? void 0 : _a.process.pop();
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/sdk",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "LI.FI Any-to-Any Cross-Chain-Swap SDK",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -52,7 +52,7 @@
   "dependencies": {
     "@ethersproject/abi": "^5.6.4",
     "@ethersproject/contracts": "^5.6.2",
-    "@lifi/types": "^1.1.0",
+    "@lifi/types": "^1.3.0",
     "axios": "^0.27.2",
     "bignumber.js": "^9.0.1",
     "eth-rpc-errors": "^4.0.3",