evm-networks

Table of Contents

1. About The Project
   1. Documented Parameters
2. Project Initialization
   1. Prerequisites
   2. Installation
3. Project Usage
4. Networks
5. Node Providers
6. Tools
   1. Block Explorers
   2. Network Listing Websites
7. Resources
   1. EIPs Documentation
   2. Contracts Documentation
   1. ENS Contracts
   2. Multicall Contracts
   3. Network Bridge Contracts
   3. Project References
8. Contributing
9. Contact
10. License

1. About The Project

The goal is to keep all parameters related to the connection and operation with an EVM network documented under a formal and complete format.

The formality comes from a certain specified tests all parameters, resources and tools related with the EVM network must pass.
The completness comes from providing all resoruces needed for a full operability with the EVM network. This includes RPC nodes (public, for testing and for production), information related with the RPC node provider (including privacy policy), blockchain explorers (with the corresponding API endpoints) and widely used contracts documentation from the specified EVM network (for now ENS, multicall and bridge contracts).

1.1. Documented Parameters

• [ ] Network Parameters
  • [ ] ID - chain id
  • [ ] Name - official human readable network name
  • [ ] Network - project internal network name
  • [ ] Information URL - network main information link
  • [ ] Documentation URL - network main documentation link
  • [ ] EIP URL - network definition on official Ethereum community EVM networks list (more information found in references)
  • [ ] Testnet - test network properties
  • [ ] Mainnet ID - chain id of the network mainnet (if network is testnet)
• [ ] Native Currency
  • [ ] Name - official human readable EVM network native currency name
  • [ ] Symbol - official EVM network native currency symbol
  • [ ] USymbol - official EVM network native currency smallest unit symbol
  • [ ] Decimals - official EVM network native currency decimals
• [ ] RPC Node
  • [ ] RPC Node - rpc node internal project name
  • [ ] type - rpc node type - public/authenticated/local/null
  • [ ] HTTP - http connection endpoint
  • [ ] WSS - websocket connection endpoint
  • [ ] Provider - service provider information
• [ ] RPC Node Provider
  • [ ] Name - provider official human readable name
  • [ ] Provider - project internal provider name
  • [ ] URL - provider official website link
  • [ ] Data Privacy Level - level of data privacy offered in the provider node service
  • [ ] Privacy Policy - provider privacy policy information link
• [ ] Block Explorer
  • [ ] Name - official human readable name
  • [ ] Block Explorer - project internal name
  • [ ] Type - type of block explorer - blockscout/etherscan/independent/subscan/null
  • [ ] Standard - EIP standard of the block explorer - eip3091/none/null
  • [ ] Browser URL - official browser website link
  • [ ] API URL - official API base endpoint
  • [ ] Documentation URL - official API documentation link
• [ ] Contracts
  • [ ] ENS Registry - name, contract internal name, address & deploy block number and deploy tx hash
  • [ ] ENS Universal Resolver - cname, contract internal name, address & deploy block number and deploy tx hash
  • [ ] Multicall - name, contract internal name, address & deploy block number and deploy tx hash

See the open issues for a full list of proposed features (and known issues).

(back to top)

2. Project Initialization

2.1. Prerequisites

Package manager installation (npm)

• npm

  npm install npm@latest -g

2.2. Installation

1. Clone the repo

   git clone https://github.com/uri1001/the-evm-networks-project.git

2. Install NPM packages

   npm install

3. TBD

   mv ./.env.sample ./.env

(back to top)

3. Project Usage

TO BE DONE

(back to top)

4. Networks

TO BE DONE

(back to top)

5. Node Providers

TO BE DONE

(back to top)

6. Tools

6.1. Block Explorers

• EVM Open-Source Blockchain Explorer - Otterscan

6.2. Network Listing Websites

• Network Parameters & RPC Nodes: Chainlist

• Network Wallet Connection Testing: Chainid

• Network Wallet Connection Testing: Chainlist

• Wagmi Compatible Networks: Spenhouet

• Ethereum Testnets Faucet Status: FaucetLink

(back to top)

7. Resources

7.1. EIPs Documentation

• EIP-155 - Official Proposal

• EIP-3014 - Official Proposal

• EIP-3770 - Official Proposal

• EIP-4527 - Official Proposal

• EIP-3091 - Official Proposal

7.2. Contracts Documentation

• Contracts Documentation - Documentation

  7.2.1. ENS Contracts

  • Ethereum Name Service Documentation - ENS

  7.2.2. Multicall Contracts

  • Multicall Contracts - Multicall

  7.2.3. Network Bridge Contracts

  • TO BE DONE - TBD

7.3. Project References

• Ethereum Community EVM Networks List - Networks List

• WagmiSH EVM Networks Repository - Networks Repository

(back to top)

8. Contributing

TO BE DONE

(back to top)

9. Contact

Oriol Rodríguez Setó - uri1001@pm.me

Project Link: https://github.com/uri1001/the-evm-networks-project

(back to top)

10. License

Distributed under the MIT License. See LICENSE for more information.

(back to top)