@lifi/types 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './base';
+export * from './bridges';
+export * from './chains';
+export * from './coins';
+export * from './exchanges';
+export * from './step';
+export * from './api';
+export * from './multicall';

package/dist/index.js

@@ -0,0 +1,24 @@
+"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("./base"), exports);
+__exportStar(require("./bridges"), exports);
+__exportStar(require("./chains"), exports);
+__exportStar(require("./coins"), exports);
+__exportStar(require("./exchanges"), exports);
+__exportStar(require("./step"), exports);
+__exportStar(require("./api"), exports);
+__exportStar(require("./multicall"), exports);

package/dist/multicall.d.ts

@@ -0,0 +1,3 @@
+export declare const multicallAddresses: {
+    [ChainId: number]: string;
+};

package/dist/multicall.js

@@ -0,0 +1,61 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.multicallAddresses = void 0;
+var _1 = require(".");
+// based on:
+// - https://github.com/mds1/multicall#deployments
+// - https://github.com/sushiswap/sushiswap-sdk/blob/canary/src/constants/addresses.ts#L323
+// - https://github.com/joshstevens19/ethereum-multicall#multicall-contracts
+// '0xcA11bde05977b3631167028862bE2a173976CA11' is a Multicall3 contract
+exports.multicallAddresses = (_a = {},
+    // Mainnet
+    _a[_1.ChainId.ETH] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.POL] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.BSC] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.DAI] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.OKT] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.FTM] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.AVA] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.ARB] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.HEC] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.OPT] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.ONE] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.FSN] = '0x0769fd68dFb93167989C6f7254cd0D766Fb2841F',
+    _a[_1.ChainId.MOR] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.CEL] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.FUS] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.CRO] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.BOB] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.MOO] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.MAM] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.AUR] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.EVM] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    // [ChainId.EXP]: '', // TODO
+    // [ChainId.TCH]: '', // TODO
+    // [ChainId.UBQ]: '', // TODO
+    // [ChainId.MET]: '', // TODO
+    // [ChainId.DIO]: '', // TODO
+    // [ChainId.TLO]: '', // TODO
+    // [ChainId.SHI]: '', // TODO
+    // [ChainId.GL1]: '', // TODO
+    // [ChainId.RSK]: '', // TODO
+    // [ChainId.TBW]: '', // TODO
+    // [ChainId.VEL]: '', // TODO
+    // [ChainId.PALM]: '0x0769fd68dFb93167989C6f7254cd0D766Fb2841F',
+    // [ChainId.TELOS]: '0xdDCbf776dF3dE60163066A5ddDF2277cB445E0F3',
+    // Testnet
+    _a[_1.ChainId.ROP] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.RIN] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.GOR] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.KOV] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.MUM] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.ARBT] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.BSCT] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.ONET] = '0xdDCbf776dF3dE60163066A5ddDF2277cB445E0F3',
+    _a[_1.ChainId.AVAT] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.OPTT] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.EVMT] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.MORT] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a[_1.ChainId.FTMT] = '0xcA11bde05977b3631167028862bE2a173976CA11',
+    _a);

package/dist/step.d.ts

@@ -0,0 +1,103 @@
+import { providers } from 'ethers';
+import { Token } from './base';
+import { Bridge } from './bridges';
+import { Exchange, ExchangeAggregator } from './exchanges';
+export interface FeeCost {
+    name: string;
+    description?: string;
+    percentage: string;
+    token: Token;
+    amount: string;
+    amountUSD?: string;
+}
+export interface GasCost {
+    type: 'SUM' | 'APPROVE' | 'SEND';
+    price?: string;
+    estimate?: string;
+    limit?: string;
+    amount: string;
+    amountUSD?: string;
+    token: Token;
+}
+export interface Action {
+    fromChainId: number;
+    fromAmount: string;
+    fromToken: Token;
+    fromAddress?: string;
+    toChainId: number;
+    toToken: Token;
+    toAddress?: string;
+    slippage: number;
+}
+export interface Estimate {
+    fromAmount: string;
+    fromAmountUSD?: string;
+    toAmount: string;
+    toAmountMin: string;
+    toAmountUSD?: string;
+    approvalAddress: string;
+    feeCosts?: FeeCost[];
+    gasCosts?: GasCost[];
+    executionDuration: number;
+    data?: any;
+}
+export declare type Status = 'NOT_STARTED' | 'STARTED' | 'ACTION_REQUIRED' | 'CHAIN_SWITCH_REQUIRED' | 'PENDING' | 'FAILED' | 'DONE' | 'RESUME' | 'CANCELLED';
+export declare type ProcessType = 'TOKEN_ALLOWANCE' | 'SWITCH_CHAIN' | 'SWAP' | 'CROSS_CHAIN' | 'RECEIVING_CHAIN' | 'TRANSACTION';
+export interface Process {
+    startedAt: number;
+    doneAt?: number;
+    failedAt?: number;
+    type: ProcessType;
+    status: Status;
+    message?: string;
+    txHash?: string;
+    txLink?: string;
+    error?: {
+        code: string | number;
+        message: string;
+        htmlMessage?: string;
+    };
+    [key: string]: any;
+}
+export interface Execution {
+    status: Status;
+    process: Array<Process>;
+    fromAmount?: string;
+    toAmount?: string;
+    toToken?: Token;
+}
+export declare const emptyExecution: Execution;
+export declare type StepType = 'swap' | 'cross' | 'lifi';
+export declare type StepTool = string;
+export interface StepBase {
+    id: string;
+    type: StepType;
+    tool: StepTool;
+    toolDetails: Pick<ExchangeAggregator | Exchange | Bridge, 'key' | 'name' | 'logoURI'>;
+    integrator?: string;
+    referrer?: string;
+    action: Action;
+    estimate?: Estimate;
+    execution?: Execution;
+    transactionRequest?: providers.TransactionRequest;
+}
+export interface SwapStep extends StepBase {
+    type: 'swap';
+    action: Action;
+    estimate: Estimate;
+}
+export declare function isSwapStep(step: Step): step is SwapStep;
+export interface CrossStep extends StepBase {
+    type: 'cross';
+    action: Action;
+    estimate: Estimate;
+}
+export declare function isCrossStep(step: Step): step is CrossStep;
+export interface LifiStep extends StepBase {
+    type: 'lifi';
+    action: Action;
+    estimate: Estimate;
+    includedSteps: Step[];
+}
+export declare function isLifiStep(step: Step): step is LifiStep;
+export declare type Step = SwapStep | CrossStep | LifiStep;

package/dist/step.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLifiStep = exports.isCrossStep = exports.isSwapStep = exports.emptyExecution = void 0;
+exports.emptyExecution = {
+    status: 'NOT_STARTED',
+    process: [],
+};
+function isSwapStep(step) {
+    return step.type === 'swap';
+}
+exports.isSwapStep = isSwapStep;
+function isCrossStep(step) {
+    return step.type === 'cross';
+}
+exports.isCrossStep = isCrossStep;
+function isLifiStep(step) {
+    return step.type === 'lifi';
+}
+exports.isLifiStep = isLifiStep;

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@lifi/types",
+  "version": "1.0.0",
+  "description": "Types for the LI.FI stack",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "install": "node -e \"if (!require('fs').existsSync('./dist')){process.exit(1)}\" || npm run build",
+    "watch": "tsc -w -p ./tsconfig.json",
+    "build": "node tools/cleanup types && tsc -p ./tsconfig.json",
+    "clean": "node tools/cleanup",
+    "package": "npm run build && npm pack",
+    "test": "jest --no-cache --runInBand",
+    "test:cov": "jest --coverage --no-cache --runInBand",
+    "addscope": "node tools/packagejson name @lifi/types",
+    "pre-commit": "lint-staged",
+    "pre-push": "yarn build && yarn test",
+    "lint:fix": "eslint --ext .tsx --ext .ts ./src --fix",
+    "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": "LI.FI <github@li.finanace>",
+  "license": "MIT",
+  "homepage": "https://github.com/lifinance/types",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/lifinance/types.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lifinance/types"
+  },
+  "dependencies": {
+    "ethers": "^5.6.9"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
+    "@types/jest": "^28.1.4",
+    "@typescript-eslint/eslint-plugin": "^5.30.6",
+    "@typescript-eslint/parser": "^5.30.6",
+    "eslint": "^8.19.0",
+    "eslint-config-prettier": "^8.5.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"
+  }
+}