History

Jon Cinque 34b57d62fe docs: Clarify audit status of all programs, no S word (#4046 )		2023-02-13 22:05:49 +00:00
..
programs	chore: update maintainer references (#4008 )	2023-01-31 08:06:36 -05:00
sdk	Account Compression: Bump TS SDK Version (#4023 )	2023-02-02 17:09:02 -06:00
Anchor.toml	Account Compression: Version ChangeLog + Test (#3632 )	2022-09-22 15:05:24 -04:00
Cargo.lock	ac: bump rust version (#3985 )	2023-01-19 10:44:41 -05: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:

yarn link @solana/spl-account-compression
yarn
yarn test

Audit

The repository README contains information about program audits.