MPL Core Candy Machine JavaScript SDK

Summary

The MPL Core Candy Machine JavaScript SDK provides a lightweight library for creating and managing Core Candy Machines on Solana using the Umi framework.

• Install the @metaplex-foundation/mpl-core-candy-machine package via npm, yarn, or bun
• Requires a configured Umi instance with an RPC endpoint and signer
• Register the SDK as a plugin on your Umi instance with .use(mplCandyMachine())
• Compatible with any JavaScript or TypeScript project

Installation

The @metaplex-foundation/mpl-core-candy-machine package can be installed with any JavaScript package manager including npm, yarn, and bun.

npm install @metaplex-foundation/mpl-core-candy-machine

Umi Setup

A configured Umi instance is required before you can interact with the Core Candy Machine SDK. If you have not yet set up Umi, visit the Umi Getting Started page to configure your RPC endpoint and identity signer.

During the initialization of the umi instance you can add the mpl-core package to umi using

.use(mplCandyMachine())

You can add the mplCandyMachine() package anywhere in your umi instance creation with .use().

import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
import { mplCandyMachine } from '@metaplex-foundation/mpl-core-candy-machine'

// Use the RPC endpoint of your choice.
const umi = createUmi('http://api.devnet.solana.com')
... // additional umi settings, packages, and signers
.use(mplCandyMachine())

From here your umi instance will have access to the mpl-core package and you can start exploring the Core Candy Machine feature set.

Notes

• The JavaScript SDK requires the Umi framework as a peer dependency. You must install and configure Umi before using this SDK.
• A Solana RPC endpoint is required. Use a dedicated RPC provider for production deployments rather than the public endpoint.
• This SDK covers both the Core Candy Machine program and the Core Candy Guard program in a single package.