diff --git a/README.md b/README.md index 02632e7d62..8e90dc7dc8 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,7 @@ Once schemas have matured and client needs are better understood Chain Registry ## Contributing -We accept pull requests to add data to an existing assetlist.json or chain.json (especially to add peer data or public rpc endpoint) or to add a new chain or asset. - -Please give Pull Requests a title that somewhat describes the change more precisely than the default title given to a Commit. PRs titled 'Update chain.json' are insufficient, and would be difficult to navigate when searching through the backlog of Pull Requests. Some recommended details would be: the affected Chain Name, API types, or Provider to give some more detail; e.g., "Add Cosmos Hub APIs for Acme Validator". +Please give Pull Requests a title that somewhat describes the change more precisely than the default title given to a Commit. PRs titled 'Update chain.json' difficult to navigate when searching through the backlog of Pull Requests. Some recommended details would be: the affected Chain Name, API types, or Provider to give some more detail; e.g., "Add Cosmos Hub APIs for Acme Validator". ### Endpoints reachability @@ -44,6 +42,7 @@ The endpoints added here are being tested via CI daily at 00:00 UTC. It is expec - rest: `/status` - rpc: `/cosmos/base/tendermint/v1beta1/syncing` - grpc: not tested +Endpoints that consistently fail to repond successfully may be removed without warning. Providers ready to be tested daily should be whitelisted here: `.github/workflows/tests/apis.py` @@ -97,43 +96,7 @@ A sample `chain.json` includes the following information. "name": "v3", "genesis_url": "https://github.com/osmosis-labs/networks/raw/main/osmosis-1/genesis.json" }, - "recommended_version": "v25.0.0", - "compatible_versions": [ - "v25.0.0" - ], - "binaries": { - "linux/amd64": "https://github.com/osmosis-labs/osmosis/releases/download/v25.0.0/osmosisd-25.0.0-linux-amd64", - "linux/arm64": "https://github.com/osmosis-labs/osmosis/releases/download/v25.0.0/osmosisd-25.0.0-linux-arm64" - }, - "consensus": { - "type": "cometbft", - "version": "0.37.4", - "repo": "https::github.com/osmosis-labs/cometbft", - "tag": "v0.37.4-v25-osmo-2" - }, - "language": { - "type": "go", - "version": "1.21.4" - }, - "sdk": { - "type": "cosmos", - "repo": "https://github.com/osmosis-labs/cosmos-sdk", - "version": "v0.47.5", - "tag": "v0.47.5-v25-osmo-1" - }, - "ibc": { - "type": "go", - "version": "v7.4.0", - "ics_enabled": [ - "ics20-1" - ] - }, - "cosmwasm": { - "version": "v0.45.0", - "repo": "https://github.com/osmosis-labs/wasmd", - "tag": "v0.45.0-osmo", - "enabled": true - } + "recommended_version": "v25.0.0" }, "images": [ { @@ -209,6 +172,11 @@ A sample `chain.json` includes the following information. } ``` +### Guidelines for Properties + +#### Bech32 Prefix +Although it is not a requirement that bech32 prefixes be unique, it is highly recommended for each chain to have its bech32 prefix registered at the Satoshi Labs Registry (see [SLIP-0173 : Registered human-readable parts for BIP-0173](https://github.com/satoshilabs/slips/blob/master/slip-0173.md)), or consider picking an uncliamed prefix if the chosen prefix has already be registered to another project. + # Assetlists Asset Lists are inspired by the [Token Lists](https://tokenlists.org/) project on Ethereum which helps discoverability of ERC20 tokens by providing a mapping between erc20 contract addresses and their associated metadata. @@ -427,7 +395,7 @@ An example ibc metadata file contains the following structure: } ] } - +``` --- Creative Commons Licence
This work is licensed under a Creative Commons Attribution 4.0 International License.