Ord Schema Type
The "ord" schema type
The base schema type for ordinals metadata is ord
. This base type can be extended with the subType
property so that wallets and markets will understand how to interpret and display metadata.
While subtypes can be created at will, a list of common subTypes is maintained at https://bitcoinschema.org.
Required Fields:
app
- The name of the app that originally produced the ordinal
type
- This should always be "ord". This helps indexers find the metadata based on type.
name
- Name description of the ordinal.
1Sat Ordinals - Metadata Proposal
The following outlines a standard set of metadata properties that should be utilized by creators and implemented by developers when adding metadata to 1Sat Ordinals. Adhering to these specifications when creating and displaying content across applications will make for a better and more cohesive cross-platform user experience.
Top-Level Metadata
Added to the inscription output using MAP protocol in OP_RETURN.
Please note that the MAP protocol expects all data types for the value in the key value pair to be of type string
.
Description | Required | Type | Example |
---|---|---|---|
| Y | string | handcash |
| Y | string | ord |
| Y | string | Joe Racoon |
| N | string | collectionItem, collection, website |
| N SubType: Y | stringified JSON | { file: ..., fileType: ... } |
| N | stringified JSON array of | see definition below |
| N | string URL | http://so.me/prev.png b://<txid><idx> c://<contentHash> |
| N | any |
Royalties
Royalties should be applied when a sale of an item occurs. The definition of royalty
within the royalties
array:
Name | Description | Required | Type |
---|---|---|---|
type | Currently supports paymail and any valid script/address/paymail | Y |
|
destination | The destination of the payment (the receivers address/paymail) | Y | string |
percentage | The royalty percentage (3% would be | Y | string |
Payment Type
The type definition for PaymentType
:
Transaction Structure
This pseudo-script creates an ordinal with metadata called "The Awesome Ordinal" with only the minimum required fields, and adds a signature via AIP so the issuer can be verified.
Output 1:
Example ord
type
ord
typeLast updated