@venusprotocol/chains 0.8.2

package/README.md

@@ -0,0 +1,56 @@
+# Venus Protocol - chains package
+
+This package lists all the chain-related metadata for the Venus Protocol.
+
+## Chains
+
+Chain IDs are exported via the `ChainId` enum. Chains are exported via the `chains` constant.
+
+```ts
+import { chains, ChainId } from '@venusprotocol/chains';
+
+console.log(chains[ChainId.BSC_MAINNET].name); // Outputs "BNB Chain"
+```
+
+## Tokens
+
+### Retrieving tokens
+
+Tokens are exported via the `tokens` constant.
+
+```ts
+import { tokens, ChainId } from '@venusprotocol/chains';
+
+console.log(tokens[ChainId.BSC_MAINNET][0].symbol); // Outputs "XVS"
+```
+
+The library also exports a `getToken` function to retrieve a singular token on a given chain using
+its symbol. The `symbol` parameter is not case-sensitive.
+
+```ts
+import { getToken, ChainId } from '@venusprotocol/chains';
+
+const xvs = getToken({
+  chainId: ChainId.BSC_MAINNET,
+  symbol: 'XVS', //
+});
+
+console.log(xvs?.symbol); // Outputs "XVS"
+```
+
+The icon source of a vToken can be retrieved using the `getVTokenIconSrc` function:
+
+```ts
+import { getVTokenIconSrc, ChainId } from '@venusprotocol/chains';
+
+const vTokenIconSrc = getVTokenIconSrc({
+  chainId: ChainId.BSC_MAINNET,
+  vTokenAddress: '0x6bCa74586218dB34cdB402295796b79663d816e9', // vWBNB market
+});
+```
+
+### Adding a token
+
+Add the token icon into the [images](./images/tokens) directory, then run the command `yarn
+generate` to update the [token manifest](./src/generated/tokenManifest.json). You can then list the
+token in any of the [token metadata files](./src/tokens).

package/build/index.d.mts

@@ -0,0 +1,106 @@
+import { Address } from "viem";
+
+//#region src/types/index.d.ts
+declare enum ChainId {
+  BSC_MAINNET = 56,
+  BSC_TESTNET = 97,
+  ETHEREUM = 1,
+  SEPOLIA = 11155111,
+  OPBNB_MAINNET = 204,
+  OPBNB_TESTNET = 5611,
+  ARBITRUM_ONE = 42161,
+  ARBITRUM_SEPOLIA = 421614,
+  ZKSYNC_MAINNET = 324,
+  ZKSYNC_SEPOLIA = 300,
+  OPTIMISM_MAINNET = 10,
+  OPTIMISM_SEPOLIA = 11155420,
+  BASE_MAINNET = 8453,
+  BASE_SEPOLIA = 84532,
+  UNICHAIN_MAINNET = 130,
+  UNICHAIN_SEPOLIA = 1301,
+}
+declare enum MainnetChainId {
+  BSC_MAINNET = 56,
+  ETHEREUM = 1,
+  OPBNB_MAINNET = 204,
+  ARBITRUM_ONE = 42161,
+  ZKSYNC_MAINNET = 324,
+  OPTIMISM_MAINNET = 10,
+  BASE_MAINNET = 8453,
+  UNICHAIN_MAINNET = 130,
+}
+declare enum TestnetChainId {
+  BSC_TESTNET = 97,
+  SEPOLIA = 11155111,
+  OPBNB_TESTNET = 5611,
+  ARBITRUM_SEPOLIA = 421614,
+  ZKSYNC_SEPOLIA = 300,
+  OPTIMISM_SEPOLIA = 11155420,
+  BASE_SEPOLIA = 84532,
+  UNICHIAN_SEPOLIA = 1301,
+}
+interface Chain {
+  name: string;
+  iconSrc: string;
+  explorerUrl: string;
+  nativeToken: Token;
+  layerZeroScanUrl: string;
+  corePoolComptrollerContractAddress: Address;
+  safeWalletApiUrl?: string;
+  proposalExecutionGracePeriodMs?: number;
+  blockTimeMs?: number;
+  blocksPerDay?: number;
+}
+interface Token {
+  symbol: string;
+  decimals: number;
+  iconSrc: string;
+  address: Address;
+  isNative?: boolean;
+  tokenWrapped?: Token;
+}
+interface VToken extends Omit<Token, 'isNative' | 'iconSrc' | 'tokenWrapped'> {
+  decimals: 8;
+  underlyingToken: Token;
+  iconSrc?: string;
+}
+type VTokenIconUrlMapping = Record<string, string>;
+//#endregion
+//#region src/constants/index.d.ts
+declare const NATIVE_TOKEN_ADDRESS: "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB";
+declare const IMAGES_DIR_NAME = "images";
+declare const IMAGES_DIR_PATH = "src/images";
+//#endregion
+//#region src/chains/index.d.ts
+declare const chains: { [chainId in ChainId]: Chain };
+//#endregion
+//#region src/tokens/underlyingTokens/index.d.ts
+declare const tokens: { [chainId in ChainId]: Token[] };
+//#endregion
+//#region src/tokens/vTokenIconSrcs/index.d.ts
+declare const vTokens: Record<ChainId, VTokenIconUrlMapping>;
+//#endregion
+//#region src/tokens/nativeTokens/index.d.ts
+declare const eth: Token;
+declare const bnb: Token;
+//#endregion
+//#region src/utilities/getToken/index.d.ts
+interface GetTokenInput {
+  chainId: ChainId;
+  symbol: string;
+}
+declare const getToken: ({
+  chainId,
+  symbol
+}: GetTokenInput) => Token | undefined;
+//#endregion
+//#region src/utilities/getVTokenIconSrc/index.d.ts
+declare const getVTokenIconSrc: ({
+  vTokenAddress,
+  chainId
+}: {
+  vTokenAddress: string;
+  chainId: ChainId;
+}) => string | undefined;
+//#endregion
+export { Chain, ChainId, GetTokenInput, IMAGES_DIR_NAME, IMAGES_DIR_PATH, MainnetChainId, NATIVE_TOKEN_ADDRESS, TestnetChainId, Token, VToken, VTokenIconUrlMapping, bnb, chains, eth, getToken, getVTokenIconSrc, tokens, vTokens };