solana-program-library/account-compression
dependabot[bot] 2d3cf089e4
build(deps): bump bumpalo from 3.10.0 to 3.12.0 in /account-compression (#3990)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-03 11:10:09 +00:00
..
programs bump accoutn compression to 0.1.10 (#4130) 2023-04-18 18:22:16 +00:00
sdk js: move `types` condition to the front (#4149) 2023-05-01 22:20:02 +00:00
Anchor.toml Account Compression: Version ChangeLog + Test (#3632) 2022-09-22 15:05:24 -04:00
Cargo.lock build(deps): bump bumpalo from 3.10.0 to 3.12.0 in /account-compression (#3990) 2023-05-03 11:10:09 +00:00
Cargo.toml account-compression: Rename packages, prep for release (#3600) 2022-09-13 17:44:18 +02:00
README.md docs: Clarify audit status of all programs, no S word (#4046) 2023-02-13 22:05:49 +00:00

README.md

Account Compression (Beta)

This on-chain program provides an interface for composing smart-contracts to create and use SPL ConcurrentMerkleTrees. The primary application of using SPL ConcurrentMerkleTrees is to make edits to off-chain data with on-chain verification.

This program is targeted towards supporting Metaplex Compressed NFTs and may be subject to change.

Note: Using this program requires an indexer to parse transaction information and write relevant information to an off-chain database.

A rough draft of the whitepaper for SPL ConcurrentMerkleTree's can be found here.

Rust Packages

  • spl-account-compression: SDK for interacting with account compression program
  • spl-noop: SDK for interacting with no op program, primarily for circumventing log truncation
  • spl-concurrent-merkle-tree: SDK for creating SPL ConcurrentMerkleTrees

Typescript SDK

@solana/spl-account-compression is generated using Metaplex Foundation's Solita.

Testing and Development

Testing contracts locally requires the SDK to be built.

With a built local SDK, the test suite can be ran with:

  1. yarn link @solana/spl-account-compression
  2. yarn
  3. yarn test

Audit

The repository README contains information about program audits.