# @metaplex-foundation/spl-account-compression

> Create and interact with compressed Metaplex NFTs

Latest version **0.0.1** (published 2025-04-11) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @metaplex-foundation/spl-account-compression
pnpm add @metaplex-foundation/spl-account-compression
yarn add @metaplex-foundation/spl-account-compression
bun add @metaplex-foundation/spl-account-compression
```

## Health

**Score 50/100 (C)** — status: stable.

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

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

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2025-04-11 |
| First published | 2025-04-11 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 133 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 128 |
| Author | Metaplex Maintainers |
| Maintainers | nhanphan, brandontulsi, svc01-metaplex, danenbm, blockiosaurus |

## Links

- npm: https://www.npmjs.com/package/@metaplex-foundation/spl-account-compression
- Repository: https://github.com/metaplex-foundation/mpl-bubblegum
- Homepage: https://metaplex.com
- Issues: https://github.com/metaplex-foundation/mpl-bubblegum/issues
- npm.io page: https://npm.io/package/@metaplex-foundation/spl-account-compression

## Dependencies (3)

- [merkletreejs](https://npm.io/package/merkletreejs.md) ^0.3.11
- [@noble/hashes](https://npm.io/package/@noble/hashes.md) ^1.3.1
- [@metaplex-foundation/digital-asset-standard-api](https://npm.io/package/@metaplex-foundation/digital-asset-standard-api.md) ^1.0.5

## Recent versions

- 0.0.1 (latest) — 2025-04-11

## README

# JavaScript client for Spl Account Compression

A Umi-compatible JavaScript library for the project.

## 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/spl-account-compression
   ```

2. Finally, register the library with your Umi instance like so.

   ```ts
   import { splAccountCompression } from '@metaplex-foundation/spl-account-compression';
   umi.use(splAccountCompression());
   ```

You can learn more about this library's API by reading its generated [TypeDoc documentation](https://spl-account-compression-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/spl-account-compression · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
