Adding a logo url field to the token metadata api #132
Conversation
davidrichards-da
requested review from
hythloda,
isegall-da,
stas-sbi,
tkatrichenko and
waynecollier-da
cip-0056/cip-0056.md
Outdated
| to the logo image associated with the token. Asset Issuers can use this field | ||
| to supply an image / logo of the token for integration into exchanges, wallets | ||
| and user interfaces. It's recommended that the image should be a 200x200 pixels | ||
| in size, in PNG, JPEG, or WEBP format with a transparent background. |
There was a problem hiding this comment.
We don't need to add a metadata key for that, as this info is not shipped on-ledger, but off-ledger where we can just extend the OpenAPI spec here: https://github.com/hyperledger-labs/splice/blob/1200346d5e8efee5dcb282e0ea1061db22725af6/token-standard/splice-api-token-metadata-v1/openapi/token-metadata-v1.yaml#L128-L169
There was a problem hiding this comment.
I'd suggest to add the details in its own section below this one: https://github.com/global-synchronizer-foundation/cips/blob/666949b851dff34cd5e5244fdedc2c1ad88e8633/cip-0056/cip-0056.md#total-supply
There was a problem hiding this comment.
Thanks, I've moved the section to the suggested location
| in size, in PNG, JPEG, or WEBP format with a transparent background. | ||
|
|
||
| ##### Metadata Key Syntax | ||
|
|
There was a problem hiding this comment.
At the bottom there's a changelog. Please add an entry there.
meiersi-da
left a comment
meiersi-da
left a comment
There was a problem hiding this comment.
Thanks from the perspective of an author of CIP-56 this looks like a sensible addition to me. I've also created the draft of the API changes we are talking about here:
They are backwards-compatible and easy to put in place.
@waynecollier-da @davidrichards-da : can you coordinate wrt how to get approval and how to ensure all wallet providers and asset issuers learn about this feature once it is supported?
|
|
||
| * **2025-03-18:** - Initial Draft | ||
| * **2025-03-31:** Approval announced via [mailing list thread](https://lists.sync.global/g/cip-announce/topic/cip_0056_canton_network/112004244) | ||
| * **2025-11-25:** - Addition of the Logo URL optional field in the off-ledger token metadata API |
There was a problem hiding this comment.
| * **2025-11-25:** - Addition of the Logo URL optional field in the off-ledger token metadata API | |
| * **2025-11-25:** - Addition of the Logo URL optional field in the off-ledger token metadata API ([draft PR](https://github.com/hyperledger-labs/splice/pull/3210)) |
2 participants
This PR adds a logo url field to the token metadata API. This has been a suggestion from multiple wallet providers and would enable token issuers the ability to add an image / logo to an asset providing consistent asset image visualization.