0026 XLS-26d: Token Metadata Extensions to xrp-ledger.toml #71

Mwni · 2022-04-04T22:55:12Z

Mwni
Apr 4, 2022

Token Metadata Extensions to xrp-ledger.toml

Revision: 4 (2024-08-08)
Contributors: mDou13

A set of additional fields for the existing xrp-ledger.toml standard. The goal is to

Make it easier for token issuers to represent themselves and their tokens.
Make it easier for developers to access this metadata.

Motivation

It can be difficult to get your token properly represented in the XRPL ecosystem. To get your token's icon to be shown, you need to personally reach out to all wallet and platform vendors. These include Xaman, Bithomp, XRP Scan, XPMarket, XRPL Coins. All vendors rely on manual management of the metadata, so for any updates, you have to do the same roundtrip again.

For developers, it's not any different. There is no standardized way of obtaining asset metadata. This standard aims to change that.

The Extensions

`[[ISSUERS]]` or `[[ACCOUNTS]]`

Defines an XRPL account that acts as an issuer of token(s).

Key	Type	Description
`address`	`String`	The public address of the issuer, encoded in the base58 format.
`name`	`String`	The display name of the issuer.
`description` or `desc`	`String`	A description of the issuer.
`icon` or `avatar`	`String`	A URL pointing to an icon image representing the issuer. Must start with the protocol, generally https:// or ipfs://.

`[[ISSUERS.WEBLINKS]]` or `[[ACCOUNTS.WEBLINKS]]`

Defines a web link associated with an issuing account. Must follow directly after the issuers stanza it belongs to.

Key	Type	Description
`url`	`String`	The URL of the hyper-link. Must start with the protocol, generally https://
`type`	`String`	The type of the content that the link is pointing to. Possible values are: `info`, `socialmedia`, `community`, `support`, `whitepaper`, `certificate`.
`title`	`String`	A descriptive title for the link. Should be used to clear ambiguities.

`[[TOKENS]]` or `[[CURRENCIES]]`

Defines an issued currency on the XRPL. Currency code and issuing address must be specified.

Key	Type	Description
`code` or `currency`	`String`	The currency code of the token. This can be a three-digit code, a 40-character hex code, or a custom format.
`issuer`	`String`	The public address of the issuer, encoded in the base58 format.
`name`	`String`	A display name for the token.
`description` or `desc`	`String`	A description of the token and the project associated with it.
`icon` or `avatar`	`String`	A URL pointing to an icon image representing the token. Must start with the protocol, generally https:// or ipfs://.
`asset_class`	`String`	The class of the underlying asset represented by this IOU. Possible values are: `fiat`, `commodity`, `equity`, `cryptocurrency`.

`[[TOKENS.WEBLINKS]]` or `[[CURRENCIES.WEBLINKS]]`

Defines a web link associated with a token. Must follow directly after the tokens stanza it belongs to.

Key	Type	Description
`url`	`String`	The URL of the hyper-link. Must start with the protocol, generally `https://`
`type`	`String`	The type of the content that the link is pointing to. Possible values are: `info`, `socialmedia`, `community`, `support`, `whitepaper`, `certificate`.
`title`	`String`	A descriptive title for the link. Should be used to clear ambiguities.

Example

The example .toml file below defines name, description, icon and 3 weblinks for the well known Elysian token.

[[ACCOUNTS]]
address = "rHXuEaRYnnJHbDeuBH5w8yPh5uwNVh5zAg"
name = "Aesthetes"

[[ACCOUNTS.WEBLINKS]]
url = "https://aesthetes.art"
type = "info"
title = "Official Website"

[[ACCOUNTS.WEBLINKS]]
url = "https://twitter.com/aesthetes_art"
type = "socialmedia"

[[CURRENCIES]]
issuer = "rHXuEaRYnnJHbDeuBH5w8yPh5uwNVh5zAg"
currency = "ELS"
name = "Elysian"
desc = "The first Token for the Art and NFT Industry running on the XRPL."
icon = "https://static.xrplmeta.org/icons/els.png"
asset_class = "cryptocurrency"

[[CURRENCIES.WEBLINKS]]
url = "https://twitter.com/Elysianers"
type = "community"

Implementations

Parsing Library

The @xrplkit/xls26 package is a Javascript implementation of this standard. It parses the string of a .toml file into a Javascript object (JSON).

Crawler + API

The project XRPL Meta (Repo, Website) automatically scans the entire ledger for issuing accounts having the Domain field set. It fetches and parses their xrp-ledger.toml file, if published. The obtained data is stored, enriched and made available through a REST or WebSocket API.

Given the example above, this is the metadata collected for Elysian:

https://s1.xrplmeta.org/token/ELS:rHXuEaRYnnJHbDeuBH5w8yPh5uwNVh5zAg

mDuo13 · 2022-06-08T21:26:25Z

mDuo13
Jun 8, 2022

I support this extension. Some thoughts:

You've got a typo, [[CURRENCIS]]. It should be [[CURRENCIES]], of course.

You list code and issuer as "extensions" to the [[CURRENCIES]] array, but those fields are already part of the standard along with some other fields you didn't mention. I suggest only listing the actually new fields, to avoid confusion. Similar situation for [[ACCOUNTS]]. Also, note that not all accounts in [[ACCOUNTS]] are issuers, so the descriptions should not assume that. (I think the field definitions are generally fine though.)

In my opinion "airdrops" should not be a separate array but deadline_date and airdrop_date could be optional fields of entries in the [[CURRENCIES]] array. The description and links can reflect that the token has not yet been issued and provide information about the airdrop. Then you can update the token's entry in the toml file after the airdrop begins.

2 replies

Mwni Jun 8, 2022
Author

Thank you for the feedback. I want to note, this proposal has since been outdated and a revision is on the way.

Regarding the redundant fields, these are indeed not extensions, but act as identifiers for the stanza, so I feel they should definitely be included. Perhaps with a better declaration of what they are. The issue with coupling airdrops with the currency stanza is that a token can have multiple airdrops.

I was considering introducing a new stanza called ISSUERS instead of using the existing accounts stanza, and your comment made clear that that's the way to go.

gadget78 Sep 11, 2022

do you have a link to this newer proposal ?

gadget78 · 2022-09-11T09:45:08Z

gadget78
Sep 11, 2022

if we are going to change this, lets make this into a MUCH more usefull data point and maximise the data held here...
i had very hard, and time consuming time finding some of what i see as basic info,
so this going to be heavily weighted on the info that i could never find easily, and people wanted..

ok so 1st of, we must already know their domain, as we would'nt be at this stage, and domain is taken from from the ledger account settings..

something that would be good to see in [[PRINCIPALS]] is country of origin....
i also propose we either have a new [[SOCIAL]] section ?
or have it officially under the [[PRINCIPALS]] which is where i have seen them already listed in some accounts ...

so for eg ..

[[SOCIAL]]
discord = "https://discord.gg/KTNmhJDXqa"
linktree = "https://linktr.ee/gadget78
instagram = ""
linkedin = ""
telegram = ""
ticktock = ""
twitter = "https://twitter.com/gadget78"
youtube = ""

i like the icon info in the [[TOKENS]] ✅
would also be good to have dedicated section for listing their "distrubution accounts"
which i know is normally the address that initially received to created tokens, but this isn't always as easy to find as you 1st think!
also how about we have dedicated fields for; whitepaper, roadmap, there business info, and XUMM xAPP links,
and also at a push how about a cex (centralised exchange links)

[[TOKENS]]
issuer = "rCSCManTZ8ME9EoLrSHHYKW8PPwWMgkwr"
currency = "CSC"
name = "CasinoCoin"
desc = "CasinoCoin (CSC) is a digital currency, developed specifically for the regulated gaming industry."
icon = "https://static.xrplmeta.org/icons/csc.png"
whitepaper = ""
roadmap = ""
registered_business = ""
xAPP = ""

also in the [[VALIDATORS]] does this include, standard node info ??

although to be honest, 99% of token creators dont even care about this stuff,
in the 240 odd tokens i have listed on gadget78.uk only 7 make use of this .toml file :(
in your example you used Casino Coin, they dont have one, nor does other big players like https://www.aesthetes.art

3 replies

Mwni Sep 11, 2022
Author

I agree on the point of adding a way to link distribution or other associated accounts. The reason why I opted against creating hard keys for every possible web link, is because you can never cover everything. It's then even harder to adapt to new trends.
In your [[SOCIAL]], where is wechat, where is facebook, where is THE_NEXT_BIG_THING? Same goes for litepaper, github, audit_certificate in the tokens stanza? All of these things are just web links. Hence the [[WEBLINKS]] stanza.

Mwni Sep 11, 2022
Author

Oh, and on the point why this standard has found nearly no adoption so far: It hasn't been advertised, yet. There will be an announcement this week from Xumm, which will mark the official roll out of this standard and its accompanying project xrplmeta.org, so to say 🚀

gadget78 Sep 11, 2022

for additional social accounts you would just add in lower case .. so using your examples,

[[SOCIAL]]
wechat = ""
facebook = ""
zerpcraft = ""

do appreciate that they are just weblinks still, but having them categorized is nicer/neater ...
as yes they are still weblinks, but having dedicated categories, is better to maintain
and quicker to parse if all your interested in is social links etc ..

plus its more about having a pre-set standard of listing these items, with examples from the outset,
so that it gets used in a uniform way, from the beginning

so if we set out that the basic items like litepaper, and audit_certificate...
with it spelt out and shown that this is how the standard way WILL be...
as in no spaces, with underscores, with no dashes, whitepaper not litepaper, in the tokens section ...

the [[WEBLINKS]] can be stated as a useable section, and used going forward as a future proof method of adding other things that we dont see as "standard" now ...

if we dont state these things, we will be back at the same mess we have now, in not easily being able to gather this information uniformly.

ledhed2222 · 2023-06-06T20:04:20Z

ledhed2222
Jun 6, 2023

I like this proposal a lot! Can we move it to a PR?

3 replies

Mwni Jun 6, 2023
Author

A PR to where?

ledhed2222 Jun 7, 2023

Into this repo. Check out the CONTRIBUTING.md and the other open pull requests here :)

Mwni Jun 7, 2023
Author

I will polish the standard and make a PR in the coming days.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

0026 XLS-26d: Token Metadata Extensions to xrp-ledger.toml #71

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 3 comments 8 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

0026 XLS-26d: Token Metadata Extensions to xrp-ledger.toml #71

Mwni Apr 4, 2022

Token Metadata Extensions to xrp-ledger.toml

Motivation

The Extensions

[[ISSUERS]] or [[ACCOUNTS]]

[[ISSUERS.WEBLINKS]] or [[ACCOUNTS.WEBLINKS]]

[[TOKENS]] or [[CURRENCIES]]

[[TOKENS.WEBLINKS]] or [[CURRENCIES.WEBLINKS]]

Example

Implementations

Parsing Library

Crawler + API

Replies: 3 comments · 8 replies

mDuo13 Jun 8, 2022

Mwni Jun 8, 2022 Author

gadget78 Sep 11, 2022

gadget78 Sep 11, 2022

Mwni Sep 11, 2022 Author

Mwni Sep 11, 2022 Author

gadget78 Sep 11, 2022

ledhed2222 Jun 6, 2023

Mwni Jun 6, 2023 Author

ledhed2222 Jun 7, 2023

Mwni Jun 7, 2023 Author

Mwni
Apr 4, 2022

`[[ISSUERS]]` or `[[ACCOUNTS]]`

`[[ISSUERS.WEBLINKS]]` or `[[ACCOUNTS.WEBLINKS]]`

`[[TOKENS]]` or `[[CURRENCIES]]`

`[[TOKENS.WEBLINKS]]` or `[[CURRENCIES.WEBLINKS]]`

Replies: 3 comments 8 replies

mDuo13
Jun 8, 2022

Mwni Jun 8, 2022
Author

gadget78
Sep 11, 2022

Mwni Sep 11, 2022
Author

Mwni Sep 11, 2022
Author

ledhed2222
Jun 6, 2023

Mwni Jun 6, 2023
Author

Mwni Jun 7, 2023
Author