blockworks-foundation
/
solana-program-library
mirror of https://github.com/blockworks-foundation/solana-program-library.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
solana-program-library/account-compression/sdk
History
Noah Gundotra 6e81794844
Account Compression: JS SDK release 0.1.1 (#3680) 
* ac: beet* as deps, not peerDeps

* ac: expose depth size pairs, add canopyDepth to CMTAccount getters

* ac: add tests for CMT Account

* ac: update README.md

* ac: update lockfile
 		2022-10-13 11:52:16 -04:00
..
idl ac: expose ChangeLogEventV1 in crate (#3707) 2022-10-12 19:01:42 -04:00
src Account Compression: JS SDK release 0.1.1 (#3680) 2022-10-13 11:52:16 -04:00
tests Account Compression: JS SDK release 0.1.1 (#3680) 2022-10-13 11:52:16 -04:00
.gitignore Account Compression: Version ChangeLog + Test (#3632) 2022-09-22 15:05:24 -04:00
.npmignore Account Compression: Version ChangeLog + Test (#3632) 2022-09-22 15:05:24 -04:00
.solitarc.js Account Compression: Version ChangeLog + Test (#3632) 2022-09-22 15:05:24 -04:00
README.md Account Compression: JS SDK release 0.1.1 (#3680) 2022-10-13 11:52:16 -04:00
jest.config.js Account Compression: Autogenerate TS SDK with Solita (#3551) 2022-09-08 17:04:54 +05:30
package.json Account Compression: JS SDK release 0.1.1 (#3680) 2022-10-13 11:52:16 -04:00
tsconfig.base.json SPL Account Compression JS Package (#3609) 2022-09-16 15:56:31 -04:00
tsconfig.cjs.json SPL Account Compression JS Package (#3609) 2022-09-16 15:56:31 -04:00
tsconfig.json SPL Account Compression JS Package (#3609) 2022-09-16 15:56:31 -04:00
yarn.lock Account Compression: JS SDK release 0.1.1 (#3680) 2022-10-13 11:52:16 -04:00

README.md

@solana/spl-account-compression

A TypeScript library for interacting with SPL Account Compression and SPL NoOp.

Install

npm install --save @solana/spl-account-compression @solana/web3.js

OR

yarn add @solana/spl-account-compression @solana/web3.js

Examples

  • Solana Program Library tests

  • Metaplex Program Library Compressed NFT tests

Information

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.

Build from Source

  1. Install dependencies with yarn.

  2. Generate the Solita SDK with yarn solita.

  3. Then build the SDK with yarn build.

  4. Run tests with yarn test. (Expect jest to detect an open handle that prevents it from exiting naturally)