Configuration File

Sugar uses a JSON configuration file to upload assets and configure a Candy Machine – in most cases, the file will be named config.json. The configuration includes the settings that are used to initialize and update the Candy Machine, as well as upload the assets to be minted. It will also include the configuration of guards that will provide access control to minting.

A basic configuration file is shown below:

{
  "tokenStandard": "pnft",
  "number": 10,
  "symbol": "TEST",
  "sellerFeeBasisPoints": 500,
  "isMutable": true,
  "isSequential": false,
  "ruleSet": "eBJLFYPxJmMGKuFwpDWkzxZeUrad92kZRC5BJLpzyT9",
  "creators": [
    {
      "address": "PanbgtcTiZ2PveV96t2FHSffiLHXXjMuhvoabUUKKm8",
      "share": 50
    },
    {
      "address": "PanbgtcTiZ2PveV96t2FHSffiLHXXjMuhvoabUUKKm8",
      "share": 50
    }
  ],
  "hiddenSettings": null,
  "uploadMethod": "bundlr",
  "awsConfig": null,
  "nftStorageAuthToken": null,
  "shdwStorageAccount": null,
  "pinataConfig": null,
  "sdriveApiKey": null,
  "guards": {
    "default": {
      "botTax": {
        "value": 0.01,
        "lastInstruction": true
      }
    },
    "groups": [
      {
        "label": "OGs",
        "guards": {
          "startDate": {
            "date": "2022-10-20 12:00:00 +0000"
          },
          "tokenGate": {
            "amount": 1,
            "mint": "7nE1GmnMmDKiycFkpHF7mKtxt356FQzVonZqBWsTWZNf"
          },
          "solPayment": {
            "value": 1,
            "destination": "PanbgtcTiZ2PveV96t2FHSffiLHXXjMuhvoabUUKKm8"
          }
        }
      },
      {
        "label": "Public",
        "guards": {
          "startDate": {
            "date": "2022-10-20 18:00:00 +0000"
          },
          "solPayment": {
            "value": 2,
            "destination": "PanbgtcTiZ2PveV96t2FHSffiLHXXjMuhvoabUUKKm8"
          }
        }
      }
    ]
  }
}

The configuration file can be viewed as having three main parts: Candy Machine settings ("tokenStandard" to "hiddenSettings"), upload settings ("uploadMethod" to "sdriveApiKey") and guard settings ("guards").

Candy Machine settings

Candy Machine settings determine the type of the asset, number of assets available and their metadata information.

The creators setting allows you to specify up to 4 addresses and their percentage share.

The Candy Machine can be configured to not have the final metadata when an NFT is minted. This is useful when you are planning a revel step once mint is completed. In this case, you can specify the "placeholder" metadata values for the hidden NFT:

Upload settings

Sugar supports a variety of storage providers – the one to be used is define by the uploadMethod setting. Depending of the provider, there would be additional configuration needed.

The table below provides an overview of the settings available:

Specific upload method settings:

Guard settings

The guards settings allows you to specify which guards will be enabled on the Candy Machine.

Candy Machine support a number of guards that provide access control to minting. Guards can be configured into a "default" guard group or appear in multiple guard groups.