@swapkit/types 0.2.3 → 0.3.0

package/src/chains/evm.ts

@@ -0,0 +1,346 @@
+import { createChain } from "./_createChain";
+import { Chain, ChainId } from "./_enums";
+
+const type = "evm";
+const baseDecimal = 18;
+const networkDerivationPath = [44, 60, 0, 0, 0] as [number, number, number, number, number];
+
+const ETHConfig = createChain({
+  baseDecimal,
+  blockTime: 12.5,
+  chain: Chain.Ethereum,
+  chainId: ChainId.Ethereum,
+  chainIdHex: "0x1",
+  explorerUrl: "https://etherscan.io",
+  name: "Ethereum",
+  nativeCurrency: "ETH",
+  networkDerivationPath,
+  rpcUrls: ["https://ethereum-rpc.publicnode.com", "https://eth.llamarpc.com", "https://cloudflare-eth.com"],
+  type,
+});
+
+const BSCConfig = createChain({
+  baseDecimal,
+  blockTime: 1,
+  chain: Chain.BinanceSmartChain,
+  chainId: ChainId.BinanceSmartChain,
+  chainIdHex: "0x38",
+  explorerUrl: "https://bscscan.com",
+  name: "BinanceSmartChain",
+  nativeCurrency: "BNB",
+  networkDerivationPath,
+  rpcUrls: [
+    "https://bsc-dataseed.binance.org",
+    "https://bsc-rpc.gateway.pokt.network",
+    "https://bsc-dataseed2.binance.org",
+  ],
+  type,
+});
+
+const AVAXConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Avalanche,
+  chainId: ChainId.Avalanche,
+  chainIdHex: "0xa86a",
+  explorerUrl: "https://snowtrace.io",
+  name: "Avalanche",
+  nativeCurrency: "AVAX",
+  networkDerivationPath,
+  rpcUrls: [
+    "https://api.avax.network/ext/bc/C/rpc",
+    "https://api.avax.network/ext/bc/C/rpc",
+    "https://avalanche-c-chain-rpc.publicnode.com",
+  ],
+  type,
+});
+
+const POLConfig = createChain({
+  baseDecimal,
+  blockTime: 2.1,
+  chain: Chain.Polygon,
+  chainId: ChainId.Polygon,
+  chainIdHex: "0x89",
+  explorerUrl: "https://polygonscan.com",
+  name: "Polygon",
+  nativeCurrency: "POL",
+  networkDerivationPath,
+  rpcUrls: ["https://polygon-rpc.com", "https://polygon.llamarpc.com", "https://polygon-bor-rpc.publicnode.com"],
+  type,
+});
+
+const ARBConfig = createChain({
+  baseDecimal,
+  blockTime: 0.3,
+  chain: Chain.Arbitrum,
+  chainId: ChainId.Arbitrum,
+  chainIdHex: "0xa4b1",
+  explorerUrl: "https://arbiscan.io",
+  name: "Arbitrum",
+  nativeCurrency: "ETH",
+  networkDerivationPath,
+  rpcUrls: [
+    "https://arb1.arbitrum.io/rpc",
+    "https://arb-mainnet.g.alchemy.com/v2/demo",
+    "https://arbitrum.blockpi.network/v1/rpc/public",
+  ],
+  type,
+});
+
+const OPConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Optimism,
+  chainId: ChainId.Optimism,
+  chainIdHex: "0xa",
+  explorerUrl: "https://optimistic.etherscan.io",
+  name: "Optimism",
+  nativeCurrency: "ETH",
+  networkDerivationPath,
+  rpcUrls: ["https://mainnet.optimism.io", "https://optimism.llamarpc.com", "https://1rpc.io/op"],
+  type,
+});
+
+const BASEConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Base,
+  chainId: ChainId.Base,
+  chainIdHex: "0x2105",
+  explorerUrl: "https://basescan.org",
+  name: "Base",
+  nativeCurrency: "ETH",
+  networkDerivationPath,
+  rpcUrls: ["https://base-rpc.publicnode.com", "https://base.blockpi.network/v1/rpc/public", "https://1rpc.io/base"],
+  type,
+});
+
+const GNOConfig = createChain({
+  baseDecimal,
+  blockTime: 5.2,
+  chain: Chain.Gnosis,
+  chainId: ChainId.Gnosis,
+  chainIdHex: "0x64",
+  explorerUrl: "https://gnosisscan.io",
+  name: "Gnosis",
+  nativeCurrency: "xDAI",
+  networkDerivationPath,
+  rpcUrls: ["https://gnosis-rpc.publicnode.com", "https://gnosis.drpc.org", "https://rpc.ankr.com/gnosis"],
+  type,
+});
+
+const AURORAConfig = createChain({
+  baseDecimal,
+  blockTime: 1,
+  chain: Chain.Aurora,
+  chainId: ChainId.Aurora,
+  chainIdHex: "0x4e454152",
+  explorerUrl: "https://explorer.mainnet.aurora.dev",
+  name: "Aurora",
+  nativeCurrency: "ETH",
+  networkDerivationPath,
+  rpcUrls: ["https://aurora-rpc.publicnode.com", "https://1rpc.io/aurora", "https://mainnet.aurora.dev"],
+  type,
+});
+
+const BERAConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Berachain,
+  chainId: ChainId.Berachain,
+  chainIdHex: "0x138de",
+  explorerUrl: "https://berascan.com",
+  name: "Berachain",
+  nativeCurrency: "BERA",
+  networkDerivationPath,
+  rpcUrls: ["https://berachain-rpc.publicnode.com", "https://rpc.berachain.com", "https://berachain.drpc.org"],
+  type,
+});
+
+const HYPEREVMConfig = createChain({
+  baseDecimal,
+  blockTime: 1,
+  chain: Chain.Hyperevm,
+  chainId: ChainId.Hyperevm,
+  chainIdHex: "0x3e7",
+  explorerUrl: "https://app.hyperliquid.xyz/explorer",
+  name: "Hyperliquid",
+  nativeCurrency: "HYPE",
+  networkDerivationPath,
+  rpcUrls: ["https://rpc.hyperliquid.xyz/evm", "https://rpc.hypurrscan.io"],
+  type,
+});
+
+const UNIConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Unichain,
+  chainId: ChainId.Unichain,
+  chainIdHex: "0x82",
+  explorerUrl: "https://unichain.blockscout.com",
+  name: "Unichain",
+  nativeCurrency: "ETH",
+  networkDerivationPath,
+  rpcUrls: ["https://unichain-rpc.publicnode.com", "https://unichain.drpc.org"],
+  type,
+});
+
+const CORNConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Corn,
+  chainId: ChainId.Corn,
+  chainIdHex: "0x1406f40",
+  explorerUrl: "https://cornscan.io",
+  name: "Corn",
+  nativeCurrency: "BTCN",
+  networkDerivationPath,
+  rpcUrls: ["https://mainnet.corn-rpc.com", "https://rpc.ankr.com/corn_maizenet"],
+  type,
+});
+
+const COREConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Core,
+  chainId: ChainId.Core,
+  chainIdHex: "0x45c",
+  explorerUrl: "https://corescan.io",
+  name: "Core",
+  nativeCurrency: "CORE",
+  networkDerivationPath,
+  rpcUrls: ["https://core-rpc.publicnode.com", "https://1rpc.io/core"],
+  type,
+});
+
+const BOTANIXConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Botanix,
+  chainId: ChainId.Botanix,
+  chainIdHex: "0xe35",
+  explorerUrl: "https://botanixscan.io",
+  name: "Botanix",
+  nativeCurrency: "BTC",
+  networkDerivationPath,
+  rpcUrls: ["https://core.drpc.org", "https://1rpc.io/core"],
+  type,
+});
+
+const CROConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Cronos,
+  chainId: ChainId.Cronos,
+  chainIdHex: "0x19",
+  explorerUrl: "https://croscan.io",
+  name: "Cronos",
+  nativeCurrency: "CRO",
+  networkDerivationPath,
+  rpcUrls: ["https://rpc.vvs.finance"],
+  type,
+});
+
+const XLAYERConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.XLayer,
+  chainId: ChainId.XLayer,
+  chainIdHex: "0xc4",
+  explorerUrl: "https://www.oklink.com/x-layer",
+  name: "X Layer",
+  nativeCurrency: "OKB",
+  networkDerivationPath,
+  rpcUrls: ["https://xlayerrpc.okx.com"],
+  type,
+});
+
+const SONICConfig = createChain({
+  baseDecimal,
+  blockTime: 2,
+  chain: Chain.Sonic,
+  chainId: ChainId.Sonic,
+  chainIdHex: "0x92",
+  explorerUrl: "https://sonicscan.io",
+  name: "Sonic",
+  nativeCurrency: "S",
+  networkDerivationPath,
+  rpcUrls: ["https://rpc.sonic.xyz"],
+  type,
+});
+
+const MONADConfig = createChain({
+  baseDecimal,
+  blockTime: 0.4,
+  chain: Chain.Monad,
+  chainId: ChainId.Monad,
+  chainIdHex: "0x8f",
+  explorerUrl: "https://monvision.io",
+  name: "Monad",
+  nativeCurrency: "MON",
+  networkDerivationPath,
+  rpcUrls: [],
+  type,
+});
+
+const MEGAETHConfig = createChain({
+  baseDecimal,
+  blockTime: 0.01,
+  chain: Chain.MegaETH,
+  chainId: ChainId.MegaETH,
+  chainIdHex: "0x10e6",
+  explorerUrl: "",
+  name: "MegaETH",
+  nativeCurrency: "ETH",
+  networkDerivationPath,
+  rpcUrls: [],
+  type,
+});
+
+export const EVMChainConfigs = [
+  ARBConfig,
+  AURORAConfig,
+  AVAXConfig,
+  BASEConfig,
+  BERAConfig,
+  BOTANIXConfig,
+  BSCConfig,
+  COREConfig,
+  CORNConfig,
+  CROConfig,
+  ETHConfig,
+  GNOConfig,
+  HYPEREVMConfig,
+  MEGAETHConfig,
+  MONADConfig,
+  OPConfig,
+  POLConfig,
+  SONICConfig,
+  UNIConfig,
+  XLAYERConfig,
+] as const;
+export const EVMChains = [
+  Chain.Arbitrum,
+  Chain.Aurora,
+  Chain.Avalanche,
+  Chain.Base,
+  Chain.Berachain,
+  Chain.BinanceSmartChain,
+  Chain.Botanix,
+  Chain.Core,
+  Chain.Corn,
+  Chain.Corn,
+  Chain.Cronos,
+  Chain.Ethereum,
+  Chain.Gnosis,
+  Chain.Hyperevm,
+  // TODO: Enable once live
+  // Chain.MegaETH,
+  // Chain.Monad,
+  Chain.Optimism,
+  Chain.Polygon,
+  Chain.Sonic,
+  Chain.Unichain,
+  Chain.XLayer,
+] as const;
+export type EVMChain = (typeof EVMChains)[number];

package/src/chains/index.ts

@@ -0,0 +1,149 @@
+import { Chain, type ChainId, StagenetChain } from "./_enums";
+import { CosmosChainConfigs, StagenetMAYAConfig, StagenetTHORConfig } from "./cosmos";
+import { EVMChainConfigs } from "./evm";
+import { OtherChainConfigs } from "./others";
+import { SubstrateChainConfigs } from "./substrate";
+import { UTXOChainConfigs } from "./utxo";
+
+export * from "./_enums";
+export * from "./cosmos";
+export * from "./evm";
+export * from "./others";
+export * from "./substrate";
+export * from "./utxo";
+
+export const AllChainConfigs = [
+  ...UTXOChainConfigs,
+  ...EVMChainConfigs,
+  ...CosmosChainConfigs,
+  ...SubstrateChainConfigs,
+  ...OtherChainConfigs,
+].sort((a, b) => a.chain.localeCompare(b.chain));
+export type AllChainConfigs = typeof AllChainConfigs;
+export type ChainConfig = AllChainConfigs[number];
+
+export const AllChains = Object.values(Chain);
+export const StagenetChains = [StagenetChain.THORChain, StagenetChain.Maya] as const;
+
+type ChainConfigMap = {
+  [K in ChainConfig["chain"]]: Extract<ChainConfig, { chain: K }>;
+} & {
+  [K in ChainConfig["chainId"]]: Extract<ChainConfig, { chainId: K }>;
+};
+
+const chainConfigs = AllChainConfigs.reduce(
+  (acc, config) => {
+    acc[config.chain] = config;
+    acc[config.chainId] = config;
+    return acc;
+  },
+  {} as Record<ChainConfig["chain"] | ChainConfig["chainId"], ChainConfig>,
+);
+
+export function getChainConfig<T extends keyof ChainConfigMap>(chainOrChainId: T): ChainConfigMap[T] {
+  const chainConfig = chainConfigs[chainOrChainId];
+
+  return (chainConfig || {}) as ChainConfigMap[T];
+}
+
+const { chainIdToChain, chainToBaseDecimal, chainToBlockTime, explorerUrls, rpcUrls } = AllChains.reduce(
+  (acc, chain) => {
+    const { chainId, baseDecimal, blockTime, explorerUrl, rpcUrls } = getChainConfig(chain);
+
+    acc.chainIdToChain[chainId] = chain;
+    acc.chainToBaseDecimal[chain] = baseDecimal;
+    acc.chainToBlockTime[chain] = blockTime;
+    acc.explorerUrls[chain] = explorerUrl;
+    acc.rpcUrls[chain] = rpcUrls[0] || "";
+    return acc;
+  },
+  {
+    chainIdToChain: {},
+    chainToBaseDecimal: {},
+    chainToBlockTime: {},
+    explorerUrls: {},
+    rpcUrls: {
+      [StagenetChain.Maya]: StagenetMAYAConfig.rpcUrls[0],
+      [StagenetChain.THORChain]: StagenetTHORConfig.rpcUrls[0],
+    },
+  } as {
+    chainIdToChain: Record<ChainId, Chain>;
+    chainToBaseDecimal: Record<Chain, number>;
+    chainToBlockTime: Record<Chain, number>;
+    explorerUrls: Record<Chain, string>;
+    rpcUrls: Record<Chain | StagenetChain, string>;
+  },
+);
+
+export const NODE_URLS = {
+  [Chain.THORChain]: "https://thornode.ninerealms.com",
+  [Chain.Maya]: "https://mayanode.mayachain.info",
+  [StagenetChain.THORChain]: "https://stagenet-thornode.ninerealms.com",
+  [StagenetChain.Maya]: "https://stagenet.mayanode.mayachain.info",
+};
+
+/**
+ * @example
+ * ```diff
+ * -const rpcUrl = RPC_URLS[Chain.Ethereum];
+ * +const { rpcUrls: [rpcUrl] } = getChainConfig(Chain.Ethereum);
+ * ```
+ */
+export const RPC_URLS: Record<Chain | StagenetChain, string> = rpcUrls;
+
+/**
+ * @example
+ * ```diff
+ * -const explorerUrl = EXPLORER_URLS[Chain.Ethereum];
+ * +const { explorerUrl } = getChainConfig(Chain.Ethereum);
+ */
+export const EXPLORER_URLS: Record<Chain, string> = explorerUrls;
+
+/**
+ *
+ * Note: ChainIdToChain will be discontinued in future versions.
+ * Please use getChainConfig instead.
+ * @example
+ * ```diff
+ * -const chainId = ChainToChainId[Chain.Ethereum];
+ * +const { chainId } = getChainConfig(Chain.Ethereum);
+ * ```
+ */
+export const ChainToChainId = Object.fromEntries(
+  AllChainConfigs.flatMap(({ chain, chainId }) => [[chain, chainId] as const]),
+) as {
+  readonly [K in Chain | StagenetChain]: Extract<ChainConfig, { chain: K }>["chainId"];
+};
+
+/**
+ * Note: ChainIdToChain will be discontinued in future versions.
+ * Please use getChainConfig instead.
+ * @example
+ * ```diff
+ * -const chain = ChainIdToChain[ChainId.Ethereum];
+ * +const { chain } = getChainConfig(ChainId.Ethereum);
+ * ```
+ */
+export const ChainIdToChain = chainIdToChain;
+
+/**
+ * Note: BaseDecimal will be discontinued in future versions.
+ * Please use getChainConfig instead.
+ * @example
+ * ```diff
+ * -const baseDecimal = BaseDecimal[Chain.Ethereum];
+ * +const { baseDecimal } = getChainConfig(Chain.Ethereum);
+ * ```
+ */
+export const BaseDecimal = chainToBaseDecimal;
+
+/**
+ * Note: BlockTimes will be discontinued in future versions.
+ * Please use getChainConfig instead.
+ * @example
+ * ```diff
+ * -const blockTime = BlockTimes[Chain.Ethereum];
+ * +const { blockTime } = getChainConfig(Chain.Ethereum);
+ * ```
+ */
+export const BlockTimes = chainToBlockTime;

package/src/chains/others.ts

@@ -0,0 +1,130 @@
+import { createChain } from "./_createChain";
+import { Chain, ChainId } from "./_enums";
+
+const type = "others";
+
+const NEAR = createChain({
+  baseDecimal: 24,
+  blockTime: 1,
+  chain: Chain.Near,
+  chainId: ChainId.Near,
+  explorerUrl: "https://nearblocks.io",
+  name: "Near",
+  nativeCurrency: "NEAR",
+  networkDerivationPath: [44, 397, 0, 0, 0],
+  rpcUrls: [
+    "https://rpc.mainnet.near.org",
+    "https://1rpc.io/near",
+    "https://near.lava.build",
+    "https://near-mainnet.infura.io/v3/3cbfcafa5e1e48b7bb0ea41f2fbc4abf",
+  ],
+  type,
+});
+
+const XRD = createChain({
+  baseDecimal: 18,
+  blockTime: 5,
+  chain: Chain.Radix,
+  chainId: ChainId.Radix,
+  explorerUrl: "https://dashboard.radixdlt.com",
+  name: "Radix",
+  nativeCurrency: "XRD",
+  networkDerivationPath: [0, 0, 0, 0, 0],
+  rpcUrls: [
+    "https://radix-mainnet.rpc.grove.city/v1/326002fc/core",
+    "https://mainnet.radixdlt.com",
+    "https://radix-mainnet.rpc.grove.city/v1",
+  ],
+  type,
+});
+
+const XRP = createChain({
+  baseDecimal: 6,
+  blockTime: 5,
+  chain: Chain.Ripple,
+  chainId: ChainId.Ripple,
+  explorerUrl: "https://livenet.xrpl.org/",
+  name: "Ripple",
+  nativeCurrency: "XRP",
+  networkDerivationPath: [44, 144, 0, 0, 0],
+  rpcUrls: ["wss://xrpl.ws/", "wss://s1.ripple.com/", "wss://s2.ripple.com/"],
+  type,
+});
+
+const SOL = createChain({
+  baseDecimal: 9,
+  blockTime: 0.4,
+  chain: Chain.Solana,
+  chainId: ChainId.Solana,
+  explorerUrl: "https://solscan.io",
+  name: "Solana",
+  nativeCurrency: "SOL",
+  networkDerivationPath: [44, 501, 0, 0, 0],
+  rpcUrls: [
+    "https://solana-rpc.publicnode.com",
+    "https://api.mainnet-beta.solana.com",
+    "https://solana-mainnet.rpc.extrnode.com",
+  ],
+  type,
+});
+
+const TON = createChain({
+  baseDecimal: 9,
+  blockTime: 5,
+  chain: Chain.Ton,
+  chainId: ChainId.Ton,
+  explorerUrl: "https://tonscan.org",
+  name: "Ton",
+  nativeCurrency: "TON",
+  networkDerivationPath: [44, 607, 0, 0, 0],
+  rpcUrls: [
+    "https://ton.api.onfinality.io/public",
+    "https://ton.drpc.org/rest/",
+    "https://toncenter.com/api/v2/jsonRPC",
+  ],
+  type,
+});
+
+const TRON = createChain({
+  baseDecimal: 6,
+  blockTime: 3,
+  chain: Chain.Tron,
+  chainId: ChainId.Tron,
+  chainIdHex: "0x2b6653dc",
+  explorerUrl: "https://tronscan.org",
+  name: "Tron",
+  nativeCurrency: "TRX",
+  networkDerivationPath: [44, 195, 0, 0, 0],
+  rpcUrls: ["https://tron-rpc.publicnode.com", "https://api.tronstack.io", "https://api.tron.network"],
+  type,
+});
+
+const SUI = createChain({
+  baseDecimal: 9,
+  blockTime: 5,
+  chain: Chain.Sui,
+  chainId: ChainId.Sui,
+  explorerUrl: "https://suiscan.xyz",
+  name: "Sui",
+  nativeCurrency: "SUI",
+  networkDerivationPath: [44, 784, 0, 0, 0],
+  rpcUrls: ["https://fullnode.mainnet.sui.io:443"],
+  type,
+});
+
+const ADA = createChain({
+  baseDecimal: 6,
+  blockTime: 600,
+  chain: Chain.Cardano,
+  chainId: ChainId.Cardano,
+  explorerUrl: "https://cexplorer.io",
+  name: "Cardano",
+  nativeCurrency: "ADA",
+  networkDerivationPath: [1852, 1815, 0, 0, 0],
+  rpcUrls: ["https://api.koios.rest/api/v1", "https://cardano-mainnet.blockfrost.io/api/v0"],
+  type,
+});
+
+export const OtherChainConfigs = [NEAR, XRD, XRP, SOL, TON, TRON, SUI, ADA] as const;
+export const OtherChains = OtherChainConfigs.map((config) => config.chain);
+export type OtherChain = (typeof OtherChains)[number];

package/src/chains/substrate.ts

@@ -0,0 +1,51 @@
+import { createChain } from "./_createChain";
+import { Chain, ChainId } from "./_enums";
+
+const type = "substrate";
+
+const DOT = createChain({
+  baseDecimal: 10,
+  blockTime: 6,
+  chain: Chain.Polkadot,
+  chainId: ChainId.Polkadot,
+  explorerUrl: "https://polkadot.subscan.io",
+  name: "Polkadot",
+  nativeCurrency: "DOT",
+  networkDerivationPath: [0, 0, 0, 0, 0],
+  rpcUrls: ["wss://rpc.polkadot.io", "wss://polkadot-rpc.dwellir.com", "wss://polkadot.api.onfinality.io/public-ws"],
+  type,
+});
+
+const FLIP = createChain({
+  baseDecimal: 18,
+  blockTime: 5,
+  chain: Chain.Chainflip,
+  chainId: ChainId.Chainflip,
+  explorerUrl: "https://explorer.polkascan.io/polkadot",
+  name: "Chainflip",
+  nativeCurrency: "FLIP",
+  networkDerivationPath: [0, 0, 0, 0, 0],
+  rpcUrls: [
+    "wss://mainnet-archive.chainflip.io",
+    "wss://archive-1.mainnet.chainflip.io",
+    "wss://archive-2.mainnet.chainflip.io",
+  ],
+  type,
+});
+
+// const TAO = createChain({
+//   baseDecimal: 18,
+//   blockTime: 5,
+//   chain: Chain.TAO,
+//   chainId: ChainId.TAO,
+//   explorerUrl: "https://taoscan.io",
+//   name: "TAO",
+//   nativeCurrency: "TAO",
+//   networkDerivationPath: [0, 0, 0, 0, 0],
+//   rpcUrls: ["wss://rpc.tao.network"],
+//   type,
+// });
+
+export const SubstrateChainConfigs = [DOT, FLIP] as const;
+export const SubstrateChains = [Chain.Polkadot, Chain.Chainflip] as const;
+export type SubstrateChain = (typeof SubstrateChains)[number];