Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snedashkovsky/on-chain-registry
metadata oracle: asset list of all cosmos-sdk chains
https://github.com/snedashkovsky/on-chain-registry
blockchain cosmos cosmos-sdk metadata osmosis tokens
Last synced: 26 days ago
JSON representation
metadata oracle: asset list of all cosmos-sdk chains
- Host: GitHub
- URL: https://github.com/snedashkovsky/on-chain-registry
- Owner: Snedashkovsky
- License: apache-2.0
- Created: 2023-06-07T03:56:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-13T09:20:10.000Z (7 months ago)
- Last Synced: 2024-04-13T23:54:01.173Z (7 months ago)
- Topics: blockchain, cosmos, cosmos-sdk, metadata, osmosis, tokens
- Language: Jupyter Notebook
- Homepage:
- Size: 270 MB
- Stars: 25
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# On-Chain Registry: Cosmos-SDK Asset List
As blockchain assets transition between various chains within the Cosmos ecosystem and beyond, the need arises for a precise tool to monitor this intricate data flow. Meet the **On-Chain Registry (OCR)** – meticulously designed to compile all proof-of-nodes data, offering a timely and detailed snapshot of the current asset landscape.
## Proof-of-Nodes Concept
Rather than a static registry, the OCR represents a living, constantly updating protocol that sources data straight directly from nodes.
This mechanism leads to:
- **Accuracy**: The registry furnishes complete and precise data, crucial for meaningful and successful blockchain transactions.
- **Reliability**: By ruling out the chance of human error, the registry delivers consistent information that users can rely on.
- **Inclusivity**: It leaves out no data not specified in the chains, thereby offering a comprehensive overview of the blockchain environment.
### [Milestones](milestones.md)
### Workflow:
## Functionality
OCR provides an interface for updating, storing, and accessing data on-chain. This enables it to dynamically adapt to the ever-changing state of the chains.
**API & IBC Tokens Verification.** OCR functions as a robust and secure API, offering users the capability to verify Inter-Blockchain Communication (IBC) tokens with trusted and verified metadata. This feature further enhances the transparency and security of cross-chain transactions.
**Integration of External Registries.** In the pursuit of providing an all-encompassing data access point, OCR integrates data from other registries as well. This guarantees that users have a comprehensive, unified, and updated view of the entire blockchain ecosystem.
## Assets
On-chain based data allows viewing of **all existing assets**:
- [**chain-registry like data**](data_json)
- [**csv data**](data_csv)
- **contracts** ([code](https://github.com/Snedashkovsky/cw-on-chain-registry/tree/main/contracts/on-chain-registry),
[schema](https://github.com/Snedashkovsky/cw-on-chain-registry/tree/main/contracts/on-chain-registry/schema))
- [bostrom](https://cyb.ai/contracts/bostrom1w33tanvadg6fw04suylew9akcagcwngmkvns476wwu40fpq36pms92re6u) ([example of asset query](https://lcd.bostrom.cybernode.ai/cosmwasm/wasm/v1/contract/bostrom1w33tanvadg6fw04suylew9akcagcwngmkvns476wwu40fpq36pms92re6u/smart/eyJnZXRfYXNzZXRzX2J5X2NoYWluIjogeyJjaGFpbl9uYW1lIjogIm9zbW9zaXMiLCAibGltaXQiOiA0LCAic3RhcnRfYWZ0ZXJfYmFzZSI6ICJpYmMvRkY2RjQ3NzRBQkMyNDc4ODMyQTZENjY4MURCOUE3QThEREM0NDg1MjEyQThBRUQ4NDY0MkVGQ0Q2M0M3NDhBOSJ9fQ==))
- [osmosis-testnet](https://testnet.mintscan.io/osmosis-testnet/wasm/contract/osmo1nwesd2xe6cnvtpqd29xg7qeznlm65x02lfjfg20wlvkdze20hcxsftxtzz) ([example of asset query](https://lcd.testnet.osmosis.zone/cosmwasm/wasm/v1/contract/osmo1nwesd2xe6cnvtpqd29xg7qeznlm65x02lfjfg20wlvkdze20hcxsftxtzz/smart/eyJnZXRfYXNzZXRzX2J5X2NoYWluIjogeyJjaGFpbl9uYW1lIjogIm9zbW9zaXMiLCAibGltaXQiOiA0LCAic3RhcnRfYWZ0ZXJfYmFzZSI6ICJpYmMvRkY2RjQ3NzRBQkMyNDc4ODMyQTZENjY4MURCOUE3QThEREM0NDg1MjEyQThBRUQ4NDY0MkVGQ0Q2M0M3NDhBOSJ9fQ==))
## Asset Data Structure
OCR uses a chain-registry like [asset data structure](assetlist.schema.json) for better compatibility.
Differences from the [chain-registry asset data structure](https://github.com/cosmos/chain-registry/blob/master/assetlist.schema.json):
- add `chain_id` required property;
- `denom_units`, `display`, `name` and `symbol` asset object properties are optional;
- add `chain_id` required property in asset traces section;
- set `chain_name` property in asset traces section as optional;
- add `supply` optional property in asset section and `base_supply` optional property in asset traces section;
- add `admin` required property for `factory` asset type in asset section.
## Contract queries
[Query schema](https://github.com/Snedashkovsky/cw-on-chain-registry/tree/main/contracts/on-chain-registry/schema/query_msg.json)
[Query examples](asset_data.ipynb)
## How to deploy
clone repo and optionally edit the `.env` file
```bash
git clone https://github.com/Snedashkovsky/on-chain-registry && \
cd on-chain-registry && \
cp .env.example .env
```
install python virtual environment and requirements in it
```bash
make install_venv
```
update asset list
```bash
make update
```
## Data Sources
[REST APIs Queries](data_sources.md)
## Contributions
We warmly welcome pull requests, issues, and feedback from the community.