Skip to content

Introduce compact keys for JSON metadata fields to reduce size of JSON metadata object #390

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+35 −33
Open

Introduce compact keys for JSON metadata fields to reduce size of JSON metadata object #390

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 35 additions & 33 deletions XLS-0089-multi-purpose-token-metadata-schema/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ MPTs include a 1024-byte field for arbitrary metadata. The metadata field is par

## 2. Base Metadata Schema

| Field | Description | Example | Allowed Values | Type | Required? |
| ----------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------- | --------- |
| `ticker` | Ticker symbol used to represent the token | EXMPL | Uppercase letters (A-Z) and digits (0-9) only. Max 6 characters recommended | string | ✔️ |
| `name` | Display name of the token | Example Token | Any UTF-8 string | string | ✔️ |
| `desc` | Short description of the token | A sample token used for demonstration | Any UTF-8 string | string | |
| `icon` | URL to the token icon | https://example.org/token-icon.png | HTTPS URL that links to an image | string | ✔️ |
| `asset_class` | Top-level classification of token purpose | rwa | rwa, memes, wrapped, gaming, defi, other | string | ✔️ |
| `asset_subclass` | Optional subcategory, required if `asset_class = rwa` | See 2.2 _asset_subclass_ | See 2.2 _asset_subclass_ | string | |
| `issuer_name` | The name of the issuer account | Example Issuer | Any UTF-8 string | string | ✔️ |
| `urls` | List of related URLs (site, dashboard, social media, etc.) | See 2.3 _urls_ | See 2.3 _urls_ | array | |
| `additional_info` | Freeform field for key token details like interest rate, maturity date, term, or other relevant info | `{ "interest_rate": "4.75%", "maturity_date": "2030-06-30", "term": "10Y", "issuer_type": "government" }` | Any valid JSON object or UTF-8 string | JSON object or string | |
| Field | Key | Description | Example | Allowed Values | Type | Required? |
| ----------------- | ---- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | --------------------- | --------- |
| `ticker` | `t` | Ticker symbol used to represent the token | EXMPL | Uppercase letters (A-Z) and digits (0-9) only. Max 6 characters recommended | string | ✔️ |
| `name` | `n` | Display name of the token | Example Token | Any UTF-8 string | string | ✔️ |
| `desc` | `d` | Short description of the token | A sample token used for demonstration | Any UTF-8 string | string | |
| `icon` | `i` | URI to the token icon | example.org/token-icon.png | `hostname/path` (HTTPS assumed) or full URI for other protocols | string | ✔️ |
| `asset_class` | `ac` | Top-level classification of token purpose | rwa | rwa, memes, wrapped, gaming, defi, other | string | ✔️ |
| `asset_subclass` | `as` | Optional subcategory, required if `asset_class = rwa` | See 2.2 _asset_subclass_ | See 2.2 _asset_subclass_ | string | |
| `issuer_name` | `in` | The name of the issuer account | Example Issuer | Any UTF-8 string | string | ✔️ |
| `uris` | `us` | List of related URIs (site, dashboard, social media, etc.) | See 2.3 _uris_ | See 2.3 _uris_ | array | |
| `additional_info` | `ai` | Freeform field for key token details like interest rate, maturity date, term, or other relevant info | `{ "interest_rate": "4.75%", "maturity_date": "2030-06-30", "term": "10Y", "issuer_type": "government" }` | Any valid JSON object or UTF-8 string | JSON object or string | |

---

Expand All @@ -67,7 +67,7 @@ MPTs include a 1024-byte field for arbitrary metadata. The metadata field is par

### 2.2 asset_subclass

| asset_type | Description |
| Asset Type | Description |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `stablecoin` | Tokens pegged to a stable value (typically fiat currencies like USD), backed by reserves such as cash, treasuries, or crypto collateral |
| `commodity` | Tokens representing physical commodities like gold, silver, or oil, often redeemable or legally linked to off-chain reserves |
Expand All @@ -79,40 +79,42 @@ MPTs include a 1024-byte field for arbitrary metadata. The metadata field is par

---

### 2.3 urls
### 2.3 uris

| Field | Description | Example | Allowed Values | Required |
| ------- | ------------------------------------- | ----------------------------- | -------------------------------- | -------- |
| `url` | The full link to the related resource | https://exampleyield.co/tbill | A valid HTTPS URL | ✔️ |
| `type` | The category of the link | website | website, social, document, other | ✔️ |
| `title` | A human-readable label for the link | Product Page | Any UTF-8 string | ✔️ |
| Field | Key | Description | Example | Allowed Values | Required |
| ---------- | ---- | ----------------------------------- | ------------------------------------ | ------------------------------------------------------------ | -------- |
| `uri` | `u` | URI to the related resource | exampleyield.com/tbill, ipfs://abc123... | `hostname/path` (HTTPS assumed) or full URI for other protocols | ✔️ |
| `category` | `c` | The category of the link | website | website, social, document, other | ✔️ |
| `title` | `t` | A human-readable label for the link | Product Page | Any UTF-8 string | ✔️ |

---

### JSON Metadata example

Note: The Key values from the tables above are used as the property names in the JSON metadata object.

```json
{
"ticker": "TBILL",
"name": "T-Bill Yield Token",
"desc": "A yield-bearing stablecoin backed by short-term U.S. Treasuries and money market instruments.",
"icon": "https://example.org/tbill-icon.png",
"asset_class": "rwa",
"asset_subclass": "treasury",
"issuer_name": "Example Yield Co.",
"urls": [
"t": "TBILL",
"n": "T-Bill Yield Token",
"d": "A yield-bearing stablecoin backed by short-term U.S. Treasuries and money market instruments.",
"i": "example.org/tbill-icon.png",
"ac": "rwa",
"as": "treasury",
"in": "Example Yield Co.",
"us": [
{
"url": "https://exampleyield.co/tbill",
"type": "website",
"title": "Product Page"
"u": "exampleyield.co/tbill",
"c": "website",
"t": "Product Page"
},
{
"url": "https://exampleyield.co/docs",
"type": "docs",
"title": "Yield Token Docs"
"u": "exampleyield.co/docs",
"c": "docs",
"t": "Yield Token Docs"
}
],
"additional_info": {
"ai": {
"interest_rate": "5.00%",
"interest_type": "variable",
"yield_source": "U.S. Treasury Bills",
Expand Down