@macalinao/clients-mpl-bubblegum 0.3.0 → 0.3.2

package/src/generated/instructions/setDecompressibleState.ts

@@ -6,26 +6,6 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  AccountMeta,
-  AccountSignerMeta,
-  Address,
-  FixedSizeCodec,
-  FixedSizeDecoder,
-  FixedSizeEncoder,
-  Instruction,
-  InstructionWithAccounts,
-  InstructionWithData,
-  ReadonlySignerAccount,
-  ReadonlyUint8Array,
-  TransactionSigner,
-  WritableAccount,
-} from "@solana/kit";
-import type { ResolvedInstructionAccount } from "@solana/program-client-core";
-import type {
-  DecompressibleState,
-  DecompressibleStateArgs,
-} from "../types/index.js";
 import {
   combineCodec,
   fixDecoderSize,
@@ -37,12 +17,30 @@ 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 ReadonlySignerAccount,
+  type ReadonlyUint8Array,
+  type TransactionSigner,
+  type WritableAccount,
 } from "@solana/kit";
-import { getAccountMetaFactory } from "@solana/program-client-core";
+import {
+  getAccountMetaFactory,
+  type ResolvedInstructionAccount,
+} from "@solana/program-client-core";
 import { BUBBLEGUM_PROGRAM_ADDRESS } from "../programs/index.js";
 import {
   getDecompressibleStateDecoder,
   getDecompressibleStateEncoder,
+  type DecompressibleState,
+  type DecompressibleStateArgs,
 } from "../types/index.js";
 
 export const SET_DECOMPRESSIBLE_STATE_DISCRIMINATOR: ReadonlyUint8Array =
@@ -74,14 +72,22 @@ export type SetDecompressibleStateInstruction<
     ]
   >;
 
-export interface SetDecompressibleStateInstructionData {
+export type SetDecompressibleStateInstructionData = {
   discriminator: ReadonlyUint8Array;
+  /**
+   * The new decompressible state to set on the tree: `Enabled` allows
+   * `redeem`/`decompressV1`, `Disabled` blocks them.
+   */
   decompressableState: DecompressibleState;
-}
+};
 
-export interface SetDecompressibleStateInstructionDataArgs {
+export type SetDecompressibleStateInstructionDataArgs = {
+  /**
+   * The new decompressible state to set on the tree: `Enabled` allows
+   * `redeem`/`decompressV1`, `Disabled` blocks them.
+   */
   decompressableState: DecompressibleStateArgs;
-}
+};
 
 export function getSetDecompressibleStateInstructionDataEncoder(): FixedSizeEncoder<SetDecompressibleStateInstructionDataArgs> {
   return transformEncoder(
@@ -113,15 +119,30 @@ export function getSetDecompressibleStateInstructionDataCodec(): FixedSizeCodec<
   );
 }
 
-export interface SetDecompressibleStateInput<
+export type SetDecompressibleStateInput<
   TAccountTreeAuthority extends string = string,
   TAccountTreeCreator 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>;
+  /**
+   * Creator of the tree, recorded in `TreeConfig` when the tree was
+   * created.
+   */
   treeCreator: TransactionSigner<TAccountTreeCreator>;
   decompressableState: SetDecompressibleStateInstructionDataArgs["decompressableState"];
-}
+};
 
+/**
+ * Sets the `decompressible_state` of a tree.
+ *
+ * Controls whether leaves in the tree may be `redeem`ed and
+ * `decompressV1`'d into regular NFTs. Only the tree creator may call
+ * this instruction.
+ */
 export function getSetDecompressibleStateInstruction<
   TAccountTreeAuthority extends string,
   TAccountTreeCreator extends string,
@@ -170,17 +191,25 @@ export function getSetDecompressibleStateInstruction<
   >);
 }
 
-export interface ParsedSetDecompressibleStateInstruction<
+export type ParsedSetDecompressibleStateInstruction<
   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];
+    /**
+     * Creator of the tree, recorded in `TreeConfig` when the tree was
+     * created.
+     */
     treeCreator: TAccountMetas[1];
   };
   data: SetDecompressibleStateInstructionData;
-}
+};
 
 export function parseSetDecompressibleStateInstruction<
   TProgram extends string,

package/src/generated/instructions/setNonTransferableV2.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,
@@ -38,19 +18,37 @@ import {
   getOptionEncoder,
   getStructDecoder,
   getStructEncoder,
-  getU8Decoder,
-  getU8Encoder,
   getU32Decoder,
   getU32Encoder,
   getU64Decoder,
   getU64Encoder,
+  getU8Decoder,
+  getU8Encoder,
   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";
@@ -73,15 +71,12 @@ export type SetNonTransferableV2Instruction<
   TAccountLeafDelegate extends string | AccountMeta<string> = string,
   TAccountMerkleTree extends string | AccountMeta<string> = string,
   TAccountCoreCollection extends string | AccountMeta<string> = string,
-  TAccountLogWrapper extends
-    | string
-    | AccountMeta<string> = "mnoopTCrg4p8ry25e4bcWA9XZjbNjMTfgYVGGEdRsf3",
-  TAccountCompressionProgram extends
-    | string
-    | AccountMeta<string> = "mcmt6YrQEMKw8Mw43FmpRLmf7BqRnFMKmAcbxE3xkAW",
-  TAccountSystemProgram extends
-    | string
-    | AccountMeta<string> = "11111111111111111111111111111111",
+  TAccountLogWrapper extends string | AccountMeta<string> =
+    "mnoopTCrg4p8ry25e4bcWA9XZjbNjMTfgYVGGEdRsf3",
+  TAccountCompressionProgram extends string | AccountMeta<string> =
+    "mcmt6YrQEMKw8Mw43FmpRLmf7BqRnFMKmAcbxE3xkAW",
+  TAccountSystemProgram extends string | AccountMeta<string> =
+    "11111111111111111111111111111111",
   TRemainingAccounts extends readonly AccountMeta<string>[] = [],
 > = Instruction<TProgram> &
   InstructionWithData<ReadonlyUint8Array> &
@@ -123,26 +118,84 @@ export type SetNonTransferableV2Instruction<
     ]
   >;
 
-export interface SetNonTransferableV2InstructionData {
+export type SetNonTransferableV2InstructionData = {
   discriminator: ReadonlyUint8Array;
-  root: number[];
-  dataHash: number[];
-  creatorHash: number[];
-  assetDataHash: Option<number[]>;
+  /**
+   * Current Merkle root of the tree, used together with the Merkle proof
+   * (passed as remaining accounts) to verify the leaf being operated on.
+   */
+  root: Array<number>;
+  /**
+   * Keccak256 hash of the leaf's metadata, used together with `root` to
+   * verify the leaf before it is modified.
+   */
+  dataHash: Array<number>;
+  /**
+   * Keccak256 hash of the leaf's creators array, used together with
+   * `root` to verify the leaf before it is modified.
+   */
+  creatorHash: Array<number>;
+  /**
+   * Expected current `assetDataHash` of the `LeafSchema` V2 leaf, if any,
+   * carried through unchanged by this instruction.
+   */
+  assetDataHash: Option<Array<number>>;
+  /**
+   * Expected current status flags (e.g. frozen, non-transferable) of the
+   * `LeafSchema` V2 leaf, verified before this instruction updates them.
+   */
   flags: Option<number>;
+  /**
+   * Tree-scoped nonce identifying the leaf, equal to the tree's
+   * `numMinted` at the time the leaf was minted. Combined with the tree
+   * address to derive the leaf's asset id.
+   */
   nonce: bigint;
+  /**
+   * Position of the leaf within the Merkle tree, used with the Merkle
+   * proof to locate and verify the leaf.
+   */
   index: number;
-}
+};
 
-export interface SetNonTransferableV2InstructionDataArgs {
-  root: number[];
-  dataHash: number[];
-  creatorHash: number[];
-  assetDataHash: OptionOrNullable<number[]>;
+export type SetNonTransferableV2InstructionDataArgs = {
+  /**
+   * Current Merkle root of the tree, used together with the Merkle proof
+   * (passed as remaining accounts) to verify the leaf being operated on.
+   */
+  root: Array<number>;
+  /**
+   * Keccak256 hash of the leaf's metadata, used together with `root` to
+   * verify the leaf before it is modified.
+   */
+  dataHash: Array<number>;
+  /**
+   * Keccak256 hash of the leaf's creators array, used together with
+   * `root` to verify the leaf before it is modified.
+   */
+  creatorHash: Array<number>;
+  /**
+   * Expected current `assetDataHash` of the `LeafSchema` V2 leaf, if any,
+   * carried through unchanged by this instruction.
+   */
+  assetDataHash: OptionOrNullable<Array<number>>;
+  /**
+   * Expected current status flags (e.g. frozen, non-transferable) of the
+   * `LeafSchema` V2 leaf, verified before this instruction updates them.
+   */
   flags: OptionOrNullable<number>;
+  /**
+   * Tree-scoped nonce identifying the leaf, equal to the tree's
+   * `numMinted` at the time the leaf was minted. Combined with the tree
+   * address to derive the leaf's asset id.
+   */
   nonce: number | bigint;
+  /**
+   * Position of the leaf within the Merkle tree, used with the Merkle
+   * proof to locate and verify the leaf.
+   */
   index: number;
-}
+};
 
 export function getSetNonTransferableV2InstructionDataEncoder(): Encoder<SetNonTransferableV2InstructionDataArgs> {
   return transformEncoder(
@@ -192,7 +245,7 @@ export function getSetNonTransferableV2InstructionDataCodec(): Codec<
   );
 }
 
-export interface SetNonTransferableV2AsyncInput<
+export type SetNonTransferableV2AsyncInput<
   TAccountTreeAuthority extends string = string,
   TAccountPayer extends string = string,
   TAccountAuthority extends string = string,
@@ -203,21 +256,41 @@ export interface SetNonTransferableV2AsyncInput<
   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>;
+  /** Account that pays for the transaction and any account rent. */
   payer: TransactionSigner<TAccountPayer>;
   /**
-   * This authority must be a permanent freeze delegate on the collection
-   * Defaults to `payer`
+   * Must be a permanent freeze delegate on the collection. Defaults to
+   * `payer`.
    */
   authority?: TransactionSigner<TAccountAuthority>;
+  /** Owner of the compressed NFT leaf being operated on. */
   leafOwner: Address<TAccountLeafOwner>;
-  /** Defaults to `leaf_owner` */
+  /** Defaults to `leafOwner`. */
   leafDelegate?: Address<TAccountLeafDelegate>;
+  /**
+   * The concurrent Merkle tree account storing the compressed leaves,
+   * owned by the account compression program.
+   */
   merkleTree: Address<TAccountMerkleTree>;
+  /** MPL Core collection account the asset belongs to (V2 collections). */
   coreCollection: Address<TAccountCoreCollection>;
+  /**
+   * 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>;
   root: SetNonTransferableV2InstructionDataArgs["root"];
   dataHash: SetNonTransferableV2InstructionDataArgs["dataHash"];
@@ -226,8 +299,16 @@ export interface SetNonTransferableV2AsyncInput<
   flags: SetNonTransferableV2InstructionDataArgs["flags"];
   nonce: SetNonTransferableV2InstructionDataArgs["nonce"];
   index: SetNonTransferableV2InstructionDataArgs["index"];
-}
+};
 
+/**
+ * Permanently sets the non-transferable flag on a `LeafSchema` V2 leaf
+ * node, making it soulbound.
+ *
+ * Unlike freezing, a non-transferable asset can still be burned by its
+ * owner; it just can no longer change owners. This flag cannot be
+ * unset once applied.
+ */
 export async function getSetNonTransferableV2InstructionAsync<
   TAccountTreeAuthority extends string,
   TAccountPayer extends string,
@@ -351,7 +432,7 @@ export async function getSetNonTransferableV2InstructionAsync<
   >);
 }
 
-export interface SetNonTransferableV2Input<
+export type SetNonTransferableV2Input<
   TAccountTreeAuthority extends string = string,
   TAccountPayer extends string = string,
   TAccountAuthority extends string = string,
@@ -362,21 +443,41 @@ export interface SetNonTransferableV2Input<
   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>;
+  /** Account that pays for the transaction and any account rent. */
   payer: TransactionSigner<TAccountPayer>;
   /**
-   * This authority must be a permanent freeze delegate on the collection
-   * Defaults to `payer`
+   * Must be a permanent freeze delegate on the collection. Defaults to
+   * `payer`.
    */
   authority?: TransactionSigner<TAccountAuthority>;
+  /** Owner of the compressed NFT leaf being operated on. */
   leafOwner: Address<TAccountLeafOwner>;
-  /** Defaults to `leaf_owner` */
+  /** Defaults to `leafOwner`. */
   leafDelegate?: Address<TAccountLeafDelegate>;
+  /**
+   * The concurrent Merkle tree account storing the compressed leaves,
+   * owned by the account compression program.
+   */
   merkleTree: Address<TAccountMerkleTree>;
+  /** MPL Core collection account the asset belongs to (V2 collections). */
   coreCollection: Address<TAccountCoreCollection>;
+  /**
+   * 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>;
   root: SetNonTransferableV2InstructionDataArgs["root"];
   dataHash: SetNonTransferableV2InstructionDataArgs["dataHash"];
@@ -385,8 +486,16 @@ export interface SetNonTransferableV2Input<
   flags: SetNonTransferableV2InstructionDataArgs["flags"];
   nonce: SetNonTransferableV2InstructionDataArgs["nonce"];
   index: SetNonTransferableV2InstructionDataArgs["index"];
-}
+};
 
+/**
+ * Permanently sets the non-transferable flag on a `LeafSchema` V2 leaf
+ * node, making it soulbound.
+ *
+ * Unlike freezing, a non-transferable asset can still be burned by its
+ * owner; it just can no longer change owners. This flag cannot be
+ * unset once applied.
+ */
 export function getSetNonTransferableV2Instruction<
   TAccountTreeAuthority extends string,
   TAccountPayer extends string,
@@ -500,30 +609,50 @@ export function getSetNonTransferableV2Instruction<
   >);
 }
 
-export interface ParsedSetNonTransferableV2Instruction<
+export type ParsedSetNonTransferableV2Instruction<
   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];
+    /** Account that pays for the transaction and any account rent. */
     payer: TAccountMetas[1];
     /**
-     * This authority must be a permanent freeze delegate on the collection
-     * Defaults to `payer`
+     * Must be a permanent freeze delegate on the collection. Defaults to
+     * `payer`.
      */
     authority?: TAccountMetas[2] | undefined;
+    /** Owner of the compressed NFT leaf being operated on. */
     leafOwner: TAccountMetas[3];
-    /** Defaults to `leaf_owner` */
+    /** Defaults to `leafOwner`. */
     leafDelegate?: TAccountMetas[4] | undefined;
+    /**
+     * The concurrent Merkle tree account storing the compressed leaves,
+     * owned by the account compression program.
+     */
     merkleTree: TAccountMetas[5];
+    /** MPL Core collection account the asset belongs to (V2 collections). */
     coreCollection: TAccountMetas[6];
+    /**
+     * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
+     * can reconstruct the tree.
+     */
     logWrapper: TAccountMetas[7];
+    /**
+     * The SPL/MPL Account Compression program that owns and manages the
+     * Merkle tree.
+     */
     compressionProgram: TAccountMetas[8];
+    /** The Solana System program. */
     systemProgram: TAccountMetas[9];
   };
   data: SetNonTransferableV2InstructionData;
-}
+};
 
 export function parseSetNonTransferableV2Instruction<
   TProgram extends string,