| CIP | Title | Status | Category | Authors | Implementors | Discussions | Created | License | |||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
86 |
NFT Metadata Update Oracles |
Proposed |
Metadata |
|
|
2022-11-01 |
CC-BY-4.0 |
This proposal extends the CIP-25 standard for defining and updating token metadata via transaction metadata, by providing a new mechanism to update token metadata without having to mint or burn tokens, while maintaining full backward compatibility with CIP-25. The new mechanism is capable of expressing metadata updates more efficiently than CIP-25 updates.
On Cardano’s eUTxO ledger, native tokens exist without any inherently attached metadata. The ledger does not provide a direct method for preserving any information associated with an asset class of native tokens, as transactions move the tokens from one UTxO to another.
The Media NFT Metadata Standard (CIP-25) proposed an indirect way to attach metadata to an asset class — using the metadata field (CBOR tag 721) of its minting transactions. When there are multiple minting transactions for the same asset class, the latest minting transaction’s metadata overrides all previous metadata defined for that asset class.
CIP-25 is widely supported across the Cardano community by blockchain indexers, wallet providers, marketplace applications, and other stakeholders. It has served the community quite well so far, in particular for non-fungible tokens (NFTs) with static metadata (i.e. intended to be mostly immutable after minting).
However, the CIP-25 metadata update mechanism is suboptimal because it requires tokens of the asset class to be minted or burned whenever its metadata is updated. This is incongruous with the often purely-informational purpose of metadata update transactions. While it may sometimes be convenient to combine token minting and metadata updates within the same transaction (e.g. to save on transaction fees), there is a broad range of applications where metadata updates need to be more frequent and independent from minting events.
In practice, there are three main drawbacks to the CIP-25 update mechanism:
- The metadata authority for an asset class must retain the ability to mint/burn more tokens of the asset class if it wants to retain the ability to post metadata updates/corrections. This compromises the token issuers’ guarantees to token holders that the token supply (or NFT collections) will not be diluted in the future. Token holders are being asked to trust that the metadata authority will not abuse its power to mint new tokens of the same asset class.
- Executing a minting policy script to mint or burn tokens every time that an asset class’ metadata is updated incurs script execution fees, particularly if the script is Plutus-based, far exceeding the fees corresponding to the actual informational content of the metadata update. This cost can become severe for large collections of thousands of NFTs, and it may be prohibitive for implementing any dynamic fields for such large NFT collections.
- An asset class’ metadata can only be updated as a whole. This is inefficient (both in terms of transaction fees and ledger bloat) when only a small subset of the metadata fields needs to be updated for a large collection of NFTs, and it can lead to errors if the unmodified fields are improperly copied over to the update.
We encountered these drawbacks during the development of an NFT gaming application, where thousands of NFTs correspond to game assets with properties (e.g. horse age, physical and mental abilities) that evolve both over time and as the NFTs participate in various game-related events on-chain. These properties do not need to interact with smart contract logic directly, which makes transaction metadata a more appropriate place to define them, rather than UTxO datums with complicated state-evolution logic.
Our NFT gaming application is leveraging the Cardano immutable ledger, rather than an off-chain database, as the single source of truth to track the evolution of the game assets’ most important properties. This reassures users that the history of metadata states for a game NFT cannot be retroactively erased or altered by the game admins — although the game admins have the authority to modify metadata going forward, they are retroactively accountable for all past updates.
We expect that this proposal will be useful to many other applications that need to track dynamic on-chain metadata for large NFT collections, particularly in the growing NFT gaming sector. It may also be useful for artists to update on-chain metadata about their art NFTs (e.g. royalty payment receiving address) without having to burn or mint anything.
Our proposal extends CIP-25 with a new update mechanism:
- A metadata oracle can be assigned for a given policy ID.
- For a policy with a metadata oracle assigned, the metadata oracle can post CIP-86 updates to add, remove, or modify any fields of the token’s CIP-25 metadata, without needing to mint or burn any tokens in the metadata update transactions.
- The current metadata for a token can be deterministically reconstructed by starting from the latest CIP-25 update to the token, and applying the subsequent CIP-86 metadata updates in ascending blockchain transaction order.
Both CIP-25 and CIP-86 updates affect the token metadata:
- A CIP-25 update removes all fields in the current metadata state and replaces them with a new complete definition of the metadata state.
- A CIP-86 update selectively adds, removes, or modifies fields relative to the current metadata state. It does not apply to any asset class that has not had tokens previously minted or any asset class that has not had CIP-25 metadata previously defined, before the CIP-86 update.
However, we recommend that CIP-86 adopters use the new metadata update mechanism exclusively to manage all updates to their token metadata after the initial CIP-25 metadata is set.
Our proposal only affects the 86 top-level CBOR tag
of the metadata field in Cardano transactions.
(Note: we’re using 86 as a stand-in for the CIP number
that will eventually be assigned to this proposal.)
A token metadata oracle is defined via two addresses:
- An oracle update address that is authorized to post metadata updates. For example, this address could be controlled by a bot that automatically posts token metadata updates as needed to the blockchain.
- An oracle main address that is used to update the oracle update address. This address should be controlled via private keys held in cold storage or hardware wallets.
A metadata oracle can be explicitly assigned to a policy ID by setting the following metadata in a transaction that mints or burns tokens for that policy:
{
"86": {
"assign_metadata_oracle": {
"<policyId>": {
"main_address": "<Shelley_address>",
"update_address": "<Shelley_address>"
}
}
}
}While a metadata oracle is not explicitly assigned to a native-script-based policy ID, the policy ID is implicitly assigned a metadata oracle with both addresses set to an address derived from the native script. Specifically, they are both set to an Enterprise address constructed by setting the payment key to the verification key from the native script and keeping the staking key empty.
The metadata oracle assignment for a policy ID can be updated via a transaction signed by the oracle main address key. The transaction must only send ADA from the oracle main address to itself and must not mint any tokens, but it may contain any number of inputs and outputs. Otherwise, the transaction is ignored for the purposes of metadata oracle assignment.
The schema for updating an oracle assignment is the same as for the initial assignment in the minting transaction:
{
"86": {
"assign_metadata_oracle": {
"<policyId>": {
"main_address": "<Shelley_address>",
"update_address": "<Shelley_address>"
}
}
}
}The main_address or the update_address fields for a <policyID>
can be omitted, in which case the addresses for the omitted fields
remain the same for that policy ID.
If a metadata oracle was implicitly assigned to a policy ID before the assignment update, then the implicit assignment is replaced by the new explicit assignment.
A simple metadata update transaction must only send ADA from the oracle update address to itself and must not mint any tokens, but it may contain any number of inputs and outputs. Otherwise, the transaction is ignored for the purposes of token metadata.
The schema for simple metadata updates in CIP-86
is similar to the CIP-25 schema,
but it is nested under 86.simple_metadata_update
in the transaction metadata object.
{
"86": {
"simple_metadata_update": {
"<policyId>": {
"<tokenName>": {
"<metadataField>": "<metadataValue>"
}
}
}
}
}To remove a metadata field,
set its value explicitly to null in the metadata update.
The schema for regex metadata updates is as follows:
{
"86": {
"regex_metadata_update": {
"<policyId>": {
"<tokenNameRegex>": {
"<metadataField>": "<metadataValue>"
}
}
}
}
}A regex metadata update transaction must only send ADA from the oracle update address to itself and must not mint any tokens, but it may contain any number of inputs and outputs. Otherwise, it is ignored for the purposes of token metadata.
The only difference from the simple metadata update is that
here the token names are defined in terms of PCRE regular expressions (regex).
The regex metadata update applies to any previously minted token
whose policy ID matches <policyID>
and whose token name matches the <tokenNameRegex> regular expression.
For example, the following metadata update would apply
to every Equine pioneer horse
between EquinePioneerHorse05000 and EquinePioneerHorse05999:
{
"86": {
"regex_metadata_update": {
"30ed3d95db1d6bb2c12fc5228a2986eab4553f192a12a4607780e15b": {
"^EquinePioneerHorse05\\d{3}$": {
"age": 2
}
}
}
}
}The regular expression pattern in <tokenNameRegex>
is defined according to the grammar in:
- European Computer Manufacturers Association, "ECMAScript Language Specification 5.1 Edition", ECMA Standard ECMA-262, June 2011. Section 15.10. https://www.ecma-international.org/wp-content/uploads/ECMA-262_5.1_edition_june_2011.pdf
Tabular metadata updates use a condensed rectangular format to specify new values for a fixed set of fields for a large number of assets. Specifically, for each policy ID we provide an object with the following three fields:
field_pathscontains an array of paths pointing to possibly-nested fields within a token metadata object. Each of these field paths is a dot-separated list of field names (e.g."images.background.sunset.url") that lead from the top of the metadata object (for asset classes of the policy) into a targeted field within that object.token_namescontains an array of token names.valuescontains a table of values, represented by an array of arrays. For each token name intoken_names, the outer array invaluescontains one element (an inner array) of metadata values to which the fields targeted byfield_pathsshould be updated for that token name under the policy ID. The outer array ofvaluesmust be equal in length totoken_namesand each inner array ofvaluesmust be equal in length tofield_paths.
{
"86": {
"tabular_metadata_update": {
"<policyId>": {
"field_paths": [
"<fieldPath>"
],
"token_names": [
"<tokenName>"
],
"values": [
["<metadataValue>"]
]
}
}
}
}A tabular metadata update transaction must only send ADA from the oracle update address to itself and must not mint any tokens, but it may contain any number of inputs and outputs. Otherwise, it is ignored for the purposes of token metadata.
For example, the following update would apply updates to six metadata fields of five Equine horse NFTs:
{
"86": {
"tabular_metadata_update": {
"<policyId>": {
"field_paths": [
"age",
"stats.acceleration",
"stats.agility",
"stats.endurance",
"stats.speed",
"stats.stamina"
],
"token_names": [
"EquinePioneerHorse00000",
"EquinePioneerHorse00012",
"EquinePioneerHorse00315",
"EquinePioneerHorse01040",
"EquinePioneerHorse09175"
],
"values": [
[3,34,16,18,51,33],
[2,24,48,12,32,18],
[3,33,34,41,14,31],
[4,19,22,21,21,50],
[1,24,11,36,22,14]
]
}
}
}
}It is equivalent to the following simple metadata update:
{
"86": {
"simple_metadata_update": {
"<policyId>": {
"EquinePioneerHorse00000": {
"age": 3,
"stats": {
"acceleration": 34,
"agility": 16,
"endurance": 18,
"speed": 51,
"stamina": 33
}
},
"EquinePioneerHorse00012": {
"age": 2,
"stats": {
"acceleration": 24,
"agility": 48,
"endurance": 12,
"speed": 32,
"stamina": 18
}
},
"EquinePioneerHorse00315": {
"age": 3,
"stats": {
"acceleration": 33,
"agility": 34,
"endurance": 41,
"speed": 14,
"stamina": 31
}
},
"EquinePioneerHorse01040": {
"age": 4,
"stats": {
"acceleration": 19,
"agility": 22,
"endurance": 21,
"speed": 21,
"stamina": 50
}
},
"EquinePioneerHorse09175": {
"age": 1,
"stats": {
"acceleration": 24,
"agility": 11,
"endurance": 36,
"speed": 22,
"stamina": 14
}
}
}
}
}
}Like CIP-25, CIP-86 supports two different methods of representing policy IDs and token name:
- In version 1, policy IDs and token names must be expressed as text (see cddl/version_1.cddl).
- In version 2, policy IDs and token names must be expressed as raw bytes (see cddl/version_2.cddl).
By default, all CIP-86 metadata updates use version 1.
However, version 2 can be used if the version field of the object
under the top-level "86" CBOR tag is set to 2.
For example:
{
"86": {
"version": 2,
"simple_metadata_update": {
"<policyIdRawBytes>": {
"<tokenNameRawBytes>": {
"<metadataField>": "<metadataValue>"
}
}
}
}
}Regex updates are disallowed in version 2, because it is unclear how to apply regular expressions to non-UTF-8 bytestrings (or their corresponding hex encodings).
Up to network consensus, the Cardano blockchain imposes a total ordering on transactions added to the chain — each transaction can be indexed by the slot number of the block that added it to the chain, and the transaction’s index within that block. Network nodes may disagree about which blocks have been added most recently to the blockchain; however, the disagreement about whether a particular transaction was added at a particular position in the total order decreases exponentially as more and more blocks are added to the chain.
To reconstruct the metadata state for a given asset class, scan through the sequence of transactions in a Cardano node’s blockchain, applying the CIP-25 and CIP-86 updates in the order that they are encountered in this sequence. If the Cardano node rolls back some blocks from the chain tip, then roll back the updates from those blocks as well.
We recommend that token metadata oracle operators wait for their metadata update transactions to be confirmed at a sufficient block depth before submitting any subsequent metadata updates for the same asset classes. Doing so should minimize any confusion about the order of simultaneous pending metadata updates while the Cardano network settles toward consensus.
A transaction that contains a CIP-25 update may also contain an explicit oracle assignment, but these can be applied in parallel because they do not clash with each other. On the other hand, a CIP-25 update transaction cannot contain CIP-86 token metadata updates, because CIP-25 updates can only occur in minting transactions while CIP-86 token metadata transactions can only occur in non-minting transactions.
A transaction can contain CIP-86 token metadata updates of different types, plus oracle assignment updates. In this case, apply the updates in the following sequence:
- Apply the CIP-86 regex update.
- Apply the CIP-86 tabular update.
- Apply the CIP-86 simple update.
- Apply the CIP-86 oracle assignment update.
We recommend that token metadata oracle operators not mix multiple update types in the same transaction, unless they have a clear understanding of the outcome of applying the updates in the above sequence.
The CIP-86 token metadata indexer begins with a configuration of the policy IDs for which it will be tracking metadata. Optionally, it can be configured to track metadata for all tokens on Cardano.
The indexer monitors the blockchain for minting transactions. If such a minting transaction mints tokens of a tracked policy ID and contains an explicit oracle assignment and/or CIP-25 metadata for that policy ID, then the indexer caches that assignment and metadata in its database. If the transaction does not contain an explicit oracle assignment for the policy ID, and there is no prior oracle assignment, then the indexer caches the implicit oracle assignment for the policy ID in its database.
The indexer continues to monitor minting transactions for the policy IDs that it’s tracking, applying oracle assignment updates and CIP-25 metadata updates accordingly in its database. A CIP-25 metadata update is applied as a wholesale replacement of the metadata cached in the indexer database for the respective asset classes.
For each oracle main address currently assigned to a policy ID, the indexer monitors the blockchain for non-minting transactions that only send ADA from the oracle main address to itself and contain oracle assignment updates in their metadata. The indexer updates its database to reflect these explicit oracle assignments and removes any implicit assignments that were replaced by explicit assignments.
For each oracle update address currently assigned to a policy ID, the indexer monitors the blockchain for non-minting transactions that only send ADA from the oracle update address to itself and contain CIP-86 token metadata updates. The indexer applies these metadata updates in the order defined in Order of application for updates. CIP-86 metadata updates are applied to the asset classes and metadata fields that they target, while keeping all other fields the same.
To be able to handle blockchain rollbacks, the indexer keeps track of
past metadata states for its policy IDs,
going back 2160 blocks (~12 hours) from the current blockchain tip.
Cardano’s securityParam Shelley Genesis parameter prevents nodes
from rolling back more than 2160 blocks.
If the Cardano node informs the indexer of a rollback,
the indexer restores the past metadata state that existed immediately before
all the metadata updates in the rolled-back blocks were applied.
For compatibility with existing applications that are already relying on CIP-25 metadata indexers, the CIP-86 indexer provides a similar API so that those applications can get and display the current CIP-86 token metadata in the same way that they have been for CIP-25 metadata. The indexer indicates that it is following the CIP-86 standard.
We pursued the following design goals in our solution:
- Maintain backward compatibility with CIP-25 — tokens that only use CIP-25 updates should have token metadata displayed identically by CIP-25 indexers and CIP-86 indexers.
- Ensure that the current token metadata can be reconstructed by only looking at the blockchain, without accessing any external resources.
- Allow token metadata to be updated by designated authorities without minting or burning tokens.
- Allow existing token issuers to opt into and out of the CIP-86 update mechanism without having to remint all of their existing tokens.
- Allow designated authorities to securely rotate any keys that they use in their automated and networked processes (e.g. oracle update address used by a bot to update token metadata).
- Allow token metadata to be updated more efficiently than by a wholesale replacement of the entire metadata object for an asset class.
- Minimize the time and resource usage required for an indexer to apply CIP-25 and CIP-86 updates for an asset class and then serve the resulting token metadata to applications.
- Gracefully handle blockchain rollbacks that modify the sequence of CIP-25 and CIP-86 metadata updates for an asset class.
We maintain full backward compatibility with CIP-25:
- CIP-25 updates are respected and applied in the same way as before by the CIP-86 indexer.
- CIP-86 updates are namespaced under a different top-level CBOR tag than CIP-25, in order to prevent any clashes between field names, policy IDs, and token names.
- The CIP-86 indexer provides the accumulated CIP-25 and CIP-86 metadata via the same API as the CIP-25 indexer.
We recognize CIP-86 updates only if they are issued by an oracle currently assigned for the corresponding policy IDs. This assignment is either directly authorized by the token issuer (explicitly or implicitly) or else indirectly authorized by the token issuer via the delegated authority that the token issuer placed in the originally assigned oracle to transfer the assignment to other oracles. Therefore, all authority to post valid CIP-86 updates about a token originates from the token issuer.
An alternative design could have oracles that declare themselves as sources of metadata for tokens, without authorization from anyone, and then users could voluntarily subscribe to the metadata oracles that they wish to follow. However, such an approach would make it very difficult for the Cardano ecosystem to converge on a single objective metadata state for a token, as each user would have his own subjective view of token metadata based on his oracles subscriptions. This alternative approach could be interesting to allow secondary/auxiliary metadata to be defined for tokens, but it is unsuitable for the primary metadata that CIP-25 and CIP-86 seek to manage.
We use two addresses to identify an oracle when assigning it to a policy ID. It would be simpler to use a single oracle address, but we chose to separate the main address (authorized to reassign the oracle) from the update address (authorized to post updates) for an oracle. We did this to mitigate the risk of using the update address in an automated process on a network machine, and to allow the update address to be safely rotated via a transaction that can only be signed on a cold storage or hardware wallet device using the main address.
Instead of using addresses to identify oracles,
we could have identified oracles by minting policies
(not the minting policies to which oracles are assigned).
In this alternative design, a minting policy X could have
an assigned oracle identified by minting policy A.
Under such an assignment, a CIP-86 update for a token under X
would be valid if the update transaction consumed a utxo
that contained a token of minting policy A.
In other words, the holder of an A token would be allowed
to post metadata updates about any X tokens.
This minting-policy-based alternative for identifying oracles may be more advantageous for more flexibly managing oracle authorization (including rate-limiting, time-boxing, etc.) and proving data provenance to on-chain scripts. These advantages are relevant for oracles that provide information in utxo datums meant for use in smart contracts, but they are not as relevant for this CIP, where we seek to provide a method to provide updateable token metadata via transaction metadata (as a direct extension of CIP-25). Furthermore, it is easier to track transactions originating from a given address in an indexer than to keep track of all the people who control various authorization tokens, at a given time.
We prohibit CIP-86 oracle assignment updates and metadata updates from occurring in transactions that mint tokens, in order to avoid awkward clashes with CIP-25 metadata transactions. Also, it does not make sense conceptually for CIP-25 metadata transactions to coincide with CIP-86 updates. CIP-25 should be used to define the initial metadata for an asset class, and then CIP-86 updates should be used for any subsequent changes to that metadata.
We require CIP-86 updates to occur in transactions that only send ADA from an oracle address (main or update, as appropriate), to prevent unforeseen interactions with other mechanisms that may have negative consequences. CIP-86 update transactions should have the singular purpose of interacting with the CIP-86 update mechanism.
The implicit method of assigning a metadata oracle is needed to allow existing token issuers to opt into the CIP-86 update mechanism. Their minting policies may no longer allow any more token minting or burning, which would prevent the token issuers from being able to explicitly assign an oracle via a CIP-25 update for those policies. The implicit assignment method bootstraps the CIP-86 update mechanism for these policies.
The implicit address is of the Enterprise address type, to avoid having to deal with staking keys. If needed, the metadata oracle operator can send ADA to the Enterprise address, and then spend it if the operator still controls the payment key of that Enterprise address.
Opting out of the CIP-86 update mechanism can be done by explicitly assigning an oracle with addresses from which ADA cannot be spent (e.g. Plutus AlwaysFails). If the minting policy does not allow any more minting or burning, then this is an irreversible opt-out.
When managing large collections of thousands of NFTs, one often needs to set a given field to the same value for many NFTs. Doing this individually for each NFT via CIP-25 updates or CIP-86 simple updates is inefficient, so we have proposed the regex metadata update as a succinct way to specify a mapping from multiple token names to a single metadata update.
Another common use case for dynamic token metadata involves having a set of volatile fields that should receive relatively frequent updates, but where those updates should be different for each NFT. Labeling each field value update with its field name for each NFT is very verbose, especially if the field is deeply nested within the metadata schema for the NFT. For this use case, we have proposed the tabular metadata update format as a way to avoid this repetition — field names/paths are defined once in the column names of a rectangular table and applied consistently for each row of updated metadata field values.
Rectangular tables are a standard format used in the data analytics field for these situations.
This proposal may be considered active if:
- The solution meets the design goals listed in the Rationale section to a satisfactory degree.
- The indexer and simple tools to construct CIP-86 update transactions (as described in the Specification section) are fully implemented and provided in an open-source (Apache 2.0 licensed) repository with sufficient documentation.
- The CIP-86 metadata format, indexer, and/or indexer API are used by several stakeholders in the Cardano ecosystem, including dApps, blockchain explorers, analytics platforms, etc.
Equine and MLabs are collaborating on developing the indexer described in this CIP and the Equine NFT gaming application will be using CIP-86 updates to manage metadata updates for its large collection of thousands of NFTs under multiple minting policies.
We will include detailed documentation, example configurations, and tutorials on how to adapt the tools to new projects.
We are actively engaged in discussions with other stakeholders in the Cardano ecosystem that are interested in adopting this CIP to their projects, platforms, and tools.
This CIP is licensed under the Creative Commons Attribution 4.0 International Public License (CC-BY-4.0).