@lifi/types 2.1.0 → 2.2.1

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 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.
 
+### [2.2.1](https://github.com/lifinance/types/compare/v2.2.0...v2.2.1) (2023-03-02)
+
+## [2.2.0](https://github.com/lifinance/types/compare/v2.1.1...v2.2.0) (2023-03-02)
+
+
+### Features
+
+* add gas suggestion and status types, lifuel icon ([#137](https://github.com/lifinance/types/issues/137)) ([94ae5f2](https://github.com/lifinance/types/commit/94ae5f2a5358e08e2096dddfe79cbad23c94eaff))
+* add protocol icons ([97cf747](https://github.com/lifinance/types/commit/97cf747d3cf8c4704e15dc23ecfd019cd0ed7bd2))
+* deprecate the possibilities endpoint ([#136](https://github.com/lifinance/types/issues/136)) ([53fa193](https://github.com/lifinance/types/commit/53fa193334fc0f929325c3e8f9b3f2c07a52edb7))
+
+
+### Bug Fixes
+
+* rename gasUp to getGas ([b2dfda9](https://github.com/lifinance/types/commit/b2dfda984e923c74275c99498e6d5818b7447a91))
+* typo ([62981c6](https://github.com/lifinance/types/commit/62981c60254cbe4342129fad88029e5870d30321))
+
+### [2.1.1](https://github.com/lifinance/types/compare/v2.1.0...v2.1.1) (2023-02-17)
+
+
+### Bug Fixes
+
+* add CZKT default tokens ([df967ac](https://github.com/lifinance/types/commit/df967ac4fb3ee89a701d89950f50b438cc67b656))
+
 ## [2.1.0](https://github.com/lifinance/types/compare/v2.0.4...v2.1.0) (2023-02-17)
 
 

package/dist/api.d.ts

@@ -74,12 +74,20 @@ export interface RoutesResponse {
     errors: ToolError[];
 }
 export type PossibilityTopic = 'chains' | 'tokens' | 'bridges' | 'exchanges';
+/**
+ * We don't want to support this endpoint anymore in the future. /chains, /tools, /connections, and /tokens should be used instead
+ * @deprecated
+ */
 export interface PossibilitiesRequest {
     chains?: number[];
     bridges?: AllowDenyPrefer;
     exchanges?: AllowDenyPrefer;
     include?: PossibilityTopic[];
 }
+/**
+ * Should not be accessed via the types package anymore
+ * @deprecated
+ */
 export interface PossibilitiesResponse {
     chains?: Chain[];
     tokens?: Token[];
@@ -250,4 +258,36 @@ export interface IntegratorWithdrawalRequest {
 export interface IntegratorWithdrawalTransactionResponse {
     transactionRequest: TransactionRequest;
 }
+declare const _LIFuelState: readonly ["PENDING", "DONE", "NOT_FOUND"];
+type LIFuelState = (typeof _LIFuelState)[number];
+export type LIFuelStatusResponse = {
+    status: LIFuelState;
+    sending?: TransactionInfo;
+    receiving?: TransactionInfo;
+};
+export type GasRecommendationRequest = {
+    chainId: ChainId;
+    fromChain?: ChainId;
+    fromToken?: string;
+};
+export type RefetchSourceLIFuelRequest = {
+    txHash: string;
+    chainId: ChainId;
+};
+export type LIFuelStatusRequest = {
+    txHash: string;
+};
+export type RefetchLIFuelRequest = {
+    txHash: string;
+    chainId: ChainId;
+};
+export type GasRecommendationResponse = {
+    available: boolean;
+    recommended?: TokenBalance;
+    limit?: TokenBalance;
+    serviceFee?: TokenBalance;
+    fromToken?: Token;
+    fromAmount?: string;
+    message?: string;
+};
 export {};

package/dist/api.js

@@ -39,3 +39,4 @@ const _SubstatusDone = [
 ];
 export const isSubstatusPending = (substatus) => _SubstatusPending.includes(substatus);
 export const isSubstatusDone = (substatus) => _SubstatusDone.includes(substatus);
+const _LIFuelState = ['PENDING', 'DONE', 'NOT_FOUND'];

package/dist/base.d.ts

@@ -198,6 +198,10 @@ export interface ExchangeDefinition {
     tool: ExchangeTools;
     chains: number[];
 }
+/**
+ * Should not be accessed via the types package anymore
+ * @deprecated
+ */
 export interface BridgeDefinition {
     tool: BridgeTool;
     fromChainId: number;

package/dist/chains/index.d.ts

@@ -1,5 +1,5 @@
 export * from './Chain';
+export * from './chain.utils';
 export * from './EVMChain';
 export * from './SolanaChain';
 export * from './supported.chains';
-export * from './chain.utils';

package/dist/chains/index.js

@@ -1,5 +1,5 @@
 export * from './Chain';
+export * from './chain.utils';
 export * from './EVMChain';
 export * from './SolanaChain';
 export * from './supported.chains';
-export * from './chain.utils';

package/dist/chains/supported.chains.js

@@ -1198,7 +1198,7 @@ export const supportedEVMChains = [
         coin: CoinKey.ETH,
         id: 59140,
         mainnet: false,
-        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/chains/consensys_skevm_test.png',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/chains/consensys_zkevm_test.png',
         // multicallAddress: multicallAddresses[ChainId.CZKT], // Not deployed yet
         faucetUrls: ['https://goerli.zkevm.consensys.net/'],
         metamask: {

package/dist/cjs/api.d.ts

@@ -74,12 +74,20 @@ export interface RoutesResponse {
     errors: ToolError[];
 }
 export type PossibilityTopic = 'chains' | 'tokens' | 'bridges' | 'exchanges';
+/**
+ * We don't want to support this endpoint anymore in the future. /chains, /tools, /connections, and /tokens should be used instead
+ * @deprecated
+ */
 export interface PossibilitiesRequest {
     chains?: number[];
     bridges?: AllowDenyPrefer;
     exchanges?: AllowDenyPrefer;
     include?: PossibilityTopic[];
 }
+/**
+ * Should not be accessed via the types package anymore
+ * @deprecated
+ */
 export interface PossibilitiesResponse {
     chains?: Chain[];
     tokens?: Token[];
@@ -250,4 +258,36 @@ export interface IntegratorWithdrawalRequest {
 export interface IntegratorWithdrawalTransactionResponse {
     transactionRequest: TransactionRequest;
 }
+declare const _LIFuelState: readonly ["PENDING", "DONE", "NOT_FOUND"];
+type LIFuelState = (typeof _LIFuelState)[number];
+export type LIFuelStatusResponse = {
+    status: LIFuelState;
+    sending?: TransactionInfo;
+    receiving?: TransactionInfo;
+};
+export type GasRecommendationRequest = {
+    chainId: ChainId;
+    fromChain?: ChainId;
+    fromToken?: string;
+};
+export type RefetchSourceLIFuelRequest = {
+    txHash: string;
+    chainId: ChainId;
+};
+export type LIFuelStatusRequest = {
+    txHash: string;
+};
+export type RefetchLIFuelRequest = {
+    txHash: string;
+    chainId: ChainId;
+};
+export type GasRecommendationResponse = {
+    available: boolean;
+    recommended?: TokenBalance;
+    limit?: TokenBalance;
+    serviceFee?: TokenBalance;
+    fromToken?: Token;
+    fromAmount?: string;
+    message?: string;
+};
 export {};

package/dist/cjs/api.js

@@ -44,3 +44,4 @@ const isSubstatusPending = (substatus) => _SubstatusPending.includes(substatus);
 exports.isSubstatusPending = isSubstatusPending;
 const isSubstatusDone = (substatus) => _SubstatusDone.includes(substatus);
 exports.isSubstatusDone = isSubstatusDone;
+const _LIFuelState = ['PENDING', 'DONE', 'NOT_FOUND'];

package/dist/cjs/base.d.ts

@@ -198,6 +198,10 @@ export interface ExchangeDefinition {
     tool: ExchangeTools;
     chains: number[];
 }
+/**
+ * Should not be accessed via the types package anymore
+ * @deprecated
+ */
 export interface BridgeDefinition {
     tool: BridgeTool;
     fromChainId: number;

package/dist/cjs/chains/index.d.ts

@@ -1,5 +1,5 @@
 export * from './Chain';
+export * from './chain.utils';
 export * from './EVMChain';
 export * from './SolanaChain';
 export * from './supported.chains';
-export * from './chain.utils';

package/dist/cjs/chains/index.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Chain"), exports);
+__exportStar(require("./chain.utils"), exports);
 __exportStar(require("./EVMChain"), exports);
 __exportStar(require("./SolanaChain"), exports);
 __exportStar(require("./supported.chains"), exports);
-__exportStar(require("./chain.utils"), exports);

package/dist/cjs/chains/supported.chains.js

@@ -1201,7 +1201,7 @@ exports.supportedEVMChains = [
         coin: base_1.CoinKey.ETH,
         id: 59140,
         mainnet: false,
-        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/chains/consensys_skevm_test.png',
+        logoURI: 'https://raw.githubusercontent.com/lifinance/types/main/src/assets/icons/chains/consensys_zkevm_test.png',
         // multicallAddress: multicallAddresses[ChainId.CZKT], // Not deployed yet
         faucetUrls: ['https://goerli.zkevm.consensys.net/'],
         metamask: {

package/dist/cjs/coins.js

@@ -126,6 +126,14 @@ const basicCoins = [
                 address: '0x0000000000000000000000000000000000000000',
                 decimals: 18,
             },
+            [base_1.ChainId.ARBG]: {
+                address: '0x0000000000000000000000000000000000000000',
+                decimals: 18,
+            },
+            [base_1.ChainId.CZKT]: {
+                address: '0x0000000000000000000000000000000000000000',
+                decimals: 18,
+            },
         },
     },
     // > MATIC
@@ -386,6 +394,10 @@ const basicCoins = [
                 decimals: 8,
                 name: 'Avalanche (Wormhole)',
             },
+            [base_1.ChainId.AVAT]: {
+                address: '0x0000000000000000000000000000000000000000',
+                decimals: 18,
+            },
         },
     },
     // > HT
@@ -679,6 +691,11 @@ const basicCoins = [
                 address: '0x6d4dd09982853f08d9966ac3ca4eb5885f16f2b2',
                 decimals: 6,
             },
+            [base_1.ChainId.CZKT]: {
+                address: '0x964FF70695da981027c81020B1c58d833D49A640',
+                decimals: 6,
+                name: 'ConsenSys USD Coin',
+            },
             // 42, 0xb7a4f3e9097c08da09517b5ab877f7a917224ede, 6
         },
     },
@@ -916,6 +933,10 @@ const basicCoins = [
                 address: '0x4200000000000000000000000000000000000006',
                 decimals: 18,
             },
+            [base_1.ChainId.CZKT]: {
+                address: '0x2C1b868d6596a18e32E61B901E4060C872647b6C',
+                decimals: 18,
+            },
         },
     },
     // > SUSHI
@@ -1512,6 +1533,16 @@ exports.wrappedTokens = {
         name: 'WETH',
         logoURI: 'https://zapper.fi/images/networks/ethereum/0x0000000000000000000000000000000000000000.png',
     },
+    [base_1.ChainId.ARBG]: {
+        // https://goerli.arbiscan.io/token/0x42da9eE191833756c618778145A86E6709f70C9b
+        address: '0x42da9eE191833756c618778145A86E6709f70C9b',
+        symbol: 'WETH',
+        decimals: 18,
+        chainId: base_1.ChainId.ARBG,
+        coinKey: base_1.CoinKey.WETH,
+        name: 'WETH',
+        logoURI: 'https://zapper.fi/images/networks/ethereum/0x0000000000000000000000000000000000000000.png',
+    },
     [base_1.ChainId.OPTT]: {
         // https://kovan-optimistic.etherscan.io/token/0x4200000000000000000000000000000000000006
         address: '0x4200000000000000000000000000000000000006',
@@ -1542,6 +1573,26 @@ exports.wrappedTokens = {
         name: 'WBNB',
         logoURI: 'https://zapper.fi/images/networks/binance-smart-chain/0x0000000000000000000000000000000000000000.png',
     },
+    [base_1.ChainId.CZKT]: {
+        // https://explorer.prealpha.zkevm.consensys.net/address/0x2C1b868d6596a18e32E61B901E4060C872647b6C
+        address: '0x2C1b868d6596a18e32E61B901E4060C872647b6C',
+        symbol: 'WETH',
+        decimals: 18,
+        chainId: base_1.ChainId.CZKT,
+        coinKey: base_1.CoinKey.WETH,
+        name: 'WETH',
+        logoURI: 'https://zapper.fi/images/networks/ethereum/0x0000000000000000000000000000000000000000.png',
+    },
+    [base_1.ChainId.AVAT]: {
+        // https://testnet.snowtrace.io/token/0xd00ae08403B9bbb9124bB305C09058E32C39A48c
+        address: '0xd00ae08403B9bbb9124bB305C09058E32C39A48c',
+        symbol: 'WAVAX',
+        decimals: 18,
+        chainId: base_1.ChainId.AVA,
+        coinKey: 'WAVAX',
+        name: 'Wrapped AVAX',
+        logoURI: '',
+    },
 };
 const findDefaultCoin = (coinKey) => {
     const coin = exports.defaultCoins.find((coin) => coin.key === coinKey);

package/dist/coins.js

@@ -123,6 +123,14 @@ const basicCoins = [
                 address: '0x0000000000000000000000000000000000000000',
                 decimals: 18,
             },
+            [ChainId.ARBG]: {
+                address: '0x0000000000000000000000000000000000000000',
+                decimals: 18,
+            },
+            [ChainId.CZKT]: {
+                address: '0x0000000000000000000000000000000000000000',
+                decimals: 18,
+            },
         },
     },
     // > MATIC
@@ -383,6 +391,10 @@ const basicCoins = [
                 decimals: 8,
                 name: 'Avalanche (Wormhole)',
             },
+            [ChainId.AVAT]: {
+                address: '0x0000000000000000000000000000000000000000',
+                decimals: 18,
+            },
         },
     },
     // > HT
@@ -676,6 +688,11 @@ const basicCoins = [
                 address: '0x6d4dd09982853f08d9966ac3ca4eb5885f16f2b2',
                 decimals: 6,
             },
+            [ChainId.CZKT]: {
+                address: '0x964FF70695da981027c81020B1c58d833D49A640',
+                decimals: 6,
+                name: 'ConsenSys USD Coin',
+            },
             // 42, 0xb7a4f3e9097c08da09517b5ab877f7a917224ede, 6
         },
     },
@@ -913,6 +930,10 @@ const basicCoins = [
                 address: '0x4200000000000000000000000000000000000006',
                 decimals: 18,
             },
+            [ChainId.CZKT]: {
+                address: '0x2C1b868d6596a18e32E61B901E4060C872647b6C',
+                decimals: 18,
+            },
         },
     },
     // > SUSHI
@@ -1509,6 +1530,16 @@ export const wrappedTokens = {
         name: 'WETH',
         logoURI: 'https://zapper.fi/images/networks/ethereum/0x0000000000000000000000000000000000000000.png',
     },
+    [ChainId.ARBG]: {
+        // https://goerli.arbiscan.io/token/0x42da9eE191833756c618778145A86E6709f70C9b
+        address: '0x42da9eE191833756c618778145A86E6709f70C9b',
+        symbol: 'WETH',
+        decimals: 18,
+        chainId: ChainId.ARBG,
+        coinKey: CoinKey.WETH,
+        name: 'WETH',
+        logoURI: 'https://zapper.fi/images/networks/ethereum/0x0000000000000000000000000000000000000000.png',
+    },
     [ChainId.OPTT]: {
         // https://kovan-optimistic.etherscan.io/token/0x4200000000000000000000000000000000000006
         address: '0x4200000000000000000000000000000000000006',
@@ -1539,6 +1570,26 @@ export const wrappedTokens = {
         name: 'WBNB',
         logoURI: 'https://zapper.fi/images/networks/binance-smart-chain/0x0000000000000000000000000000000000000000.png',
     },
+    [ChainId.CZKT]: {
+        // https://explorer.prealpha.zkevm.consensys.net/address/0x2C1b868d6596a18e32E61B901E4060C872647b6C
+        address: '0x2C1b868d6596a18e32E61B901E4060C872647b6C',
+        symbol: 'WETH',
+        decimals: 18,
+        chainId: ChainId.CZKT,
+        coinKey: CoinKey.WETH,
+        name: 'WETH',
+        logoURI: 'https://zapper.fi/images/networks/ethereum/0x0000000000000000000000000000000000000000.png',
+    },
+    [ChainId.AVAT]: {
+        // https://testnet.snowtrace.io/token/0xd00ae08403B9bbb9124bB305C09058E32C39A48c
+        address: '0xd00ae08403B9bbb9124bB305C09058E32C39A48c',
+        symbol: 'WAVAX',
+        decimals: 18,
+        chainId: ChainId.AVA,
+        coinKey: 'WAVAX',
+        name: 'Wrapped AVAX',
+        logoURI: '',
+    },
 };
 export const findDefaultCoin = (coinKey) => {
     const coin = defaultCoins.find((coin) => coin.key === coinKey);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/types",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "Types for the LI.FI stack",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
@@ -73,26 +73,23 @@
     "ethers": "^5.7.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.2.0",
-    "@commitlint/config-conventional": "^17.2.0",
-    "@types/jest": "^29.2.2",
-    "@typescript-eslint/eslint-plugin": "^5.42.1",
-    "@typescript-eslint/parser": "^5.42.1",
-    "eslint": "^8.27.0",
-    "eslint-config-prettier": "^8.5.0",
+    "@commitlint/cli": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@types/jest": "^29.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.54.0",
+    "@typescript-eslint/parser": "^5.54.0",
+    "eslint": "^8.35.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.2",
-    "jest": "^29.3.1",
-    "lint-staged": ">=13.0.3",
+    "husky": "^8.0.3",
+    "jest": "^29.4.3",
+    "lint-staged": "^13.1.2",
     "npm-run-all": "^4.1.5",
     "pinst": "^3.0.0",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.4",
     "standard-version": "^9.5.0",
-    "ts-jest": "^29.0.3",
-    "ts-loader": "^9.4.1",
-    "typescript": "^4.8.4",
-    "webpack": "^5.75.0",
-    "webpack-cli": "^4.10.0"
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.5"
   },
   "directories": {
     "test": "test"