createTokenPool() or use createMint() to create a new one from scratch.
// Create SPL mint with interface PDA for compression
const { mint, transactionSignature } = await createMint(
rpc,
payer,
mintAuthority.publicKey,
decimals,
);
Best Practice: Each mint supports a maximum of 4 interface PDAs total. During compression/decompression, interface PDAs get write-locked. Use
addTokenPools() to create additional PDAs that increase per-block write-lock capacity.Get Started
1
Create a Mint Account with Interface PDA for Compression
Installation
Installation
- npm
- yarn
- pnpm
- SDK 2.0 (token-interface)
Install packages in your working directory:Install the CLI globally:
npm install @lightprotocol/stateless.js@^0.23.0 \
@lightprotocol/compressed-token@^0.23.0
npm install -g @lightprotocol/zk-compression-cli
Install packages in your working directory:Install the CLI globally:
yarn add @lightprotocol/stateless.js@^0.23.0 \
@lightprotocol/compressed-token@^0.23.0
yarn global add @lightprotocol/zk-compression-cli
Install packages in your working directory:Install the CLI globally:
pnpm add @lightprotocol/stateless.js@^0.23.0 \
@lightprotocol/compressed-token@^0.23.0
pnpm add -g @lightprotocol/zk-compression-cli
Install packages in your working directory:Install the CLI globally:
# npm
npm install @lightprotocol/stateless.js@^0.23.0 \
@lightprotocol/token-interface@^0.1.2
# yarn
yarn add @lightprotocol/stateless.js@^0.23.0 \
@lightprotocol/token-interface@^0.1.2
# pnpm
pnpm add @lightprotocol/stateless.js@^0.23.0 \
@lightprotocol/token-interface@^0.1.2
npm install -g @lightprotocol/zk-compression-cli
- Localnet
- Devnet
# start local test-validator in a separate terminal
light test-validator
In the code examples, use
createRpc() without arguments for localnet.Get an API key from Helius and add to
.env:.env
API_KEY=<your-helius-api-key>
In the code examples, use
createRpc(RPC_URL) with the devnet URL.- Action
- Instruction
import "dotenv/config";
import { Keypair } from "@solana/web3.js";
import { createRpc } from "@lightprotocol/stateless.js";
import { createMint } from "@lightprotocol/compressed-token";
import { homedir } from "os";
import { readFileSync } from "fs";
// devnet:
const RPC_URL = `https://devnet.helius-rpc.com?api-key=${process.env.API_KEY!}`;
// localnet:
// const RPC_URL = undefined;
const payer = Keypair.fromSecretKey(
new Uint8Array(
JSON.parse(readFileSync(`${homedir()}/.config/solana/id.json`, "utf8"))
)
);
(async function () {
// devnet:
const rpc = createRpc(RPC_URL);
// localnet:
// const rpc = createRpc();
const { mint, transactionSignature } = await createMint(
rpc,
payer,
payer.publicKey,
9
);
console.log("Mint:", mint.toBase58());
console.log("Tx:", transactionSignature);
})();
import "dotenv/config";
import {
Keypair,
ComputeBudgetProgram,
PublicKey,
Transaction,
sendAndConfirmTransaction,
} from "@solana/web3.js";
import {
createRpc,
getBatchAddressTreeInfo,
selectStateTreeInfo,
LIGHT_TOKEN_PROGRAM_ID,
} from "@lightprotocol/stateless.js";
import { createMintInstruction } from "@lightprotocol/compressed-token";
import { homedir } from "os";
import { readFileSync } from "fs";
const COMPRESSED_MINT_SEED = Buffer.from("compressed_mint");
function findMintAddress(mintSigner: PublicKey): [PublicKey, number] {
return PublicKey.findProgramAddressSync(
[COMPRESSED_MINT_SEED, mintSigner.toBuffer()],
LIGHT_TOKEN_PROGRAM_ID
);
}
// devnet:
const RPC_URL = `https://devnet.helius-rpc.com?api-key=${process.env.API_KEY!}`;
const rpc = createRpc(RPC_URL);
// localnet:
// const rpc = createRpc();
const payer = Keypair.fromSecretKey(
new Uint8Array(
JSON.parse(readFileSync(`${homedir()}/.config/solana/id.json`, "utf8"))
)
);
(async function () {
const mintSigner = Keypair.generate();
const addressTreeInfo = getBatchAddressTreeInfo();
const stateTreeInfo = selectStateTreeInfo(await rpc.getStateTreeInfos());
const [mintPda] = findMintAddress(mintSigner.publicKey);
const validityProof = await rpc.getValidityProofV2(
[],
[{ address: mintPda.toBytes(), treeInfo: addressTreeInfo }]
);
const ix = createMintInstruction(
mintSigner.publicKey,
9,
payer.publicKey,
null,
payer.publicKey,
validityProof,
addressTreeInfo,
stateTreeInfo
);
const tx = new Transaction().add(
ComputeBudgetProgram.setComputeUnitLimit({ units: 1_000_000 }),
ix
);
const signature = await sendAndConfirmTransaction(rpc, tx, [payer, mintSigner]);
console.log("Mint:", mintPda.toBase58());
console.log("Tx:", signature);
})();
Advanced Configuration
Customize Mint Authority
Customize Mint Authority
Customize who can mint new compressed tokens.
const mintAuthority = Keypair.generate();
const { mint, transactionSignature } = await createMint(
rpc,
payer,
mintAuthority.publicKey,
9,
);
Add Freeze Authority
Add Freeze Authority
Customize who can freeze/thaw compressed token accounts.
const freezeAuthority = Keypair.generate();
const { mint, transactionSignature } = await createMint(
rpc,
payer,
payer.publicKey, // mint authority
9, // decimals
Keypair.generate(), // mint keypair
undefined, // confirm options
undefined, // token program ID
freezeAuthority.publicKey, // freeze authority
);