Skip to content
This repository was archived by the owner on Mar 11, 2025. It is now read-only.

Commit 6e81794

Browse files
ngundotrangundotra
authored
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
1 parent 39935ba commit 6e81794

File tree

7 files changed

+135
-52
lines changed

7 files changed

+135
-52
lines changed

‎account-compression/sdk/README.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,42 @@
1-
# Account Compression SDK
1+
# `@solana/spl-account-compression`
22

3-
Currently contains a typescript SDK to interact with on-chain SPL ConcurrentMerkleTrees.
3+
A TypeScript library for interacting with SPL Account Compression and SPL NoOp.
44

5-
Used to test Account Compression program.
5+
## Install
66

7-
# Setting up the Solita-based Typescript SDK
7+
```shell
8+
npm install --save @solana/spl-account-compression @solana/web3.js
9+
```
10+
11+
__OR__
12+
13+
```shell
14+
yarn add @solana/spl-account-compression @solana/web3.js
15+
```
16+
17+
18+
## Examples
19+
20+
* Solana Program Library [tests](https://github.com/solana-labs/solana-program-library/tree/master/account-compression/sdk/tests)
21+
22+
* Metaplex Program Library Compressed NFT [tests](https://github.com/metaplex-foundation/metaplex-program-library/tree/master/bubblegum/js/tests)
23+
24+
## Information
25+
26+
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.
27+
28+
This program is targeted towards supporting [Metaplex Compressed NFTs](https://github.com/metaplex-foundation/metaplex-program-library/tree/master/bubblegum) and may be subject to change.
29+
30+
Note: Using this program requires an indexer to parse transaction information and write relevant information to an off-chain database.
31+
32+
A **rough draft** of the whitepaper for SPL ConcurrentMerkleTree's can be found [here](https://drive.google.com/file/d/1BOpa5OFmara50fTvL0VIVYjtg-qzHCVc/view).
33+
34+
## Build from Source
35+
36+
0. Install dependencies with `yarn`.
837

938
1. Generate the Solita SDK with `yarn solita`.
1039

1140
2. Then build the SDK with `yarn build`.
1241

13-
# Testing the SDK
14-
15-
Run `yarn test`. Expect `jest` to detect an open handle that prevents it from exiting tests naturally.
42+
3. Run tests with `yarn test`. (Expect `jest` to detect an open handle that prevents it from exiting naturally)

‎account-compression/sdk/package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@solana/spl-account-compression",
33
"description": "SPL Account Compression Program JS API",
4-
"version": "0.1.0",
4+
"version": "0.1.1",
55
"author": "Solana Maintainers <maintainers@solana.foundation>",
66
"repository": {
77
"url": "https://github.com/solana-labs/solana-program-library",
@@ -37,7 +37,9 @@
3737
"start-validator": "solana-test-validator --reset --quiet --bpf-program cmtDvXumGCrqC1Age74AVPhSRVXJMd8PJS91L8KbNCK ../target/deploy/spl_account_compression.so --bpf-program noopb9bkMVfRPU8AsbpTUg8AQkHtKwMYZiFUjNRtMmV ../target/deploy/spl_noop.so",
3838
"run-tests": "jest tests --detectOpenHandles",
3939
"run-tests:events": "jest tests/events --detectOpenHandles",
40+
"run-tests:accounts": "jest tests/accounts --detectOpenHandles",
4041
"test:events": "start-server-and-test start-validator http://localhost:8899/health run-tests:events",
42+
"test:accounts": "start-server-and-test start-validator http://localhost:8899/health run-tests:accounts",
4143
"test": "start-server-and-test start-validator http://localhost:8899/health run-tests"
4244
},
4345
"dependencies": {
@@ -46,11 +48,11 @@
4648
"borsh": "^0.7.0"
4749
},
4850
"peerDependencies": {
49-
"@metaplex-foundation/beet": "^0.6.1",
50-
"@metaplex-foundation/beet-solana": "^0.6.1",
5151
"@solana/web3.js": "^1.50.1"
5252
},
5353
"devDependencies": {
54+
"@metaplex-foundation/beet": "^0.7.1",
55+
"@metaplex-foundation/beet-solana": "^0.4.0",
5456
"@metaplex-foundation/rustbin": "^0.3.1",
5557
"@metaplex-foundation/solita": "0.15.2",
5658
"@project-serum/anchor": "^0.25.0",
@@ -68,4 +70,4 @@
6870
"typescript": "=4.7.4",
6971
"typescript-collections": "^1.3.3"
7072
}
71-
}
73+
}

‎account-compression/sdk/src/accounts/ConcurrentMerkleTreeAccount.ts

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { PublicKey, Connection } from "@solana/web3.js";
1+
import type { PublicKey, Connection, Commitment, GetAccountInfoConfig } from "@solana/web3.js";
22
import * as borsh from "borsh";
33
import * as BN from 'bn.js';
44
import * as beet from '@metaplex-foundation/beet';
@@ -35,8 +35,8 @@ export class ConcurrentMerkleTreeAccount {
3535
return deserializeConcurrentMerkleTree(buffer);
3636
}
3737

38-
static async fromAccountAddress(connection: Connection, publicKey: PublicKey): Promise<ConcurrentMerkleTreeAccount> {
39-
const account = await connection.getAccountInfo(publicKey);
38+
static async fromAccountAddress(connection: Connection, publicKey: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<ConcurrentMerkleTreeAccount> {
39+
const account = await connection.getAccountInfo(publicKey, commitmentOrConfig);
4040
if (!account) {
4141
throw new Error("CMT account data unexpectedly null!");
4242
}
@@ -79,9 +79,13 @@ export class ConcurrentMerkleTreeAccount {
7979
return new BN.BN(this.tree.sequenceNumber).toNumber();
8080
}
8181

82+
getCanopyDepth(): number {
83+
return getCanopyDepth(this.canopy.canopyBytes.length);
84+
}
85+
8286
};
8387

84-
function getCanopyDepth(canopyByteLength: number): number {
88+
export function getCanopyDepth(canopyByteLength: number): number {
8589
if (canopyByteLength === 0) {
8690
return 0;
8791
}

‎account-compression/sdk/src/utils/index.ts

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,40 @@ import {
33
} from "@solana/web3.js";
44

55
export const SPL_NOOP_ADDRESS = "noopb9bkMVfRPU8AsbpTUg8AQkHtKwMYZiFUjNRtMmV";
6-
export const SPL_NOOP_PROGRAM_ID = new PublicKey(SPL_NOOP_ADDRESS);
6+
export const SPL_NOOP_PROGRAM_ID = new PublicKey(SPL_NOOP_ADDRESS);
7+
8+
type DepthSizePair = {
9+
maxDepth: number,
10+
maxBufferSize: number
11+
};
12+
13+
const allPairs: number[][] = [
14+
[3, 8],
15+
[5, 8],
16+
[14, 64],
17+
[14, 256],
18+
[14, 1024],
19+
[14, 2048],
20+
[20, 64],
21+
[20, 256],
22+
[20, 1024],
23+
[20, 2048],
24+
[24, 64],
25+
[24, 256],
26+
[24, 512],
27+
[24, 1024],
28+
[24, 2048],
29+
[26, 512],
30+
[26, 1024],
31+
[26, 2048],
32+
[30, 512],
33+
[30, 1024],
34+
[30, 2048],
35+
];
36+
37+
export const ALL_DEPTH_SIZE_PAIRS: DepthSizePair[] = allPairs.map((pair) => {
38+
return {
39+
maxDepth: pair[0],
40+
maxBufferSize: pair[1]
41+
}
42+
})

‎account-compression/sdk/tests/accountCompression.test.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,7 @@ import { BN } from 'bn.js';
33
import { AnchorProvider } from "@project-serum/anchor";
44
import {
55
Connection,
6-
Signer,
76
Keypair,
8-
PublicKey,
9-
Transaction,
107
TransactionInstruction,
118
} from "@solana/web3.js";
129
import { assert } from "chai";

‎account-compression/sdk/tests/utils.ts

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,35 +23,6 @@ import {
2323
Tree,
2424
} from "./merkleTree";
2525

26-
export async function assertCMTProperties(
27-
connection: Connection,
28-
expectedMaxDepth: number,
29-
expectedMaxBufferSize: number,
30-
expectedAuthority: PublicKey,
31-
expectedRoot: Buffer,
32-
onChainCMTKey: PublicKey
33-
) {
34-
const onChainCMT = await ConcurrentMerkleTreeAccount.fromAccountAddress(connection, onChainCMTKey);
35-
36-
assert(
37-
onChainCMT.getMaxDepth() === expectedMaxDepth,
38-
`Max depth does not match ${onChainCMT.getMaxDepth()}, expected ${expectedMaxDepth}`,
39-
);
40-
assert(
41-
onChainCMT.getMaxBufferSize() === expectedMaxBufferSize,
42-
`Max buffer size does not match ${onChainCMT.getMaxBufferSize()}, expected ${expectedMaxBufferSize}`,
43-
);
44-
assert(
45-
onChainCMT.getAuthority().equals(expectedAuthority),
46-
"Failed to write auth pubkey",
47-
);
48-
assert(
49-
onChainCMT.getCurrentRoot().equals(expectedRoot),
50-
"On chain root does not match root passed in instruction",
51-
);
52-
}
53-
54-
5526
/// Wait for a transaction of a certain id to confirm and optionally log its messages
5627
export async function confirmAndLogTx(provider: AnchorProvider, txId: string, verbose: boolean = false) {
5728
const tx = await provider.connection.confirmTransaction(txId, "confirmed");
@@ -98,6 +69,7 @@ export async function execute(
9869
return txid;
9970
}
10071

72+
10173
export async function createTreeOnChain(
10274
provider: AnchorProvider,
10375
payer: Keypair,
@@ -152,15 +124,41 @@ export async function createTreeOnChain(
152124
appendIxs = appendIxs.slice(5,);
153125
}
154126
}
127+
return [cmtKeypair, tree];
128+
}
155129

156-
await assertCMTProperties(
130+
export async function createEmptyTreeOnChain(
131+
provider: AnchorProvider,
132+
payer: Keypair,
133+
maxDepth: number,
134+
maxSize: number,
135+
canopyDepth: number = 0,
136+
): Promise<Keypair> {
137+
const cmtKeypair = Keypair.generate();
138+
const allocAccountIx = await createAllocTreeIx(
157139
provider.connection,
158-
maxDepth,
159140
maxSize,
141+
maxDepth,
142+
canopyDepth,
160143
payer.publicKey,
161-
tree.root,
162144
cmtKeypair.publicKey
163145
);
164146

165-
return [cmtKeypair, tree];
147+
let ixs = [
148+
allocAccountIx,
149+
createInitEmptyMerkleTreeIx(
150+
payer,
151+
cmtKeypair.publicKey,
152+
maxDepth,
153+
maxSize,
154+
)
155+
];
156+
157+
let txId = await execute(provider, ixs, [
158+
payer,
159+
cmtKeypair,
160+
]);
161+
await confirmAndLogTx(provider, txId as string);
162+
163+
return cmtKeypair;
166164
}

‎account-compression/sdk/yarn.lock

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -620,6 +620,16 @@
620620
bs58 "^5.0.0"
621621
debug "^4.3.4"
622622

623+
"@metaplex-foundation/beet-solana@^0.4.0":
624+
version "0.4.0"
625+
resolved "https://registry.yarnpkg.com/@metaplex-foundation/beet-solana/-/beet-solana-0.4.0.tgz#52891e78674aaa54e0031f1bca5bfbc40de12e8d"
626+
integrity sha512-B1L94N3ZGMo53b0uOSoznbuM5GBNJ8LwSeznxBxJ+OThvfHQ4B5oMUqb+0zdLRfkKGS7Q6tpHK9P+QK0j3w2cQ==
627+
dependencies:
628+
"@metaplex-foundation/beet" ">=0.1.0"
629+
"@solana/web3.js" "^1.56.2"
630+
bs58 "^5.0.0"
631+
debug "^4.3.4"
632+
623633
"@metaplex-foundation/beet@>=0.1.0", "@metaplex-foundation/beet@^0.6.1":
624634
version "0.6.1"
625635
resolved "https://registry.yarnpkg.com/@metaplex-foundation/beet/-/beet-0.6.1.tgz#6331bdde0648bf2cae6f9e482f8e3552db05d69f"
@@ -629,6 +639,15 @@
629639
bn.js "^5.2.0"
630640
debug "^4.3.3"
631641

642+
"@metaplex-foundation/beet@^0.7.1":
643+
version "0.7.1"
644+
resolved "https://registry.yarnpkg.com/@metaplex-foundation/beet/-/beet-0.7.1.tgz#0975314211643f87b5f6f3e584fa31abcf4c612c"
645+
integrity sha512-hNCEnS2WyCiYyko82rwuISsBY3KYpe828ubsd2ckeqZr7tl0WVLivGkoyA/qdiaaHEBGdGl71OpfWa2rqL3DiA==
646+
dependencies:
647+
ansicolors "^0.3.2"
648+
bn.js "^5.2.0"
649+
debug "^4.3.3"
650+
632651
"@metaplex-foundation/rustbin@^0.3.0", "@metaplex-foundation/rustbin@^0.3.1":
633652
version "0.3.1"
634653
resolved "https://registry.yarnpkg.com/@metaplex-foundation/rustbin/-/rustbin-0.3.1.tgz#bbcd61e8699b73c0b062728c6f5e8d52e8145042"

0 commit comments

Comments
 (0)