Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SIP-019: Notifications for Token Metadata Updates #72

Merged
merged 23 commits into from
Jun 9, 2023

Conversation

rafaelcr
Copy link
Contributor

@rafaelcr rafaelcr commented May 24, 2022

Preamble

SIP Number: 019

Title: Notifications for Token Metadata Updates

Author: Rafael Cárdenas ([email protected]), Matthew Little ([email protected])

Consideration: Technical

Type: Standard

Status: Activation-in-Progress

Created: 17 May 2022

License: GPL-3.0

Sign-off: Jude Nelson ([email protected]), Aaron Blankstein ([email protected])

Layer: Traits

Abstract

As the use of tokens (fungible and non-fungible) has grown in popularity, Stacks developers have
found novel ways to define and use metadata to describe them. This rich data is commonly cached and
indexed for future use in applications such as marketplaces, statistics aggregators, and developer
tools like the Stacks Blockchain API.

Occasionally, however, this metadata needs to change for a number of reasons: artwork reveals, media
storage migrations, branding updates, etc. As of today, these changes do not have a standardized way
of being propagated through the network for indexers to refresh their cache, so the display of stale
metadata is a very common problem.

This SIP aims to define a simple mechanism for developers to notify the Stacks network when metadata
for a token has changed, so interested parties can refresh their cache and display up-to-date
information in their applications.

Introduction

Smart contracts that declare NFTs, FTs and SFTs conform to a standard set of traits used to describe
each token (see SIP-009,
SIP-010 and
SIP-013).
One of these traits is get-token-uri, which should return a URI string that resolves to a token's
metadata usually in the form of a JSON file. There is currently no defined structure for this data,
and it is not considered to be immutable.

To illustrate a common use of get-token-uri, we'll look at the
SPSCWDV3RKV5ZRN1FQD84YE1NQFEDJ9R1F4DYQ11.newyorkcitycoin-token-v2
contract which declares the NewYorkCityCoin fungible token.

At the time of writing, the value returned by this contract for get-token-uri is the string:

"https://cdn.citycoins.co/metadata/newyorkcitycoin.json"

When this URI is resolved, it returns a JSON file with the following metadata:

{
  "name": "NewYorkCityCoin",
  "description": "A CityCoin for New York City, ticker is NYC, Stack it to earn Stacks (STX)",
  "image": "https://cdn.citycoins.co/logos/newyorkcitycoin.png"
}

Even though the URI string is fixed, this file lives off-chain so it is conceivable that its
contents could change at any point in the future. Additionally, this contract includes a way for its
owners to change this URI via a var-set function call:

(define-data-var tokenUri (optional (string-utf8 256)) (some u"https://cdn.citycoins.co/metadata/newyorkcitycoin.json"))

;; set token URI to new value, only accessible by Auth
(define-public (set-token-uri (newUri (optional (string-utf8 256))))
  (begin
    (asserts! (is-authorized-auth) ERR_UNAUTHORIZED)
    (ok (var-set tokenUri newUri))
  )
)

This setup is very flexible for administrators, but it creates a complex problem for metadata
indexers which now need to figure out if (and when) they should re-index token contracts to avoid
displaying stale metadata in their applications.

Metadata staleness

Within the Stacks ecosystem, there are a number of applications that need to index token metadata
and struggle with specific challenges caused by changed metadata. For example:

  • An NFT marketplace, which needs to display a token's artwork for users to view.
    • Presenting a token's icon correctly is difficult given that the get-token-uri on-chain
      variable could change, the off-chain JSON file could change, and/or the image served by the URL
      could change.
  • A blockchain API, which needs to serve FT
    metadata to return account balances correctly.
    • Wallets require the on-chain decimals value in order to correctly send and receive tokens.
      Critical balance draining is possible when this property is zero at contract launch but updated
      later.

For indexing, developers usually run and maintain a background process that listens for new token
contracts deployed to the blockchain so they can immediately call on their metadata to save the
results. This works for new contracts, but it is insufficient for old ones that may change their
metadata after it has been processed.

To avoid staleness, some indexers resort to a cron-like periodic refresh of all tracked contracts,
but while this may work for individual applications, it does not provide a consistent experience for
Stacks users that may interact with different metadata-aware systems with different refresh periods.
This workaround also adds unnecessary network traffic and creates extra strain on public Stacks
nodes due to aggressively polling contract-read RPC endpoints.

Metadata update notifications

To solve this problem reliably, contract administrators need a way to notify the network when they
have made changes to the metadata so any indexers may then perform a refresh just for that contract.

The proposed mechanism for these notifications leverages the print Clarity
language function
. When
used, its output is bundled inside an event of type contract_event:

{
  "type": "contract_event",
  "contract_event": {
    "contract_identifier": "<emitter contract>",
    "topic": "print",
    "value": "<print output>"
  }
}

This event is then attached to a transaction object and broadcasted when the same transaction is
included in a block or microblock.

This SIP proposes a standard message structure (similar to a notification payload) that would be
used through print. Existing metadata indexers would receive this event through the Stacks node
event-emitter
interface
,
parse and validate its contents, and refresh any contracts that were updated. print was also
selected for the following reasons:

  1. There is precedent for the use of print notifications in the Stacks ecosystem: the BNS
    contract, for example, uses it to notify the network when a change to a name or its zonefile has
    occurred. The PoX-2 contract for Stacks 2.1 will make heavy use of it to record stacking state
    changes across addresses. This SIP aims to continue this trend.
  2. For chain indexers, consuming it is practically free if they already process transactions. This
    would enable, for example, a notification to be clearly displayed in the Stacks Explorer alongside
    its transaction.
  3. Adding a print notification to a function's Clarity code also serves as self-explanatory
    documentation.
  4. If there is a new notification use case in the future, a newer SIP can propose an additional
    print structure and indexers would be quick to adopt these if they need to. See Notification
    structure reusability
    .

Specification

Notification messages for each token class are specified below. Token metadata update notifications
must be made via a contract call transaction to the deployed reference
contract

or from a call to print within any other contract, including the token contract itself.

Fungible Tokens

When a contract needs to notify the network that metadata has changed for a Fungible Token, it
shall call print with a tuple with the following structure:

{ notification: "token-metadata-update", payload: { token-class: "ft", contract-id: <token contract id> }}
Key Value
notification The string "token-metadata-update"
payload.token-class The string "ft"
payload.contract-id The contract id (principal) of the contract that declared the token
payload.update-mode [optional] Metadata update mode (see section below)
payload.ttl [optional] Time-to-live for payload.update-mode: dynamic

Non-Fungible Tokens

When a contract needs to notify the network that metadata has changed for a Non-Fungible Token,
it shall call print with a tuple with the following structure:

{ notification: "token-metadata-update", payload: { token-class: "nft", token-ids: (list u100, u101), contract-id: <token contract id> }}
Key Value
notification The string "token-metadata-update"
payload.token-class The string "nft"
payload.contract-id The contract id (principal) of the contract that declared the tokens
payload.token-ids [optional] A list with the uint token ids that need to be refreshed
payload.update-mode [optional] Metadata update mode (see section below)
payload.ttl [optional] Time-to-live for payload.update-mode: dynamic

If a notification does not contain a value for payload.token-ids, it means it is requesting an
update for all tokens.

Semi-Fungible Tokens

When a contract needs to notify the network that metadata has changed for a Semi-Fungible Token,
it shall call print with a tuple with the following structure:

{ notification: "token-metadata-update", payload: { token-class: "sft", token-ids: (list u100, u101), contract-id: <token contract id> }}
Key Value
notification The string "token-metadata-update"
payload.token-class The string "sft"
payload.contract-id The contract id (principal) of the contract that declared the tokens
payload.token-ids A list with the uint token ids that need to be refreshed
payload.update-mode [optional] Metadata update mode (see section below)
payload.ttl [optional] Time-to-live for payload.update-mode: dynamic

Notifications for SFTs must include a value for payload.token-ids.

Metadata update modes

Applications may use tokens for very different purposes. Some of these could require none or very
few metadata updates ever (e.g. digital artwork that never changes except for reveals), while others
could need to alter it several times a day (e.g. NFTs for in-game items that are traded and modded
continuously).

This use-case variety also affects how developers decide to host their metadata JSON files. For
example, they could choose to use IPFS for low-frequency updates and finality, versus Amazon S3 for
high-frequency off-chain updates.

In order to allow creators and app developers to specify how token metadata should be treated by
indexers, notifications support an optional payload.update-mode key that may contain one of the
following values:

  • standard: The new metadata will be valid until the next notification comes.

    This is the default mode if none is specified.

  • frozen: This token's metadata will never change again, ever.

    Indexers should ignore new notifications for this token, even if valid.

  • dynamic: The new metadata is expected to change very quickly and many times in the future (even
    off-chain).

    Indexers should not expect to receive explicit notifications for each of these changes and
    should consider refreshing this token's metadata frequently. Token developers may suggest a
    reasonable amount of time between refreshes by adding an estimated value (defined in seconds) to the
    payload.ttl notification property.

Considerations for metadata indexers

For a token metadata update notification to be considered valid by metadata indexers, it must meet
the following requirements:

  1. Its payload structure should be correct whether it is updating a FT, an
    NFT or an SFT.
  2. Either the contract_identifier field of the contract event must be equal to the
    payload.contract-id (i.e., the event was produced by the contract that owns the metadata) or
    the transaction's tx-sender principal should match the principal contained in the
    notification's payload.contract-id (i.e., the STX address that sent the transaction which emits
    the notification should match the owner of the token contract being updated).

Notifications that do not meet these requirements must be ignored.

Other implications

  • Notifications can come at any point in time and are persistent in the Stacks blockchain.
    • When performing a local sync to the chain tip, old notifications for old metadata updates could
      not necessarily have a distinct effect in metadata responses when processed in the present.
  • Multiple notifications for the same tokens will not necessarily correspond to multiple metadata
    updates.
    • Refreshing a token's metadata should be an idempotent operation. Repeated refreshes should not
      create distinct records in the internal metadata database.
    • To prevent slow performance and guard against any Denial of Service attack attempts, contract
      call rate limiting should be implemented locally.
  • Notifications can be delayed and out of order.
    • A notification transaction's timestamp should not be considered to be the time when the token
      metadata was actually updated.

Given these constraints the notifications this SIP proposes should be taken as hints to metadata
indexers. Metadata indexers are not obliged to follow them.

Notification structure reusability

Even though establishing a generalized smart contract notification standard is out of scope for this
SIP, the proposed print message structure was designed for reusability by future SIPs that wish to
standardize other events.

For example, developers could vary the notification and payload values to notify the network
when an NFT collection has been fully minted or another important milestone is reached.

Related work

An alternative considered for token metadata update notifications is for them to be transmitted via
an off-chain notification service that indexer developers may subscribe to, such as:

  • An official mailing list
  • A forum post
  • An authoritative API service

While these channels would have several advantages like being simpler to update, faster to
propagate, and easier to moderate, they have key disadvantages that make them inadequate for this
SIP's intended use:

  1. They introduce a third party dependency
    • An off-chain notification service would most likely be maintained by centralized entities
      unrelated to the Stacks ecosystem. As such, they could modify the channel, its reach, or its
      rules at any time while affecting the entire network.
    • Accepting third party solutions would invite developers to use many different hinting service
      APIs and implementations, defeating the standardization purpose of this SIP. Moving
      notifications to the blockchain establishes a canonical way to store and access them.
    • Even if a decentralized off-chain third-party solution is found, it could still add a layer
      of friction for developer adoption.
  2. They are not future proof
    • If the selected off-chain service changes at any point, a migration to another notification
      channel will be much more difficult once the Stacks ecosystem has more token applications and
      metadata indexers.

Backwards compatibility

Developers who need to emit metadata update notifications for tokens declared in older contracts
(that were deployed before this notification standard was established) could do so by either calling
the contract described in Reference Implementations or by first
deploying a new separate contract containing a public function that prints this notification and
then calling it to have it emitted.

Activation

This SIP will be activated when the following conditions are met:

  1. At least 10 unique contracts have had metadata updates triggered via contract-call transactions
    that print the proposed notification payload.
  2. At least 3 metadata indexers (like the Stacks Blockchain API or an NFT marketplace) start
    listening for and reacting to the emitted notifications.

If the Stacks blockchain reaches block height 170000 and the above has not happened, this SIP will
be considered rejected.

Reference implementations

A reference contract has been deployed to mainnet as
SP1H6HY2ZPSFPZF6HBNADAYKQ2FJN75GHVV95YZQ.token-metadata-update-notify.
It demonstrates how to send notifications for each token class and it is available for developers to
use for refreshing any existing or future token contract. If the SIP evolves to require a change to
this contract pre-activation, a new one will be deployed and noted here.

;; token-metadata-update-notify
;;
;; Use this contract to notify token metadata indexers that an NFT or FT needs its metadata
;; refreshed.

(use-trait nft-trait 'SP2PABAF9FTAJYNFZH93XENAJ8FVY99RRM50D2JG9.nft-trait.nft-trait)
(use-trait ft-trait 'SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.sip-010-trait-ft-standard.sip-010-trait)

;; Refresh the metadata for one or more NFTs from a specific contract.
(define-public (nft-metadata-update-notify (contract <nft-trait>) (token-ids (list 100 uint)))
  (ok (print
    {
      notification: "token-metadata-update",
      payload: {
        contract-id: contract,
        token-class: "nft",
        token-ids: token-ids
      }
    })))

;; Refresh the metadata for a FT from a specific contract
(define-public (ft-metadata-update-notify (contract <ft-trait>))
  (ok (print
    {
      notification: "token-metadata-update",
      payload: {
        contract-id: contract,
        token-class: "ft"
      }
    })))

The Stacks Blockchain API will also add
compatibility for this standard while this SIP is being considered to demonstrate how indexers can
listen for and react to these notifications.

@aulneau
Copy link
Contributor

aulneau commented May 24, 2022

Really happy to see this!

My first thought around this is the concept around having to specify a list of asset id's for the NFT section

(define-public (nft-metadata-update-notify (contract <nft-trait>) (token-ids (list 100 uint)))

what if we wanted to refresh the megapont robot components (tens of thousands of assets)? I feel like we need an option to do all, or a range, or some other syntax. What do you all think?

@hstove
Copy link
Contributor

hstove commented May 26, 2022

I think this is a great proposal - I like the approach of standardizing print events which a schema.

My only real feedback is the same as Thomas's - the most likely use case is going to be "update all metadata", in the case of reveals. This should definitely be able to handle that. Secondarily would be ranged updates, which would be nice, but my guess is that it's not a hugely common use case.

Another thought - is including the contract-id in the payload necessary? My first thought is that this can't really be verified - which means it could be abused as a kind of DDoS vector. Maybe not an issue, because you'd have to pay TX fees. Also, isn't the contract principal included in the payload of the print event by default? Maybe this doesn't work, because we want this to work for existing NFT contracts.

Overall I'd say 👍🏼

@rafaelcr
Copy link
Contributor Author

My only real feedback is the same as Thomas's - the most likely use case is going to be "update all metadata"

@hstove I agree that this is a very real and valid use case. A simple solution would be to make the token-ids argument optional. If it's not provided, then indexers would refresh metadata for all token IDs. cc @aulneau

Another thought - is including the contract-id in the payload necessary? My first thought is that this can't really be verified - which means it could be abused as a kind of DDoS vector. Maybe not an issue, because you'd have to pay TX fees. Also, isn't the contract principal included in the payload of the print event by default? Maybe this doesn't work, because we want this to work for existing NFT contracts.

That's right, including the contract-id is necessary if you want to send notifications for tokens declared by old contracts. We designed it this way so any contract may send notifications on behalf of any other contract. As you say, this could be abused but we decided transaction fees were enough to discourage that. Besides, the side effect of abuse is that contracts will just have their metadata refreshed.

@jcnelson
Copy link
Contributor

jcnelson commented May 26, 2022

Thank you for your submission @rafaelcr! I think this SIP looks pretty good. One thing I would add before advancing it would be a section about the API contract this creates for indexers and metadata servers. Because in the legacy case anyone can trigger a refresh event, I think at the very least you'll want to point this out in this SIP that indexers should be prepared for things like gratuitous, delayed, and out-of-order notification delivery (since you don't know the order txs will be mined in, or that they even correspond to an actual metadata change), and all metadata URL queries should be idempotent.

@zone117x
Copy link
Contributor

zone117x commented May 27, 2022

Couple thoughts in response to the feedback:

I agree with @aulneau and @hstove about usefulness of bulk updates for NFT metadata. That said, I'd like to dig more into the scalability implications (e.g. DDoS possibilities) that have been brought up. We should encourage NFT-class owners to only issue update notifications for tokens which actually need updated, as opposed the easy path of "update all", which would likely be (ab)used if available. Perhaps having a token limit per contract-call tx would actually be a helpful limiter here.

As an example, a request to refresh metadata for all tokens in a given NFT class results in DDoS-like traffic patterns, where an indexer ends up issuing tens of thousands of http requests. Common hosts like cloudflare or public ipfs-http gateways have high likelihood of rate-limiting / IP-banning the indexer service.

We should disallow the ability for anyone to trigger tens or hundreds of thousands of NFT metadata resolution processes with a few relatively cheap contract-calls. This could be done in a way that is backwards-compatible with existing token contracts by requiring a signed message that matches the principal of the contract in the update event payload.


After thinking through the above, it's clear that there are significant interface and scale difference between FT and individual-NFT metadata operations.

I think it would be reasonable to separate this into two different SIPs: one for FT metadata, another for NFT metadata.

In my opinion, this first SIP should be limited to FT metadata updates, and a later followup SIP can be related to NFT metadata updates and tackle issue around scalability, DDoS, and developer-friendly interfaces. That seems like a logical progression:

  • SIP-016 - NFT metadata is not yet activated.
  • The Hiro API (and thus most wallets and explorers) does not currently support NFT metadata right now anyway.
  • The Hiro API does support FT metadata, and the Stacks ecosystem has clear, immediate benefits to FT metadata updating.

@rafaelcr
Copy link
Contributor Author

Thanks for your review @jcnelson , I've addressed your observations and I've also added a new section covering considerations for metadata indexers. Looking forward to your comments.

@rafaelcr
Copy link
Contributor Author

rafaelcr commented Jun 6, 2022

@zone117x and myself were discussing abuse vectors for NFT metadata updates, here's a brief summary on some conclusions we reached:

We should disallow the ability for anyone to trigger tens or hundreds of thousands of NFT metadata resolution processes with a few relatively cheap contract-calls. This could be done in a way that is backwards-compatible with existing token contracts by requiring a signed message that matches the principal of the contract in the update event payload.

A simple solution to this problem could be to modify this SIP so that notifications are treated as valid only when initiated by the same principal who deployed the contract declaring the tokens to be refreshed.

For example, if the Megapont developers wish to notify metadata was updated for the entire Wasteland-Apes NFT collection, they would need to make the notification contract call transaction from the SP2KAF9RF86PVX3NEE27DFV1CQX0T4WGR41X3S45C address, while specifying SP2KAF9RF86PVX3NEE27DFV1CQX0T4WGR41X3S45C.wasteland-apes-nft::Wasteland-Apes as the contract_id in the notification payload. Metadata indexers would then look at the sender_address value in the incoming transaction and compare it against contract_id from the notification payload looking for a match in the principal value before refreshing metadata.

Making this change will get rid of any worries on third-party attackers constantly issuing "update all" notifications for large NFT collections, i.e. it will remove the ability to perform gratuitous updates.

Nevertheless, there are remaining worries around other kind of attacks like a malicious agent deploying an NFT contract, intentionally making metadata refresh calls really heavy (in size and/or computation required for nodes), and then making constant "update all" notifications on their contract. This could potentially still successfully DDoS metadata indexers and some nodes.

I'd love to get some thoughts on this @aulneau @hstove

@jcnelson
Copy link
Contributor

jcnelson commented Jun 8, 2022

@zone117x SIP-016 - NFT metadata is not yet activated.

It's in the process of being activated.

@jcnelson
Copy link
Contributor

jcnelson commented Jun 8, 2022

Left a few more comments. Feel free to rename this tip SIP-019 and set its status to Accepted (and add me to the Signed-off section).

@rafaelcr rafaelcr changed the title SIP: Notifications for Token Metadata Updates SIP 019: Notifications for Token Metadata Updates Jun 9, 2022
@rafaelcr rafaelcr changed the title SIP 019: Notifications for Token Metadata Updates SIP-019: Notifications for Token Metadata Updates Jun 9, 2022
@rafaelcr
Copy link
Contributor Author

@Jamil

Is that just for backwards compatibility or a more general solution?

Exactly. For example, the reference contract allows a token owner to still emit a notification for their old contract that was deployed before this SIP was proposed.

For newer contracts, you have the option to emit the prints directly e.g. inside a function that changes the metadata URI for a token.

@friedger
Copy link
Contributor

friedger commented Oct 5, 2022

Updated meta data via contract call: https://explorer.stacks.co/txid/0xfc81a8c30025d7135d4313ea746831de1c7794478d4e0d23ef76970ee071cf20?chain=mainnet
And will do so whenever a new exhibition is inaugurated.

@friedger
Copy link
Contributor

friedger commented Oct 5, 2022

Is there any use for these transactions on-chain? If not, the argument against off-chain communication is not convincing.

I suggest to investigate the matrix protocol, create an open room, where signed messages indicate updates of token meta data. Indexers can verify the signatures and act upon the message content.

No centralized service involved.

This SIP could be reduced to the definition of which matrix room to choose for notifications and a process to update the room.

@rafaelcr
Copy link
Contributor Author

rafaelcr commented Oct 7, 2022

Hi @friedger, thanks, that is a good question. I really believe these notifications should be on-chain primarily for the following reasons:

  1. For newer token contracts, emitting a notification on a metadata URI update function is trivial.
    The transaction you provided is a great example of this, actually, as it piggy-backs on the inaugurate function call you intended to do anyway and emitted a notification consistent with this change immediately. Older contracts (before this SIP) will have an additional notification step to perform, of course, but this would be slowly outpaced by the deployment of newer token collections. Adding the print to the function's Clarity code also serves as self-explanatory documentation, and ultimately I think this will encourage more devs to emit these notifications.
  2. It does not force a dependency on a third party protocol.
    Even though the Matrix protocol is free, open source and decentralized, it still adds a layer of friction for developer adoption of this SIP (both for creators and indexers) and creates a dependency to something outside of the Stacks ecosystem, which IMO is not in the best interest of a SIP.
  3. The notification can be clearly displayed in the explorer (and any other similar/relevant apps) alongside the transaction.
    This also reinforces the intent of updating the metadata and makes it explicit to users that this actually happened in the contract. The explorer UI can be improved to accommodate this in a better way, of course, but the effort to do something like that would be minimal.
  4. For chain indexers, consuming this event is practically free if they already process transactions.
    They would also have an immediate association of the notification with the actual transaction that made the change if they emitted the event within it.
  5. Adding notifications through print is consistent with current practices and opens up new use cases in the future.
    Print events are already heavily used by BNS, for example, and I think adding to that practice is a good idea for consistency and standardization. If there is a new use case that comes up in the future, a newer SIP can propose an additional print structure and indexers would be quick to adopt these if they need to.

To be fair, these advantages would not present themselves entirely if the metadata update was done without the need for a transaction (e.g. updating a JSON file in Amazon S3), however, calling one of the provided reference contracts to emit the notification would make this task simple for developers or creators in this case.

After writing this response I realize that these reasons should also be included in the SIP text, so I will fix that. Nevertheless, if you have any other thoughts on this I'll be happy to discuss.

Cheers

@friedger
Copy link
Contributor

friedger commented Oct 9, 2022

Thank you for your thoughts. It makes sense to have a standard when looking at tx like inaugurate.

I still believe that we should not promote notifications for off-chain data if the ordering of events do not matter. Maybe that can be clarified in the SIP. Probably, high gas fees will prevent this use case anyway in the long run.

Re dependencies, we have already dependencies on http, p2p protocols, gaia,.. Does the Stacks ecosystem have closed borders?

@friedger
Copy link
Contributor

I now approve :-)

@dantrevino
Copy link

  • For chain indexers, consuming this event is practically free if they already process transactions.
    They would also have an immediate association of the notification with the actual transaction that made the change if they emitted the event within it.

Conversely, client-side applications now have an extra dependency/cost of running an indexer. Pushing more centralized databases seems counter-productive in the long term.

@rafaelcr
Copy link
Contributor Author

@dantrevino what I tried to say is that if there is already any client app that listens to node RPC messages to process token transactions and events, they only need to add an extra check to see if the print events they already receive (in the events key in /new_block messages) represent a SIP-019 notification. No extra dependency required.

@friedger
Copy link
Contributor

friedger commented Nov 30, 2022

@Hero-Gamer
Copy link
Contributor

Is it just about increasing this SIP's awareness to target audiences like the marketplaces? If so we (or I) can help keep relevant people updated on this

@rafaelcr
Copy link
Contributor Author

rafaelcr commented Dec 7, 2022

Hiro's Token Metadata Service could also help increase adoption once it's deployed to production and it gets some user traction. We aim to publish a beta before year end.

I'll be hosting a demo this week if you're interested: https://discord.com/channels/621759717756370964/623217767356694547/1049746072840454214 @friedger @Hero-Gamer

@Jamil
Copy link

Jamil commented Dec 7, 2022

We'll be adding this to Gamma's Create Portal contracts by default within the next week or so.

@Hero-Gamer
Copy link
Contributor

Hi @Jamil I wonder if has Gamma added SIP-019 support?

@rafaelcr
Copy link
Contributor Author

Adoption of this SIP has picked up considerably in the last few months. We're now at ~1,600 contracts using these notifications: https://github.com/boomcrypto/clarity-deployed-contracts/search?q=token-metadata-update

As far as I can tell from these contracts, in terms of indexer support these notifications are emitted by and/or used by:

  • Hiro's Token Metadata API
  • Gamma
  • Stackswap
  • Alex
  • Arkadiko
  • etc.

I think we can now safely consider all activation criteria are met for this SIP 🎉 cc @Hero-Gamer
As such, I hereby kindly request the Steering Commitee to review these results and move SIP-019 to Ratified

@MarvinJanssen
Copy link
Collaborator

Marvin here from the Steering Committee. I think it is safe to say that all activation criteria have been met 😁. You can increment the status to Ratified and append me to the sign-off list Marvin Janssen (http://github.com/MarvinJanssen). Thanks!

@rafaelcr
Copy link
Contributor Author

rafaelcr commented Jun 9, 2023

Done @MarvinJanssen , thanks!

@MarvinJanssen
Copy link
Collaborator

🎉

@MarvinJanssen MarvinJanssen merged commit b142a4b into stacksgov:main Jun 9, 2023
@rafaelcr rafaelcr deleted the feat/token-metadata-updates branch June 10, 2023 03:29
@eriqferrari
Copy link

hi there, i deployed a token yesterday, but metadata are not yet indexed. there is something I can do to fix it? should i launch a metadata update to see if it works? with the same contract on testnet it tooks about 8hours to index, but now are more than 24h on mainnet and still wrong decimals..

@rafaelcr
Copy link
Contributor Author

Hi @eriqferrari you can try a metadata update. Usually IPFS takes a while to reflect a file across nodes so Hiro's API (and other indexers) could have missed the data when you first deployed the token. However, to keep this conversation about this SIP only, please open an issue in https://github.com/hirosystems/token-metadata-api if you still believe there is a problem. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Activation-in-Progress SIP is in the process of activating
Projects
None yet
Development

Successfully merging this pull request may close these issues.