3. Add assets and metadata

Stargaze's sg721 contract allows for off-chain metadata storage. We recommend using a decentralized storage solution such as IPFS.

In this guide, we will cover basic project structure as well as using NFT.storage or Pinata to upload your project to IPFS.

Project Structure

Add your NFT images and metadata .json files to the respective images and metadata folders. Your project should be structured like this:

Project Folder:
  - images
    - 1.jpg
    - 2.jpg
    - 3.jpg
  - metadata
    - 1.json
    - 2.json
    - 3.json

Files should be numbered sequentially and there should be a matching metadata file for each image.

NOTE: It is very important that each of the images are numbered sequentially and have corresponding metadata files.

NOTE: If using NFT.storage, remove the .json extension from metadata files or switch to the branch nft.storage.

NOTE: Images can be JPG, PNG, SVG, GIF. We are adding support for other formats soon.

Structuring metadata

Stargaze NFT metadata follows the OpenSea metadata standards.

Sample metadata files are available in /metadata. Let's take a look at one of them.

NOTE: use animation_url for multimedia content

// 1.json
{
  "attributes": [
    {
      "trait_type": "hat",
      "value": "bandana"
    },
    {
      "trait_type": "glasses",
      "value": "sunglasses"
    },
    {
      "trait_type": "personality",
      "value": "chill"
    },
    {
      "trait_type": "shirt_color",
      "value": "purple"
    },
    {
      "display_type": "number",
      "trait_type": "generation",
      "value": 1
    }
  ],
  "description": "Just some guy that likes to code and listen to Stargaze Trooprs music.",
  "external_url": "https://example.com/?token_id=1",
  "image": "ipfs://bafybeih3ykpa42eipgtzcrfkeo5nvazcdqhj3oh3ztju44tcoipzsdaauy/images/1.png",
  "animation_url": "ipfs://bafybeia5r3hwyou3iggzfvakjkxu2zy5pt3kjil6nyqzvrqwrrtkwe6xrm/images/Genesis.m4a"
  "name": "Shane Stargaze"
}

Uploading to IPFS and getting the Base URL

After setting up your project, upload the files to IPFS using one of our guides:

• Pinata (with script)

Pinata website can be used to upload assets, but a script is also provided for convenience.

After following the steps in the guides above, you'll receive a baseTokenUri for your project. This way, the contract knows how to associate each token ID with an individual token URI without having to send the contract a list of URIs. All token URIs can be determined by appending the token ID to the base URL.

Be sure to update your config.js with this baseTokenUri.