@debank/common

@debank/common

common library for debank frontend projects, including information about the chains supported in the business. Different businesses may support different chains. Please introduce different entries according to the business.

Install

yarn add @debank/common

Usage

import { CHAINS_LIST, CHAINS, CHAINS_ENUM } from '@debank/common'
import { type Chain } from '@debank/common'

CHAINS_LIST is order sensitive. CHAINS is a map of chain information, and CHAINS_ENUM is an enumeration of chain information, their keys' order is same with the order in CHAINS_LIST.

Entries

There are three entries in the library, which are used to describe the chain information supported by the business:

• default: @debank/common
• rabby: @debank/common/dist/index-rabby
• mainsite: @debank/common/dist/index-mainsite

// full
import { CHAINS_LIST, CHAINS, CHAINS_ENUM } from '@debank/common'
// rabby
import { CHAINS_LIST, CHAINS, CHAINS_ENUM } from '@debank/common/dist/index-rabby'

How to import

We guarantee all entries export those object/types:

• CHAINS_LIST: type, runtime variable
• CHAINS: type, runtime variable
• CHAINS_ENUM: enum, runtime variable
• Chain: type

So if your webpack-based project used to import ALL chains before, but from one moment, you customize the chain list and add one new entry (like '@debank/common/dist/index-rabby'), you can configure the resolve.alias to keep @debank/common in your project, just like:

// webpack.config.js
module.exports = {
  // ...
  resolve: {
    alias: {
      '@debank/common': '@debank/common/dist/index-rabby'
    }
  }
}

Why? CHAINS_ENUM exported from '@debank/common' is the real enum type in TypeScript, but the CHAINS_ENUM from '@debank/common/dist/index-rabby' is a const object which generated by enum type. You can use CHAINS_ENUM.ETH from '@debank/common' as enum, but you cannot use CHAINS_ENUM.ETH from '@debank/common/dist/index-rabby' as enum.

in Rabby project, we used to use CHAINS_ENUM as enum, but one day we need omit some chains at runtime, we don't want change all references of CHAINS_ENUM at Rabby, so we configure the resolve.alias to keep @debank/common in Rabby project, but at runtime it's actually @debank/common/dist/index-rabby.

If you never mind the enum type, e.g. you start a fresh project, you can use @debank/common/dist/index-rabby directly.

// full
import { CHAINS_LIST, CHAINS, CHAINS_ENUM } from '@debank/common'
// rabby
import { CHAINS_LIST, CHAINS, CHAINS_ENUM } from '@debank/common/dist/index-rabby'

Test

Test is often forgotten after it's written, but if you want to modified the CHAINS_LIST, before you publish it, the Test is forced to run to ensure the CHAINS_LIST works as you expected.

You may also want to know which chains are omitted in specific entry, you can run yarn test:d to see the details.