@lifi/sdk 1.0.0

package/dist/utils/utils.js

@@ -0,0 +1,188 @@
+"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) {
+        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.isNativeTokenAddress = exports.isZeroAddress = exports.loadTransactionReceipt = exports.repeatUntilDone = exports.formatTokenAmountOnly = exports.splitListIntoChunks = exports.personalizeStep = exports.sleep = exports.deepClone = void 0;
+var bignumber_js_1 = __importDefault(require("bignumber.js"));
+var ethers_1 = require("ethers");
+var connectors_1 = require("../connectors");
+var deepClone = function (src) {
+    return JSON.parse(JSON.stringify(src));
+};
+exports.deepClone = deepClone;
+var sleep = function (mills) {
+    return new Promise(function (resolve) {
+        setTimeout(resolve, mills);
+    });
+};
+exports.sleep = sleep;
+var personalizeStep = function (signer, step) { return __awaiter(void 0, void 0, void 0, function () {
+    var address, fromAddress, toAddress;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                if (step.action.toAddress && step.action.fromAddress) {
+                    return [2 /*return*/, step];
+                }
+                return [4 /*yield*/, signer.getAddress()];
+            case 1:
+                address = _a.sent();
+                fromAddress = step.action.fromAddress || address;
+                toAddress = step.action.toAddress || address;
+                return [2 /*return*/, __assign(__assign({}, step), { action: __assign(__assign({}, step.action), { fromAddress: fromAddress, toAddress: toAddress }) })];
+        }
+    });
+}); };
+exports.personalizeStep = personalizeStep;
+var splitListIntoChunks = function (list, chunkSize) {
+    return list.reduce(function (resultList, item, index) {
+        var chunkIndex = Math.floor(index / chunkSize);
+        if (!resultList[chunkIndex]) {
+            resultList[chunkIndex] = []; // start a new chunk
+        }
+        resultList[chunkIndex].push(item);
+        return resultList;
+    }, []);
+};
+exports.splitListIntoChunks = splitListIntoChunks;
+var formatTokenAmountOnly = function (token, amount) {
+    if (!amount) {
+        return '0.0';
+    }
+    var floated;
+    if (typeof amount === 'string') {
+        if (amount === '0') {
+            return '0.0';
+        }
+        floated = new bignumber_js_1.default(amount).shiftedBy(-token.decimals);
+    }
+    else {
+        floated = amount;
+        if (floated.isZero()) {
+            return '0.0';
+        }
+    }
+    // show at least 4 decimal places and at least two non-zero digests
+    var decimalPlaces = 3;
+    while (floated.lt(1 / Math.pow(10, decimalPlaces))) {
+        decimalPlaces++;
+    }
+    return floated.toFixed(decimalPlaces + 1, 1);
+};
+exports.formatTokenAmountOnly = formatTokenAmountOnly;
+/**
+ * Repeatedly calls a given asynchronous function until it resolves with a value
+ * @param toRepeat The function that should be repeated
+ * @param timeout The timeout in milliseconds between retries, defaults to 5000
+ * @returns The result of the toRepeat function
+ */
+var repeatUntilDone = function (toRepeat, timeout) {
+    if (timeout === void 0) { timeout = 5000; }
+    return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!!result) return [3 /*break*/, 4];
+                    return [4 /*yield*/, toRepeat()];
+                case 1:
+                    result = _a.sent();
+                    if (!!result) return [3 /*break*/, 3];
+                    return [4 /*yield*/, (0, exports.sleep)(timeout)];
+                case 2:
+                    _a.sent();
+                    _a.label = 3;
+                case 3: return [3 /*break*/, 0];
+                case 4: return [2 /*return*/, result];
+            }
+        });
+    });
+};
+exports.repeatUntilDone = repeatUntilDone;
+/**
+ * Loads a transaction receipt using the rpc for the given chain id
+ * @param chainId The chain id where the transaction should be loaded from
+ * @param txHash The hash of the transaction
+ * @returns TransactionReceipt
+ */
+var loadTransactionReceipt = function (chainId, txHash) { return __awaiter(void 0, void 0, void 0, function () {
+    var rpc, tx;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, connectors_1.getRpcProvider)(chainId)];
+            case 1:
+                rpc = _a.sent();
+                return [4 /*yield*/, rpc.getTransaction(txHash)];
+            case 2:
+                tx = _a.sent();
+                return [2 /*return*/, tx.wait()];
+        }
+    });
+}); };
+exports.loadTransactionReceipt = loadTransactionReceipt;
+var isZeroAddress = function (address) {
+    if (address === ethers_1.constants.AddressZero ||
+        address === '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee') {
+        return true;
+    }
+    return false;
+};
+exports.isZeroAddress = isZeroAddress;
+var isNativeTokenAddress = function (address) {
+    if (address === ethers_1.constants.AddressZero ||
+        address === '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee' ||
+        // CELO native token
+        address === '0x471ece3750da237f93b8e339c536989b8978a438') {
+        return true;
+    }
+    return false;
+};
+exports.isNativeTokenAddress = isNativeTokenAddress;

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@lifi/sdk",
+  "version": "1.0.0",
+  "description": "LI.FI Any-to-Any Cross-Chain-Swap SDK",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "watch": "tsc -w -p ./tsconfig.json",
+    "build": "yarn clean && tsc --project ./tsconfig.json",
+    "clean": "node tools/cleanup",
+    "package": "npm run build && npm pack",
+    "test": "jest --no-cache --runInBand --forceExit",
+    "test:unit": "yarn test .unit.spec.ts",
+    "test:cov": "jest --coverage --no-cache --runInBand --forceExit",
+    "test:e2e": "jest -c jest.e2e.config.js",
+    "addscope": "node tools/packagejson name @lifi/sdk",
+    "pre-commit": "lint-staged",
+    "pre-push": "yarn types:check && yarn build && yarn test:unit",
+    "lint": "eslint --ext .tsx --ext .ts ./src",
+    "lint:fix": "eslint --ext .tsx --ext .ts ./src --fix",
+    "types:check": "tsc --noEmit",
+    "prettier:fix": "prettier --write ./src/.",
+    "use:npmReadme": "mv 'README.md' 'git.README.md' && mv 'npm.README.md' 'README.md'",
+    "use:gitReadme": "mv 'README.md' 'npm.README.md' && mv 'git.README.md' 'README.md'",
+    "prepublishOnly": "run-s build use:npmReadme && pinst --enable",
+    "postpublish": "npm run use:gitReadme && pinst --enable",
+    "prepare": "husky install",
+    "release": "standard-version"
+  },
+  "lint-staged": {
+    "src/**/*.{ts,tsx}": [
+      "yarn run lint:fix",
+      "yarn run prettier:fix"
+    ]
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Max Klenk <max@li.finance>",
+  "license": "UNLICENSED",
+  "homepage": "https://github.com/lifinance/sdk",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/lifinance/sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lifinance/sdk/issues"
+  },
+  "dependencies": {
+    "@ethersproject/abi": "^5.6.4",
+    "@ethersproject/contracts": "^5.6.2",
+    "@lifi/types": "^1.0.0",
+    "axios": "^0.27.2",
+    "bignumber.js": "^9.0.1",
+    "eth-rpc-errors": "^4.0.3",
+    "ethers": "^5.6.9"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
+    "@types/bip39": "^3.0.0",
+    "@types/chai": "^4.3.1",
+    "@types/hdkey": "^2.0.0",
+    "@types/jest": "^28.1.4",
+    "@types/websocket": "^1.0.4",
+    "@typescript-eslint/eslint-plugin": "^5.30.6",
+    "@typescript-eslint/parser": "^5.30.6",
+    "eslint": "^8.19.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.1",
+    "jest": "^28.1.2",
+    "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.5",
+    "ts-loader": "^9.3.1",
+    "typescript": "^4.7.4",
+    "webpack": "^5.73.0",
+    "webpack-cli": "^4.10.0"
+  },
+  "directories": {
+    "test": "test"
+  }
+}