# @metaplex-foundation/mpl-candy-guard

> MPL Candy Guard JavaScript API. This MPL package is for the current generation of the Candy Guard

Latest version **0.5.0** (published 2023-06-15) · Apache-2.0 license · 0 weekly downloads

## Install

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

## Health

**Score 25/100 (F)** — status: abandoned.

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2023-06-15 |
| First published | 2022-10-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 242.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 27 |
| Author | Metaplex Maintainers |
| Maintainers | danenbm, nhanphan, blockiosaurus, 0x_febo, svc01-metaplex, samuelvanderwaal, brandontulsi, lorisleiva, thlorenz, austbotm |
| Keywords | nft, metaplex, solana, blockchain |

## Links

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

## Dependencies (5)

- [bn.js](https://npm.io/package/bn.js.md) ^5.2.0
- [@solana/web3.js](https://npm.io/package/@solana/web3.js.md) ^1.73.3
- [@metaplex-foundation/beet](https://npm.io/package/@metaplex-foundation/beet.md) ^0.7.1
- [@metaplex-foundation/cusper](https://npm.io/package/@metaplex-foundation/cusper.md) ^0.0.2
- [@metaplex-foundation/beet-solana](https://npm.io/package/@metaplex-foundation/beet-solana.md) ^0.4.0

## Recent versions

- 0.5.0 (latest) — 2023-06-15
- 0.4.2 — 2023-04-05
- 0.4.1 — 2023-03-20
- 0.4.0 — 2023-03-08
- 0.3.2 — 2023-01-27
- 0.3.1 — 2022-12-20
- 0.3.0 — 2022-10-28
- 0.2.0 — 2022-10-12
- 0.1.0 — 2022-10-11
- 0.0.2 — 2022-10-07

## README

# mpl-candy-guard

This package contains the Metaplex Candy Guard contract SDK code.

## API Docs

Find the [candy-guard API docs published here](https://metaplex-foundation.github.io/mpl-candy-guard/index.html).

## Installation

```shell
npm install @metaplex-foundation/mpl-candy-guard --save
```

## Developing

In order to update the generated SDK when the rust contract was updated please run:

```
yarn api:gen
```

and then update the wrapper code and tests.

## LICENSE

Apache v2.0

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