Skip to content

add NOWNodes #7615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add NOWNodes #7615

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 68 additions & 57 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EVM-based Chains

The source data is in _data/chains. Each chain has its own file with the filename being the [CAIP-2](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md) representation as name and `.json` as extension.
The source data is in \_data/chains. Each chain has its own file with the filename being the [CAIP-2](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md) representation as name and `.json` as extension.

## Example:

Expand All @@ -24,39 +24,39 @@ The source data is in _data/chains. Each chain has its own file with the filenam
"chainId": 1,
"networkId": 1,
"icon": "ethereum",
"explorers": [{
"name": "etherscan",
"url": "https://etherscan.io",
"icon": "etherscan",
"standard": "EIP3091"
}]
"explorers": [
{
"name": "etherscan",
"url": "https://etherscan.io",
"icon": "etherscan",
"standard": "EIP3091"
}
]
}
```

When an icon is used in either the network or an explorer, there must be a JSON in _data/icons with the name used.
When an icon is used in either the network or an explorer, there must be a JSON in \_data/icons with the name used.
(e.g. in the above example there must be a `ethereum.json` and a `etherscan.json` in there) - The icon JSON files look like this:

```json

[
{
"url": "ipfs://QmdwQDr6vmBtXmK2TmknkEuZNoaDqTasFdZdu3DRw8b2wt",
"width": 1000,
"height": 1628,
"format": "png"
}
{
"url": "ipfs://QmdwQDr6vmBtXmK2TmknkEuZNoaDqTasFdZdu3DRw8b2wt",
"width": 1000,
"height": 1628,
"format": "png"
}
]

```

where:
* The URL MUST be publicly resolvable through IPFS
* width and height MUST be positive integers
* format is either "png", "jpg" or "svg"
* size MUST be less than 250kb

If the chain is an L2 or a shard of another chain you can link it to the parent chain like this:
- The URL MUST be publicly resolvable through IPFS
- width and height MUST be positive integers
- format is either "png", "jpg" or "svg"
- size MUST be less than 250kb

If the chain is an L2 or a shard of another chain you can link it to the parent chain like this:

```json
{
Expand All @@ -77,24 +77,26 @@ Other options for `status` are `active` (default) or `incubating`
## Aggregation

There are also aggregated json files with all chains automatically assembled:
* https://chainid.network/chains.json
* https://chainid.network/chains_mini.json (miniaturized - fewer fields for smaller filesize)

- https://chainid.network/chains.json
- https://chainid.network/chains_mini.json (miniaturized - fewer fields for smaller filesize)

## Constraints

* the shortName and name MUST be unique - see e.g. EIP-3770 on why
* if referencing a parent chain - the chain MUST exist in the repo
* if using an IPFS CID for the icon - the CID MUST be retrievable via `ipfs get` - not only through some gateway (means please do not use pinata for now)
* for more constraints you can look into the CI
- the shortName and name MUST be unique - see e.g. EIP-3770 on why
- if referencing a parent chain - the chain MUST exist in the repo
- if using an IPFS CID for the icon - the CID MUST be retrievable via `ipfs get` - not only through some gateway (means please do not use pinata for now)
- for more constraints you can look into the CI

## Collision management

We cannot allow more than one chain with the same chainID - this would open the door to replay attacks.
The first pull request gets the chainID assigned. When creating a chain we can expect that you read EIP155 which states this repo.
All pull requests trying to replace a chainID because they think their chain is better than the other will be closed.
The only way to get a chain reassigned is when the old chain gets deprecated. This can e.g. be used for testnets that are short-lived. But then you will get the redFlag "reusedChainID" that should be displayed in clients to warn them about the dangers here.
We cannot allow more than one chain with the same chainID - this would open the door to replay attacks.
The first pull request gets the chainID assigned. When creating a chain we can expect that you read EIP155 which states this repo.
All pull requests trying to replace a chainID because they think their chain is better than the other will be closed.
The only way to get a chain reassigned is when the old chain gets deprecated. This can e.g. be used for testnets that are short-lived. But then you will get the redFlag "reusedChainID" that should be displayed in clients to warn them about the dangers here.

## Getting your PR merged

### before PR is submitted

Before submitting a PR, please ensure all checks pass by running:
Expand All @@ -115,43 +117,52 @@ npx prettier --write _data/*/*.json

### Once PR is submitted

* Make sure CI is green. There will likely be no review when the CI is red.
* When making changes that fix the CI problems - please re-request a review - otherwise it is too much work to track such changes with so many PRs daily
- Make sure CI is green. There will likely be no review when the CI is red.
- When making changes that fix the CI problems - please re-request a review - otherwise it is too much work to track such changes with so many PRs daily

## Usages

### Tools
* [MESC](https://paradigmxyz.github.io/mesc)

- [MESC](https://paradigmxyz.github.io/mesc)
- [NOWNodes](https://nownodes.io/)

### Explorers
* [Otterscan](https://otterscan.io)

- [Otterscan](https://otterscan.io)
- [NOWNodes](https://blockexplorers.nownodes.io/)

### Wallets
* [WallETH](https://walleth.org)
* [TREZOR](https://trezor.io)
* [Minerva Wallet](https://minerva.digital)

- [WallETH](https://walleth.org)
- [TREZOR](https://trezor.io)
- [Minerva Wallet](https://minerva.digital)

### EIPs
* EIP-155
* EIP-3014
* EIP-3770
* EIP-4527

- EIP-155
- EIP-3014
- EIP-3770
- EIP-4527

### Listing sites
* [chainid.network](https://chainid.network) / [chainlist.wtf](https://chainlist.wtf)
* [chainlist.org](https://chainlist.org)
* [Chainlink docs](https://docs.chain.link/)
* [dRPC Chainlist - Load-balanced public nodes](https://drpc.org/chainlist)
* [eth-chains](https://github.com/taylorjdawson/eth-chains)
* [EVM-BOX](https://github.com/izayl/evm-box)
* [evmchain.info](https://evmchain.info)
* [evmchainlist.org](https://evmchainlist.org)
* [networks.vercel.app](https://networks.vercel.app)
* [Wagmi compatible chain configurations](https://spenhouet.com/chains)
* [chainlist.simplr.sh - Info packaged single pager](https://chainlist.simplr.sh)

- [chainid.network](https://chainid.network) / [chainlist.wtf](https://chainlist.wtf)
- [chainlist.org](https://chainlist.org)
- [Chainlink docs](https://docs.chain.link/)
- [dRPC Chainlist - Load-balanced public nodes](https://drpc.org/chainlist)
- [eth-chains](https://github.com/taylorjdawson/eth-chains)
- [EVM-BOX](https://github.com/izayl/evm-box)
- [evmchain.info](https://evmchain.info)
- [evmchainlist.org](https://evmchainlist.org)
- [networks.vercel.app](https://networks.vercel.app)
- [Wagmi compatible chain configurations](https://spenhouet.com/chains)
- [chainlist.simplr.sh - Info packaged single pager](https://chainlist.simplr.sh)

### Other
* [FaucETH](https://github.com/komputing/FaucETH)
* [Sourcify playground](https://playground.sourcify.dev)
* [Smart Contract UI](https://xtools-at.github.io/smartcontract-ui)

* Your project - contact us to add it here!
- [FaucETH](https://github.com/komputing/FaucETH)
- [Sourcify playground](https://playground.sourcify.dev)
- [Smart Contract UI](https://xtools-at.github.io/smartcontract-ui)

- Your project - contact us to add it here!