@macalinao/clients-mpl-bubblegum 0.3.1 → 0.3.2

package/src/generated/instructions/compress.ts

@@ -6,24 +6,6 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  AccountMeta,
-  AccountSignerMeta,
-  Address,
-  FixedSizeCodec,
-  FixedSizeDecoder,
-  FixedSizeEncoder,
-  Instruction,
-  InstructionWithAccounts,
-  InstructionWithData,
-  ReadonlyAccount,
-  ReadonlySignerAccount,
-  ReadonlyUint8Array,
-  TransactionSigner,
-  WritableAccount,
-  WritableSignerAccount,
-} from "@solana/kit";
-import type { ResolvedInstructionAccount } from "@solana/program-client-core";
 import {
   combineCodec,
   fixDecoderSize,
@@ -35,10 +17,26 @@ import {
   SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
   SolanaError,
   transformEncoder,
+  type AccountMeta,
+  type AccountSignerMeta,
+  type Address,
+  type FixedSizeCodec,
+  type FixedSizeDecoder,
+  type FixedSizeEncoder,
+  type Instruction,
+  type InstructionWithAccounts,
+  type InstructionWithData,
+  type ReadonlyAccount,
+  type ReadonlySignerAccount,
+  type ReadonlyUint8Array,
+  type TransactionSigner,
+  type WritableAccount,
+  type WritableSignerAccount,
 } from "@solana/kit";
 import {
   getAccountMetaFactory,
   getAddressFromResolvedInstructionAccount,
+  type ResolvedInstructionAccount,
 } from "@solana/program-client-core";
 import { findTreeConfigPda } from "../pdas/index.js";
 import { BUBBLEGUM_PROGRAM_ADDRESS } from "../programs/index.js";
@@ -125,9 +123,7 @@ export type CompressInstruction<
     ]
   >;
 
-export interface CompressInstructionData {
-  discriminator: ReadonlyUint8Array;
-}
+export type CompressInstructionData = { discriminator: ReadonlyUint8Array };
 
 export type CompressInstructionDataArgs = {};
 
@@ -154,7 +150,7 @@ export function getCompressInstructionDataCodec(): FixedSizeCodec<
   );
 }
 
-export interface CompressAsyncInput<
+export type CompressAsyncInput<
   TAccountTreeAuthority extends string = string,
   TAccountLeafOwner extends string = string,
   TAccountLeafDelegate extends string = string,
@@ -169,23 +165,62 @@ export interface CompressAsyncInput<
   TAccountTokenProgram extends string = string,
   TAccountTokenMetadataProgram extends string = string,
   TAccountSystemProgram extends string = string,
-> {
+> = {
+  /**
+   * The tree's `TreeConfig` PDA, which stores its configuration and acts
+   * as the tree's authority for CPIs into the compression program.
+   */
   treeAuthority?: Address<TAccountTreeAuthority>;
+  /** Owner of the compressed NFT leaf being operated on. */
   leafOwner: TransactionSigner<TAccountLeafOwner>;
+  /**
+   * Delegate authority for the leaf; defaults to the leaf owner when no
+   * delegate is set.
+   */
   leafDelegate: Address<TAccountLeafDelegate>;
+  /**
+   * The concurrent Merkle tree account storing the compressed leaves,
+   * owned by the account compression program.
+   */
   merkleTree: Address<TAccountMerkleTree>;
+  /** Token account that will hold the decompressed NFT for `leafOwner`. */
   tokenAccount: Address<TAccountTokenAccount>;
+  /** Mint account of the decompressed NFT, created fresh during decompression. */
   mint: Address<TAccountMint>;
+  /** Metadata account created for the decompressed NFT. */
   metadata: Address<TAccountMetadata>;
+  /** Master edition account created for the decompressed NFT. */
   masterEdition: Address<TAccountMasterEdition>;
+  /** Account that pays for the transaction and any account rent. */
   payer: TransactionSigner<TAccountPayer>;
+  /**
+   * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
+   * can reconstruct the tree.
+   */
   logWrapper?: Address<TAccountLogWrapper>;
+  /**
+   * The SPL/MPL Account Compression program that owns and manages the
+   * Merkle tree.
+   */
   compressionProgram?: Address<TAccountCompressionProgram>;
+  /** The SPL Token program. */
   tokenProgram?: Address<TAccountTokenProgram>;
+  /**
+   * The Token Metadata program, invoked to read or (un)verify the
+   * legacy collection accounts.
+   */
   tokenMetadataProgram?: Address<TAccountTokenMetadataProgram>;
+  /** The Solana System program. */
   systemProgram?: Address<TAccountSystemProgram>;
-}
+};
 
+/**
+ * Compresses an existing decompressed (SPL/Token Metadata) NFT into a
+ * new leaf of a compressed Merkle tree.
+ *
+ * Reads the mint, token account, metadata and master edition of the
+ * decompressed NFT to build the leaf, then appends it to the tree.
+ */
 export async function getCompressInstructionAsync<
   TAccountTreeAuthority extends string,
   TAccountLeafOwner extends string,
@@ -339,7 +374,7 @@ export async function getCompressInstructionAsync<
   >);
 }
 
-export interface CompressInput<
+export type CompressInput<
   TAccountTreeAuthority extends string = string,
   TAccountLeafOwner extends string = string,
   TAccountLeafDelegate extends string = string,
@@ -354,23 +389,62 @@ export interface CompressInput<
   TAccountTokenProgram extends string = string,
   TAccountTokenMetadataProgram extends string = string,
   TAccountSystemProgram extends string = string,
-> {
+> = {
+  /**
+   * The tree's `TreeConfig` PDA, which stores its configuration and acts
+   * as the tree's authority for CPIs into the compression program.
+   */
   treeAuthority: Address<TAccountTreeAuthority>;
+  /** Owner of the compressed NFT leaf being operated on. */
   leafOwner: TransactionSigner<TAccountLeafOwner>;
+  /**
+   * Delegate authority for the leaf; defaults to the leaf owner when no
+   * delegate is set.
+   */
   leafDelegate: Address<TAccountLeafDelegate>;
+  /**
+   * The concurrent Merkle tree account storing the compressed leaves,
+   * owned by the account compression program.
+   */
   merkleTree: Address<TAccountMerkleTree>;
+  /** Token account that will hold the decompressed NFT for `leafOwner`. */
   tokenAccount: Address<TAccountTokenAccount>;
+  /** Mint account of the decompressed NFT, created fresh during decompression. */
   mint: Address<TAccountMint>;
+  /** Metadata account created for the decompressed NFT. */
   metadata: Address<TAccountMetadata>;
+  /** Master edition account created for the decompressed NFT. */
   masterEdition: Address<TAccountMasterEdition>;
+  /** Account that pays for the transaction and any account rent. */
   payer: TransactionSigner<TAccountPayer>;
+  /**
+   * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
+   * can reconstruct the tree.
+   */
   logWrapper?: Address<TAccountLogWrapper>;
+  /**
+   * The SPL/MPL Account Compression program that owns and manages the
+   * Merkle tree.
+   */
   compressionProgram?: Address<TAccountCompressionProgram>;
+  /** The SPL Token program. */
   tokenProgram?: Address<TAccountTokenProgram>;
+  /**
+   * The Token Metadata program, invoked to read or (un)verify the
+   * legacy collection accounts.
+   */
   tokenMetadataProgram?: Address<TAccountTokenMetadataProgram>;
+  /** The Solana System program. */
   systemProgram?: Address<TAccountSystemProgram>;
-}
+};
 
+/**
+ * Compresses an existing decompressed (SPL/Token Metadata) NFT into a
+ * new leaf of a compressed Merkle tree.
+ *
+ * Reads the mint, token account, metadata and master edition of the
+ * decompressed NFT to build the leaf, then appends it to the tree.
+ */
 export function getCompressInstruction<
   TAccountTreeAuthority extends string,
   TAccountLeafOwner extends string,
@@ -514,29 +588,61 @@ export function getCompressInstruction<
   >);
 }
 
-export interface ParsedCompressInstruction<
+export type ParsedCompressInstruction<
   TProgram extends string = typeof BUBBLEGUM_PROGRAM_ADDRESS,
   TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
-> {
+> = {
   programAddress: Address<TProgram>;
   accounts: {
+    /**
+     * The tree's `TreeConfig` PDA, which stores its configuration and acts
+     * as the tree's authority for CPIs into the compression program.
+     */
     treeAuthority: TAccountMetas[0];
+    /** Owner of the compressed NFT leaf being operated on. */
     leafOwner: TAccountMetas[1];
+    /**
+     * Delegate authority for the leaf; defaults to the leaf owner when no
+     * delegate is set.
+     */
     leafDelegate: TAccountMetas[2];
+    /**
+     * The concurrent Merkle tree account storing the compressed leaves,
+     * owned by the account compression program.
+     */
     merkleTree: TAccountMetas[3];
+    /** Token account that will hold the decompressed NFT for `leafOwner`. */
     tokenAccount: TAccountMetas[4];
+    /** Mint account of the decompressed NFT, created fresh during decompression. */
     mint: TAccountMetas[5];
+    /** Metadata account created for the decompressed NFT. */
     metadata: TAccountMetas[6];
+    /** Master edition account created for the decompressed NFT. */
     masterEdition: TAccountMetas[7];
+    /** Account that pays for the transaction and any account rent. */
     payer: TAccountMetas[8];
+    /**
+     * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
+     * can reconstruct the tree.
+     */
     logWrapper: TAccountMetas[9];
+    /**
+     * The SPL/MPL Account Compression program that owns and manages the
+     * Merkle tree.
+     */
     compressionProgram: TAccountMetas[10];
+    /** The SPL Token program. */
     tokenProgram: TAccountMetas[11];
+    /**
+     * The Token Metadata program, invoked to read or (un)verify the
+     * legacy collection accounts.
+     */
     tokenMetadataProgram: TAccountMetas[12];
+    /** The Solana System program. */
     systemProgram: TAccountMetas[13];
   };
   data: CompressInstructionData;
-}
+};
 
 export function parseCompressInstruction<
   TProgram extends string,

package/src/generated/instructions/createTree.ts

@@ -6,26 +6,6 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  AccountMeta,
-  AccountSignerMeta,
-  Address,
-  Codec,
-  Decoder,
-  Encoder,
-  Instruction,
-  InstructionWithAccounts,
-  InstructionWithData,
-  Option,
-  OptionOrNullable,
-  ReadonlyAccount,
-  ReadonlySignerAccount,
-  ReadonlyUint8Array,
-  TransactionSigner,
-  WritableAccount,
-  WritableSignerAccount,
-} from "@solana/kit";
-import type { ResolvedInstructionAccount } from "@solana/program-client-core";
 import {
   combineCodec,
   fixDecoderSize,
@@ -43,10 +23,28 @@ import {
   SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
   SolanaError,
   transformEncoder,
+  type AccountMeta,
+  type AccountSignerMeta,
+  type Address,
+  type Codec,
+  type Decoder,
+  type Encoder,
+  type Instruction,
+  type InstructionWithAccounts,
+  type InstructionWithData,
+  type Option,
+  type OptionOrNullable,
+  type ReadonlyAccount,
+  type ReadonlySignerAccount,
+  type ReadonlyUint8Array,
+  type TransactionSigner,
+  type WritableAccount,
+  type WritableSignerAccount,
 } from "@solana/kit";
 import {
   getAccountMetaFactory,
   getAddressFromResolvedInstructionAccount,
+  type ResolvedInstructionAccount,
 } from "@solana/program-client-core";
 import { findTreeConfigPda } from "../pdas/index.js";
 import { BUBBLEGUM_PROGRAM_ADDRESS } from "../programs/index.js";
@@ -103,18 +101,42 @@ export type CreateTreeInstruction<
     ]
   >;
 
-export interface CreateTreeInstructionData {
+export type CreateTreeInstructionData = {
   discriminator: ReadonlyUint8Array;
+  /**
+   * Maximum depth of the Merkle tree, i.e. log2 of the maximum number of
+   * leaves it can hold. Fixed for the lifetime of the tree.
+   */
   maxDepth: number;
+  /**
+   * Maximum number of concurrent, unconflicting modifications the tree's
+   * changelog buffer can track. Fixed for the lifetime of the tree.
+   */
   maxBufferSize: number;
+  /**
+   * Optional flag; when `true`, any signer may mint into the tree, not
+   * just the tree delegate. Defaults to `false`.
+   */
   public: Option<boolean>;
-}
+};
 
-export interface CreateTreeInstructionDataArgs {
+export type CreateTreeInstructionDataArgs = {
+  /**
+   * Maximum depth of the Merkle tree, i.e. log2 of the maximum number of
+   * leaves it can hold. Fixed for the lifetime of the tree.
+   */
   maxDepth: number;
+  /**
+   * Maximum number of concurrent, unconflicting modifications the tree's
+   * changelog buffer can track. Fixed for the lifetime of the tree.
+   */
   maxBufferSize: number;
+  /**
+   * Optional flag; when `true`, any signer may mint into the tree, not
+   * just the tree delegate. Defaults to `false`.
+   */
   public: OptionOrNullable<boolean>;
-}
+};
 
 export function getCreateTreeInstructionDataEncoder(): Encoder<CreateTreeInstructionDataArgs> {
   return transformEncoder(
@@ -147,7 +169,7 @@ export function getCreateTreeInstructionDataCodec(): Codec<
   );
 }
 
-export interface CreateTreeAsyncInput<
+export type CreateTreeAsyncInput<
   TAccountTreeAuthority extends string = string,
   TAccountMerkleTree extends string = string,
   TAccountPayer extends string = string,
@@ -155,19 +177,49 @@ export interface CreateTreeAsyncInput<
   TAccountLogWrapper extends string = string,
   TAccountCompressionProgram extends string = string,
   TAccountSystemProgram extends string = string,
-> {
+> = {
+  /**
+   * The tree's `TreeConfig` PDA, which stores its configuration and acts
+   * as the tree's authority for CPIs into the compression program.
+   */
   treeAuthority?: Address<TAccountTreeAuthority>;
+  /**
+   * The concurrent Merkle tree account storing the compressed leaves,
+   * owned by the account compression program.
+   */
   merkleTree: Address<TAccountMerkleTree>;
+  /** Account that pays for the transaction and any account rent. */
   payer: TransactionSigner<TAccountPayer>;
+  /**
+   * Creator of the tree, recorded in `TreeConfig` when the tree was
+   * created.
+   */
   treeCreator: TransactionSigner<TAccountTreeCreator>;
+  /**
+   * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
+   * can reconstruct the tree.
+   */
   logWrapper?: Address<TAccountLogWrapper>;
+  /**
+   * The SPL/MPL Account Compression program that owns and manages the
+   * Merkle tree.
+   */
   compressionProgram?: Address<TAccountCompressionProgram>;
+  /** The Solana System program. */
   systemProgram?: Address<TAccountSystemProgram>;
   maxDepth: CreateTreeInstructionDataArgs["maxDepth"];
   maxBufferSize: CreateTreeInstructionDataArgs["maxBufferSize"];
   public: CreateTreeInstructionDataArgs["public"];
-}
+};
 
+/**
+ * Creates a new empty Merkle tree for storing compressed (V1) NFTs.
+ *
+ * Initializes both the underlying concurrent Merkle tree account and its
+ * `TreeConfig` PDA. `maxDepth` and `maxBufferSize` are fixed for the life
+ * of the tree and bound its maximum leaf capacity and the number of
+ * concurrent modifications it can support.
+ */
 export async function getCreateTreeInstructionAsync<
   TAccountTreeAuthority extends string,
   TAccountMerkleTree extends string,
@@ -273,7 +325,7 @@ export async function getCreateTreeInstructionAsync<
   >);
 }
 
-export interface CreateTreeInput<
+export type CreateTreeInput<
   TAccountTreeAuthority extends string = string,
   TAccountMerkleTree extends string = string,
   TAccountPayer extends string = string,
@@ -281,19 +333,49 @@ export interface CreateTreeInput<
   TAccountLogWrapper extends string = string,
   TAccountCompressionProgram extends string = string,
   TAccountSystemProgram extends string = string,
-> {
+> = {
+  /**
+   * The tree's `TreeConfig` PDA, which stores its configuration and acts
+   * as the tree's authority for CPIs into the compression program.
+   */
   treeAuthority: Address<TAccountTreeAuthority>;
+  /**
+   * The concurrent Merkle tree account storing the compressed leaves,
+   * owned by the account compression program.
+   */
   merkleTree: Address<TAccountMerkleTree>;
+  /** Account that pays for the transaction and any account rent. */
   payer: TransactionSigner<TAccountPayer>;
+  /**
+   * Creator of the tree, recorded in `TreeConfig` when the tree was
+   * created.
+   */
   treeCreator: TransactionSigner<TAccountTreeCreator>;
+  /**
+   * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
+   * can reconstruct the tree.
+   */
   logWrapper?: Address<TAccountLogWrapper>;
+  /**
+   * The SPL/MPL Account Compression program that owns and manages the
+   * Merkle tree.
+   */
   compressionProgram?: Address<TAccountCompressionProgram>;
+  /** The Solana System program. */
   systemProgram?: Address<TAccountSystemProgram>;
   maxDepth: CreateTreeInstructionDataArgs["maxDepth"];
   maxBufferSize: CreateTreeInstructionDataArgs["maxBufferSize"];
   public: CreateTreeInstructionDataArgs["public"];
-}
+};
 
+/**
+ * Creates a new empty Merkle tree for storing compressed (V1) NFTs.
+ *
+ * Initializes both the underlying concurrent Merkle tree account and its
+ * `TreeConfig` PDA. `maxDepth` and `maxBufferSize` are fixed for the life
+ * of the tree and bound its maximum leaf capacity and the number of
+ * concurrent modifications it can support.
+ */
 export function getCreateTreeInstruction<
   TAccountTreeAuthority extends string,
   TAccountMerkleTree extends string,
@@ -389,22 +471,44 @@ export function getCreateTreeInstruction<
   >);
 }
 
-export interface ParsedCreateTreeInstruction<
+export type ParsedCreateTreeInstruction<
   TProgram extends string = typeof BUBBLEGUM_PROGRAM_ADDRESS,
   TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
-> {
+> = {
   programAddress: Address<TProgram>;
   accounts: {
+    /**
+     * The tree's `TreeConfig` PDA, which stores its configuration and acts
+     * as the tree's authority for CPIs into the compression program.
+     */
     treeAuthority: TAccountMetas[0];
+    /**
+     * The concurrent Merkle tree account storing the compressed leaves,
+     * owned by the account compression program.
+     */
     merkleTree: TAccountMetas[1];
+    /** Account that pays for the transaction and any account rent. */
     payer: TAccountMetas[2];
+    /**
+     * Creator of the tree, recorded in `TreeConfig` when the tree was
+     * created.
+     */
     treeCreator: TAccountMetas[3];
+    /**
+     * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
+     * can reconstruct the tree.
+     */
     logWrapper: TAccountMetas[4];
+    /**
+     * The SPL/MPL Account Compression program that owns and manages the
+     * Merkle tree.
+     */
     compressionProgram: TAccountMetas[5];
+    /** The Solana System program. */
     systemProgram: TAccountMetas[6];
   };
   data: CreateTreeInstructionData;
-}
+};
 
 export function parseCreateTreeInstruction<
   TProgram extends string,