@macalinao/clients-mpl-bubblegum 0.3.0 → 0.3.2

package/src/generated/types/leafSchema.ts

@@ -6,14 +6,6 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  Address,
-  Codec,
-  Decoder,
-  Encoder,
-  GetDiscriminatedUnionVariant,
-  GetDiscriminatedUnionVariantContent,
-} from "@solana/kit";
 import {
   combineCodec,
   getAddressDecoder,
@@ -24,55 +16,100 @@ import {
   getDiscriminatedUnionEncoder,
   getStructDecoder,
   getStructEncoder,
-  getU8Decoder,
-  getU8Encoder,
   getU64Decoder,
   getU64Encoder,
+  getU8Decoder,
+  getU8Encoder,
+  type Address,
+  type Codec,
+  type Decoder,
+  type Encoder,
+  type GetDiscriminatedUnionVariant,
+  type GetDiscriminatedUnionVariantContent,
 } from "@solana/kit";
 
+/**
+ * The canonical on-chain representation of a compressed NFT leaf,
+ * hashed to produce the value stored at a tree's leaf node.
+ *
+ * `V1` is produced by `mintV1`/`mintToCollectionV1` and the legacy
+ * instruction family; `V2` is produced by `mintV2` and adds
+ * `collectionHash`, `assetDataHash` and `flags` to support MPL Core
+ * collections and freezing/non-transferable assets.
+ */
 export type LeafSchema =
   | {
       __kind: "V1";
+      /** Asset id of the leaf, derived from the tree address and `nonce`. */
       id: Address;
+      /** Current owner of the leaf. */
       owner: Address;
+      /** Current delegate of the leaf (equal to `owner` when unset). */
       delegate: Address;
+      /** Tree-scoped nonce assigned to the leaf when it was minted; part of the asset id derivation. */
       nonce: bigint;
-      dataHash: number[];
-      creatorHash: number[];
+      /** Keccak256 hash of the leaf's metadata (`MetadataArgs`/`MetadataArgsV2`). */
+      dataHash: Array<number>;
+      /** Keccak256 hash of the leaf's creators array. */
+      creatorHash: Array<number>;
     }
   | {
       __kind: "V2";
+      /** Asset id of the leaf, derived from the tree address and `nonce`. */
       id: Address;
+      /** Current owner of the leaf. */
       owner: Address;
+      /** Current delegate of the leaf (equal to `owner` when unset). */
       delegate: Address;
+      /** Tree-scoped nonce assigned to the leaf when it was minted; part of the asset id derivation. */
       nonce: bigint;
-      dataHash: number[];
-      creatorHash: number[];
-      collectionHash: number[];
-      assetDataHash: number[];
+      /** Keccak256 hash of the leaf's metadata (`MetadataArgs`/`MetadataArgsV2`). */
+      dataHash: Array<number>;
+      /** Keccak256 hash of the leaf's creators array. */
+      creatorHash: Array<number>;
+      /** Hash of the leaf's MPL Core collection reference, if any (V2 only). */
+      collectionHash: Array<number>;
+      /** Hash of the leaf's optional off-chain asset data, if any (V2 only). */
+      assetDataHash: Array<number>;
+      /** Packed status bits for the leaf, e.g. frozen and non-transferable (V2 only). */
       flags: number;
     };
 
 export type LeafSchemaArgs =
   | {
       __kind: "V1";
+      /** Asset id of the leaf, derived from the tree address and `nonce`. */
       id: Address;
+      /** Current owner of the leaf. */
       owner: Address;
+      /** Current delegate of the leaf (equal to `owner` when unset). */
       delegate: Address;
+      /** Tree-scoped nonce assigned to the leaf when it was minted; part of the asset id derivation. */
       nonce: number | bigint;
-      dataHash: number[];
-      creatorHash: number[];
+      /** Keccak256 hash of the leaf's metadata (`MetadataArgs`/`MetadataArgsV2`). */
+      dataHash: Array<number>;
+      /** Keccak256 hash of the leaf's creators array. */
+      creatorHash: Array<number>;
     }
   | {
       __kind: "V2";
+      /** Asset id of the leaf, derived from the tree address and `nonce`. */
       id: Address;
+      /** Current owner of the leaf. */
       owner: Address;
+      /** Current delegate of the leaf (equal to `owner` when unset). */
       delegate: Address;
+      /** Tree-scoped nonce assigned to the leaf when it was minted; part of the asset id derivation. */
       nonce: number | bigint;
-      dataHash: number[];
-      creatorHash: number[];
-      collectionHash: number[];
-      assetDataHash: number[];
+      /** Keccak256 hash of the leaf's metadata (`MetadataArgs`/`MetadataArgsV2`). */
+      dataHash: Array<number>;
+      /** Keccak256 hash of the leaf's creators array. */
+      creatorHash: Array<number>;
+      /** Hash of the leaf's MPL Core collection reference, if any (V2 only). */
+      collectionHash: Array<number>;
+      /** Hash of the leaf's optional off-chain asset data, if any (V2 only). */
+      assetDataHash: Array<number>;
+      /** Packed status bits for the leaf, e.g. frozen and non-transferable (V2 only). */
       flags: number;
     };
 

package/src/generated/types/metadataArgs.ts

@@ -6,25 +6,6 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  Codec,
-  Decoder,
-  Encoder,
-  Option,
-  OptionOrNullable,
-} from "@solana/kit";
-import type {
-  Collection,
-  CollectionArgs,
-  Creator,
-  CreatorArgs,
-  TokenProgramVersion,
-  TokenProgramVersionArgs,
-  TokenStandard,
-  TokenStandardArgs,
-  Uses,
-  UsesArgs,
-} from "./index.js";
 import {
   addDecoderSizePrefix,
   addEncoderSizePrefix,
@@ -37,14 +18,19 @@ import {
   getOptionEncoder,
   getStructDecoder,
   getStructEncoder,
-  getU8Decoder,
-  getU8Encoder,
   getU16Decoder,
   getU16Encoder,
   getU32Decoder,
   getU32Encoder,
+  getU8Decoder,
+  getU8Encoder,
   getUtf8Decoder,
   getUtf8Encoder,
+  type Codec,
+  type Decoder,
+  type Encoder,
+  type Option,
+  type OptionOrNullable,
 } from "@solana/kit";
 import {
   getCollectionDecoder,
@@ -57,9 +43,27 @@ import {
   getTokenStandardEncoder,
   getUsesDecoder,
   getUsesEncoder,
+  type Collection,
+  type CollectionArgs,
+  type Creator,
+  type CreatorArgs,
+  type TokenProgramVersion,
+  type TokenProgramVersionArgs,
+  type TokenStandard,
+  type TokenStandardArgs,
+  type Uses,
+  type UsesArgs,
 } from "./index.js";
 
-export interface MetadataArgs {
+/**
+ * Metadata for a V1 (`LeafSchema` V1) compressed NFT leaf.
+ *
+ * Mirrors the fields of a Token Metadata `Metadata` account closely
+ * enough that a leaf can be decompressed into one. Hashed (along with
+ * `creators`) to produce the `dataHash`/`creatorHash` used to verify
+ * the leaf on every mutating instruction.
+ */
+export type MetadataArgs = {
   /** The name of the asset */
   name: string;
   /** The symbol for the asset */
@@ -80,11 +84,13 @@ export interface MetadataArgs {
   collection: Option<Collection>;
   /** Uses */
   uses: Option<Uses>;
+  /** Which SPL token program a decompressed version of this leaf's mint should use. */
   tokenProgramVersion: TokenProgramVersion;
-  creators: Creator[];
-}
+  /** Creators of the asset and their royalty shares; hashed to produce `creatorHash`. */
+  creators: Array<Creator>;
+};
 
-export interface MetadataArgsArgs {
+export type MetadataArgsArgs = {
   /** The name of the asset */
   name: string;
   /** The symbol for the asset */
@@ -105,9 +111,11 @@ export interface MetadataArgsArgs {
   collection: OptionOrNullable<CollectionArgs>;
   /** Uses */
   uses: OptionOrNullable<UsesArgs>;
+  /** Which SPL token program a decompressed version of this leaf's mint should use. */
   tokenProgramVersion: TokenProgramVersionArgs;
-  creators: CreatorArgs[];
-}
+  /** Creators of the asset and their royalty shares; hashed to produce `creatorHash`. */
+  creators: Array<CreatorArgs>;
+};
 
 export function getMetadataArgsEncoder(): Encoder<MetadataArgsArgs> {
   return getStructEncoder([

package/src/generated/types/metadataArgsV2.ts

@@ -6,20 +6,6 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  Address,
-  Codec,
-  Decoder,
-  Encoder,
-  Option,
-  OptionOrNullable,
-} from "@solana/kit";
-import type {
-  Creator,
-  CreatorArgs,
-  TokenStandard,
-  TokenStandardArgs,
-} from "./index.js";
 import {
   addDecoderSizePrefix,
   addEncoderSizePrefix,
@@ -40,15 +26,32 @@ import {
   getU32Encoder,
   getUtf8Decoder,
   getUtf8Encoder,
+  type Address,
+  type Codec,
+  type Decoder,
+  type Encoder,
+  type Option,
+  type OptionOrNullable,
 } from "@solana/kit";
 import {
   getCreatorDecoder,
   getCreatorEncoder,
   getTokenStandardDecoder,
   getTokenStandardEncoder,
+  type Creator,
+  type CreatorArgs,
+  type TokenStandard,
+  type TokenStandardArgs,
 } from "./index.js";
 
-export interface MetadataArgsV2 {
+/**
+ * Metadata for a `LeafSchema` V2 compressed NFT leaf.
+ *
+ * Streamlined relative to `MetadataArgs`: it drops `editionNonce` and
+ * `uses`, and its `collection` is a plain, always-verified `Pubkey`
+ * rather than a `Collection` struct with a separate verified flag.
+ */
+export type MetadataArgsV2 = {
   /** The name of the asset */
   name: string;
   /** The symbol for the asset */
@@ -64,12 +67,12 @@ export interface MetadataArgsV2 {
   /** Token standard.  Currently only `NonFungible` is allowed. */
   tokenStandard: Option<TokenStandard>;
   /** Creator array */
-  creators: Creator[];
+  creators: Array<Creator>;
   /** Collection.  Note in V2 its just a `Pubkey` and is always considered verified. */
   collection: Option<Address>;
-}
+};
 
-export interface MetadataArgsV2Args {
+export type MetadataArgsV2Args = {
   /** The name of the asset */
   name: string;
   /** The symbol for the asset */
@@ -85,10 +88,10 @@ export interface MetadataArgsV2Args {
   /** Token standard.  Currently only `NonFungible` is allowed. */
   tokenStandard: OptionOrNullable<TokenStandardArgs>;
   /** Creator array */
-  creators: CreatorArgs[];
+  creators: Array<CreatorArgs>;
   /** Collection.  Note in V2 its just a `Pubkey` and is always considered verified. */
   collection: OptionOrNullable<Address>;
-}
+};
 
 export function getMetadataArgsV2Encoder(): Encoder<MetadataArgsV2Args> {
   return getStructEncoder([

package/src/generated/types/tokenProgramVersion.ts

@@ -6,16 +6,19 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  FixedSizeCodec,
-  FixedSizeDecoder,
-  FixedSizeEncoder,
+import {
+  combineCodec,
+  getEnumDecoder,
+  getEnumEncoder,
+  type FixedSizeCodec,
+  type FixedSizeDecoder,
+  type FixedSizeEncoder,
 } from "@solana/kit";
-import { combineCodec, getEnumDecoder, getEnumEncoder } from "@solana/kit";
 
+/** Which SPL token program a decompressed leaf's mint should use. */
 export enum TokenProgramVersion {
-  Original = 0,
-  Token2022 = 1,
+  Original,
+  Token2022,
 }
 
 export type TokenProgramVersionArgs = TokenProgramVersion;

package/src/generated/types/tokenStandard.ts

@@ -6,18 +6,25 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  FixedSizeCodec,
-  FixedSizeDecoder,
-  FixedSizeEncoder,
+import {
+  combineCodec,
+  getEnumDecoder,
+  getEnumEncoder,
+  type FixedSizeCodec,
+  type FixedSizeDecoder,
+  type FixedSizeEncoder,
 } from "@solana/kit";
-import { combineCodec, getEnumDecoder, getEnumEncoder } from "@solana/kit";
 
+/**
+ * Token Metadata token standard recorded on a leaf. Bubblegum
+ * currently only mints `NonFungible` assets; the other variants exist
+ * for compatibility with the wider Token Metadata type.
+ */
 export enum TokenStandard {
-  NonFungible = 0,
-  FungibleAsset = 1,
-  Fungible = 2,
-  NonFungibleEdition = 3,
+  NonFungible,
+  FungibleAsset,
+  Fungible,
+  NonFungibleEdition,
 }
 
 export type TokenStandardArgs = TokenStandard;

package/src/generated/types/updateArgs.ts

@@ -6,14 +6,6 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  Codec,
-  Decoder,
-  Encoder,
-  Option,
-  OptionOrNullable,
-} from "@solana/kit";
-import type { Creator, CreatorArgs } from "./index.js";
 import {
   addDecoderSizePrefix,
   addEncoderSizePrefix,
@@ -32,28 +24,57 @@ import {
   getU32Encoder,
   getUtf8Decoder,
   getUtf8Encoder,
+  type Codec,
+  type Decoder,
+  type Encoder,
+  type Option,
+  type OptionOrNullable,
 } from "@solana/kit";
-import { getCreatorDecoder, getCreatorEncoder } from "./index.js";
+import {
+  getCreatorDecoder,
+  getCreatorEncoder,
+  type Creator,
+  type CreatorArgs,
+} from "./index.js";
 
-export interface UpdateArgs {
+/**
+ * Metadata fields to change on a leaf via `updateMetadata` /
+ * `updateMetadataV2`. Every field is optional; omitted fields keep
+ * their current value.
+ */
+export type UpdateArgs = {
+  /** New name for the asset, or unset to keep the current name. */
   name: Option<string>;
+  /** New symbol for the asset, or unset to keep the current symbol. */
   symbol: Option<string>;
+  /** New metadata URI for the asset, or unset to keep the current URI. */
   uri: Option<string>;
-  creators: Option<Creator[]>;
+  /** New creators array for the asset, or unset to keep the current creators. */
+  creators: Option<Array<Creator>>;
+  /** New royalty basis points, or unset to keep the current value. */
   sellerFeeBasisPoints: Option<number>;
+  /** New primary sale flag, or unset to keep the current value. */
   primarySaleHappened: Option<boolean>;
+  /** New mutability flag, or unset to keep the current value. */
   isMutable: Option<boolean>;
-}
+};
 
-export interface UpdateArgsArgs {
+export type UpdateArgsArgs = {
+  /** New name for the asset, or unset to keep the current name. */
   name: OptionOrNullable<string>;
+  /** New symbol for the asset, or unset to keep the current symbol. */
   symbol: OptionOrNullable<string>;
+  /** New metadata URI for the asset, or unset to keep the current URI. */
   uri: OptionOrNullable<string>;
-  creators: OptionOrNullable<CreatorArgs[]>;
+  /** New creators array for the asset, or unset to keep the current creators. */
+  creators: OptionOrNullable<Array<CreatorArgs>>;
+  /** New royalty basis points, or unset to keep the current value. */
   sellerFeeBasisPoints: OptionOrNullable<number>;
+  /** New primary sale flag, or unset to keep the current value. */
   primarySaleHappened: OptionOrNullable<boolean>;
+  /** New mutability flag, or unset to keep the current value. */
   isMutable: OptionOrNullable<boolean>;
-}
+};
 
 export function getUpdateArgsEncoder(): Encoder<UpdateArgsArgs> {
   return getStructEncoder([

package/src/generated/types/useMethod.ts

@@ -6,17 +6,20 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  FixedSizeCodec,
-  FixedSizeDecoder,
-  FixedSizeEncoder,
+import {
+  combineCodec,
+  getEnumDecoder,
+  getEnumEncoder,
+  type FixedSizeCodec,
+  type FixedSizeDecoder,
+  type FixedSizeEncoder,
 } from "@solana/kit";
-import { combineCodec, getEnumDecoder, getEnumEncoder } from "@solana/kit";
 
+/** How the remaining uses of an asset are consumed. */
 export enum UseMethod {
-  Burn = 0,
-  Multiple = 1,
-  Single = 2,
+  Burn,
+  Multiple,
+  Single,
 }
 
 export type UseMethodArgs = UseMethod;

package/src/generated/types/uses.ts

@@ -6,32 +6,45 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  FixedSizeCodec,
-  FixedSizeDecoder,
-  FixedSizeEncoder,
-} from "@solana/kit";
-import type { UseMethod, UseMethodArgs } from "./index.js";
 import {
   combineCodec,
   getStructDecoder,
   getStructEncoder,
   getU64Decoder,
   getU64Encoder,
+  type FixedSizeCodec,
+  type FixedSizeDecoder,
+  type FixedSizeEncoder,
 } from "@solana/kit";
-import { getUseMethodDecoder, getUseMethodEncoder } from "./index.js";
+import {
+  getUseMethodDecoder,
+  getUseMethodEncoder,
+  type UseMethod,
+  type UseMethodArgs,
+} from "./index.js";
 
-export interface Uses {
+/**
+ * Consumable-use configuration for an asset (e.g. tickets or
+ * redeemable passes), tracking how it may be used and how many uses
+ * remain.
+ */
+export type Uses = {
+  /** How the remaining uses are consumed. */
   useMethod: UseMethod;
+  /** Number of uses left. */
   remaining: bigint;
+  /** Total number of uses the asset was minted with. */
   total: bigint;
-}
+};
 
-export interface UsesArgs {
+export type UsesArgs = {
+  /** How the remaining uses are consumed. */
   useMethod: UseMethodArgs;
+  /** Number of uses left. */
   remaining: number | bigint;
+  /** Total number of uses the asset was minted with. */
   total: number | bigint;
-}
+};
 
 export function getUsesEncoder(): FixedSizeEncoder<UsesArgs> {
   return getStructEncoder([

package/src/generated/types/version.ts

@@ -6,16 +6,23 @@
  * @see https://github.com/codama-idl/codama
  */
 
-import type {
-  FixedSizeCodec,
-  FixedSizeDecoder,
-  FixedSizeEncoder,
+import {
+  combineCodec,
+  getEnumDecoder,
+  getEnumEncoder,
+  type FixedSizeCodec,
+  type FixedSizeDecoder,
+  type FixedSizeEncoder,
 } from "@solana/kit";
-import { combineCodec, getEnumDecoder, getEnumEncoder } from "@solana/kit";
 
+/**
+ * Schema version of a tree's leaves: `V1` (Token Metadata
+ * collections) or `V2` (MPL Core collections, freezing, and
+ * non-transferable assets).
+ */
 export enum Version {
-  V1 = 0,
-  V2 = 1,
+  V1,
+  V2,
 }
 
 export type VersionArgs = Version;