Expose mapping between chainIds and Networks (#983)

Author: Smrecz

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [4.1.6] - 2023.10.15
+### Added
+- `TatumUtils` added with access to chainId <-> `Network` mapping
+
 ## [4.1.5] - 2023.10.13
 ### Changed
 - Loosen types for extension usage to better support optional configs.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tatumio/tatum",
-  "version": "4.1.5",
+  "version": "4.1.6",
   "description": "Tatum JS SDK",
   "author": "Tatum",
   "repository": "https://github.com/tatumio/tatum-js",

src/e2e/tatum.spec.ts

@@ -1,5 +1,6 @@
-import { Network } from '../dto'
+import { EVM_BASED_NETWORKS, Network } from '../dto'
 import { Bitcoin, TatumSDK } from '../service'
+import { TatumUtils } from '../util'
 
 describe('Tatum Init', () => {
   describe('IP auth', () => {
@@ -42,3 +43,15 @@ describe('Tatum Init', () => {
     })
   })
 })
+describe('Network to chainId mapping check', () => {
+  const networks = Object.values(EVM_BASED_NETWORKS)
+
+  for (const network of networks) {
+    it(`${network} should have chainId mapped`, async () => {
+      const chainId = TatumUtils.getChainId(network)
+
+      expect(chainId).toBeGreaterThan(0)
+      expect(TatumUtils.getNetwork(chainId as number)).toBe(network)
+    })
+  }
+})

src/util/constant.ts

@@ -6,6 +6,57 @@ export const Constant = {
     V4: 'https://api.tatum.io/v4/',
   },
   NETWORK: {
+    ChainId: {
+      [Network.ETHEREUM]: 1,
+      [Network.ETHEREUM_SEPOLIA]: 11155111,
+      [Network.ETHEREUM_CLASSIC]: 61,
+      [Network.ETHEREUM_GOERLI]: 5,
+      [Network.ETHEREUM_HOLESKY]: 17000,
+      [Network.AVALANCHE_C]: 43114,
+      [Network.AVALANCHE_C_TESTNET]: 43113,
+      [Network.POLYGON]: 137,
+      [Network.POLYGON_MUMBAI]: 80001,
+      [Network.GNOSIS]: 100,
+      [Network.FANTOM]: 250,
+      [Network.FANTOM_TESTNET]: 4002,
+      [Network.AURORA]: 1313161554,
+      [Network.AURORA_TESTNET]: 1313161555,
+      [Network.CELO]: 42220,
+      [Network.CELO_ALFAJORES]: 44787,
+      [Network.BINANCE_SMART_CHAIN_TESTNET]: 97,
+      [Network.PALM]: 11297108109,
+      [Network.PALM_TESTNET]: 11297108099,
+      [Network.CRONOS]: 25,
+      [Network.CRONOS_TESTNET]: 338,
+      [Network.KUCOIN]: 321,
+      [Network.KUCOIN_TESTNET]: 322,
+      [Network.OASIS]: 42262,
+      [Network.OASIS_TESTNET]: 42261,
+      [Network.OPTIMISM]: 10,
+      [Network.HARMONY_ONE_SHARD_0]: 1666600000,
+      [Network.HARMONY_ONE_TESTNET_SHARD_0]: 1666700000,
+      [Network.KLAYTN]: 8217,
+      [Network.KLAYTN_BAOBAB]: 1001,
+      [Network.FLARE_COSTON]: 16,
+      [Network.FLARE_COSTON_2]: 114,
+      [Network.FLARE]: 14,
+      [Network.FLARE_SONGBIRD]: 19,
+      [Network.HAQQ]: 11235,
+      [Network.HAQQ_TESTNET]: 54211,
+      [Network.ARBITRUM_NOVA]: 42170,
+      [Network.ARBITRUM_NOVA_TESTNET]: 421613,
+      [Network.ARBITRUM_ONE]: 42161,
+      [Network.BINANCE_SMART_CHAIN]: 56,
+      [Network.HORIZEN_EON]: 7332,
+      [Network.HORIZEN_EON_GOBI]: 1663,
+      [Network.CHILIZ]: 88888,
+      [Network.GNOSIS_TESTNET]: 10200,
+      [Network.VECHAIN]: 100009,
+      [Network.VECHAIN_TESTNET]: 100010,
+      [Network.XDC]: 50,
+      [Network.XDC_TESTNET]: 51,
+      [Network.OPTIMISM_TESTNET]: 420,
+    },
     ChainMapInverse: {
       [AddressEventNotificationChain.ETH]: Chain.Ethereum,
       [AddressEventNotificationChain.SOL]: Chain.Solana,

src/util/index.ts

@@ -1,4 +1,5 @@
 export * from './constant'
 export * from './di.tokens'
 export * from './error'
+export * from './tatum.utils'
 export * from './util.shared'

src/util/tatum.utils.ts

@@ -0,0 +1,26 @@
+import { Network } from '../dto'
+import { Constant } from './constant'
+
+export const TatumUtils = {
+  getChainId: (network: Network): number | undefined => {
+    if (network in Constant.NETWORK.ChainId) {
+      return Constant.NETWORK.ChainId[network as keyof typeof Constant.NETWORK.ChainId]
+    }
+    return undefined
+  },
+  getNetwork: (chainId: number): keyof typeof Constant.NETWORK.ChainId | undefined => {
+    if (Object.keys(chainIdToNetworkCache).length === 0) {
+      buildChainIdToNetworkCache()
+    }
+    return chainIdToNetworkCache[chainId] || undefined
+  },
+}
+
+const chainIdToNetworkCache: { [key: number]: keyof typeof Constant.NETWORK.ChainId } = {}
+
+const buildChainIdToNetworkCache = () => {
+  for (const network of Object.keys(Constant.NETWORK.ChainId)) {
+    const netKey = network as keyof typeof Constant.NETWORK.ChainId
+    chainIdToNetworkCache[Constant.NETWORK.ChainId[netKey]] = netKey
+  }
+}