@loxjs/web3networks

The @loxjs/web3networks module provides a comprehensive and easy-to-use interface to manage Ethereum-based blockchain network configurations. It allows developers to add, retrieve, update, and validate network configurations for different Ethereum chains, including testnets and mainnets.

Features

Add single or multiple network configurations with validation
Retrieve network configurations by chain ID, with optional property selection
Update existing network configurations by chain ID
Validate network data with required and optional fields, with default values for optional fields not provided
Helper function to validate URLs
Helper functions to generate blockchain explorer URLs for contracts and tokens
Preconfigured with a list of common networks

Preconfigured Networks

The package comes with the following preconfigured networks:

Network Name	Chain ID
Ethereum	1
Holesky	17000
Sepolia	11155111
Avalanche	43114
Avalanche Fuji	43113
Polygon	137
Mumbai	80001
BNB Chain	56
BNB Chain Testnet	97
Skale Calypso Hub Testnet	974399131
Skale Calypso Hub	1564830818
Bitfinity Testnet	355113

Installation

To install the module, use npm or yarn as follows:

npm:

npm install @loxjs/web3networks

yarn:

yarn add @loxjs/web3networks

Usage

First, require the module in your project:

const ethereumNetworkManager = require('@loxjs/web3networks');

Adding Networks

To add a new network configuration:

const newNetwork = {
    chainId: 1,
    chain: 'Ethereum',
    name: 'Ethereum Mainnet',
    rpcUrl: 'https://mainnet-rpc-url.com',
    blockExplorerUrl: 'https://mainnet-block-explorer.com',
    currency: {
        name: 'Ether',
        symbol: 'ETH',
        decimals: 18,
    },
    options: {
        defaultGasLimit: 21000,
        defaultGasPrice: '1000000000',
    },
};

try {
    ethereumNetworkManager.addNetwork(newNetwork);
    console.log('Network added successfully');
} catch (error) {
    console.error('Failed to add network:', error.message);
}

To add multiple networks at once:

const networksArray = [/* array of network objects */];

try {
    ethereumNetworkManager.addNetworks(networksArray);
    console.log('Networks added successfully');
} catch (error) {
    console.error('Failed to add networks:', error.message);
}

Retrieving Networks

To get a network by its chain ID:

const chainId = 1; // For Ethereum Mainnet
const network = ethereumNetworkManager.getNetworkByChainId(chainId);

if (network) {
    console.log('Retrieved network:', network);
} else {
    console.log('Network not found for chain ID:', chainId);
}

Updating Networks

To update an existing network:

const chainIdToUpdate = 1;
const newRpcUrl = 'https://new-mainnet-rpc-url.com';

try {
    ethereumNetworkManager.updateNetwork(chainIdToUpdate, { rpcUrl: newRpcUrl });
    console.log('Network updated successfully');
} catch (error) {
    console.error('Failed to update network:', error.message);
}

Validating Network Data

To validate network data:

const networkData = {
    chainId: 1,
    // ...other required properties
};

try {
    ethereumNetworkManager.validateNetwork(networkData);
    console.log('Network data is valid');
} catch (error) {
    console.error('Invalid network data:', error.message);
}

API Reference

Below is the reference for the available methods in the @loxjs/web3networks module.

`addNetwork(network)`

Adds a single network configuration.

Parameters:

network - An object containing the network configuration.

Example:

ethereumNetworkManager.addNetwork({
    chainId: 1,
    // ...other network properties
});

`addNetworks(networks)`

Adds multiple network configurations.

Parameters:

networks - An array of objects containing the network configurations.

Example:

ethereumNetworkManager.addNetworks([
    {
        chainId: 1,
        // ...other network properties
    },
    {
        chainId: 2,
        // ...other network properties
    },
]);

`getNetworkByChainId(chainId, [properties])`

Retrieves a network by its chain ID. Optionally, specific properties can be retrieved.

Parameters:

chainId - The chain ID of the network to retrieve.
properties (optional) - An array of strings specifying which properties to retrieve.

Example:

const network = ethereumNetworkManager.getNetworkByChainId(1, ['rpcUrl', 'currency.name']);

`updateNetwork(chainId, newNetworkData)`

Updates an existing network configuration by chain ID.

Parameters:

chainId - The chain ID of the network to update.
newNetworkData - An object containing the new network data.

Example:

ethereumNetworkManager.updateNetwork(1, {
    rpcUrl: 'https://new-mainnet-rpc-url.com',
    // ...other network properties
});

ethereumNetworkManager.updateNetwork(1, {
    name: 'New chain name',
    'currency.name': 'New Name',
    'options.defaultGasLimit': 4000000,
    // ...other network properties
});

`validateNetwork(network, [isUpdate])`

Validates a network configuration. If validating for an update, only the provided fields are validated.

Parameters:

network - An object containing the network configuration.
isUpdate (optional) - A boolean indicating whether the validation is for an update operation.

Example:

ethereumNetworkManager.validateNetwork({
    chainId: 1,
    // ...other network properties
});

`getContractExplorerUrl(chainId, contractAddress)`

Generates the contract explorer URL for a given contract address on a specific chain.

Parameters:

chainId - The chain ID of the network.
contractAddress - The contract address.

Example:

const url = ethereumNetworkManager.getContractExplorerUrl(1, '0x...');

`getContractTokensExplorerUrl(chainId, contractAddress)`

Generates the contract token list explorer URL for a given contract address on a specific chain.

Parameters:

chainId - The chain ID of the network.
contractAddress - The contract address.

Example:

const url = ethereumNetworkManager.getContractTokensExplorerUrl(1, '0x...');

`getContractTokenExplorerUrl(chainId, contractAddress, tokenId)`

Generates the token explorer URL for a given contract address and token ID on a specific chain.

Parameters:

chainId - The chain ID of the network.
contractAddress - The contract address.
tokenId - The token ID.

Example:

const url = ethereumNetworkManager.getContractTokenExplorerUrl(1, '0x...', '123');

`getHashExplorerUrl(chainId, hash)`

Get the transaction hash explorer URL for a given hash on a specific chain.

Parameters:

chainId - The chain ID of the network.
hash - The transaction hash.

Example:

const url = ethereumNetworkManager.getHashExplorerUrl(1, '0x...');

`getBlockExplorerUrl(chainId, blockHashOrNumber)`

Get the block explorer URL for a given block hash or number on a specific chain.

Parameters:

chainId - The chain ID of the network.
blockHashOrNumber - The block hash or number.

Example:

const url = ethereumNetworkManager.getBlockExplorerUrl(1, '0x...');
// Or
const url = ethereumNetworkManager.getBlockExplorerUrl(1, 123);

Contributing

Contributions to @loxjs/web3networks are welcome! Please ensure that your contributions adhere to the following guidelines:

Write clear, readable, and maintainable code.
Follow existing coding styles and practices.
Write meaningful commit messages.
Update the documentation accordingly.

For more detailed information, please read the contributing guide.

Enjoy using @loxjs/web3networks!