feat(token-metadata): add burn_print_edition handler

token-metadata/js/idl/mpl_token_metadata.json

@@ -2044,6 +2044,70 @@
         "type": "u8",
         "value": 36
       }
+    },
+    {
+      "name": "BurnEditionNft",
+      "accounts": [
+        {
+          "name": "metadata",
+          "isMut": true,
+          "isSigner": false,
+          "desc": "Metadata (pda of ['metadata', program id, mint id])"
+        },
+        {
+          "name": "owner",
+          "isMut": true,
+          "isSigner": true,
+          "desc": "NFT owner"
+        },
+        {
+          "name": "mint",
+          "isMut": true,
+          "isSigner": false,
+          "desc": "Mint of the print edition NFT"
+        },
+        {
+          "name": "originalMint",
+          "isMut": true,
+          "isSigner": false,
+          "desc": "Mint of the original/master NFT"
+        },
+        {
+          "name": "tokenAccount",
+          "isMut": true,
+          "isSigner": false,
+          "desc": "Token account the print edition NFT is in"
+        },
+        {
+          "name": "masterEditionAccount",
+          "isMut": true,
+          "isSigner": false,
+          "desc": "MasterEdition2 of the original NFT"
+        },
+        {
+          "name": "editionAccount",
+          "isMut": true,
+          "isSigner": false,
+          "desc": "Print Edition account of the NFT"
+        },
+        {
+          "name": "editionMarkerAccount",
+          "isMut": true,
+          "isSigner": false,
+          "desc": "Edition Marker PDA of the NFT"
+        },
+        {
+          "name": "splTokenProgram",
+          "isMut": false,
+          "isSigner": false,
+          "desc": "SPL Token Program"
+        }
+      ],
+      "args": [],
+      "discriminant": {
+        "type": "u8",
+        "value": 36
+      }
     }
   ],
   "accounts": [
@@ -3419,6 +3483,16 @@
       "code": 115,
       "name": "AlreadyUnverified",
       "msg": "Item is already unverified."
+    },
+    {
+      "code": 116,
+      "name": "NotAPrintEdition",
+      "msg": "This edition is not a Print Edition"
+    },
+    {
+      "code": 117,
+      "name": "InvalidEditionMarker",
+      "msg": "Invalid Edition Marker"
     }
   ],
   "metadata": {

token-metadata/js/src/generated/errors/index.ts

@@ -2502,6 +2502,46 @@ export class AlreadyUnverifiedError extends Error {
 createErrorFromCodeLookup.set(0x73, () => new AlreadyUnverifiedError());
 createErrorFromNameLookup.set('AlreadyUnverified', () => new AlreadyUnverifiedError());
 
+/**
+ * NotAPrintEdition: 'This edition is not a Print Edition'
+ *
+ * @category Errors
+ * @category generated
+ */
+export class NotAPrintEditionError extends Error {
+  readonly code: number = 0x74;
+  readonly name: string = 'NotAPrintEdition';
+  constructor() {
+    super('This edition is not a Print Edition');
+    if (typeof Error.captureStackTrace === 'function') {
+      Error.captureStackTrace(this, NotAPrintEditionError);
+    }
+  }
+}
+
+createErrorFromCodeLookup.set(0x74, () => new NotAPrintEditionError());
+createErrorFromNameLookup.set('NotAPrintEdition', () => new NotAPrintEditionError());
+
+/**
+ * InvalidEditionMarker: 'Invalid Edition Marker'
+ *
+ * @category Errors
+ * @category generated
+ */
+export class InvalidEditionMarkerError extends Error {
+  readonly code: number = 0x75;
+  readonly name: string = 'InvalidEditionMarker';
+  constructor() {
+    super('Invalid Edition Marker');
+    if (typeof Error.captureStackTrace === 'function') {
+      Error.captureStackTrace(this, InvalidEditionMarkerError);
+    }
+  }
+}
+
+createErrorFromCodeLookup.set(0x75, () => new InvalidEditionMarkerError());
+createErrorFromNameLookup.set('InvalidEditionMarker', () => new InvalidEditionMarkerError());
+
 /**
  * Attempts to resolve a custom program error from the provided error code.
  * @category Errors

token-metadata/js/src/generated/instructions/BurnEditionNft.ts

@@ -0,0 +1,119 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as beet from '@metaplex-foundation/beet';
+import * as web3 from '@solana/web3.js';
+
+/**
+ * @category Instructions
+ * @category BurnEditionNft
+ * @category generated
+ */
+export const BurnEditionNftStruct = new beet.BeetArgsStruct<{ instructionDiscriminator: number }>(
+  [['instructionDiscriminator', beet.u8]],
+  'BurnEditionNftInstructionArgs',
+);
+/**
+ * Accounts required by the _BurnEditionNft_ instruction
+ *
+ * @property [_writable_] metadata Metadata (pda of ['metadata', program id, mint id])
+ * @property [_writable_, **signer**] owner NFT owner
+ * @property [_writable_] mint Mint of the print edition NFT
+ * @property [_writable_] originalMint Mint of the original/master NFT
+ * @property [_writable_] tokenAccount Token account the print edition NFT is in
+ * @property [_writable_] masterEditionAccount MasterEdition2 of the original NFT
+ * @property [_writable_] editionAccount Print Edition account of the NFT
+ * @property [_writable_] editionMarkerAccount Edition Marker PDA of the NFT
+ * @property [] splTokenProgram SPL Token Program
+ * @category Instructions
+ * @category BurnEditionNft
+ * @category generated
+ */
+export type BurnEditionNftInstructionAccounts = {
+  metadata: web3.PublicKey;
+  owner: web3.PublicKey;
+  mint: web3.PublicKey;
+  originalMint: web3.PublicKey;
+  tokenAccount: web3.PublicKey;
+  masterEditionAccount: web3.PublicKey;
+  editionAccount: web3.PublicKey;
+  editionMarkerAccount: web3.PublicKey;
+  splTokenProgram: web3.PublicKey;
+};
+
+export const burnEditionNftInstructionDiscriminator = 36;
+
+/**
+ * Creates a _BurnEditionNft_ instruction.
+ *
+ * @param accounts that will be accessed while the instruction is processed
+ * @category Instructions
+ * @category BurnEditionNft
+ * @category generated
+ */
+export function createBurnEditionNftInstruction(
+  accounts: BurnEditionNftInstructionAccounts,
+  programId = new web3.PublicKey('metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s'),
+) {
+  const [data] = BurnEditionNftStruct.serialize({
+    instructionDiscriminator: burnEditionNftInstructionDiscriminator,
+  });
+  const keys: web3.AccountMeta[] = [
+    {
+      pubkey: accounts.metadata,
+      isWritable: true,
+      isSigner: false,
+    },
+    {
+      pubkey: accounts.owner,
+      isWritable: true,
+      isSigner: true,
+    },
+    {
+      pubkey: accounts.mint,
+      isWritable: true,
+      isSigner: false,
+    },
+    {
+      pubkey: accounts.originalMint,
+      isWritable: true,
+      isSigner: false,
+    },
+    {
+      pubkey: accounts.tokenAccount,
+      isWritable: true,
+      isSigner: false,
+    },
+    {
+      pubkey: accounts.masterEditionAccount,
+      isWritable: true,
+      isSigner: false,
+    },
+    {
+      pubkey: accounts.editionAccount,
+      isWritable: true,
+      isSigner: false,
+    },
+    {
+      pubkey: accounts.editionMarkerAccount,
+      isWritable: true,
+      isSigner: false,
+    },
+    {
+      pubkey: accounts.splTokenProgram,
+      isWritable: false,
+      isSigner: false,
+    },
+  ];
+
+  const ix = new web3.TransactionInstruction({
+    programId,
+    keys,
+    data,
+  });
+  return ix;
+}

token-metadata/js/src/generated/instructions/index.ts

@@ -1,6 +1,7 @@
 export * from './ApproveCollectionAuthority';
 export * from './ApproveUseAuthority';
 export * from './BubblegumSetCollectionSize';
+export * from './BurnEditionNft';
 export * from './BurnNft';
 export * from './ConvertMasterEditionV1ToV2';
 export * from './CreateMasterEdition';

token-metadata/program/src/error.rs

@@ -456,6 +456,14 @@ pub enum MetadataError {
     /// 115 - Item is already unverified.
     #[error("Item is already unverified.")]
     AlreadyUnverified,
+
+    /// 116 - Not a Print Edition
+    #[error("This edition is not a Print Edition")]
+    NotAPrintEdition,
+
+    /// 117 - Invalid Edition Marker
+    #[error("Invalid Edition Marker")]
+    InvalidEditionMarker,
 }
 
 impl PrintProgramError for MetadataError {

token-metadata/program/src/instruction.rs

@@ -525,6 +525,18 @@ pub enum MetadataInstruction {
     #[account(3, signer, name="bubblegum_signer", desc="Signing PDA of Bubblegum program")]
     #[account(4, optional, name="collection_authority_record", desc="Collection Authority Record PDA")]
     BubblegumSetCollectionSize(SetCollectionSizeArgs),
+
+    /// Completely burn a print edition NFT.
+    #[account(0, writable, name="metadata", desc="Metadata (pda of ['metadata', program id, mint id])")]
+    #[account(1, signer, writable, name="owner", desc="NFT owner")]
+    #[account(2, writable, name="mint", desc="Mint of the print edition NFT")]
+    #[account(3, writable, name="original_mint", desc="Mint of the original/master NFT")]
+    #[account(4, writable, name="token_account", desc="Token account the print edition NFT is in")]
+    #[account(5, writable, name="master_edition_account", desc="MasterEdition2 of the original NFT")]
+    #[account(6, writable, name="edition_account", desc="Print Edition account of the NFT")]
+    #[account(7, writable, name="edition_marker_account", desc="Edition Marker PDA of the NFT")]
+    #[account(8, name="spl token program", desc="SPL Token Program")]
+    BurnEditionNft,
 }
 
 /// Creates an CreateMetadataAccounts instruction
@@ -1430,6 +1442,46 @@ pub fn burn_nft(
     }
 }
 
+// #[account(0, writable, name="metadata", desc="Metadata (pda of ['metadata', program id, mint id])")]
+// #[account(1, signer, writable, name="owner", desc="NFT owner")]
+// #[account(2, writable, name="mint", desc="Mint of the print edition NFT")]
+// #[account(3, writable, name="original_mint", desc="Mint of the original/master NFT")]
+// #[account(4, writable, name="token_account", desc="Token account the print edition NFT is in")]
+// #[account(5, writable, name="master_edition_account", desc="MasterEdition2 of the original NFT")]
+// #[account(6, writable, name="edition_account", desc="Print Edition account of the NFT")]
+// #[account(7, writable, name="edition_marker_account", desc="Edition Marker PDA of the NFT")]
+// #[account(8, name="spl token program", desc="SPL Token Program")]
+pub fn burn_edition_nft(
+    program_id: Pubkey,
+    metadata: Pubkey,
+    owner: Pubkey,
+    mint: Pubkey,
+    original_mint: Pubkey,
+    token: Pubkey,
+    master_edition: Pubkey,
+    edition: Pubkey,
+    edition_marker: Pubkey,
+    spl_token: Pubkey,
+) -> Instruction {
+    let accounts = vec![
+        AccountMeta::new(metadata, false),
+        AccountMeta::new(owner, true),
+        AccountMeta::new(mint, false),
+        AccountMeta::new(original_mint, false),
+        AccountMeta::new(token, false),
+        AccountMeta::new(master_edition, false),
+        AccountMeta::new(edition, false),
+        AccountMeta::new(edition_marker, false),
+        AccountMeta::new_readonly(spl_token, false),
+    ];
+
+    Instruction {
+        program_id,
+        accounts,
+        data: MetadataInstruction::BurnEditionNft.try_to_vec().unwrap(),
+    }
+}
+
 /// # Verify Collection V2 -- Supports v1.3 Collection Details
 ///
 /// If a MetadataAccount Has a Collection allow the UpdateAuthority of the Collection to Verify the NFT Belongs in the Collection