augustfr / reservoir-metadata

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Adding custom metadata

To add custom metadata for a collection, create a directory in src/custom containing an index.js file (See src/custom/forgotten-ponies/index.js for example). Example directory structure:

src/custom
.
├── my-custom-contract                    # Directory for your collection with custom metadata
│   ├── index.js                               # Implement required functions and customize metadata
│   ├── ...                                    # If needed, data files or other helpers can also go in this directory
└── ...

An update is also required in src/custom/index.js:

import * as myCustomContract from "./my-custom-contract";

custom["1,${YOUR_CONTRACT}"] = myCustomContract;

Testing

You can test the custom metadata response at http://localhost:3000/api/v4/mainnet/metadata/token?method=opensea&token=YOUR_CONTRACT:TOKEN_ID