Skip to content

Latest commit

 

History

History
232 lines (180 loc) · 6.15 KB

README.md

File metadata and controls

232 lines (180 loc) · 6.15 KB
Raw

Metaplex Deprecated JS Clis

🚨 Deprecated Repo 🚨

Please note that this GitHub repository is no longer being maintained. To use the Metaplex Candy Machine or to integrate Metaplex's programs with your JavaScript applications please use the following:

CANDY MACHINE

metaupload.mp4

Documentation

Gettting started and usage instructions can be found at https://docs.metaplex.com/candy-machine-v2/introduction

Settings examples

{
  "price": 0.01,
  "number": 10000,
  "gatekeeper": {
    "gatekeeperNetwork": "ignREusXmGrscGNUesoU9mxfds9AiYTezUKex2PsZV6",
    "expireOnUse": true
  },
  "solTreasuryAccount": null,
  "splTokenAccount": null,
  "splToken": null,
  "goLiveDate": "11 Dec 2021 13:00:00 CST",
  "endSettings": null,
  "whitelistMintSettings": null,
  "hiddenSettings": null,
  "storage": "arweave",
  "ipfsInfuraProjectId": null,
  "ipfsInfuraSecret": null,
  "awsS3Bucket": null,
  "noRetainAuthority": false,
  "noMutable": false
}

See example-candy-machine-upload-config.json

Captcha Settings (Gateway)

Want captcha? Add this for gatekeeper value and you are done:

{
    "gatekeeperNetwork": "ignREusXmGrscGNUesoU9mxfds9AiYTezUKex2PsZV6",
    "expireOnUse": true
  }

Hidden Settings

If you plan to do a mint larger than 20k, consider this option. With this, none of the arweave URIs actually go on Solana. You just provide the following in the config for hiddenSettings:

{
"name": "Billy Bob ",
"uri": "https://arweave.net/w_yuIHAmS10B4VFGVGqdSig3fYqZ5_SwR_DUCll1o3c",
"hash": "44kiGWWsSgdqPMvmqYgTS78Mx2BKCWzd"
}

And it will mint the same URI and name (plus #45 or whatever, notice the space I left in there) each time someone mints. You will need to use a script to make a post-mint update. One will be inside the candy machine CLI soon.

The hash can be any 32 character string you want but would preferably be a hash of the cache file itself so that the order can be verified by others after the mint is complete.

End Settings

Stop a mint at a date

{
"endSettingType": { "date": true },
"value": "11 Dec 2021 13:30:00 CST"
}

Stop a mint after a certain amount have sold

{
"endSettingType": { "amount": true },
"value": 10
}

Whitelist Mint Settings

Here are some examples to help you construct your settings file.

I want to burn the token each time. This whitelist is ONLY used for presale, and once the sale begins, the whitelist gets you nothing.


"whitelistMintSettings": {
"mode": { "burnEveryTime": true },
"mint": "7nE1GmnMmDKiycFkpHF7mKtxt356FQzVonZqBWsTWZNf",
"presale": true,
"discountPrice": null
},

I want to burn the token each time. This whitelist is ONLY used for presale, and gives users a 0.5 SOL price tag instead. Once the sale begins, the whitelist gets you only a discount.


"whitelistMintSettings": {
"mode": { "burnEveryTime": true },
"mint": "7nE1GmnMmDKiycFkpHF7mKtxt356FQzVonZqBWsTWZNf",
"presale": true,
"discountPrice": 0.5
},

I do not want to burn the whitelist token - it can be reused. This whitelist is ONLY used for presale, and gives users a 0.5 SOL price tag instead. Once the sale begins, the whitelist gets you only a discount.


"whitelistMintSettings": {
"mode": { "neverBurn": true },
"mint": "7nE1GmnMmDKiycFkpHF7mKtxt356FQzVonZqBWsTWZNf",
"presale": true,
"discountPrice": 0.5
},

I do not want to burn the whitelist token - it can be reused. This whitelist is ONLY used to grant users discounts - a 0.5 SOL price tag.


"whitelistMintSettings": {
"mode": { "neverBurn": true },
"mint": "7nE1GmnMmDKiycFkpHF7mKtxt356FQzVonZqBWsTWZNf",
"presale": false,
"discountPrice": 0.5
},

I want the whitelist token to be burned every mint. This whitelist runs during the sale(not presale) and will restrict any user without such a token from purchasing at all. This is because why would you have this setting with no discount price unless you wanted it applied to all.


"whitelistMintSettings": {
"mode": { "burnEveryTime": true },
"mint": "7nE1GmnMmDKiycFkpHF7mKtxt356FQzVonZqBWsTWZNf",
"presale": false,
"discountPrice": null
},

Creating generative art

There are great tools that can make generative art for you. One of the open source tools we like is HashLips.

Assets folder

  • Folder with file pairs named with incrementing integer numbers starting from 0.png (or other supported image format) and 0.json (example below)
  • If you are using an animation format, you must also include a numbered animation file with a supported format (mp4, html, glb, etc...).
  • JSON format can be checked out here: https://docs.metaplex.com/token-metadata/specification.

Example 0.json File

{
  "name": "SolanaArtProject #0",
  "description": "Generative art on Solana.",
  "image": "0.jpeg", // This means you should also have a 0.jpeg file in the assets folder
  "animation_url": "0.glb", // This means you should also have a 0.glb file in the assets folder
  "external_url": "https://example.com",
  "attributes": [
    {
      "trait_type": "trait1",
      "value": "value1"
    },
    {
      "trait_type": "trait2",
      "value": "value2"
    }
  ],
  //@deprecated -> do not use - may be removed in a future release
  "collection": {
    "name": "Solflare X NFT",
    "family": "Solflare"
  },
  "properties": {
    // If you have additional files or CDN files, you can include them here
    "files": [
      {
        "uri": "https://www.arweave.net/abcd5678?ext=png",
        "type": "image/png"
      },
      {
        "uri": "https://watch.videodelivery.net/9876jkl",
        "type": "unknown",
        "cdn": true
      },
      {
        "uri": "https://www.arweave.net/efgh1234?ext=mp4",
        "type": "video/mp4"
      }
    ],
    "category": "video",
    //@deprecated -> do not use - may be removed in a future release
    "creators": [
      {
        "address": "xEtQ9Fpv62qdc1GYfpNReMasVTe9YW5bHJwfVKqo72u",
        "share": 100
      }
    ]
  }
}