# @metaplex-foundation/mpl-candy-machine

> Client library for Candy Machine related programs

Latest version **6.1.0** (published 2025-01-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @metaplex-foundation/mpl-candy-machine
pnpm add @metaplex-foundation/mpl-candy-machine
yarn add @metaplex-foundation/mpl-candy-machine
bun add @metaplex-foundation/mpl-candy-machine
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 6.1.0 |
| Published | 2025-01-29 |
| First published | 2022-02-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 674.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 101 |
| Author | Metaplex Maintainers |
| Maintainers | nhanphan, brandontulsi, svc01-metaplex, danenbm, blockiosaurus |

## Links

- npm: https://www.npmjs.com/package/@metaplex-foundation/mpl-candy-machine
- Repository: https://github.com/metaplex-foundation/mpl-candy-machine
- Homepage: https://metaplex.com
- Issues: https://github.com/metaplex-foundation/mpl-candy-machine/issues
- npm.io page: https://npm.io/package/@metaplex-foundation/mpl-candy-machine

## Dependencies (4)

- [merkletreejs](https://npm.io/package/merkletreejs.md) ^0.3.9
- [@noble/hashes](https://npm.io/package/@noble/hashes.md) ^1.2.0
- [@metaplex-foundation/mpl-toolbox](https://npm.io/package/@metaplex-foundation/mpl-toolbox.md) 0.10.0
- [@metaplex-foundation/mpl-token-metadata](https://npm.io/package/@metaplex-foundation/mpl-token-metadata.md) 3.0.0-alpha.27

## Recent versions

- 6.1.0 (latest) — 2025-01-29
- 6.0.0-alpha.20 (alpha) — 2023-09-03
- 6.0.1 — 2024-02-01
- 6.0.0 — 2023-09-03
- 6.0.0-alpha.19 — 2023-08-11
- 6.0.0-alpha.18 — 2023-07-27
- 6.0.0-alpha.17 — 2023-07-12
- 6.0.0-alpha.16 — 2023-06-19
- 6.0.0-alpha.15 — 2023-06-13
- 6.0.0-alpha.14 — 2023-06-13
- 6.0.0-alpha.13 — 2023-06-06
- 6.0.0-alpha.12 — 2023-05-09
- 6.0.0-alpha.11 — 2023-04-27
- 6.0.0-alpha.10 — 2023-04-24
- 6.0.0-alpha.9 — 2023-04-17
- … 26 more at https://npm.io/package/@metaplex-foundation/mpl-candy-machine/versions

## README

# JavaScript client for Mpl Candy Machine

A Umi-compatible JavaScript library for candy machines.

## Getting started

1. First, if you're not already using Umi, [follow these instructions to install the Umi framework](https://github.com/metaplex-foundation/umi/blob/main/docs/installation.md).
2. Next, install this library using the package manager of your choice.
   ```sh
   npm install @metaplex-foundation/mpl-candy-machine
   ```
2. Finally, register the library with your Umi instance like so.
   ```ts
   import { mplCandyMachine } from '@metaplex-foundation/mpl-candy-machine';
   umi.use(mplCandyMachine());
   ```

You can learn more about this library's API by reading its generated [TypeDoc documentation](https://mpl-candy-machine-js-docs.vercel.app).

## Contributing

Check out the [Contributing Guide](./CONTRIBUTING.md) the learn more about how to contribute to this library.

---
_Source: https://npm.io/package/@metaplex-foundation/mpl-candy-machine · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._