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.
This repo is a modified fork of the original repository published by Solana Labs, Inc. under the Apache 2.0 License. Modifications to the original repository are made by the Metaplex Foundation to diverge from the behavior of the original implementation. Such modifications are made available for review in the commit history.
mpl-account-compression: SDK for interacting with account compression programmpl-noop: SDK for interacting with no op program, primarily for circumventing log truncation
From the sdk directory of the repository:
pnpm install
pnpm build:program
@metaplex-foundation/mpl-account-compression is generated using Metaplex Foundation's Solita.
From the sdk directory of the repository:
pnpm generate
pnpm lint:fix
Note: It is important to run the lint step after generating with Solita to maintain the existing ordering of struct members.
Note: Due to a Solita generation issue, you also have to manually add export * from './types'; to sdk/src/generated/index.ts, or if there are no other changes, simply checkout the previously-generated version of the file.
Testing contracts locally requires the SDK to be built.
From the sdk directory of the repository:
pnpm build
pnpm test
The most recent security audit of Account Compression was completed 2022-12-05 by OtterShield.
This audit was completed while the programs were part of the Solana Program Library. See this README for more information.