Skip to content

Commit

Permalink
Update README.md (cosmos#5828)
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyParish69 authored Jan 16, 2025
1 parent 32a0e27 commit 649a774
Showing 1 changed file with 9 additions and 41 deletions.
50 changes: 9 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,15 @@ 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

The endpoints added here are being tested via CI daily at 00:00 UTC. It is expected that your endpoints return an HTTP 200 in the following paths:
- 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`

Expand Down Expand Up @@ -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": [
{
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -427,7 +395,7 @@ An example ibc metadata file contains the following structure:
}
]
}

```
---

<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons Licence" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

0 comments on commit 649a774

Please sign in to comment.