Module instruction 

Utilities to build instructions for programs with compressed accounts.

Overview

This module provides types and utilities for building Solana instructions that work with compressed accounts. The main workflow involves:

 ├─ 𝐂𝐥𝐢𝐞𝐧𝐭
 │  ├─ Get ValidityProof from RPC.
 │  ├─ pack accounts with PackedAccounts into PackedAddressTreeInfo and PackedStateTreeInfo.
 │  ├─ pack CompressedAccountMeta.
 │  ├─ Build Instruction from packed accounts and CompressedAccountMetas.
 │  └─ Send transaction
 │
 └─ 𝐂𝐮𝐬𝐭𝐨𝐦 𝐏𝐫𝐨𝐠𝐫𝐚𝐦
    ├─ use PackedAddressTreeInfo to create a new address.
    ├─ use CompressedAccountMeta to instantiate a LightAccount struct.
    │
    └─ 𝐋𝐢𝐠𝐡𝐭 𝐒𝐲𝐬𝐭𝐞𝐦 𝐏𝐫𝐨𝐠𝐫𝐚𝐦 𝐂𝐏𝐈
       ├─ Verify ValidityProof.
       ├─ Update State Merkle tree.
       ├─ Update Address Merkle tree.
       └─ Complete atomic state transition.

Main Types

• PackedAddressTreeInfo - Indices of address tree and queue accounts.
• PackedStateTreeInfo - Indices of state tree and queue accounts.
• PackedAccounts - Packs accounts and creates indices for instruction building (client-side).
• SystemAccountMetaConfig - Configures which Light system program accounts to add to PackedAccounts.
• ValidityProof - Proves that new addresses don’t exist yet, and compressed account state exists.
• CompressedAccountMeta - Metadata for compressed accounts.

Compressed Account Metas

Instruction data types to pass compressed account metadata into instructions. CompressedAccountMeta and variations with and without lamports and addresses are used to instantiate LightAccount structs in your program.

Packed Structs Pattern

Structs prefixed with Packed (eg PackedAddressTreeInfo, PackedStateTreeInfo) are instruction data structs that contain account indices instead of pubkeys to reduce instruction size.

• Packed* structs: Contain indices (u8) for use in instruction data.
• Non-Packed structs: Contain pubkeys (Pubkey) for use in the client, and are returned by RPC methods.
• PackedAccounts: Manages account deduplication and index assignment to create Packed* structs.

Modules

account_info

account_meta

Structs

AddressTreeInfo

CompressedProof

Zero-knowledge proof to prove the validity of existing compressed accounts and new addresses.

MerkleContext

PackedAccounts

Builder for organizing accounts into compressed account instructions.

PackedAddressTreeInfo

PackedMerkleContext

PackedStateTreeInfo

SystemAccountMetaConfig

Configuration for Light system program accounts when building instructions.

SystemAccountPubkeys

ValidityProof

Zero-knowledge proof to prove the validity of existing compressed accounts and new addresses.

Traits

AccountMetasVec

Functions

get_light_system_account_metas

InvokeSystemCpi v1.

pack_address_tree_info

Returns a PackedAddressTreeInfo and fills up remaining_accounts based on the given merkle_context. Packs Merkle tree account first. Packs queue account second.

pack_address_tree_infos

Returns an iterator of PackedAddressTreeInfo and fills up remaining_accounts based on the given merkle_contexts.

pack_merkle_contextDeprecated

pack_merkle_contextsDeprecated

unpack_address_tree_info

unpack_address_tree_infos