@w3-kit/registry

Chain, token, Solana program, and ABI registry for web3 development.

Install

npm install @w3-kit/registry

Usage

import {
  getChain,
  getToken,
  getAllChains,
  getChainsByEcosystem,
  getSolanaProgram,
  getSolanaProgramByAddress,
} from "@w3-kit/registry";

// Get a chain by ID
const ethereum = getChain(1);

// Get all EVM chains
const evmChains = getChainsByEcosystem("evm");

// Get a token by symbol
const usdc = getToken("USDC");

// Get a Solana program by key
const splTokenProgram = getSolanaProgram("spl-token");

// Reverse lookup a Solana program deployment
const raydium = getSolanaProgramByAddress(
  "675kPX9MHTjS2zt1qfr1NYHuzeLXfQM9H24wFSUt1Mp8",
  "mainnet-beta",
);

Validation

Registry data is validated in CI before merge. Run the validation gate locally with:

npm run validate

The validator checks schema shape, URLs, chain references, duplicate identifiers, and ecosystem-specific token identifiers.

API

Function	Description
getAllChains()	Get all chains
getChain(chainId)	Get chain by ID
getChainsByEcosystem(eco)	Filter chains by ecosystem
getAllTokens()	Get all tokens
getToken(symbol)	Get token by symbol
getTokensByChain(chainId)	Get tokens on a chain
getAllSolanaPrograms()	Get all registered Solana programs
getSolanaProgram(key)	Get Solana program by stable key
getSolanaProgramsByCluster(cluster)	Filter Solana programs by cluster
getSolanaProgramByAddress(programId, cluster)	Reverse lookup a Solana program deployment

Types

import type {
  Chain,
  Token,
  SolanaProgram,
  SolanaCluster,
  ChainId,
  Address,
} from "@w3-kit/registry";

Architecture

Uses Domain-Driven Design (DDD) with domain, application, and infrastructure layers. See CONTRIBUTING.md for details.

Part of the w3-kit ecosystem

• w3-kit/ui — Component library
• w3-kit/cli — CLI tool
• w3-kit/learn — Recipes and guides
• w3-kit/website — w3-kit.com

License

MIT