README.md

Ordinals Collections Standards

A place for creators & builders to organize ordinal collections

Getting Started

Artists

Collection creators can format their collection data using the inscriptions.json and meta.json format below to be listed on all platforms using the standard

Steps

1. Create your inscriptions.json and meta.json files in the format provided below
2. Add to the registry by creating a pull request including new collections that follow the standard
3. After successfully opening a pull request, your files will be tested for compatibility with the main repo. If the test fails, click on "Details" to look into the test log for error messages. You might get a hint on what needs to be corrected within your pull request.

Tips

• Check out this file formatting tool
• Formatting can also easily be done in Visual Studio Code Editor. Open your .json with Visual Studio Code and press Shift+Alt+F.

File Structure

 .
 ├── ...
 └── collections
     └── [collection-name]
          ├── inscriptions.json
          └── meta.json

Collection Metadata meta.json

{
  "name": "",                    # inscription name
  "inscription_icon": "",        # (optional) collection cover inscription id
  "icon": "",                    # (optional) collection cover icon url
  "slug": "",                    # directory name
  "description": "",             # collection description
  "twitter_link": "",            # official twitter
  "discord_link": "",            # official discord
  "website_link": ""             # official website
}

Inscription Data inscriptions.json

[
  {
    "id": "",                    # inscription id
    "meta": {
      "name": ""                 # inscription name
    }
  },
  ...
]

Artists can assign unqiue traits to ordinals with attributes

[
  {
    "id": "",
    "meta": {
      "name": ""
      "attributes": [
        {
          "trait_type": "",        # trait category
          "value": "",             # trait value
        },
        ...
      ]
    }
  },
  ...
]

Here is an example of a completed collection inscription

Your meta.json file will look like this:

{
  "name": "Bitcoin Frog #2989",
  "inscription_icon": "c387a2656ef973a55df57edd3ac4b26b09865cc3fcb21cfaa4921ead1363f53ai0",
  "slug": "bitcoin-frogs",
  "description": "Bitcoin Frogs are 10,000 pure digital collectibles that will remain on Bitcoin forever. No more will ever be created. Rarities of all traits within each layer are equal, allowing subjective appreciation of aesthetics and Satoshi-based rarities to emerge.",
  "twitter_link": "https://twitter.com/BitcoinFrogs",
  "discord_link": "https://discord.com/invite/bitcoinfrogs",
  "website_link": "https://bitcoinfrogs.com"
}

Your inscriptions.json file will look like this:

[
  {
    "id": "c387a2656ef973a55df57edd3ac4b26b09865cc3fcb21cfaa4921ead1363f53ai0",
    "meta": {
      "name": "Bitcoin Frog #2989",
      "attributes": [
        {
          "trait_type": "Background",
          "value": "Black",
        },
        {
          "trait_type": "Body",
          "value": "Tron",
        },
        {
          "trait_type": "Clothing",
          "value": "Green Hoodie",
        },
        {
          "trait_type": "Mouth",
          "value": "Cigar",
        },
        {
          "trait_type": "Eyes",
          "value": "Visor",
        }

      ]
    }
  }
]

Error hunting

After succesfully opening a pull request, your metadata files will be auto-tested for compatibility with the main repo.

✅ Green check mark means there were no problems found and your files should be ready to be merged into the repo by the maintainer.

❌ Red mark means there were conflicts found in your file. Click on "Details" to see the autocheck log. In the log, the end of the "Run tests" section will give you a hint on what went wrong.

Common mistakes

Wrong "supply" in the meta.json.

If the supply is lower than the amount of inscriptions in the inscriptions.json, the website may not list your whole collection.

Too many commas.

On of the most common mistakes in jsons is having commas between a closing " and a closing } or ]. wrong: javascript ..."example",} correct: javascript ..."example"}

Wrong directory.

Your meta.json and inscriptions.json should go into /ordinals-collections/collections/your-collection-name/... Ideally, "your-collection-name" and "slug" within the meta.json are identical. To correct the directory in your open pull request, simply go to "Edit" your jsons within it, and then look at the directory above the edit section. If you backspace on the filename you can edit the /directory entry too!

Outdated fork used for creating a pull request.

When UPDATING your collection metadata, please make sure you have updated/synchronized the repo fork your are creating the pull request for.

Different directory or "slug" in metadata update

Please use THE SAME directory (and also "slug" in meta.json) as you used for your collection before. Otherwise your pull request will be conflicting with the main repo, and may require the maintainer to manually delete your old metadata before merging your new pull request.