@lifi/types 9.0.0-alpha.8 → 9.0.0

package/dist/index.d.ts

@@ -1,7 +1,10 @@
-export * from './api';
+export * from './base';
 export * from './bridges';
 export * from './chains';
+export * from './coins';
 export * from './exchanges';
-export * from './quests';
 export * from './step';
-export * from './tokens';
+export * from './api';
+export * from './apiErrors';
+export * from './multicall';
+export * from './quests';

package/dist/index.js

@@ -1,7 +1,10 @@
-export * from './api';
+export * from './base';
 export * from './bridges';
 export * from './chains';
+export * from './coins';
 export * from './exchanges';
-export * from './quests';
 export * from './step';
-export * from './tokens';
+export * from './api';
+export * from './apiErrors';
+export * from './multicall';
+export * from './quests';

package/dist/multicall.d.ts

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

package/dist/multicall.js

@@ -0,0 +1,77 @@
+import { ChainId } from '.';
+// based on:
+// new nice tool to search for addresses: https://www.multicall3.com/deployments
+// - 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
+// export const multicallAddresses: Record<ChainId, string> = {
+export const multicallAddresses = {
+    // Mainnet
+    [ChainId.ETH]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.POL]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.BSC]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.DAI]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.OKT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.FTM]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.AVA]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.ARB]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.HEC]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.OPT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.ONE]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.FSN]: '0x0769fd68dFb93167989C6f7254cd0D766Fb2841F',
+    [ChainId.MOR]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.CEL]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.FUS]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.CRO]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.BOB]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.MOO]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.MAM]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.AUR]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.EVM]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.MET]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.RSK]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.VEL]: '0x6ede559F2Bd951777470595761672091CCD21Ac6',
+    [ChainId.PZE]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.ERA]: '0xF9cda624FBC7e059355ce98a31693d299FACd963',
+    [ChainId.LNA]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.ARN]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.BAS]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    // TODO
+    // [ChainId.EXP]: '', // TODO
+    // [ChainId.TCH]: '', // TODO
+    // [ChainId.UBQ]: '', // TODO
+    // [ChainId.DIO]: '', // TODO
+    // [ChainId.TLO]: '', // TODO
+    // [ChainId.SHI]: '', // TODO
+    // [ChainId.GL1]: '', // TODO
+    // [ChainId.TBW]: '', // TODO
+    // [ChainId.PALM]: '0x0769fd68dFb93167989C6f7254cd0D766Fb2841F',
+    // [ChainId.TELOS]: '0xdDCbf776dF3dE60163066A5ddDF2277cB445E0F3',
+    // Testnet
+    [ChainId.GOR]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.MUM]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.BSCT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.ONET]: '0xdDCbf776dF3dE60163066A5ddDF2277cB445E0F3',
+    [ChainId.AVAT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.OPTG]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.EVMT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.MORT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.FTMT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.RSKT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.ARBG]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    [ChainId.LNAT]: '0xcA11bde05977b3631167028862bE2a173976CA11',
+    // TODO
+    // [ChainId.METT]: '', // TODO
+    // [ChainId.DIOT]: '', // TODO
+    // [ChainId.HECT]: '', // TODO
+    // [ChainId.FUST]: '', // TODO
+    // [ChainId.TLOT]: '', // TODO
+    // none EVM
+    // [ChainId.SOL]: '', // NOT NEEDED
+    // [ChainId.TER]: '', // NOT NEEDED
+    // [ChainId.OAS]: '', // NOT NEEDED
+    // [ChainId.SOLT]: '', // NOT NEEDED
+    // [ChainId.TERT]: '', // NOT NEEDED
+    // [ChainId.OAST]: '', // NOT NEEDED
+};

package/dist/step.d.ts

@@ -1,12 +1,15 @@
-import { Substatus, TransactionRequest } from '.';
-import { Token } from './tokens/token';
+import { providers } from 'ethers';
+import { Substatus } from '.';
+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;
+    amountUSD: string;
     included: boolean;
 }
 export interface GasCost {
@@ -76,22 +79,17 @@ export declare const emptyExecution: Execution;
 export declare const _StepType: readonly ["lifi", "swap", "cross", "protocol", "custom"];
 export type StepType = (typeof _StepType)[number];
 export type StepTool = string;
-export type StepToolDetails = {
-    key: string;
-    name: string;
-    logoURI: string;
-};
 export interface StepBase {
     id: string;
     type: StepType;
     tool: StepTool;
-    toolDetails: StepToolDetails;
+    toolDetails: Pick<ExchangeAggregator | Exchange | Bridge, 'key' | 'name' | 'logoURI'>;
     integrator?: string;
     referrer?: string;
     action: Action;
     estimate?: Estimate;
     execution?: Execution;
-    transactionRequest?: TransactionRequest;
+    transactionRequest?: providers.TransactionRequest;
 }
 export interface DestinationCallInfo {
     toContractAddress: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/types",
-  "version": "9.0.0-alpha.8",
+  "version": "9.0.0",
   "description": "Types for the LI.FI stack",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
@@ -10,23 +10,23 @@
     "import": "./dist/index.js"
   },
   "scripts": {
-    "addscope": "node tools/packagejson name @lifi/types",
+    "watch": "tsc -w -p ./tsconfig.json",
     "build": "node tools/cleanup types && tsc -p ./tsconfig.json && tsc -p ./tsconfig.cjs.json",
     "clean": "node tools/cleanup",
-    "lint:fix": "eslint --ext .tsx --ext .ts ./src --fix",
     "package": "npm run build && npm pack",
-    "postpublish": "npm run use:gitReadme && pinst --enable",
+    "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",
-    "prepare": "husky install",
-    "prepublishOnly": "run-s build use:npmReadme && pinst --enable",
+    "pre-push": "yarn build && yarn test",
+    "lint:fix": "eslint --ext .tsx --ext .ts ./src --fix",
     "prettier:fix": "prettier --write ./src/.",
-    "release": "standard-version -a",
-    "release:alpha": "standard-version -a --prerelease alpha --skip.changelog",
-    "release:beta": "standard-version -a --prerelease beta --skip.changelog",
-    "use:gitReadme": "mv 'README.md' 'npm.README.md' && mv 'git.README.md' 'README.md'",
     "use:npmReadme": "mv 'README.md' 'git.README.md' && mv 'npm.README.md' 'README.md'",
-    "watch": "tsc -w -p ./tsconfig.json"
+    "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 --release-as major"
   },
   "lint-staged": {
     "src/**/*.{ts,tsx}": [
@@ -68,21 +68,31 @@
   "bugs": {
     "url": "https://github.com/lifinance/types"
   },
+  "dependencies": {
+    "ethers": "^5.7.2"
+  },
   "devDependencies": {
-    "@commitlint/cli": "^17.7.1",
-    "@commitlint/config-conventional": "^17.7.0",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^6.3.0",
-    "eslint": "^8.47.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.0",
+    "@commitlint/cli": "^17.5.1",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@types/jest": "^29.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.58.0",
+    "@typescript-eslint/parser": "^5.58.0",
+    "axios": "^1.4.0",
+    "eslint": "^8.38.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.3",
-    "lint-staged": "^14.0.0",
+    "jest": "^29.5.0",
+    "lint-staged": "^13.2.1",
     "npm-run-all": "^4.1.5",
     "pinst": "^3.0.0",
-    "prettier": "^3.0.1",
+    "prettier": "^2.8.7",
     "standard-version": "^9.5.0",
-    "typescript": "^5.1.6"
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.4"
+  },
+  "directories": {
+    "test": "test"
   },
   "packageManager": "yarn@3.5.0"
 }