An overview of the main Map3 Metadata Components
Repository & Submodules
All of the assets and networks data are stored in Github under an MIT open source license.
The main repository is hosted at https://github.com/map3xyz/assets.
Individual networks with fungible assets, like Ethereum, have their own Tokenlist Standard repository. For example: https://github.com/map3xyz/ethereum-tokenlists.
These are composed via Git submodules, offering linear data scaling that is transparent and practical to manage.
You can read more about the repository architecture and files available here: https://github.com/map3xyz/assets/blob/master/docs/STRUCTURE.md.
Adding Data
Anyone can add new assets for existings networks on Map3 Metadata. We're working on a way to make it easier for community members to request adding more networks to Map3 Metadata.
There are two primary ways to add data:
- Programmatically: We rely on the ingestion of tokenlists from existing community sources via our open source Indexer.
- Manually: You can create a pull request against any of the tokenlist submodule repos adding or editing asset data. In the short term, our admins are reviewing all submissions. We are working on creating an assets app to streamline add/edit/map/verify actions.
For more details, read our contribution guide: https://github.com/map3xyz/assets/blob/master/docs/STRUCTURE.md
Data Validation
All of our data is validated by a continuous integration service powered by Github Actions.
We have built the open source Assets Helper to power these validations.
The ultimate goal is that anyone, anywhere can add data — manually or programmatically — to Map3 Metadata. It will get merged as long as it passes our CI checks.
The data can then be verified via our Kleros-powered verification process.
Data Aggregation
Our data is aggregated into an SQLite database for ease of use on a regular basis.
You can find the latest instance in our releases page: https://github.com/map3xyz/assets/releases
API
Our API makes it easy to consume the data via a REST interface. Our API is open source and can be self-hosted.
You can get started using our API by signing up for an account at https://map3.xyz.
Once you have an account, you can create an API key. You can also self-host our API here: https://github.com/map3xyz/api
Map3 Metadata Objects
| Object | Description | Examples |
|---|---|---|
| Networks | Blockchain Networks house crypto assets. Each network must have at least one asset, the fee asset of the network. | Bitcoin, Ethereum |
| Assets | Assets live in crypto networks. The same asset might live on multiple crypto networks if they are mapped to each other. | Ether, USDC |
| Maps | Maps contain the necessary metadata to link crypto assets across networks. | USDC on Solana is equal to USDC on Ethereum |
| Verifications | Networks, Assets and Maps contain an optional list of Verification objects which detail whether the object has been verified. | Kleros verification transaction/IPFS hash |