0.0.545 β€’ Published 4 months ago

chainmap v0.0.545

Weekly downloads
-
License
-
Repository
github
Last release
4 months ago

πŸ—ΊοΈ ChainMap

npm

ChainMap provides a comprehensive map of EVM blockchain networks and their associated data. It includes information such as chain IDs, network names, RPC URLs, and currency details.

import chainMap from "chainmap";
import { JsonRpcProvider, formatUnits } from "ethers";

const ethereum = chainMap.ethereum.mainnet;
const provider = new JsonRpcProvider(ethereum.rpc[0]);

Features

  • πŸ—ΊοΈ A Comprehensive map of blockchain networks.
  • πŸ“ Includes chain IDs, network names, image assets, RPC URLs, and currency details.
  • ⚑️ Free RPC URLs for each network.
  • πŸ“… Built daily to ensure RPCs are working.

Installation

You can install ChainMap using npm/yarn/bun:

npm install chainmap

Supported Networks

Arbitrum Goerli (421613), Arbitrum Mainnet (42161), Arbitrum Nova (42170), Arbitrum Sepolia (421614), Avalanche C-chain (43114), Avalanche Fuji Testnet (43113), Base (8453), Binance SmartChain Mainnet (56), Binance SmartChain Testnet (97), Celo Alfajores Testnet (44787), Celo Baklava Testnet (62320), Celo Mainnet (42220), Cronos Mainnet (25), Ethereum Goerli (5), Ethereum Mainnet (1), Ethereum Sepolia (11155111), Fantom Opera (250), Fantom Testnet (4002), Gnosis (100), Harmony Mainnet Shard 0 (1666600000), Harmony Testnet Shard 0 (1666700000), Klayton Mainnet (8217), Moonbase Alpha (1287), Moonbeam (1284), Moonriver (1285), Moonrock (1288), OP Mainnet (10), Polygon (137), Polygon Mumbai (80001), Polygon Zkevm (1101), Polygon Zkevm Testnet (1442), Zora (7777777)

Usage

Get a specific chains data:

import chainMap from "chainmap";

chainMap.ethereum.mainnet.rpc; // <- an array of free RPC URLs
chainMap.ethereum.mainnet.chainId; // <- the chain ID e.g. "1"
chainMap.ethereum.mainnet.name; // <- the network name e.g. "Ethereum Mainnet"
chainMap.ethereum.mainnet.currency; // <- the currency details e.g. { name: "Ether", symbol: "ETH", decimals: 18 }
chainMap.ethereum.mainnet.explorerUrl; // <- the explorer URL e.g. "https://etherscan.io"

Get a chains data by its chain ID:

import chainMap from "chainmap";

const ethereumInfo = chainMap[1] // <- in this example '1' is the chain ID for Ethereum Mainnet.
ethereumInfo.rpc; // <- an array of free RPC URLs
... // etc

Docs

ChainInfo: An object containing information about a blockchain.

PropertyTypeDescription
namestringThe name of the blockchain
chainIdnumberThe ID of the blockchain
rpcstring[]An array of RPC URLs
currencyCurrencyInfoInformation about the blockchain's currency
explorerUrlstring (optional)The URL of the blockchain's explorer (if available)
iconUrlstring (optional)The URL of the blockchain's icon (if available)

CurrencyInfo: An object containing information about a blockchain's currency.

PropertyTypeDescription
namestringThe name of the currency
symbolstringThe symbol of the currency
decimalsnumberThe number of decimal places for the currency
iconUrlstring (optional)The URL of the currency's icon (if available)

Contributing

Chainmap source files are generated from specifications in data directory. During the generation process, rpcs are tested to ensure they are working. If a network fails to connect, it is removed from the generated source files.

✏️ Modify a network

Open the network data file data/<network>.list.ts, and make your modifications, ensuring the default exported Object still confroms to the ChainMap interface.

βž• Add a network

Create a new file in the data directory, named <network>.list.ts. The file should export an object that conforms to the ChainMap interface.

e.g. Creating a new network called mychain with chain ID 1234 and RPC URL https://mychain.com:

import { ChainMap } from "./types";

export const MYC {
  name: "MyCoin",
  symbol: "MYC",
  decimals: 18,
  }

export default {
  mainnet: {
    chainId: 1234,
    name: "MyChain mainnet",
    currency: MYC,
    explorerUrl: "https://mychain.com",
    rpc: [
      "https://rpc.mychain.com",
      "https://rpc2.mychain.com",
    ],
  },
} as ChainMap; // <- ensures the object conforms to the ChainMap interface

Generate and build

Typically source files should be generated by the github action, but you can generate them locally using bun.

Prerequisites:

bun run generate

You can then build the distribution files:

bun run build

Testing networks

You can check that all network RPCs are working by running:

bun test
0.0.539

4 months ago

0.0.545

4 months ago

0.0.544

4 months ago

0.0.543

4 months ago

0.0.542

4 months ago

0.0.541

4 months ago

0.0.540

4 months ago

0.0.535

4 months ago

0.0.534

4 months ago

0.0.533

4 months ago

0.0.532

4 months ago

0.0.538

4 months ago

0.0.537

4 months ago

0.0.536

4 months ago

0.0.524

5 months ago

0.0.528

4 months ago

0.0.527

4 months ago

0.0.526

5 months ago

0.0.525

5 months ago

0.0.531

4 months ago

0.0.530

4 months ago

0.0.529

4 months ago

0.0.523

5 months ago

0.0.522

5 months ago

0.0.521

5 months ago

0.0.520

5 months ago

0.0.519

5 months ago

0.0.513

5 months ago

0.0.512

5 months ago

0.0.511

5 months ago

0.0.517

5 months ago

0.0.516

5 months ago

0.0.515

5 months ago

0.0.514

5 months ago

0.0.518

5 months ago

0.0.510

5 months ago

0.0.509

5 months ago

0.0.508

5 months ago

0.0.507

5 months ago

0.0.506

5 months ago

0.0.505

5 months ago

0.0.504

5 months ago

0.0.502

5 months ago

0.0.501

5 months ago

0.0.500

5 months ago

0.0.503

5 months ago

0.0.499

5 months ago

0.0.498

5 months ago

0.0.497

5 months ago

0.0.494

6 months ago

0.0.493

6 months ago

0.0.492

6 months ago

0.0.491

6 months ago

0.0.496

6 months ago

0.0.495

6 months ago

0.0.490

6 months ago

0.0.489

6 months ago

0.0.488

6 months ago

0.0.487

6 months ago

0.0.486

6 months ago

0.0.485

6 months ago

0.0.484

6 months ago

0.0.479

6 months ago

0.0.478

6 months ago

0.0.477

6 months ago

0.0.483

6 months ago

0.0.482

6 months ago

0.0.481

6 months ago

0.0.472

6 months ago

0.0.471

6 months ago

0.0.470

6 months ago

0.0.476

6 months ago

0.0.475

6 months ago

0.0.474

6 months ago

0.0.473

6 months ago

0.0.469

6 months ago

0.0.468

6 months ago

0.0.467

7 months ago

0.0.466

7 months ago

0.0.465

7 months ago

0.0.464

7 months ago

0.0.463

7 months ago

0.0.458

7 months ago

0.0.457

7 months ago

0.0.456

7 months ago

0.0.459

7 months ago

0.0.461

7 months ago

0.0.460

7 months ago

0.0.462

7 months ago

0.0.455

7 months ago

0.0.454

7 months ago

0.0.453

7 months ago

0.0.452

7 months ago

0.0.451

7 months ago

0.0.449

7 months ago

0.0.450

7 months ago

0.0.447

7 months ago

0.0.446

7 months ago

0.0.448

7 months ago

0.0.445

7 months ago

0.0.444

7 months ago

0.0.443

7 months ago

0.0.439

7 months ago

0.0.438

7 months ago

0.0.437

8 months ago

0.0.442

7 months ago

0.0.441

7 months ago

0.0.440

7 months ago

0.0.436

8 months ago

0.0.435

8 months ago

0.0.434

8 months ago

0.0.433

8 months ago

0.0.432

8 months ago

0.0.431

8 months ago

0.0.430

8 months ago

0.0.425

8 months ago

0.0.424

8 months ago

0.0.423

8 months ago

0.0.429

8 months ago

0.0.428

8 months ago

0.0.427

8 months ago

0.0.426

8 months ago

0.0.418

8 months ago

0.0.417

8 months ago

0.0.416

8 months ago

0.0.415

8 months ago

0.0.422

8 months ago

0.0.421

8 months ago

0.0.420

8 months ago

0.0.419

8 months ago

0.0.414

8 months ago

0.0.413

8 months ago

0.0.412

8 months ago

0.0.407

9 months ago

0.0.406

9 months ago

0.0.411

8 months ago

0.0.410

8 months ago

0.0.409

8 months ago

0.0.408

8 months ago

0.0.405

9 months ago

0.0.403

9 months ago

0.0.404

9 months ago

0.0.402

9 months ago

0.0.401

9 months ago

0.0.400

9 months ago

0.0.399

9 months ago

0.0.398

9 months ago

0.0.397

9 months ago

0.0.396

9 months ago

0.0.395

9 months ago

0.0.394

9 months ago

0.0.393

9 months ago

0.0.392

9 months ago

0.0.391

9 months ago

0.0.390

9 months ago

0.0.379

9 months ago

0.0.378

9 months ago

0.0.377

10 months ago

0.0.376

10 months ago

0.0.375

10 months ago

0.0.389

9 months ago

0.0.384

9 months ago

0.0.383

9 months ago

0.0.382

9 months ago

0.0.381

9 months ago

0.0.388

9 months ago

0.0.387

9 months ago

0.0.386

9 months ago

0.0.385

9 months ago

0.0.380

9 months ago

0.0.348

10 months ago

0.0.347

11 months ago

0.0.346

11 months ago

0.0.345

11 months ago

0.0.349

10 months ago

0.0.344

11 months ago

0.0.359

10 months ago

0.0.358

10 months ago

0.0.357

10 months ago

0.0.356

10 months ago

0.0.351

10 months ago

0.0.350

10 months ago

0.0.355

10 months ago

0.0.354

10 months ago

0.0.353

10 months ago

0.0.352

10 months ago

0.0.369

10 months ago

0.0.368

10 months ago

0.0.367

10 months ago

0.0.362

10 months ago

0.0.361

10 months ago

0.0.360

10 months ago

0.0.366

10 months ago

0.0.365

10 months ago

0.0.364

10 months ago

0.0.363

10 months ago

0.0.373

10 months ago

0.0.372

10 months ago

0.0.371

10 months ago

0.0.370

10 months ago

0.0.374

10 months ago

0.0.343

11 months ago

0.0.342

11 months ago

0.0.341

11 months ago

0.0.337

11 months ago

0.0.339

11 months ago

0.0.338

11 months ago

0.0.340

11 months ago

0.0.336

11 months ago

0.0.335

11 months ago

0.0.334

11 months ago

0.0.333

11 months ago

0.0.332

11 months ago

0.0.331

11 months ago

0.0.330

11 months ago

0.0.326

11 months ago

0.0.329

11 months ago

0.0.328

11 months ago

0.0.327

11 months ago

0.0.325

11 months ago

0.0.324

11 months ago

0.0.323

11 months ago

0.0.322

11 months ago

0.0.319

11 months ago

0.0.321

11 months ago

0.0.320

11 months ago

0.0.315

12 months ago

0.0.318

11 months ago

0.0.317

12 months ago

0.0.316

12 months ago

0.0.314

12 months ago

0.0.313

12 months ago

0.0.312

12 months ago

0.0.311

12 months ago

0.0.310

12 months ago

0.0.309

12 months ago

0.0.308

12 months ago

0.0.304

12 months ago

0.0.303

12 months ago

0.0.302

12 months ago

0.0.301

12 months ago

0.0.307

12 months ago

0.0.305

12 months ago

0.0.300

12 months ago

0.0.279

1 year ago

0.0.274

1 year ago

0.0.273

1 year ago

0.0.272

1 year ago

0.0.271

1 year ago

0.0.278

1 year ago

0.0.277

1 year ago

0.0.276

1 year ago

0.0.275

1 year ago

0.0.270

1 year ago

0.0.285

1 year ago

0.0.284

1 year ago

0.0.283

1 year ago

0.0.282

1 year ago

0.0.289

1 year ago

0.0.288

1 year ago

0.0.287

1 year ago

0.0.286

1 year ago

0.0.281

1 year ago

0.0.280

1 year ago

0.0.296

1 year ago

0.0.295

1 year ago

0.0.294

1 year ago

0.0.293

1 year ago

0.0.299

12 months ago

0.0.298

12 months ago

0.0.297

1 year ago

0.0.292

1 year ago

0.0.291

1 year ago

0.0.290

1 year ago

0.0.269

1 year ago

0.0.268

1 year ago

0.0.267

1 year ago

0.0.266

1 year ago

0.0.265

1 year ago

0.0.264

1 year ago

0.0.263

1 year ago

0.0.262

1 year ago

0.0.261

1 year ago

0.0.249

1 year ago

0.0.259

1 year ago

0.0.258

1 year ago

0.0.257

1 year ago

0.0.252

1 year ago

0.0.251

1 year ago

0.0.250

1 year ago

0.0.256

1 year ago

0.0.255

1 year ago

0.0.254

1 year ago

0.0.253

1 year ago

0.0.260

1 year ago

0.0.248

1 year ago

0.0.247

1 year ago

0.0.246

1 year ago

0.0.245

1 year ago

0.0.244

1 year ago

0.0.243

1 year ago

0.0.242

1 year ago

0.0.241

1 year ago

0.0.240

1 year ago

0.0.239

1 year ago

0.0.238

1 year ago

0.0.237

1 year ago

0.0.236

1 year ago

0.0.235

1 year ago

0.0.234

1 year ago

0.0.233

1 year ago

0.0.232

1 year ago

0.0.231

1 year ago

0.0.229

1 year ago

0.0.230

1 year ago

0.0.228

1 year ago

0.0.227

1 year ago

0.0.226

1 year ago

0.0.225

1 year ago

0.0.224

1 year ago

0.0.223

1 year ago

0.0.222

1 year ago

0.0.221

1 year ago

0.0.220

1 year ago

0.0.219

1 year ago

0.0.218

1 year ago

0.0.217

1 year ago

0.0.216

1 year ago

0.0.215

1 year ago

0.0.214

1 year ago

0.0.213

1 year ago

0.0.212

1 year ago

0.0.211

1 year ago

0.0.209

1 year ago

0.0.210

1 year ago

0.0.208

1 year ago

0.0.207

1 year ago

0.0.206

1 year ago

0.0.205

1 year ago

0.0.204

1 year ago

0.0.203

1 year ago

0.0.202

1 year ago

0.0.201

1 year ago

0.0.200

1 year ago

0.0.199

1 year ago

0.0.198

1 year ago

0.0.197

1 year ago

0.0.196

1 year ago

0.0.195

1 year ago

0.0.194

1 year ago

0.0.193

1 year ago

0.0.192

1 year ago

0.0.191

1 year ago

0.0.190

1 year ago

0.0.189

1 year ago

0.0.188

1 year ago

0.0.187

1 year ago

0.0.186

1 year ago

0.0.185

1 year ago

0.0.184

1 year ago

0.0.183

1 year ago

0.0.182

1 year ago

0.0.181

1 year ago

0.0.180

1 year ago

0.0.179

1 year ago

0.0.178

1 year ago

0.0.177

1 year ago

0.0.176

1 year ago

0.0.175

1 year ago

0.0.174

1 year ago

0.0.173

1 year ago

0.0.172

1 year ago

0.0.171

1 year ago

0.0.170

1 year ago

0.0.169

1 year ago

0.0.168

1 year ago

0.0.167

1 year ago

0.0.166

1 year ago

0.0.164

1 year ago

0.0.165

1 year ago

0.0.163

1 year ago

0.0.159

1 year ago

0.0.162

1 year ago

0.0.161

1 year ago

0.0.160

1 year ago

0.0.158

1 year ago

0.0.157

1 year ago

0.0.156

1 year ago

0.0.155

1 year ago

0.0.154

1 year ago

0.0.153

1 year ago

0.0.152

1 year ago

0.0.151

1 year ago

0.0.150

1 year ago

0.0.149

1 year ago

0.0.148

1 year ago

0.0.147

1 year ago

0.0.146

1 year ago

0.0.145

1 year ago

0.0.144

1 year ago

0.0.143

1 year ago

0.0.142

1 year ago

0.0.141

1 year ago

0.0.140

1 year ago

0.0.139

1 year ago

0.0.138

1 year ago

0.0.137

1 year ago

0.0.136

1 year ago

0.0.135

1 year ago

0.0.134

1 year ago

0.0.133

1 year ago

0.0.131

1 year ago

0.0.132

1 year ago

0.0.130

1 year ago

0.0.128

1 year ago

0.0.129

1 year ago

0.0.127

1 year ago

0.0.126

1 year ago

0.0.125

1 year ago

0.0.124

1 year ago

0.0.123

1 year ago

0.0.120

1 year ago

0.0.122

1 year ago

0.0.121

1 year ago

0.0.119

1 year ago

0.0.118

1 year ago

0.0.117

1 year ago

0.0.116

1 year ago

0.0.115

2 years ago

0.0.114

2 years ago

0.0.113

2 years ago

0.0.112

2 years ago

0.0.111

2 years ago

0.0.110

2 years ago

0.0.109

2 years ago

0.0.108

2 years ago

0.0.106

2 years ago

0.0.107

2 years ago

0.0.105

2 years ago

0.0.104

2 years ago

0.0.103

2 years ago

0.0.102

2 years ago

0.0.101

2 years ago

0.0.100

2 years ago

0.0.98

2 years ago

0.0.99

2 years ago

0.0.97

2 years ago

0.0.96

2 years ago

0.0.95

2 years ago

0.0.94

2 years ago

0.0.93

2 years ago

0.0.92

2 years ago

0.0.91

2 years ago

0.0.90

2 years ago

0.0.89

2 years ago

0.0.88

2 years ago

0.0.86

2 years ago

0.0.87

2 years ago

0.0.85

2 years ago

0.0.84

2 years ago

0.0.83

2 years ago

0.0.82

2 years ago

0.0.81

2 years ago

0.0.80

2 years ago

0.0.79

2 years ago

0.0.78

2 years ago

0.0.77

2 years ago

0.0.76

2 years ago

0.0.75

2 years ago

0.0.74

2 years ago

0.0.73

2 years ago

0.0.72

2 years ago

0.0.71

2 years ago

0.0.70

2 years ago

0.0.69

2 years ago

0.0.68

2 years ago

0.0.67

2 years ago

0.0.66

2 years ago

0.0.65

2 years ago

0.0.64

2 years ago

0.0.63

2 years ago

0.0.62

2 years ago

0.0.61

2 years ago

0.0.60

2 years ago

0.0.59

2 years ago

0.0.58

2 years ago

0.0.57

2 years ago

0.0.56

2 years ago

0.0.55

2 years ago

0.0.54

2 years ago

0.0.53

2 years ago

0.0.52

2 years ago

0.0.51

2 years ago

0.0.50

2 years ago

0.0.49

2 years ago

0.0.48

2 years ago

0.0.47

2 years ago

0.0.46

2 years ago

0.0.45

2 years ago

0.0.44

2 years ago

0.0.43

2 years ago

0.0.42

2 years ago

0.0.41

2 years ago

0.0.40

2 years ago

0.0.39

2 years ago

0.0.38

2 years ago

0.0.37

2 years ago

0.0.36

2 years ago

0.0.35

2 years ago

0.0.34

2 years ago

0.0.33

2 years ago

0.0.32

2 years ago

0.0.31

2 years ago

0.0.30

2 years ago

0.0.29

2 years ago

0.0.28

2 years ago

0.0.27

2 years ago

0.0.26

2 years ago

0.0.25

2 years ago

0.0.24

2 years ago

0.0.23

2 years ago

0.0.22

2 years ago

0.0.21

2 years ago

0.0.20

2 years ago

0.0.19

2 years ago

0.0.18

2 years ago

0.0.17

2 years ago

0.0.16

2 years ago

0.0.15

2 years ago

0.0.14

2 years ago

0.0.13

2 years ago

0.0.12

2 years ago

0.0.11

2 years ago

0.0.10

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.5

2 years ago