@macalinao/clients-mpl-bubblegum 0.0.0 → 0.2.0

package/src/generated/instructions/updateMetadata.ts

@@ -0,0 +1,449 @@
+/**
+ * This code was AUTOGENERATED using the Codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun Codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+import type {
+  AccountMeta,
+  AccountSignerMeta,
+  Address,
+  Codec,
+  Decoder,
+  Encoder,
+  Instruction,
+  InstructionWithAccounts,
+  InstructionWithData,
+  ReadonlyAccount,
+  ReadonlySignerAccount,
+  ReadonlyUint8Array,
+  TransactionSigner,
+  WritableAccount,
+} from "@solana/kit";
+import type { ResolvedInstructionAccount } from "@solana/program-client-core";
+import type {
+  MetadataArgs,
+  MetadataArgsArgs,
+  UpdateArgs,
+  UpdateArgsArgs,
+} from "../types/index.js";
+import {
+  combineCodec,
+  fixDecoderSize,
+  fixEncoderSize,
+  getArrayDecoder,
+  getArrayEncoder,
+  getBytesDecoder,
+  getBytesEncoder,
+  getStructDecoder,
+  getStructEncoder,
+  getU8Decoder,
+  getU8Encoder,
+  getU32Decoder,
+  getU32Encoder,
+  getU64Decoder,
+  getU64Encoder,
+  SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
+  SolanaError,
+  transformEncoder,
+} from "@solana/kit";
+import { getAccountMetaFactory } from "@solana/program-client-core";
+import { BUBBLEGUM_PROGRAM_ADDRESS } from "../programs/index.js";
+import {
+  getMetadataArgsDecoder,
+  getMetadataArgsEncoder,
+  getUpdateArgsDecoder,
+  getUpdateArgsEncoder,
+} from "../types/index.js";
+
+export const UPDATE_METADATA_DISCRIMINATOR: ReadonlyUint8Array = new Uint8Array(
+  [170, 182, 43, 239, 97, 78, 225, 186],
+);
+
+export function getUpdateMetadataDiscriminatorBytes(): ReadonlyUint8Array {
+  return fixEncoderSize(getBytesEncoder(), 8).encode(
+    UPDATE_METADATA_DISCRIMINATOR,
+  );
+}
+
+export type UpdateMetadataInstruction<
+  TProgram extends string = typeof BUBBLEGUM_PROGRAM_ADDRESS,
+  TAccountTreeAuthority extends string | AccountMeta = string,
+  TAccountAuthority extends string | AccountMeta = string,
+  TAccountCollectionMint extends string | AccountMeta = string,
+  TAccountCollectionMetadata extends string | AccountMeta = string,
+  TAccountCollectionAuthorityRecordPda extends string | AccountMeta = string,
+  TAccountLeafOwner extends string | AccountMeta = string,
+  TAccountLeafDelegate extends string | AccountMeta = string,
+  TAccountPayer extends string | AccountMeta = string,
+  TAccountMerkleTree extends string | AccountMeta = string,
+  TAccountLogWrapper extends string | AccountMeta = string,
+  TAccountCompressionProgram extends string | AccountMeta = string,
+  TAccountTokenMetadataProgram extends
+    | string
+    | AccountMeta = "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s",
+  TAccountSystemProgram extends
+    | string
+    | AccountMeta = "11111111111111111111111111111111",
+  TRemainingAccounts extends readonly AccountMeta[] = [],
+> = Instruction<TProgram> &
+  InstructionWithData<ReadonlyUint8Array> &
+  InstructionWithAccounts<
+    [
+      TAccountTreeAuthority extends string
+        ? ReadonlyAccount<TAccountTreeAuthority>
+        : TAccountTreeAuthority,
+      TAccountAuthority extends string
+        ? ReadonlySignerAccount<TAccountAuthority> &
+            AccountSignerMeta<TAccountAuthority>
+        : TAccountAuthority,
+      TAccountCollectionMint extends string
+        ? ReadonlyAccount<TAccountCollectionMint>
+        : TAccountCollectionMint,
+      TAccountCollectionMetadata extends string
+        ? ReadonlyAccount<TAccountCollectionMetadata>
+        : TAccountCollectionMetadata,
+      TAccountCollectionAuthorityRecordPda extends string
+        ? ReadonlyAccount<TAccountCollectionAuthorityRecordPda>
+        : TAccountCollectionAuthorityRecordPda,
+      TAccountLeafOwner extends string
+        ? ReadonlyAccount<TAccountLeafOwner>
+        : TAccountLeafOwner,
+      TAccountLeafDelegate extends string
+        ? ReadonlyAccount<TAccountLeafDelegate>
+        : TAccountLeafDelegate,
+      TAccountPayer extends string
+        ? ReadonlySignerAccount<TAccountPayer> &
+            AccountSignerMeta<TAccountPayer>
+        : TAccountPayer,
+      TAccountMerkleTree extends string
+        ? WritableAccount<TAccountMerkleTree>
+        : TAccountMerkleTree,
+      TAccountLogWrapper extends string
+        ? ReadonlyAccount<TAccountLogWrapper>
+        : TAccountLogWrapper,
+      TAccountCompressionProgram extends string
+        ? ReadonlyAccount<TAccountCompressionProgram>
+        : TAccountCompressionProgram,
+      TAccountTokenMetadataProgram extends string
+        ? ReadonlyAccount<TAccountTokenMetadataProgram>
+        : TAccountTokenMetadataProgram,
+      TAccountSystemProgram extends string
+        ? ReadonlyAccount<TAccountSystemProgram>
+        : TAccountSystemProgram,
+      ...TRemainingAccounts,
+    ]
+  >;
+
+export interface UpdateMetadataInstructionData {
+  discriminator: ReadonlyUint8Array;
+  root: number[];
+  nonce: bigint;
+  index: number;
+  currentMetadata: MetadataArgs;
+  updateArgs: UpdateArgs;
+}
+
+export interface UpdateMetadataInstructionDataArgs {
+  root: number[];
+  nonce: number | bigint;
+  index: number;
+  currentMetadata: MetadataArgsArgs;
+  updateArgs: UpdateArgsArgs;
+}
+
+export function getUpdateMetadataInstructionDataEncoder(): Encoder<UpdateMetadataInstructionDataArgs> {
+  return transformEncoder(
+    getStructEncoder([
+      ["discriminator", fixEncoderSize(getBytesEncoder(), 8)],
+      ["root", getArrayEncoder(getU8Encoder(), { size: 32 })],
+      ["nonce", getU64Encoder()],
+      ["index", getU32Encoder()],
+      ["currentMetadata", getMetadataArgsEncoder()],
+      ["updateArgs", getUpdateArgsEncoder()],
+    ]),
+    (value) => ({ ...value, discriminator: UPDATE_METADATA_DISCRIMINATOR }),
+  );
+}
+
+export function getUpdateMetadataInstructionDataDecoder(): Decoder<UpdateMetadataInstructionData> {
+  return getStructDecoder([
+    ["discriminator", fixDecoderSize(getBytesDecoder(), 8)],
+    ["root", getArrayDecoder(getU8Decoder(), { size: 32 })],
+    ["nonce", getU64Decoder()],
+    ["index", getU32Decoder()],
+    ["currentMetadata", getMetadataArgsDecoder()],
+    ["updateArgs", getUpdateArgsDecoder()],
+  ]);
+}
+
+export function getUpdateMetadataInstructionDataCodec(): Codec<
+  UpdateMetadataInstructionDataArgs,
+  UpdateMetadataInstructionData
+> {
+  return combineCodec(
+    getUpdateMetadataInstructionDataEncoder(),
+    getUpdateMetadataInstructionDataDecoder(),
+  );
+}
+
+export interface UpdateMetadataInput<
+  TAccountTreeAuthority extends string = string,
+  TAccountAuthority extends string = string,
+  TAccountCollectionMint extends string = string,
+  TAccountCollectionMetadata extends string = string,
+  TAccountCollectionAuthorityRecordPda extends string = string,
+  TAccountLeafOwner extends string = string,
+  TAccountLeafDelegate extends string = string,
+  TAccountPayer extends string = string,
+  TAccountMerkleTree extends string = string,
+  TAccountLogWrapper extends string = string,
+  TAccountCompressionProgram extends string = string,
+  TAccountTokenMetadataProgram extends string = string,
+  TAccountSystemProgram extends string = string,
+> {
+  treeAuthority: Address<TAccountTreeAuthority>;
+  /**
+   * Either collection authority or tree owner/delegate, depending
+   * on whether the item is in a verified collection
+   */
+  authority: TransactionSigner<TAccountAuthority>;
+  /** Used when item is in a verified collection */
+  collectionMint?: Address<TAccountCollectionMint>;
+  /** Used when item is in a verified collection */
+  collectionMetadata?: Address<TAccountCollectionMetadata>;
+  collectionAuthorityRecordPda?: Address<TAccountCollectionAuthorityRecordPda>;
+  leafOwner: Address<TAccountLeafOwner>;
+  leafDelegate: Address<TAccountLeafDelegate>;
+  payer: TransactionSigner<TAccountPayer>;
+  merkleTree: Address<TAccountMerkleTree>;
+  logWrapper: Address<TAccountLogWrapper>;
+  compressionProgram: Address<TAccountCompressionProgram>;
+  tokenMetadataProgram?: Address<TAccountTokenMetadataProgram>;
+  systemProgram?: Address<TAccountSystemProgram>;
+  root: UpdateMetadataInstructionDataArgs["root"];
+  nonce: UpdateMetadataInstructionDataArgs["nonce"];
+  index: UpdateMetadataInstructionDataArgs["index"];
+  currentMetadata: UpdateMetadataInstructionDataArgs["currentMetadata"];
+  updateArgs: UpdateMetadataInstructionDataArgs["updateArgs"];
+}
+
+export function getUpdateMetadataInstruction<
+  TAccountTreeAuthority extends string,
+  TAccountAuthority extends string,
+  TAccountCollectionMint extends string,
+  TAccountCollectionMetadata extends string,
+  TAccountCollectionAuthorityRecordPda extends string,
+  TAccountLeafOwner extends string,
+  TAccountLeafDelegate extends string,
+  TAccountPayer extends string,
+  TAccountMerkleTree extends string,
+  TAccountLogWrapper extends string,
+  TAccountCompressionProgram extends string,
+  TAccountTokenMetadataProgram extends string,
+  TAccountSystemProgram extends string,
+  TProgramAddress extends Address = typeof BUBBLEGUM_PROGRAM_ADDRESS,
+>(
+  input: UpdateMetadataInput<
+    TAccountTreeAuthority,
+    TAccountAuthority,
+    TAccountCollectionMint,
+    TAccountCollectionMetadata,
+    TAccountCollectionAuthorityRecordPda,
+    TAccountLeafOwner,
+    TAccountLeafDelegate,
+    TAccountPayer,
+    TAccountMerkleTree,
+    TAccountLogWrapper,
+    TAccountCompressionProgram,
+    TAccountTokenMetadataProgram,
+    TAccountSystemProgram
+  >,
+  config?: { programAddress?: TProgramAddress },
+): UpdateMetadataInstruction<
+  TProgramAddress,
+  TAccountTreeAuthority,
+  TAccountAuthority,
+  TAccountCollectionMint,
+  TAccountCollectionMetadata,
+  TAccountCollectionAuthorityRecordPda,
+  TAccountLeafOwner,
+  TAccountLeafDelegate,
+  TAccountPayer,
+  TAccountMerkleTree,
+  TAccountLogWrapper,
+  TAccountCompressionProgram,
+  TAccountTokenMetadataProgram,
+  TAccountSystemProgram
+> {
+  // Program address.
+  const programAddress = config?.programAddress ?? BUBBLEGUM_PROGRAM_ADDRESS;
+
+  // Original accounts.
+  const originalAccounts = {
+    treeAuthority: { value: input.treeAuthority ?? null, isWritable: false },
+    authority: { value: input.authority ?? null, isWritable: false },
+    collectionMint: { value: input.collectionMint ?? null, isWritable: false },
+    collectionMetadata: {
+      value: input.collectionMetadata ?? null,
+      isWritable: false,
+    },
+    collectionAuthorityRecordPda: {
+      value: input.collectionAuthorityRecordPda ?? null,
+      isWritable: false,
+    },
+    leafOwner: { value: input.leafOwner ?? null, isWritable: false },
+    leafDelegate: { value: input.leafDelegate ?? null, isWritable: false },
+    payer: { value: input.payer ?? null, isWritable: false },
+    merkleTree: { value: input.merkleTree ?? null, isWritable: true },
+    logWrapper: { value: input.logWrapper ?? null, isWritable: false },
+    compressionProgram: {
+      value: input.compressionProgram ?? null,
+      isWritable: false,
+    },
+    tokenMetadataProgram: {
+      value: input.tokenMetadataProgram ?? null,
+      isWritable: false,
+    },
+    systemProgram: { value: input.systemProgram ?? null, isWritable: false },
+  };
+  const accounts = originalAccounts as Record<
+    keyof typeof originalAccounts,
+    ResolvedInstructionAccount
+  >;
+
+  // Original args.
+  const args = { ...input };
+
+  // Resolve default values.
+  if (!accounts.tokenMetadataProgram.value) {
+    accounts.tokenMetadataProgram.value =
+      "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s" as Address<"metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s">;
+  }
+  if (!accounts.systemProgram.value) {
+    accounts.systemProgram.value =
+      "11111111111111111111111111111111" as Address<"11111111111111111111111111111111">;
+  }
+
+  const getAccountMeta = getAccountMetaFactory(programAddress, "programId");
+  return Object.freeze({
+    accounts: [
+      getAccountMeta("treeAuthority", accounts.treeAuthority),
+      getAccountMeta("authority", accounts.authority),
+      getAccountMeta("collectionMint", accounts.collectionMint),
+      getAccountMeta("collectionMetadata", accounts.collectionMetadata),
+      getAccountMeta(
+        "collectionAuthorityRecordPda",
+        accounts.collectionAuthorityRecordPda,
+      ),
+      getAccountMeta("leafOwner", accounts.leafOwner),
+      getAccountMeta("leafDelegate", accounts.leafDelegate),
+      getAccountMeta("payer", accounts.payer),
+      getAccountMeta("merkleTree", accounts.merkleTree),
+      getAccountMeta("logWrapper", accounts.logWrapper),
+      getAccountMeta("compressionProgram", accounts.compressionProgram),
+      getAccountMeta("tokenMetadataProgram", accounts.tokenMetadataProgram),
+      getAccountMeta("systemProgram", accounts.systemProgram),
+    ],
+    data: getUpdateMetadataInstructionDataEncoder().encode(
+      args as UpdateMetadataInstructionDataArgs,
+    ),
+    programAddress,
+  } as UpdateMetadataInstruction<
+    TProgramAddress,
+    TAccountTreeAuthority,
+    TAccountAuthority,
+    TAccountCollectionMint,
+    TAccountCollectionMetadata,
+    TAccountCollectionAuthorityRecordPda,
+    TAccountLeafOwner,
+    TAccountLeafDelegate,
+    TAccountPayer,
+    TAccountMerkleTree,
+    TAccountLogWrapper,
+    TAccountCompressionProgram,
+    TAccountTokenMetadataProgram,
+    TAccountSystemProgram
+  >);
+}
+
+export interface ParsedUpdateMetadataInstruction<
+  TProgram extends string = typeof BUBBLEGUM_PROGRAM_ADDRESS,
+  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
+> {
+  programAddress: Address<TProgram>;
+  accounts: {
+    treeAuthority: TAccountMetas[0];
+    /**
+     * Either collection authority or tree owner/delegate, depending
+     * on whether the item is in a verified collection
+     */
+    authority: TAccountMetas[1];
+    /** Used when item is in a verified collection */
+    collectionMint?: TAccountMetas[2] | undefined;
+    /** Used when item is in a verified collection */
+    collectionMetadata?: TAccountMetas[3] | undefined;
+    collectionAuthorityRecordPda?: TAccountMetas[4] | undefined;
+    leafOwner: TAccountMetas[5];
+    leafDelegate: TAccountMetas[6];
+    payer: TAccountMetas[7];
+    merkleTree: TAccountMetas[8];
+    logWrapper: TAccountMetas[9];
+    compressionProgram: TAccountMetas[10];
+    tokenMetadataProgram: TAccountMetas[11];
+    systemProgram: TAccountMetas[12];
+  };
+  data: UpdateMetadataInstructionData;
+}
+
+export function parseUpdateMetadataInstruction<
+  TProgram extends string,
+  TAccountMetas extends readonly AccountMeta[],
+>(
+  instruction: Instruction<TProgram> &
+    InstructionWithAccounts<TAccountMetas> &
+    InstructionWithData<ReadonlyUint8Array>,
+): ParsedUpdateMetadataInstruction<TProgram, TAccountMetas> {
+  if (instruction.accounts.length < 13) {
+    throw new SolanaError(
+      SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
+      {
+        actualAccountMetas: instruction.accounts.length,
+        expectedAccountMetas: 13,
+      },
+    );
+  }
+  let accountIndex = 0;
+  const getNextAccount = () => {
+    const accountMeta = (instruction.accounts as TAccountMetas)[accountIndex]!;
+    accountIndex += 1;
+    return accountMeta;
+  };
+  const getNextOptionalAccount = () => {
+    const accountMeta = getNextAccount();
+    return accountMeta.address === BUBBLEGUM_PROGRAM_ADDRESS
+      ? undefined
+      : accountMeta;
+  };
+  return {
+    programAddress: instruction.programAddress,
+    accounts: {
+      treeAuthority: getNextAccount(),
+      authority: getNextAccount(),
+      collectionMint: getNextOptionalAccount(),
+      collectionMetadata: getNextOptionalAccount(),
+      collectionAuthorityRecordPda: getNextOptionalAccount(),
+      leafOwner: getNextAccount(),
+      leafDelegate: getNextAccount(),
+      payer: getNextAccount(),
+      merkleTree: getNextAccount(),
+      logWrapper: getNextAccount(),
+      compressionProgram: getNextAccount(),
+      tokenMetadataProgram: getNextAccount(),
+      systemProgram: getNextAccount(),
+    },
+    data: getUpdateMetadataInstructionDataDecoder().decode(instruction.data),
+  };
+}