Configuration Values
This section is a reference to all of the values in the Sugar configuration file (default: config.json).
Setting | Options | Accepted Values | Description |
---|---|---|---|
price | Number | The amount in SOL or SPL token for a mint | |
number | Integer | The number of items in the Candy Machine | |
gatekeeper | Enables captcha verification for users prior to minting | ||
gatekeeperNetwork | Address | Gateway provider address | |
expireOnUse | boolean | Requires a new gateway challenge after a use | |
solTreasuryAccount | PublicKey | SOL wallet to receive proceedings SOL payments | |
splTokenAccount | PublicKey | SPL token wallet to receive proceedings from SPL token payments; set to null to use the default token account for your wallet | |
splToken | PublicKey | Mint address of the token accepted as payment | |
goLiveDate | Datetime | RFC 3339 standard timestamp when minting is allowed – the Candy Machine authority and whitelists can bypass this constraint | |
endSettings | |||
endSettingType | String | Either "Date" or "Amount" to stop minting after a specific timestamp or a specific number of NFTs minted | |
date | String | Value to test the end condition. This is an ISO8601 formatted date string. | |
number | Number | Value to test the end condition. This is integer value for number of NFTs | |
whitelistMintSettings | |||
mode | String | "burnEveryTime" to burn the whitelist token after minting, and "neverBurn" to return whitelist token to holder after mint. | |
mint | PublicKey | Mint address of the whitelist token | |
presale | boolean | Indicates whether whitelist token holders can mint before goLiveDate (presale) | |
discountPrice | Number | Price for whitelist token holders | |
hiddenSettings | |||
name | String | Name of the mint. The number of the mint will be appended to the name | |
uri | String | Single URI to all mints | |
hash | String | 32 character hash – in most cases this is the hash of the cache file with the mapping between mint number and metadata so that the order can be verified when the mint is complete | |
freezeTime | number | The time in seconds to keep freeze enabled. Max value of 30 x 86400 | |
uploadMethod | Storage type to upload images and metadata | ||
“aws” | Uploads to AWS (must specify AWS Bucket name) | ||
bundlr” | Uploads to arweave using Bundlr and payments are made in SOL (Works on mainnet and devnet. Files are only stored for 7 days on devnet.) | ||
“pinata” | Uploads to Pinata (works on all networks, free and tiered subscriptions) | ||
“nft-storage” | Uploads to NFT.Storage (no payment required, works on all networks) | ||
“shdw” | Uploads to the GenesysGo Shadow Drive (Only works on mainnet currently) | ||
awsConfig | (optional) | ||
bucket | String | AWS bucket name | |
profile | String | AWS profile to use from the credentials file name | |
directory | String | The directory within the bucket to upload the items to. An empty string means uploading files to the bucket root directory. name | |
nftStorageAuthToken | String | (optional) NFT.Storage API Key | |
pinataConfig | (optional) | ||
JWT | String | JWT authentication token | |
apiGateway | String | URL to connect to Pinata API | |
apiContent | String | URL to use as the base for creating the asset links | |
parallelLimit | number | Number of concurrent uploads; use this setting to avoid rate limits | |
shadowStorageAccount | String | (optional) Shadow Drive storage pubkey | |
retainAuthority | boolean | Indicates whether the candy machine authority has the update authority for each mint or if it is transferred to the minter. This should be kept as true for the vast majority of cases. | |
isMutable | boolean | Indicates whether the NFTs' metadata is mutable or not after having been minted. Most cases should leave this true | |
tokenStandard | string | Whether the candy machine should mint "normal" or "programmable" NFTS: "nft" or "pnft". Default: "nft". | |
ruleSet | PublicKey | The rule set to apply to minmted pNFTs, if any. Default: null. |