feat!: introduce Base and StaticToken and make priceUSD in Token requ…

…ired (#153) * fix: baseToken wont contain price information * fix: add StaticToken and update BaseToken types * fix: chainId should have type ChainId --------- Co-authored-by: Daniela Chybisova <iron.melmel@gmail.com>
lifinance · Apr 25, 2023 · 85b9ab1 · 85b9ab1
1 parent 6aa9253
commit 85b9ab1
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 63 deletions.
diff --git a/src/base.ts b/src/base.ts
@@ -178,17 +178,22 @@ export enum ChainId {
   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
@@ -200,7 +205,7 @@ export interface Coin {
   logoURI: string
   verified: boolean
   chains: {
-    [ChainId: string]: Token
+    [ChainId: string]: StaticToken
   }
 }
 
@@ -216,9 +221,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

diff --git a/src/coins.ts b/src/coins.ts
@@ -1,4 +1,4 @@
-import { ChainId, Coin, CoinKey, Token } from './base'
+import { StaticToken, ChainId, Coin, CoinKey, BaseToken } from './base'
 
 type BasicToken = {
   address: string
@@ -1343,7 +1343,7 @@ export const defaultCoins: Array<Coin> = basicCoins.map((coin) => {
 })
 
 // Wrapped version of gas on chain
-export const wrappedTokens: { [ChainId: string]: Token } = {
+export const wrappedTokens: { [ChainId: string]: StaticToken } = {
   [ChainId.ETH]: {
     // https://ww7.etherscan.io/token/0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2
     address: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
@@ -1659,7 +1659,10 @@ export const findDefaultCoin = (coinKey: CoinKey): Coin => {
   }
   return coin
 }
-export const findDefaultToken = (coinKey: CoinKey, chainId: ChainId): Token => {
+export const findDefaultToken = (
+  coinKey: CoinKey,
+  chainId: ChainId
+): StaticToken => {
   const coin = findDefaultCoin(coinKey)
   const token = coin.chains[chainId]
   if (!token) {
@@ -1668,7 +1671,7 @@ export const findDefaultToken = (coinKey: CoinKey, chainId: ChainId): Token => {
   return token
 }
 
-export const findWrappedGasOnChain = (chainId: ChainId): Token => {
+export const findWrappedGasOnChain = (chainId: ChainId): StaticToken => {
   const token = wrappedTokens[chainId]
   if (!token) {
     throw new Error(`Wrapped Gas Token not defined for chain ${chainId}.`)
@@ -1679,11 +1682,11 @@ export const findWrappedGasOnChain = (chainId: ChainId): Token => {
 export const findTokenByChainIdAndAddress = (
   chainId: number,
   tokenAddress: string
-): Token | null => {
-  let token: Token | null = null
+): StaticToken | null => {
+  let token: StaticToken | null = null
 
   defaultCoins.forEach((coin) => {
-    Object.values(coin.chains).forEach((coinToken: Token) => {
+    Object.values(coin.chains).forEach((coinToken: StaticToken) => {
       if (coinToken.chainId === chainId && coinToken.address === tokenAddress) {
         token = coinToken
       }