You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Frederic J d185d6a29f
Merge pull request #234 from Chris-Graffagnino/master
3 months ago
.github DIFF variable no longer exists, look at file diff instead 4 months ago
mappings Merge pull request #234 from Chris-Graffagnino/master 3 months ago
nix Bumps nix shell cardano-node -> 1.27.0, offchain-metadata-tools -> v0.2.0.0 4 months ago
.gitignore Adds GH ci, PR template, nix-shell 7 months ago
API_Terms_of_Use.md Update API_Terms_of_Use.md 7 months ago
README.md adding decimals in readme 3 months ago
Registry_Terms_of_Use.md Update Registry_Terms_of_Use.md 7 months ago
shell.nix offchain-metadata-tools v0.1.0.0 release 5 months ago

README.md

cardano-token-registry

Background

This repository provides a means to register off-chain token metadata that can map to on-chain identifiers (typically hashes representing asset IDs, output locking scripts, or token forging policies).

A server exposes the functionality of a key-value store, allowing users and applications to query registry entries through a RESTful API.

While this registry is limited in scope to handle native tokens only, it will also serve to facilitate a discussion and introduce a standard for a metadata distribution system that is currently put forward as a draft CIP.

Use of this registry is subject to the Registry Terms of Use.
Use of the public API is subject to the API Terms of Use.

Process

New registration

New submissions to this registry will take the form of a GitHub Pull Request with the addition of one JSON file to the mappings/ folder. Submissions will be subject to automated checking for well-formedness and human vetting before being merged to the registry.

Updating existing entries

Modification of entries in this registry will take the form of a GitHub Pull Request with the modification of one or more JSON files in the mappings/ folder. Submissions will be subject to automated checking for well-formedness and human vetting before being merged to the registry.

Semantic content of registry entries

Each entry contains the following information:

Name Required/Optional Description
subject Required The base16-encoded policyId + base16-encoded assetName
policy Required The script that hashes to the policyId
name Required A human-readable name for the subject, suitable for use in an interface
description Required A human-readable description for the subject, suitable for use in an interface
ticker Optional A human-readable ticker name for the subject, suitable for use in an interface
url Optional A HTTPS URL (web page relating to the token)
logo Optional A PNG image file as a byte string
decimals Optional how many decimals to the token

For a comprehensive description of all fields and how to generate them, please see offchain-metadata-tools.

Submission well-formedness rules

  1. Submissions to the registry must consist of a single commit, directly off the master branch of the cardano-token-registry repository.

  2. Submissions must add or modify files in the mappings/ folder.

  3. The file name must match the encoded "subject" key of the entry, all lowercase.

  4. The maximum file size of a single metadata entry is 370KB.

Server

Users and applications can query this registry through an API at https://tokens.cardano.org/metadata.

The API documentation and source code for the server implementation is available with the offchain-metadata-tools.

Use of the https://tokens.cardano.org/metadata API is subject to the API Terms of Use.

Step-by-Step Guide

See Wiki.