Skip to content

Document "hidden" metadata attribute #33

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
EtayM wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document "hidden" metadata attribute #33

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
14 changes: 12 additions & 2 deletions ...s/01-platform/03-advanced-mechanics/02-metadata-standard/02-metadata-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ Ensure you use the correct casing when defining attributes to avoid errors.
],
"banner_image": "https://platform.production.enjinusercontent.com/enterprise/enjin/assets/media/2024-multiverse.banner.jpg",
"fallback_image": "https://cdn.enjin.io/mint/image/15.jpg",
"external_url": "https://enjin.io/multiverse"
"external_url": "https://enjin.io/multiverse",
"hidden": false
}
```

Expand All @@ -45,6 +46,8 @@ Ensure you use the correct casing when defining attributes to avoid errors.
- `banner_image`: A link to an image file to be displayed as the collection banner. (Recommended ratio: 4:1)
- `fallback_image`: A link to an alternative image file to be used when the media provided in the `media` list fails to load.
- `external_url`: A link to the collection's website.
- `hidden`: When set to `true`, hides the collection from public lists, search results, and profile pages. Defaults to `false`.
- **Only takes effect when set as an on-chain attribute** (see the note below the token example).

## Token Metadata

Expand Down Expand Up @@ -80,7 +83,8 @@ Ensure you use the correct casing when defining attributes to avoid errors.
"Multiverse Item",
"Key",
"Free"
]
],
"hidden": false
}
```

Expand All @@ -98,6 +102,12 @@ Ensure you use the correct casing when defining attributes to avoid errors.
- `external_url`: A link to the token's website or a website with information on the token.
- `keywords`: A list of keywords relevant to this token. Used to help find this token in search queries.
- In the NFT.io Marketplace, keywords also act as tags.
- `hidden`: When set to `true`, hides the token from public lists, search results, and profile pages. Defaults to `false`.
- **Only takes effect when set as an on-chain attribute** (see the note below).

:::warning **Important:** The `hidden` attribute only works on-chain.
Unlike the other fields, `hidden` only takes effect when set directly as an **on-chain attribute** (attribute key `hidden`, value `true`). It is ignored when supplied only through an off-chain hosted JSON file (i.e. via the `uri` attribute).
:::

:::info Need more information?
For a comprehensive document on the metadata structure, please head over to the [Universal Off-Chain Token Metadata Standard](https://github.com/enjin/universal-metadata-standard/blob/uotm-standard-wip/README.md) page.
Expand Down
Loading