@lifi/types 4.0.1 → 5.1.0

package/CHANGELOG.md

@@ -2,12 +2,28 @@
 
 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.
 
-### [4.0.1](https://github.com/lifinance/types/compare/v4.0.0...v4.0.1) (2023-04-28)
+## [5.1.0](https://github.com/lifinance/types/compare/v5.0.0...v5.1.0) (2023-04-28)
+
+
+### Features
+
+* add circle logo ([7f68249](https://github.com/lifinance/types/commit/7f68249aa10f301d6ad1805c49690f1628b5ed7e))
 
 
 ### Bug Fixes
 
-* more explicit type for GasRecommendationResponse ([#165](https://github.com/lifinance/types/issues/165)) ([bdcd8b1](https://github.com/lifinance/types/commit/bdcd8b1155104237925dedb1aa9208d1ec7bb608))
+* more explicit type for GasRecommendationResponse ([#165](https://github.com/lifinance/types/issues/165)) ([9fc5756](https://github.com/lifinance/types/commit/9fc57560356ecc977785b6dccce3b060523c32e3))
+
+## [5.0.0](https://github.com/lifinance/types/compare/v4.0.0...v5.0.0) (2023-04-25)
+
+
+### ⚠ BREAKING CHANGES
+
+* introduce Base and StaticToken and make priceUSD in Token required (#153)
+
+### Features
+
+* introduce Base and StaticToken and make priceUSD in Token required ([#153](https://github.com/lifinance/types/issues/153)) ([85b9ab1](https://github.com/lifinance/types/commit/85b9ab10570c9a3cce8ab076fa7b77fb339fc492))
 
 ## [4.0.0](https://github.com/lifinance/types/compare/v3.2.8...v4.0.0) (2023-04-24)
 

package/dist/base.d.ts

@@ -164,16 +164,20 @@ export declare enum ChainId {
     FTMT = 4002,
     LNAT = 59140
 }
-export interface Token {
+export interface BaseToken {
+    chainId: ChainId;
     address: string;
+}
+export interface StaticToken extends BaseToken {
     symbol: string;
     decimals: number;
-    chainId: number;
     name: string;
     coinKey?: CoinKey;
-    priceUSD?: string;
     logoURI?: string;
 }
+export interface Token extends StaticToken {
+    priceUSD: string;
+}
 export interface TokenAmount extends Token {
     amount: string;
     blockNumber?: number;
@@ -184,7 +188,7 @@ export interface Coin {
     logoURI: string;
     verified: boolean;
     chains: {
-        [ChainId: string]: Token;
+        [ChainId: string]: StaticToken;
     };
 }
 export interface ExchangeDefinition {
@@ -198,9 +202,9 @@ export interface ExchangeDefinition {
 export interface BridgeDefinition {
     tool: BridgeTool;
     fromChainId: number;
-    fromToken: Token;
+    fromToken: BaseToken;
     toChainId: number;
-    toToken: Token;
+    toToken: BaseToken;
     maximumTransfer: string;
     minimumTransfer: string;
     swapFeeRate: string;

package/dist/cjs/base.d.ts

@@ -164,16 +164,20 @@ export declare enum ChainId {
     FTMT = 4002,
     LNAT = 59140
 }
-export interface Token {
+export interface BaseToken {
+    chainId: ChainId;
     address: string;
+}
+export interface StaticToken extends BaseToken {
     symbol: string;
     decimals: number;
-    chainId: number;
     name: string;
     coinKey?: CoinKey;
-    priceUSD?: string;
     logoURI?: string;
 }
+export interface Token extends StaticToken {
+    priceUSD: string;
+}
 export interface TokenAmount extends Token {
     amount: string;
     blockNumber?: number;
@@ -184,7 +188,7 @@ export interface Coin {
     logoURI: string;
     verified: boolean;
     chains: {
-        [ChainId: string]: Token;
+        [ChainId: string]: StaticToken;
     };
 }
 export interface ExchangeDefinition {
@@ -198,9 +202,9 @@ export interface ExchangeDefinition {
 export interface BridgeDefinition {
     tool: BridgeTool;
     fromChainId: number;
-    fromToken: Token;
+    fromToken: BaseToken;
     toChainId: number;
-    toToken: Token;
+    toToken: BaseToken;
     maximumTransfer: string;
     minimumTransfer: string;
     swapFeeRate: string;

package/dist/cjs/coins.d.ts

@@ -1,9 +1,9 @@
-import { ChainId, Coin, CoinKey, Token } from './base';
+import { StaticToken, ChainId, Coin, CoinKey } from './base';
 export declare const defaultCoins: Array<Coin>;
 export declare const wrappedTokens: {
-    [ChainId: string]: Token;
+    [ChainId: string]: StaticToken;
 };
 export declare const findDefaultCoin: (coinKey: CoinKey) => Coin;
-export declare const findDefaultToken: (coinKey: CoinKey, chainId: ChainId) => Token;
-export declare const findWrappedGasOnChain: (chainId: ChainId) => Token;
-export declare const findTokenByChainIdAndAddress: (chainId: number, tokenAddress: string) => Token | null;
+export declare const findDefaultToken: (coinKey: CoinKey, chainId: ChainId) => StaticToken;
+export declare const findWrappedGasOnChain: (chainId: ChainId) => StaticToken;
+export declare const findTokenByChainIdAndAddress: (chainId: number, tokenAddress: string) => StaticToken | null;

package/dist/cjs/exchanges.d.ts

@@ -1,4 +1,4 @@
-import { Token } from '.';
+import { StaticToken } from '.';
 /**
  * @deprecated
  * These values are now obtainable from the LI.FI API
@@ -37,13 +37,12 @@ export interface Exchange {
     routerAddress: string;
     factoryAddress: string;
     initCodeHash: string;
-    baseTokens: readonly Token[];
+    baseTokens: readonly StaticToken[];
 }
 /**
  * @deprecated
  * These values are now obtainable from the LI.FI API
- */
-export declare const supportedExchanges: Array<Exchange>;
+ */ export declare const supportedExchanges: Array<Exchange>;
 /**
  * @deprecated
  * Available exchanges should be queried from the API

package/dist/cjs/exchanges.js

@@ -53,8 +53,7 @@ exports.supportedExchangeAggregators = [
 /**
  * @deprecated
  * These values are now obtainable from the LI.FI API
- */
-exports.supportedExchanges = [
+ */ exports.supportedExchanges = [
     // 1 - Ethereum
     {
         key: 'uniswap-eth',
@@ -851,7 +850,7 @@ exports.supportedExchanges = [
     //       symbol: 'fUSD',
     //       decimals: 18,
     //       chainId: ChainId.FUS,
-    //     } as Token,
+    //     } as StaticToken,
     //   ],
     // },
     {
@@ -953,19 +952,19 @@ exports.supportedExchanges = [
     //       symbol: 'STND',
     //       decimals: 18,
     //       chainId: ChainId.MAM,
-    //     } as Token,
+    //     } as StaticToken,
     //     {
     //       address: '0xea32a96608495e54156ae48931a7c20f0dcc1a21',
     //       symbol: 'm.USDC',
     //       decimals: 6,
     //       chainId: ChainId.MAM,
-    //     } as Token,
+    //     } as StaticToken,
     //     {
     //       address: '0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc',
     //       symbol: 'm.USDT',
     //       decimals: 6,
     //       chainId: ChainId.MAM,
-    //     } as Token,
+    //     } as StaticToken,
     //   ],
     // },
     // 288 Boba Network

package/dist/coins.d.ts

@@ -1,9 +1,9 @@
-import { ChainId, Coin, CoinKey, Token } from './base';
+import { StaticToken, ChainId, Coin, CoinKey } from './base';
 export declare const defaultCoins: Array<Coin>;
 export declare const wrappedTokens: {
-    [ChainId: string]: Token;
+    [ChainId: string]: StaticToken;
 };
 export declare const findDefaultCoin: (coinKey: CoinKey) => Coin;
-export declare const findDefaultToken: (coinKey: CoinKey, chainId: ChainId) => Token;
-export declare const findWrappedGasOnChain: (chainId: ChainId) => Token;
-export declare const findTokenByChainIdAndAddress: (chainId: number, tokenAddress: string) => Token | null;
+export declare const findDefaultToken: (coinKey: CoinKey, chainId: ChainId) => StaticToken;
+export declare const findWrappedGasOnChain: (chainId: ChainId) => StaticToken;
+export declare const findTokenByChainIdAndAddress: (chainId: number, tokenAddress: string) => StaticToken | null;

package/dist/exchanges.d.ts

@@ -1,4 +1,4 @@
-import { Token } from '.';
+import { StaticToken } from '.';
 /**
  * @deprecated
  * These values are now obtainable from the LI.FI API
@@ -37,13 +37,12 @@ export interface Exchange {
     routerAddress: string;
     factoryAddress: string;
     initCodeHash: string;
-    baseTokens: readonly Token[];
+    baseTokens: readonly StaticToken[];
 }
 /**
  * @deprecated
  * These values are now obtainable from the LI.FI API
- */
-export declare const supportedExchanges: Array<Exchange>;
+ */ export declare const supportedExchanges: Array<Exchange>;
 /**
  * @deprecated
  * Available exchanges should be queried from the API

package/dist/exchanges.js

@@ -50,8 +50,7 @@ export const supportedExchangeAggregators = [
 /**
  * @deprecated
  * These values are now obtainable from the LI.FI API
- */
-export const supportedExchanges = [
+ */ export const supportedExchanges = [
     // 1 - Ethereum
     {
         key: 'uniswap-eth',
@@ -848,7 +847,7 @@ export const supportedExchanges = [
     //       symbol: 'fUSD',
     //       decimals: 18,
     //       chainId: ChainId.FUS,
-    //     } as Token,
+    //     } as StaticToken,
     //   ],
     // },
     {
@@ -950,19 +949,19 @@ export const supportedExchanges = [
     //       symbol: 'STND',
     //       decimals: 18,
     //       chainId: ChainId.MAM,
-    //     } as Token,
+    //     } as StaticToken,
     //     {
     //       address: '0xea32a96608495e54156ae48931a7c20f0dcc1a21',
     //       symbol: 'm.USDC',
     //       decimals: 6,
     //       chainId: ChainId.MAM,
-    //     } as Token,
+    //     } as StaticToken,
     //     {
     //       address: '0xbb06dca3ae6887fabf931640f67cab3e3a16f4dc',
     //       symbol: 'm.USDT',
     //       decimals: 6,
     //       chainId: ChainId.MAM,
-    //     } as Token,
+    //     } as StaticToken,
     //   ],
     // },
     // 288 Boba Network

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lifi/types",
-  "version": "4.0.1",
+  "version": "5.1.0",
   "description": "Types for the LI.FI stack",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",