• Stars
    star
    235
  • Rank 171,079 (Top 4 %)
  • Language
    Nix
  • Created over 3 years ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

CIP26 Off-Chain Metadata Registry (mainnet)

This is the CIP26 off-chain metadata registry for mainnet. If you intend to register any metadata for on-chain assets that exist on the publicly available testnets only (e.g. preview and preprod environments) please use the metadata-registry from IOHK.

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 require a GitHub Pull Request with the modification of one JSON file 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
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
policy Optional The base16-encoded CBOR representation of the monetary policy script, used to verify ownership. Optional in the case of Plutus scripts as verification is handled elsewhere.
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

The policy field is optional in order to support Plutus Smart-Contracts which are not linked to a set of signing keys by default. It is used in priority if present. Otherwise, signature verification is performed using user-provided trusted keys.

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 a singular file in the mappings/ folder. Multiple mappings should be split across multiple PRs.

  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.

More Repositories

1

cardano-wallet

HTTP server & command-line for managing UTxOs and HD wallets in Cardano.
Haskell
764
star
2

CIPs

JavaScript
468
star
3

developer-portal

The Cardano Developer Portal
JavaScript
378
star
4

cardano-graphql

GraphQL API for Cardano
Nix
263
star
5

cardano-explorer-app

Cardano Explorer App
TypeScript
100
star
6

cardano-rosetta

An implementation of Rosetta for Cardano
TypeScript
98
star
7

docs-cardano-org

Documentation for Cardano
CSS
96
star
8

cf-identity-wallet

Identity Wallet is an open source mobile application developed by the Cardano Foundation. It provides a digital solution for users to securely store, manage, and share their identifiers and verifiable credentials.
TypeScript
79
star
9

cardano-connect-with-wallet

This repository aims to provide useful hooks and React components as well as a framework-independent core library
TypeScript
74
star
10

testnets-cardano-org

Official Cardano Testnets website repository
JavaScript
57
star
11

incentivized-testnet-stakepool-registry

Standard ML
53
star
12

stake-pool-school-handbook

36
star
13

dab

Decentralized applicaton backend for Cardano.
Haskell
35
star
14

ledgerjs-hw-app-cardano

Cardano bindings for Ledger Nano S JavaScript APIs for Node.js and browsers
TypeScript
31
star
15

ledger-app-cardano

Cardano Ledger App for Ledger Nano S
C
25
star
16

cardano-org

The Cardano Website
JavaScript
25
star
17

cf-java-rewards-calculation

This java project is used to calculate the rewards of the Cardano blockchain. It aims to be both an edge case documentation and formula implementation.
Java
19
star
18

cf-ledger-sync

An open-source Java application designed to facilitate access to indexed Cardano blockchain data
Java
17
star
19

cf-cardano-ballot

Cardano Ballot is a user-friendly, hybrid on- and off-chain voting system developed by the Cardano Foundation. Cardano Ballot leverages a set of backend services combined with frontend applications to facilitate voting within the Cardano Ecosystem.
TypeScript
17
star
20

aiken-lucid-yaci-dev-kit-starter-kit

A template showing how to develop on Cardano using Yaci-Dev-Kit, Lucid and Aiken.
TypeScript
14
star
21

cardano-verify-datasignature

A lightweight typescript library to verify a cip30 datasignature
TypeScript
13
star
22

hydra-voting-poc

Hydra Voting PoC with Catalyst
Java
12
star
23

hydra-java

Incubation project for Java client for Hydra L2 solution.
Java
11
star
24

cardano-rosetta-java

An implementation of Rosetta for cardano based yaci-store to offer reduced ressource footprints
Java
11
star
25

fine-types

FineTypes is an interface description language (IDL) focussing on types
Haskell
10
star
26

ambassadors-guild

The Ambassadors Guild aims to support the Community and the Foundation as a communicative and coordinating body, acting as an independent and supportive extension of the Foundation.
10
star
27

cf-explorer

The Cardano Explorer makes it easy for regulators, policymakers and regulated entities to navigate the Cardano blockchain without having to be Cardano experts. Publicly available and to be open sourced soon!
Shell
10
star
28

CIP-0094-polls

JavaScript
9
star
29

state-of-the-developer-ecosystem

https://cardano-foundation.github.io/state-of-the-developer-ecosystem/2022/
JavaScript
9
star
30

cf-explorer-frontend

This repository houses the frontend component of Explorer
TypeScript
7
star
31

cf-adahandle-resolver

This project aims to provide a scoped indexer for retrieving ADA Handle information from the Cardano blockchain and exposing it via REST using Yaci Store
Java
6
star
32

cip30-data-signature-parser

Java implementation of CIP-30 DataSignature parsing and validation
Java
6
star
33

cf-explorer-api

This service provides access to blockchain data that is compatible with the PostgreSQL database of DBSync. It serves as a data source for the explorer
Java
4
star
34

cf-summit-evoting-status

📈 Uptime monitor and status page for the Cardano Ballot app for Cardano Summit, powered by @upptime
Markdown
4
star
35

cf-token-metadata-registry

Java
4
star
36

blockperf

Python
3
star
37

cardano-org-header

JavaScript
3
star
38

cf-ledger-consumer-schedules

This repository executes tasks in a periodic sequence to precompute computationally intensive jobs within the scope of the explorer project
Java
3
star
39

cf-cardano-conversions-java

Cardano Conversions is a library that exposes a various deterministic conversions that can be done in Cardano, e.g. utc time to absolute slot, utc time to epoch no, epoch no to absolute slot, etc
Java
3
star
40

merkle-tree-java

Merkle Tree implementation in Java and Aiken including proof generation and verification.
Java
2
star
41

cf-cip-frontend

The Cardano CIP Frontend
JavaScript
2
star
42

cf-discord-wallet-verification-bot

This bot aims to provide a wallet and user association based on the user's discord account.
TypeScript
2
star
43

cardano-wallet-client

Haskell
2
star
44

cf-explorer-authentication

The Explorer Authentication API enables users to log in, with or without a wallet, to share personalized data such as bookmarks across devices
Java
2
star
45

cf-explorer-landing

A web application showcasing major Cardano blockchain explorers
JavaScript
2
star
46

cardano-ibc-summit-demo

Go
1
star
47

cf-java-cardano-common-explorer

Java
1
star
48

cardano-ibc-incubator

TypeScript
1
star
49

cf-explorer-rewards

This repository provides an API for retrieving reward data for stake pools and delegators. It utilizes Koios to fetch the data, aggregates and stores it, and serves it for the cardano explorer
Java
1
star