Skip to content

Guidelines

This section is an overview for the 3 main types of contributions that are possible for offchain.

Contributing a Collection Parser

Collection parsers are used on specific NFT collections that have unique metadata e.g. Autoglphys, Nouns, and ENS. If you have a specific NFT collection you'd like to support, you can contribute a collection parser.

Contributing a Schema Parser

Schema parsers are used for general purpose formatting across many NFT collections e.g. Opensea Metadata Standard. If you have a new NFT metadata format that will be used in many different NFT contracts, you can contribute a schema parser.

Contributing an Adapter

Adapters are used to parse the metadata url into an acceptable request format for the fetcher to retrieve the data. For example if retrieving the IPFS hash from a contract the adapter will reformat the URI so a request can be made to an IPFS gateway.

from

  • IPFS Hash: ipfs://QmaXzZhcYnsisuue5WRdQDH6FDvqkLQX1NckLqBYeYYEfm/9559.json

to

Currently supported URL formats:

  • HTTP
  • Data URI (base64 encoded onchain)
  • IPFS
  • Arweave

If you have another url format you'd like to support, you can write a custom adapter to handle it.