@macalinao/clients-mpl-bubblegum 0.0.0 → 0.2.0

package/src/generated/instructions/unverifyCollection.ts

@@ -0,0 +1,496 @@
+/**
+ * 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 } 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,
+} from "../types/index.js";
+
+export const UNVERIFY_COLLECTION_DISCRIMINATOR: ReadonlyUint8Array =
+  new Uint8Array([250, 251, 42, 106, 41, 137, 186, 168]);
+
+export function getUnverifyCollectionDiscriminatorBytes(): ReadonlyUint8Array {
+  return fixEncoderSize(getBytesEncoder(), 8).encode(
+    UNVERIFY_COLLECTION_DISCRIMINATOR,
+  );
+}
+
+export type UnverifyCollectionInstruction<
+  TProgram extends string = typeof BUBBLEGUM_PROGRAM_ADDRESS,
+  TAccountTreeAuthority extends string | AccountMeta = string,
+  TAccountLeafOwner extends string | AccountMeta = string,
+  TAccountLeafDelegate extends string | AccountMeta = string,
+  TAccountMerkleTree extends string | AccountMeta = string,
+  TAccountPayer extends string | AccountMeta = string,
+  TAccountTreeDelegate extends string | AccountMeta = string,
+  TAccountCollectionAuthority extends string | AccountMeta = string,
+  TAccountCollectionAuthorityRecordPda extends string | AccountMeta = string,
+  TAccountCollectionMint extends string | AccountMeta = string,
+  TAccountCollectionMetadata extends string | AccountMeta = string,
+  TAccountEditionAccount extends string | AccountMeta = string,
+  TAccountBubblegumSigner 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,
+      TAccountLeafOwner extends string
+        ? ReadonlyAccount<TAccountLeafOwner>
+        : TAccountLeafOwner,
+      TAccountLeafDelegate extends string
+        ? ReadonlyAccount<TAccountLeafDelegate>
+        : TAccountLeafDelegate,
+      TAccountMerkleTree extends string
+        ? WritableAccount<TAccountMerkleTree>
+        : TAccountMerkleTree,
+      TAccountPayer extends string
+        ? ReadonlySignerAccount<TAccountPayer> &
+            AccountSignerMeta<TAccountPayer>
+        : TAccountPayer,
+      TAccountTreeDelegate extends string
+        ? ReadonlyAccount<TAccountTreeDelegate>
+        : TAccountTreeDelegate,
+      TAccountCollectionAuthority extends string
+        ? ReadonlySignerAccount<TAccountCollectionAuthority> &
+            AccountSignerMeta<TAccountCollectionAuthority>
+        : TAccountCollectionAuthority,
+      TAccountCollectionAuthorityRecordPda extends string
+        ? ReadonlyAccount<TAccountCollectionAuthorityRecordPda>
+        : TAccountCollectionAuthorityRecordPda,
+      TAccountCollectionMint extends string
+        ? ReadonlyAccount<TAccountCollectionMint>
+        : TAccountCollectionMint,
+      TAccountCollectionMetadata extends string
+        ? WritableAccount<TAccountCollectionMetadata>
+        : TAccountCollectionMetadata,
+      TAccountEditionAccount extends string
+        ? ReadonlyAccount<TAccountEditionAccount>
+        : TAccountEditionAccount,
+      TAccountBubblegumSigner extends string
+        ? ReadonlyAccount<TAccountBubblegumSigner>
+        : TAccountBubblegumSigner,
+      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 UnverifyCollectionInstructionData {
+  discriminator: ReadonlyUint8Array;
+  root: number[];
+  dataHash: number[];
+  creatorHash: number[];
+  nonce: bigint;
+  index: number;
+  message: MetadataArgs;
+}
+
+export interface UnverifyCollectionInstructionDataArgs {
+  root: number[];
+  dataHash: number[];
+  creatorHash: number[];
+  nonce: number | bigint;
+  index: number;
+  message: MetadataArgsArgs;
+}
+
+export function getUnverifyCollectionInstructionDataEncoder(): Encoder<UnverifyCollectionInstructionDataArgs> {
+  return transformEncoder(
+    getStructEncoder([
+      ["discriminator", fixEncoderSize(getBytesEncoder(), 8)],
+      ["root", getArrayEncoder(getU8Encoder(), { size: 32 })],
+      ["dataHash", getArrayEncoder(getU8Encoder(), { size: 32 })],
+      ["creatorHash", getArrayEncoder(getU8Encoder(), { size: 32 })],
+      ["nonce", getU64Encoder()],
+      ["index", getU32Encoder()],
+      ["message", getMetadataArgsEncoder()],
+    ]),
+    (value) => ({ ...value, discriminator: UNVERIFY_COLLECTION_DISCRIMINATOR }),
+  );
+}
+
+export function getUnverifyCollectionInstructionDataDecoder(): Decoder<UnverifyCollectionInstructionData> {
+  return getStructDecoder([
+    ["discriminator", fixDecoderSize(getBytesDecoder(), 8)],
+    ["root", getArrayDecoder(getU8Decoder(), { size: 32 })],
+    ["dataHash", getArrayDecoder(getU8Decoder(), { size: 32 })],
+    ["creatorHash", getArrayDecoder(getU8Decoder(), { size: 32 })],
+    ["nonce", getU64Decoder()],
+    ["index", getU32Decoder()],
+    ["message", getMetadataArgsDecoder()],
+  ]);
+}
+
+export function getUnverifyCollectionInstructionDataCodec(): Codec<
+  UnverifyCollectionInstructionDataArgs,
+  UnverifyCollectionInstructionData
+> {
+  return combineCodec(
+    getUnverifyCollectionInstructionDataEncoder(),
+    getUnverifyCollectionInstructionDataDecoder(),
+  );
+}
+
+export interface UnverifyCollectionInput<
+  TAccountTreeAuthority extends string = string,
+  TAccountLeafOwner extends string = string,
+  TAccountLeafDelegate extends string = string,
+  TAccountMerkleTree extends string = string,
+  TAccountPayer extends string = string,
+  TAccountTreeDelegate extends string = string,
+  TAccountCollectionAuthority extends string = string,
+  TAccountCollectionAuthorityRecordPda extends string = string,
+  TAccountCollectionMint extends string = string,
+  TAccountCollectionMetadata extends string = string,
+  TAccountEditionAccount extends string = string,
+  TAccountBubblegumSigner extends string = string,
+  TAccountLogWrapper extends string = string,
+  TAccountCompressionProgram extends string = string,
+  TAccountTokenMetadataProgram extends string = string,
+  TAccountSystemProgram extends string = string,
+> {
+  treeAuthority: Address<TAccountTreeAuthority>;
+  leafOwner: Address<TAccountLeafOwner>;
+  leafDelegate: Address<TAccountLeafDelegate>;
+  merkleTree: Address<TAccountMerkleTree>;
+  payer: TransactionSigner<TAccountPayer>;
+  /**
+   * This account is checked to be a signer in
+   * the case of `set_and_verify_collection` where
+   * we are actually changing the NFT metadata.
+   */
+  treeDelegate: Address<TAccountTreeDelegate>;
+  collectionAuthority: TransactionSigner<TAccountCollectionAuthority>;
+  /**
+   * If there is no collecton authority record PDA then
+   * this must be the Bubblegum program address.
+   */
+  collectionAuthorityRecordPda: Address<TAccountCollectionAuthorityRecordPda>;
+  collectionMint: Address<TAccountCollectionMint>;
+  collectionMetadata: Address<TAccountCollectionMetadata>;
+  editionAccount: Address<TAccountEditionAccount>;
+  bubblegumSigner: Address<TAccountBubblegumSigner>;
+  logWrapper: Address<TAccountLogWrapper>;
+  compressionProgram: Address<TAccountCompressionProgram>;
+  tokenMetadataProgram?: Address<TAccountTokenMetadataProgram>;
+  systemProgram?: Address<TAccountSystemProgram>;
+  root: UnverifyCollectionInstructionDataArgs["root"];
+  dataHash: UnverifyCollectionInstructionDataArgs["dataHash"];
+  creatorHash: UnverifyCollectionInstructionDataArgs["creatorHash"];
+  nonce: UnverifyCollectionInstructionDataArgs["nonce"];
+  index: UnverifyCollectionInstructionDataArgs["index"];
+  message: UnverifyCollectionInstructionDataArgs["message"];
+}
+
+export function getUnverifyCollectionInstruction<
+  TAccountTreeAuthority extends string,
+  TAccountLeafOwner extends string,
+  TAccountLeafDelegate extends string,
+  TAccountMerkleTree extends string,
+  TAccountPayer extends string,
+  TAccountTreeDelegate extends string,
+  TAccountCollectionAuthority extends string,
+  TAccountCollectionAuthorityRecordPda extends string,
+  TAccountCollectionMint extends string,
+  TAccountCollectionMetadata extends string,
+  TAccountEditionAccount extends string,
+  TAccountBubblegumSigner extends string,
+  TAccountLogWrapper extends string,
+  TAccountCompressionProgram extends string,
+  TAccountTokenMetadataProgram extends string,
+  TAccountSystemProgram extends string,
+  TProgramAddress extends Address = typeof BUBBLEGUM_PROGRAM_ADDRESS,
+>(
+  input: UnverifyCollectionInput<
+    TAccountTreeAuthority,
+    TAccountLeafOwner,
+    TAccountLeafDelegate,
+    TAccountMerkleTree,
+    TAccountPayer,
+    TAccountTreeDelegate,
+    TAccountCollectionAuthority,
+    TAccountCollectionAuthorityRecordPda,
+    TAccountCollectionMint,
+    TAccountCollectionMetadata,
+    TAccountEditionAccount,
+    TAccountBubblegumSigner,
+    TAccountLogWrapper,
+    TAccountCompressionProgram,
+    TAccountTokenMetadataProgram,
+    TAccountSystemProgram
+  >,
+  config?: { programAddress?: TProgramAddress },
+): UnverifyCollectionInstruction<
+  TProgramAddress,
+  TAccountTreeAuthority,
+  TAccountLeafOwner,
+  TAccountLeafDelegate,
+  TAccountMerkleTree,
+  TAccountPayer,
+  TAccountTreeDelegate,
+  TAccountCollectionAuthority,
+  TAccountCollectionAuthorityRecordPda,
+  TAccountCollectionMint,
+  TAccountCollectionMetadata,
+  TAccountEditionAccount,
+  TAccountBubblegumSigner,
+  TAccountLogWrapper,
+  TAccountCompressionProgram,
+  TAccountTokenMetadataProgram,
+  TAccountSystemProgram
+> {
+  // Program address.
+  const programAddress = config?.programAddress ?? BUBBLEGUM_PROGRAM_ADDRESS;
+
+  // Original accounts.
+  const originalAccounts = {
+    treeAuthority: { value: input.treeAuthority ?? null, isWritable: false },
+    leafOwner: { value: input.leafOwner ?? null, isWritable: false },
+    leafDelegate: { value: input.leafDelegate ?? null, isWritable: false },
+    merkleTree: { value: input.merkleTree ?? null, isWritable: true },
+    payer: { value: input.payer ?? null, isWritable: false },
+    treeDelegate: { value: input.treeDelegate ?? null, isWritable: false },
+    collectionAuthority: {
+      value: input.collectionAuthority ?? null,
+      isWritable: false,
+    },
+    collectionAuthorityRecordPda: {
+      value: input.collectionAuthorityRecordPda ?? null,
+      isWritable: false,
+    },
+    collectionMint: { value: input.collectionMint ?? null, isWritable: false },
+    collectionMetadata: {
+      value: input.collectionMetadata ?? null,
+      isWritable: true,
+    },
+    editionAccount: { value: input.editionAccount ?? null, isWritable: false },
+    bubblegumSigner: {
+      value: input.bubblegumSigner ?? null,
+      isWritable: false,
+    },
+    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("leafOwner", accounts.leafOwner),
+      getAccountMeta("leafDelegate", accounts.leafDelegate),
+      getAccountMeta("merkleTree", accounts.merkleTree),
+      getAccountMeta("payer", accounts.payer),
+      getAccountMeta("treeDelegate", accounts.treeDelegate),
+      getAccountMeta("collectionAuthority", accounts.collectionAuthority),
+      getAccountMeta(
+        "collectionAuthorityRecordPda",
+        accounts.collectionAuthorityRecordPda,
+      ),
+      getAccountMeta("collectionMint", accounts.collectionMint),
+      getAccountMeta("collectionMetadata", accounts.collectionMetadata),
+      getAccountMeta("editionAccount", accounts.editionAccount),
+      getAccountMeta("bubblegumSigner", accounts.bubblegumSigner),
+      getAccountMeta("logWrapper", accounts.logWrapper),
+      getAccountMeta("compressionProgram", accounts.compressionProgram),
+      getAccountMeta("tokenMetadataProgram", accounts.tokenMetadataProgram),
+      getAccountMeta("systemProgram", accounts.systemProgram),
+    ],
+    data: getUnverifyCollectionInstructionDataEncoder().encode(
+      args as UnverifyCollectionInstructionDataArgs,
+    ),
+    programAddress,
+  } as UnverifyCollectionInstruction<
+    TProgramAddress,
+    TAccountTreeAuthority,
+    TAccountLeafOwner,
+    TAccountLeafDelegate,
+    TAccountMerkleTree,
+    TAccountPayer,
+    TAccountTreeDelegate,
+    TAccountCollectionAuthority,
+    TAccountCollectionAuthorityRecordPda,
+    TAccountCollectionMint,
+    TAccountCollectionMetadata,
+    TAccountEditionAccount,
+    TAccountBubblegumSigner,
+    TAccountLogWrapper,
+    TAccountCompressionProgram,
+    TAccountTokenMetadataProgram,
+    TAccountSystemProgram
+  >);
+}
+
+export interface ParsedUnverifyCollectionInstruction<
+  TProgram extends string = typeof BUBBLEGUM_PROGRAM_ADDRESS,
+  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
+> {
+  programAddress: Address<TProgram>;
+  accounts: {
+    treeAuthority: TAccountMetas[0];
+    leafOwner: TAccountMetas[1];
+    leafDelegate: TAccountMetas[2];
+    merkleTree: TAccountMetas[3];
+    payer: TAccountMetas[4];
+    /**
+     * This account is checked to be a signer in
+     * the case of `set_and_verify_collection` where
+     * we are actually changing the NFT metadata.
+     */
+    treeDelegate: TAccountMetas[5];
+    collectionAuthority: TAccountMetas[6];
+    /**
+     * If there is no collecton authority record PDA then
+     * this must be the Bubblegum program address.
+     */
+    collectionAuthorityRecordPda: TAccountMetas[7];
+    collectionMint: TAccountMetas[8];
+    collectionMetadata: TAccountMetas[9];
+    editionAccount: TAccountMetas[10];
+    bubblegumSigner: TAccountMetas[11];
+    logWrapper: TAccountMetas[12];
+    compressionProgram: TAccountMetas[13];
+    tokenMetadataProgram: TAccountMetas[14];
+    systemProgram: TAccountMetas[15];
+  };
+  data: UnverifyCollectionInstructionData;
+}
+
+export function parseUnverifyCollectionInstruction<
+  TProgram extends string,
+  TAccountMetas extends readonly AccountMeta[],
+>(
+  instruction: Instruction<TProgram> &
+    InstructionWithAccounts<TAccountMetas> &
+    InstructionWithData<ReadonlyUint8Array>,
+): ParsedUnverifyCollectionInstruction<TProgram, TAccountMetas> {
+  if (instruction.accounts.length < 16) {
+    throw new SolanaError(
+      SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
+      {
+        actualAccountMetas: instruction.accounts.length,
+        expectedAccountMetas: 16,
+      },
+    );
+  }
+  let accountIndex = 0;
+  const getNextAccount = () => {
+    const accountMeta = (instruction.accounts as TAccountMetas)[accountIndex]!;
+    accountIndex += 1;
+    return accountMeta;
+  };
+  return {
+    programAddress: instruction.programAddress,
+    accounts: {
+      treeAuthority: getNextAccount(),
+      leafOwner: getNextAccount(),
+      leafDelegate: getNextAccount(),
+      merkleTree: getNextAccount(),
+      payer: getNextAccount(),
+      treeDelegate: getNextAccount(),
+      collectionAuthority: getNextAccount(),
+      collectionAuthorityRecordPda: getNextAccount(),
+      collectionMint: getNextAccount(),
+      collectionMetadata: getNextAccount(),
+      editionAccount: getNextAccount(),
+      bubblegumSigner: getNextAccount(),
+      logWrapper: getNextAccount(),
+      compressionProgram: getNextAccount(),
+      tokenMetadataProgram: getNextAccount(),
+      systemProgram: getNextAccount(),
+    },
+    data: getUnverifyCollectionInstructionDataDecoder().decode(
+      instruction.data,
+    ),
+  };
+}