@macalinao/clients-mpl-bubblegum 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (324) hide show
  1. package/dist/generated/accounts/index.d.ts +2 -1
  2. package/dist/generated/accounts/treeConfig.d.ts +22 -7
  3. package/dist/generated/accounts/treeConfig.d.ts.map +1 -1
  4. package/dist/generated/accounts/treeConfig.js +7 -0
  5. package/dist/generated/accounts/treeConfig.js.map +1 -1
  6. package/dist/generated/accounts/voucher.d.ts +14 -7
  7. package/dist/generated/accounts/voucher.d.ts.map +1 -1
  8. package/dist/generated/accounts/voucher.js +7 -0
  9. package/dist/generated/accounts/voucher.js.map +1 -1
  10. package/dist/generated/errors/bubblegum.d.ts +0 -1
  11. package/dist/generated/errors/bubblegum.d.ts.map +1 -1
  12. package/dist/generated/errors/bubblegum.js +66 -59
  13. package/dist/generated/errors/bubblegum.js.map +1 -1
  14. package/dist/generated/errors/index.d.ts +2 -1
  15. package/dist/generated/index.d.ts +8 -1
  16. package/dist/generated/instructions/burn.d.ts +141 -17
  17. package/dist/generated/instructions/burn.d.ts.map +1 -1
  18. package/dist/generated/instructions/burn.js +23 -0
  19. package/dist/generated/instructions/burn.js.map +1 -1
  20. package/dist/generated/instructions/burnV2.d.ts +179 -31
  21. package/dist/generated/instructions/burnV2.d.ts.map +1 -1
  22. package/dist/generated/instructions/burnV2.js +21 -0
  23. package/dist/generated/instructions/burnV2.js.map +1 -1
  24. package/dist/generated/instructions/cancelRedeem.d.ts +99 -13
  25. package/dist/generated/instructions/cancelRedeem.d.ts.map +1 -1
  26. package/dist/generated/instructions/cancelRedeem.js +19 -0
  27. package/dist/generated/instructions/cancelRedeem.js.map +1 -1
  28. package/dist/generated/instructions/closeTreeV2.d.ts +85 -19
  29. package/dist/generated/instructions/closeTreeV2.d.ts.map +1 -1
  30. package/dist/generated/instructions/closeTreeV2.js +21 -0
  31. package/dist/generated/instructions/closeTreeV2.js.map +1 -1
  32. package/dist/generated/instructions/collectV2.d.ts +20 -7
  33. package/dist/generated/instructions/collectV2.d.ts.map +1 -1
  34. package/dist/generated/instructions/collectV2.js +10 -0
  35. package/dist/generated/instructions/collectV2.js.map +1 -1
  36. package/dist/generated/instructions/compress.d.ts +119 -9
  37. package/dist/generated/instructions/compress.d.ts.map +1 -1
  38. package/dist/generated/instructions/compress.js +21 -0
  39. package/dist/generated/instructions/compress.js.map +1 -1
  40. package/dist/generated/instructions/createTree.d.ts +117 -11
  41. package/dist/generated/instructions/createTree.d.ts.map +1 -1
  42. package/dist/generated/instructions/createTree.js +23 -0
  43. package/dist/generated/instructions/createTree.js.map +1 -1
  44. package/dist/generated/instructions/createTreeV2.d.ts +109 -14
  45. package/dist/generated/instructions/createTreeV2.d.ts.map +1 -1
  46. package/dist/generated/instructions/createTreeV2.js +23 -0
  47. package/dist/generated/instructions/createTreeV2.js.map +1 -1
  48. package/dist/generated/instructions/decompressV1.d.ts +106 -11
  49. package/dist/generated/instructions/decompressV1.d.ts.map +1 -1
  50. package/dist/generated/instructions/decompressV1.js +25 -0
  51. package/dist/generated/instructions/decompressV1.js.map +1 -1
  52. package/dist/generated/instructions/delegate.d.ts +140 -17
  53. package/dist/generated/instructions/delegate.d.ts.map +1 -1
  54. package/dist/generated/instructions/delegate.js +19 -0
  55. package/dist/generated/instructions/delegate.js.map +1 -1
  56. package/dist/generated/instructions/delegateAndFreezeV2.d.ts +171 -27
  57. package/dist/generated/instructions/delegateAndFreezeV2.d.ts.map +1 -1
  58. package/dist/generated/instructions/delegateAndFreezeV2.js +17 -0
  59. package/dist/generated/instructions/delegateAndFreezeV2.js.map +1 -1
  60. package/dist/generated/instructions/delegateV2.d.ts +169 -27
  61. package/dist/generated/instructions/delegateV2.d.ts.map +1 -1
  62. package/dist/generated/instructions/delegateV2.js +15 -0
  63. package/dist/generated/instructions/delegateV2.js.map +1 -1
  64. package/dist/generated/instructions/freezeV2.d.ts +174 -28
  65. package/dist/generated/instructions/freezeV2.d.ts.map +1 -1
  66. package/dist/generated/instructions/freezeV2.js +23 -0
  67. package/dist/generated/instructions/freezeV2.js.map +1 -1
  68. package/dist/generated/instructions/index.d.ts +2 -1
  69. package/dist/generated/instructions/mintToCollectionV1.d.ts +171 -20
  70. package/dist/generated/instructions/mintToCollectionV1.d.ts.map +1 -1
  71. package/dist/generated/instructions/mintToCollectionV1.js +23 -0
  72. package/dist/generated/instructions/mintToCollectionV1.js.map +1 -1
  73. package/dist/generated/instructions/mintV1.d.ts +109 -11
  74. package/dist/generated/instructions/mintV1.d.ts.map +1 -1
  75. package/dist/generated/instructions/mintV1.js +21 -0
  76. package/dist/generated/instructions/mintV1.js.map +1 -1
  77. package/dist/generated/instructions/mintV2.d.ts +163 -17
  78. package/dist/generated/instructions/mintV2.d.ts.map +1 -1
  79. package/dist/generated/instructions/mintV2.js +45 -0
  80. package/dist/generated/instructions/mintV2.js.map +1 -1
  81. package/dist/generated/instructions/redeem.d.ts +153 -17
  82. package/dist/generated/instructions/redeem.d.ts.map +1 -1
  83. package/dist/generated/instructions/redeem.js +23 -0
  84. package/dist/generated/instructions/redeem.js.map +1 -1
  85. package/dist/generated/instructions/setAndVerifyCollection.d.ts +222 -38
  86. package/dist/generated/instructions/setAndVerifyCollection.d.ts.map +1 -1
  87. package/dist/generated/instructions/setAndVerifyCollection.js +21 -0
  88. package/dist/generated/instructions/setAndVerifyCollection.js.map +1 -1
  89. package/dist/generated/instructions/setCollectionV2.d.ts +186 -39
  90. package/dist/generated/instructions/setCollectionV2.d.ts.map +1 -1
  91. package/dist/generated/instructions/setCollectionV2.js +21 -0
  92. package/dist/generated/instructions/setCollectionV2.js.map +1 -1
  93. package/dist/generated/instructions/setDecompressableState.d.ts +40 -9
  94. package/dist/generated/instructions/setDecompressableState.d.ts.map +1 -1
  95. package/dist/generated/instructions/setDecompressableState.js +13 -0
  96. package/dist/generated/instructions/setDecompressableState.js.map +1 -1
  97. package/dist/generated/instructions/setDecompressibleState.d.ts +41 -9
  98. package/dist/generated/instructions/setDecompressibleState.d.ts.map +1 -1
  99. package/dist/generated/instructions/setDecompressibleState.js +14 -0
  100. package/dist/generated/instructions/setDecompressibleState.js.map +1 -1
  101. package/dist/generated/instructions/setNonTransferableV2.d.ts +166 -31
  102. package/dist/generated/instructions/setNonTransferableV2.d.ts.map +1 -1
  103. package/dist/generated/instructions/setNonTransferableV2.js +23 -0
  104. package/dist/generated/instructions/setNonTransferableV2.js.map +1 -1
  105. package/dist/generated/instructions/setTreeDelegate.d.ts +65 -9
  106. package/dist/generated/instructions/setTreeDelegate.d.ts.map +1 -1
  107. package/dist/generated/instructions/setTreeDelegate.js +21 -0
  108. package/dist/generated/instructions/setTreeDelegate.js.map +1 -1
  109. package/dist/generated/instructions/thawAndRevokeV2.d.ts +158 -24
  110. package/dist/generated/instructions/thawAndRevokeV2.d.ts.map +1 -1
  111. package/dist/generated/instructions/thawAndRevokeV2.js +17 -0
  112. package/dist/generated/instructions/thawAndRevokeV2.js.map +1 -1
  113. package/dist/generated/instructions/thawV2.d.ts +166 -28
  114. package/dist/generated/instructions/thawV2.d.ts.map +1 -1
  115. package/dist/generated/instructions/thawV2.js +15 -0
  116. package/dist/generated/instructions/thawV2.js.map +1 -1
  117. package/dist/generated/instructions/transfer.d.ts +140 -17
  118. package/dist/generated/instructions/transfer.d.ts.map +1 -1
  119. package/dist/generated/instructions/transfer.js +19 -0
  120. package/dist/generated/instructions/transfer.js.map +1 -1
  121. package/dist/generated/instructions/transferV2.d.ts +167 -31
  122. package/dist/generated/instructions/transferV2.d.ts.map +1 -1
  123. package/dist/generated/instructions/transferV2.js +21 -0
  124. package/dist/generated/instructions/transferV2.js.map +1 -1
  125. package/dist/generated/instructions/unverifyCollection.d.ts +215 -38
  126. package/dist/generated/instructions/unverifyCollection.d.ts.map +1 -1
  127. package/dist/generated/instructions/unverifyCollection.js +19 -0
  128. package/dist/generated/instructions/unverifyCollection.js.map +1 -1
  129. package/dist/generated/instructions/unverifyCreator.d.ts +161 -17
  130. package/dist/generated/instructions/unverifyCreator.d.ts.map +1 -1
  131. package/dist/generated/instructions/unverifyCreator.js +19 -0
  132. package/dist/generated/instructions/unverifyCreator.js.map +1 -1
  133. package/dist/generated/instructions/unverifyCreatorV2.d.ts +143 -21
  134. package/dist/generated/instructions/unverifyCreatorV2.d.ts.map +1 -1
  135. package/dist/generated/instructions/unverifyCreatorV2.js +19 -0
  136. package/dist/generated/instructions/unverifyCreatorV2.js.map +1 -1
  137. package/dist/generated/instructions/updateAssetDataV2.d.ts +180 -28
  138. package/dist/generated/instructions/updateAssetDataV2.d.ts.map +1 -1
  139. package/dist/generated/instructions/updateAssetDataV2.js +21 -0
  140. package/dist/generated/instructions/updateAssetDataV2.js.map +1 -1
  141. package/dist/generated/instructions/updateMetadata.d.ts +183 -28
  142. package/dist/generated/instructions/updateMetadata.d.ts.map +1 -1
  143. package/dist/generated/instructions/updateMetadata.js +21 -0
  144. package/dist/generated/instructions/updateMetadata.js.map +1 -1
  145. package/dist/generated/instructions/updateMetadataV2.d.ts +162 -27
  146. package/dist/generated/instructions/updateMetadataV2.d.ts.map +1 -1
  147. package/dist/generated/instructions/updateMetadataV2.js +19 -0
  148. package/dist/generated/instructions/updateMetadataV2.js.map +1 -1
  149. package/dist/generated/instructions/verifyCollection.d.ts +215 -38
  150. package/dist/generated/instructions/verifyCollection.d.ts.map +1 -1
  151. package/dist/generated/instructions/verifyCollection.js +19 -0
  152. package/dist/generated/instructions/verifyCollection.js.map +1 -1
  153. package/dist/generated/instructions/verifyCreator.d.ts +161 -17
  154. package/dist/generated/instructions/verifyCreator.d.ts.map +1 -1
  155. package/dist/generated/instructions/verifyCreator.js +19 -0
  156. package/dist/generated/instructions/verifyCreator.js.map +1 -1
  157. package/dist/generated/instructions/verifyCreatorV2.d.ts +143 -21
  158. package/dist/generated/instructions/verifyCreatorV2.d.ts.map +1 -1
  159. package/dist/generated/instructions/verifyCreatorV2.js +19 -0
  160. package/dist/generated/instructions/verifyCreatorV2.js.map +1 -1
  161. package/dist/generated/pdas/assetId.d.ts +2 -3
  162. package/dist/generated/pdas/assetId.d.ts.map +1 -1
  163. package/dist/generated/pdas/assetId.js +7 -0
  164. package/dist/generated/pdas/assetId.js.map +1 -1
  165. package/dist/generated/pdas/bubblegumSigner.d.ts +0 -1
  166. package/dist/generated/pdas/bubblegumSigner.d.ts.map +1 -1
  167. package/dist/generated/pdas/bubblegumSigner.js +7 -0
  168. package/dist/generated/pdas/bubblegumSigner.js.map +1 -1
  169. package/dist/generated/pdas/index.d.ts +2 -1
  170. package/dist/generated/pdas/masterEdition.d.ts +2 -3
  171. package/dist/generated/pdas/masterEdition.d.ts.map +1 -1
  172. package/dist/generated/pdas/masterEdition.js +7 -0
  173. package/dist/generated/pdas/masterEdition.js.map +1 -1
  174. package/dist/generated/pdas/metadata.d.ts +2 -3
  175. package/dist/generated/pdas/metadata.d.ts.map +1 -1
  176. package/dist/generated/pdas/metadata.js +7 -0
  177. package/dist/generated/pdas/metadata.js.map +1 -1
  178. package/dist/generated/pdas/mintAuthority.d.ts +2 -3
  179. package/dist/generated/pdas/mintAuthority.d.ts.map +1 -1
  180. package/dist/generated/pdas/mintAuthority.js +7 -0
  181. package/dist/generated/pdas/mintAuthority.js.map +1 -1
  182. package/dist/generated/pdas/treeConfig.d.ts +2 -3
  183. package/dist/generated/pdas/treeConfig.d.ts.map +1 -1
  184. package/dist/generated/pdas/treeConfig.js +7 -0
  185. package/dist/generated/pdas/treeConfig.js.map +1 -1
  186. package/dist/generated/pdas/voucher.d.ts +2 -3
  187. package/dist/generated/pdas/voucher.d.ts.map +1 -1
  188. package/dist/generated/pdas/voucher.js +7 -0
  189. package/dist/generated/pdas/voucher.js.map +1 -1
  190. package/dist/generated/programs/bubblegum.d.ts +17 -12
  191. package/dist/generated/programs/bubblegum.d.ts.map +1 -1
  192. package/dist/generated/programs/bubblegum.js +11 -1
  193. package/dist/generated/programs/bubblegum.js.map +1 -1
  194. package/dist/generated/programs/index.d.ts +2 -1
  195. package/dist/generated/programs/mplTokenMetadata.d.ts +8 -8
  196. package/dist/generated/programs/mplTokenMetadata.d.ts.map +1 -1
  197. package/dist/generated/programs/mplTokenMetadata.js +7 -0
  198. package/dist/generated/programs/mplTokenMetadata.js.map +1 -1
  199. package/dist/generated/types/assetDataSchema.d.ts +4 -1
  200. package/dist/generated/types/assetDataSchema.d.ts.map +1 -1
  201. package/dist/generated/types/assetDataSchema.js +11 -0
  202. package/dist/generated/types/assetDataSchema.js.map +1 -1
  203. package/dist/generated/types/bubblegumEventType.d.ts +4 -1
  204. package/dist/generated/types/bubblegumEventType.d.ts.map +1 -1
  205. package/dist/generated/types/bubblegumEventType.js +11 -0
  206. package/dist/generated/types/bubblegumEventType.js.map +1 -1
  207. package/dist/generated/types/collection.d.ts +9 -3
  208. package/dist/generated/types/collection.d.ts.map +1 -1
  209. package/dist/generated/types/collection.js +7 -0
  210. package/dist/generated/types/collection.js.map +1 -1
  211. package/dist/generated/types/creator.d.ts +9 -7
  212. package/dist/generated/types/creator.d.ts.map +1 -1
  213. package/dist/generated/types/creator.js +7 -0
  214. package/dist/generated/types/creator.js.map +1 -1
  215. package/dist/generated/types/decompressibleState.d.ts +5 -1
  216. package/dist/generated/types/decompressibleState.d.ts.map +1 -1
  217. package/dist/generated/types/decompressibleState.js +12 -0
  218. package/dist/generated/types/decompressibleState.js.map +1 -1
  219. package/dist/generated/types/index.d.ts +2 -1
  220. package/dist/generated/types/instructionName.d.ts +4 -1
  221. package/dist/generated/types/instructionName.d.ts.map +1 -1
  222. package/dist/generated/types/instructionName.js +11 -0
  223. package/dist/generated/types/instructionName.js.map +1 -1
  224. package/dist/generated/types/leafSchema.d.ts +51 -13
  225. package/dist/generated/types/leafSchema.d.ts.map +1 -1
  226. package/dist/generated/types/leafSchema.js +7 -0
  227. package/dist/generated/types/leafSchema.js.map +1 -1
  228. package/dist/generated/types/metadataArgs.d.ts +19 -7
  229. package/dist/generated/types/metadataArgs.d.ts.map +1 -1
  230. package/dist/generated/types/metadataArgs.js +7 -0
  231. package/dist/generated/types/metadataArgs.js.map +1 -1
  232. package/dist/generated/types/metadataArgsV2.d.ts +14 -7
  233. package/dist/generated/types/metadataArgsV2.d.ts.map +1 -1
  234. package/dist/generated/types/metadataArgsV2.js +7 -0
  235. package/dist/generated/types/metadataArgsV2.js.map +1 -1
  236. package/dist/generated/types/tokenProgramVersion.d.ts +1 -1
  237. package/dist/generated/types/tokenProgramVersion.d.ts.map +1 -1
  238. package/dist/generated/types/tokenProgramVersion.js +8 -0
  239. package/dist/generated/types/tokenProgramVersion.js.map +1 -1
  240. package/dist/generated/types/tokenStandard.d.ts +5 -1
  241. package/dist/generated/types/tokenStandard.d.ts.map +1 -1
  242. package/dist/generated/types/tokenStandard.js +12 -0
  243. package/dist/generated/types/tokenStandard.js.map +1 -1
  244. package/dist/generated/types/updateArgs.d.ts +26 -7
  245. package/dist/generated/types/updateArgs.d.ts.map +1 -1
  246. package/dist/generated/types/updateArgs.js +7 -0
  247. package/dist/generated/types/updateArgs.js.map +1 -1
  248. package/dist/generated/types/useMethod.d.ts +1 -1
  249. package/dist/generated/types/useMethod.d.ts.map +1 -1
  250. package/dist/generated/types/useMethod.js +8 -0
  251. package/dist/generated/types/useMethod.js.map +1 -1
  252. package/dist/generated/types/uses.d.ts +16 -5
  253. package/dist/generated/types/uses.d.ts.map +1 -1
  254. package/dist/generated/types/uses.js +7 -0
  255. package/dist/generated/types/uses.js.map +1 -1
  256. package/dist/generated/types/version.d.ts +5 -1
  257. package/dist/generated/types/version.d.ts.map +1 -1
  258. package/dist/generated/types/version.js +12 -0
  259. package/dist/generated/types/version.js.map +1 -1
  260. package/dist/index.d.ts +1 -0
  261. package/package.json +6 -6
  262. package/src/generated/accounts/treeConfig.ts +36 -27
  263. package/src/generated/accounts/voucher.ts +30 -23
  264. package/src/generated/errors/bubblegum.ts +121 -154
  265. package/src/generated/instructions/burn.ts +157 -35
  266. package/src/generated/instructions/burnV2.ts +197 -52
  267. package/src/generated/instructions/cancelRedeem.ts +116 -32
  268. package/src/generated/instructions/closeTreeV2.ts +96 -35
  269. package/src/generated/instructions/collectV2.ts +34 -23
  270. package/src/generated/instructions/compress.ts +136 -30
  271. package/src/generated/instructions/createTree.ts +137 -33
  272. package/src/generated/instructions/createTreeV2.ts +128 -36
  273. package/src/generated/instructions/decompressV1.ts +124 -31
  274. package/src/generated/instructions/delegate.ts +159 -38
  275. package/src/generated/instructions/delegateAndFreezeV2.ts +191 -51
  276. package/src/generated/instructions/delegateV2.ts +189 -51
  277. package/src/generated/instructions/freezeV2.ts +193 -49
  278. package/src/generated/instructions/mintToCollectionV1.ts +186 -37
  279. package/src/generated/instructions/mintV1.ts +127 -31
  280. package/src/generated/instructions/mintV2.ts +184 -45
  281. package/src/generated/instructions/redeem.ts +172 -38
  282. package/src/generated/instructions/setAndVerifyCollection.ts +236 -54
  283. package/src/generated/instructions/setCollectionV2.ts +202 -58
  284. package/src/generated/instructions/setDecompressableState.ts +59 -31
  285. package/src/generated/instructions/setDecompressibleState.ts +60 -31
  286. package/src/generated/instructions/setNonTransferableV2.ts +184 -52
  287. package/src/generated/instructions/setTreeDelegate.ts +82 -28
  288. package/src/generated/instructions/thawAndRevokeV2.ts +179 -48
  289. package/src/generated/instructions/thawV2.ts +185 -49
  290. package/src/generated/instructions/transfer.ts +156 -35
  291. package/src/generated/instructions/transferV2.ts +185 -52
  292. package/src/generated/instructions/unverifyCollection.ts +229 -54
  293. package/src/generated/instructions/unverifyCreator.ts +181 -39
  294. package/src/generated/instructions/unverifyCreatorV2.ts +164 -46
  295. package/src/generated/instructions/updateAssetDataV2.ts +200 -50
  296. package/src/generated/instructions/updateMetadata.ts +200 -52
  297. package/src/generated/instructions/updateMetadataV2.ts +183 -54
  298. package/src/generated/instructions/verifyCollection.ts +229 -54
  299. package/src/generated/instructions/verifyCreator.ts +181 -39
  300. package/src/generated/instructions/verifyCreatorV2.ts +164 -46
  301. package/src/generated/pdas/assetId.ts +4 -3
  302. package/src/generated/pdas/bubblegumSigner.ts +6 -2
  303. package/src/generated/pdas/masterEdition.ts +4 -3
  304. package/src/generated/pdas/metadata.ts +4 -3
  305. package/src/generated/pdas/mintAuthority.ts +8 -4
  306. package/src/generated/pdas/treeConfig.ts +8 -4
  307. package/src/generated/pdas/voucher.ts +4 -3
  308. package/src/generated/programs/bubblegum.ts +146 -144
  309. package/src/generated/programs/mplTokenMetadata.ts +5 -10
  310. package/src/generated/types/assetDataSchema.ts +14 -8
  311. package/src/generated/types/bubblegumEventType.ts +13 -7
  312. package/src/generated/types/collection.ts +13 -8
  313. package/src/generated/types/creator.ts +11 -10
  314. package/src/generated/types/decompressibleState.ts +14 -7
  315. package/src/generated/types/instructionName.ts +46 -40
  316. package/src/generated/types/leafSchema.ts +59 -22
  317. package/src/generated/types/metadataArgs.ts +35 -27
  318. package/src/generated/types/metadataArgsV2.ts +23 -20
  319. package/src/generated/types/tokenProgramVersion.ts +10 -7
  320. package/src/generated/types/tokenStandard.ts +16 -9
  321. package/src/generated/types/updateArgs.ts +36 -15
  322. package/src/generated/types/useMethod.ts +11 -8
  323. package/src/generated/types/uses.ts +24 -11
  324. package/src/generated/types/version.ts +14 -7
@@ -6,20 +6,6 @@
6
6
  * @see https://github.com/codama-idl/codama
7
7
  */
8
8
 
9
- import type {
10
- AccountMeta,
11
- Address,
12
- FixedSizeCodec,
13
- FixedSizeDecoder,
14
- FixedSizeEncoder,
15
- Instruction,
16
- InstructionWithAccounts,
17
- InstructionWithData,
18
- ReadonlyAccount,
19
- ReadonlyUint8Array,
20
- WritableAccount,
21
- } from "@solana/kit";
22
- import type { ResolvedInstructionAccount } from "@solana/program-client-core";
23
9
  import {
24
10
  combineCodec,
25
11
  fixDecoderSize,
@@ -30,19 +16,31 @@ import {
30
16
  getBytesEncoder,
31
17
  getStructDecoder,
32
18
  getStructEncoder,
33
- getU8Decoder,
34
- getU8Encoder,
35
19
  getU32Decoder,
36
20
  getU32Encoder,
37
21
  getU64Decoder,
38
22
  getU64Encoder,
23
+ getU8Decoder,
24
+ getU8Encoder,
39
25
  SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
40
26
  SolanaError,
41
27
  transformEncoder,
28
+ type AccountMeta,
29
+ type Address,
30
+ type FixedSizeCodec,
31
+ type FixedSizeDecoder,
32
+ type FixedSizeEncoder,
33
+ type Instruction,
34
+ type InstructionWithAccounts,
35
+ type InstructionWithData,
36
+ type ReadonlyAccount,
37
+ type ReadonlyUint8Array,
38
+ type WritableAccount,
42
39
  } from "@solana/kit";
43
40
  import {
44
41
  getAccountMetaFactory,
45
42
  getAddressFromResolvedInstructionAccount,
43
+ type ResolvedInstructionAccount,
46
44
  } from "@solana/program-client-core";
47
45
  import { findTreeConfigPda } from "../pdas/index.js";
48
46
  import { BUBBLEGUM_PROGRAM_ADDRESS } from "../programs/index.js";
@@ -97,22 +95,64 @@ export type BurnInstruction<
97
95
  ]
98
96
  >;
99
97
 
100
- export interface BurnInstructionData {
98
+ export type BurnInstructionData = {
101
99
  discriminator: ReadonlyUint8Array;
102
- root: number[];
103
- dataHash: number[];
104
- creatorHash: number[];
100
+ /**
101
+ * Current Merkle root of the tree, used together with the Merkle proof
102
+ * (passed as remaining accounts) to verify the leaf being operated on.
103
+ */
104
+ root: Array<number>;
105
+ /**
106
+ * Keccak256 hash of the leaf's metadata, used together with `root` to
107
+ * verify the leaf before it is modified.
108
+ */
109
+ dataHash: Array<number>;
110
+ /**
111
+ * Keccak256 hash of the leaf's creators array, used together with
112
+ * `root` to verify the leaf before it is modified.
113
+ */
114
+ creatorHash: Array<number>;
115
+ /**
116
+ * Tree-scoped nonce identifying the leaf, equal to the tree's
117
+ * `numMinted` at the time the leaf was minted. Combined with the tree
118
+ * address to derive the leaf's asset id.
119
+ */
105
120
  nonce: bigint;
121
+ /**
122
+ * Position of the leaf within the Merkle tree, used with the Merkle
123
+ * proof to locate and verify the leaf.
124
+ */
106
125
  index: number;
107
- }
126
+ };
108
127
 
109
- export interface BurnInstructionDataArgs {
110
- root: number[];
111
- dataHash: number[];
112
- creatorHash: number[];
128
+ export type BurnInstructionDataArgs = {
129
+ /**
130
+ * Current Merkle root of the tree, used together with the Merkle proof
131
+ * (passed as remaining accounts) to verify the leaf being operated on.
132
+ */
133
+ root: Array<number>;
134
+ /**
135
+ * Keccak256 hash of the leaf's metadata, used together with `root` to
136
+ * verify the leaf before it is modified.
137
+ */
138
+ dataHash: Array<number>;
139
+ /**
140
+ * Keccak256 hash of the leaf's creators array, used together with
141
+ * `root` to verify the leaf before it is modified.
142
+ */
143
+ creatorHash: Array<number>;
144
+ /**
145
+ * Tree-scoped nonce identifying the leaf, equal to the tree's
146
+ * `numMinted` at the time the leaf was minted. Combined with the tree
147
+ * address to derive the leaf's asset id.
148
+ */
113
149
  nonce: number | bigint;
150
+ /**
151
+ * Position of the leaf within the Merkle tree, used with the Merkle
152
+ * proof to locate and verify the leaf.
153
+ */
114
154
  index: number;
115
- }
155
+ };
116
156
 
117
157
  export function getBurnInstructionDataEncoder(): FixedSizeEncoder<BurnInstructionDataArgs> {
118
158
  return transformEncoder(
@@ -149,7 +189,7 @@ export function getBurnInstructionDataCodec(): FixedSizeCodec<
149
189
  );
150
190
  }
151
191
 
152
- export interface BurnAsyncInput<
192
+ export type BurnAsyncInput<
153
193
  TAccountTreeAuthority extends string = string,
154
194
  TAccountLeafOwner extends string = string,
155
195
  TAccountLeafDelegate extends string = string,
@@ -157,21 +197,51 @@ export interface BurnAsyncInput<
157
197
  TAccountLogWrapper extends string = string,
158
198
  TAccountCompressionProgram extends string = string,
159
199
  TAccountSystemProgram extends string = string,
160
- > {
200
+ > = {
201
+ /**
202
+ * The tree's `TreeConfig` PDA, which stores its configuration and acts
203
+ * as the tree's authority for CPIs into the compression program.
204
+ */
161
205
  treeAuthority?: Address<TAccountTreeAuthority>;
206
+ /** Owner of the compressed NFT leaf being operated on. */
162
207
  leafOwner: Address<TAccountLeafOwner>;
208
+ /**
209
+ * Delegate authority for the leaf; defaults to the leaf owner when no
210
+ * delegate is set.
211
+ */
163
212
  leafDelegate: Address<TAccountLeafDelegate>;
213
+ /**
214
+ * The concurrent Merkle tree account storing the compressed leaves,
215
+ * owned by the account compression program.
216
+ */
164
217
  merkleTree: Address<TAccountMerkleTree>;
218
+ /**
219
+ * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
220
+ * can reconstruct the tree.
221
+ */
165
222
  logWrapper?: Address<TAccountLogWrapper>;
223
+ /**
224
+ * The SPL/MPL Account Compression program that owns and manages the
225
+ * Merkle tree.
226
+ */
166
227
  compressionProgram?: Address<TAccountCompressionProgram>;
228
+ /** The Solana System program. */
167
229
  systemProgram?: Address<TAccountSystemProgram>;
168
230
  root: BurnInstructionDataArgs["root"];
169
231
  dataHash: BurnInstructionDataArgs["dataHash"];
170
232
  creatorHash: BurnInstructionDataArgs["creatorHash"];
171
233
  nonce: BurnInstructionDataArgs["nonce"];
172
234
  index: BurnInstructionDataArgs["index"];
173
- }
235
+ };
174
236
 
237
+ /**
238
+ * Burns a compressed NFT leaf, permanently removing it from the tree.
239
+ *
240
+ * The caller must be the leaf owner or delegate. The leaf's current state
241
+ * (root, dataHash, creatorHash, nonce, index) plus a Merkle proof passed
242
+ * as remaining accounts are required to prove the leaf exists before it
243
+ * is replaced with an empty node.
244
+ */
175
245
  export async function getBurnInstructionAsync<
176
246
  TAccountTreeAuthority extends string,
177
247
  TAccountLeafOwner extends string,
@@ -277,7 +347,7 @@ export async function getBurnInstructionAsync<
277
347
  >);
278
348
  }
279
349
 
280
- export interface BurnInput<
350
+ export type BurnInput<
281
351
  TAccountTreeAuthority extends string = string,
282
352
  TAccountLeafOwner extends string = string,
283
353
  TAccountLeafDelegate extends string = string,
@@ -285,21 +355,51 @@ export interface BurnInput<
285
355
  TAccountLogWrapper extends string = string,
286
356
  TAccountCompressionProgram extends string = string,
287
357
  TAccountSystemProgram extends string = string,
288
- > {
358
+ > = {
359
+ /**
360
+ * The tree's `TreeConfig` PDA, which stores its configuration and acts
361
+ * as the tree's authority for CPIs into the compression program.
362
+ */
289
363
  treeAuthority: Address<TAccountTreeAuthority>;
364
+ /** Owner of the compressed NFT leaf being operated on. */
290
365
  leafOwner: Address<TAccountLeafOwner>;
366
+ /**
367
+ * Delegate authority for the leaf; defaults to the leaf owner when no
368
+ * delegate is set.
369
+ */
291
370
  leafDelegate: Address<TAccountLeafDelegate>;
371
+ /**
372
+ * The concurrent Merkle tree account storing the compressed leaves,
373
+ * owned by the account compression program.
374
+ */
292
375
  merkleTree: Address<TAccountMerkleTree>;
376
+ /**
377
+ * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
378
+ * can reconstruct the tree.
379
+ */
293
380
  logWrapper?: Address<TAccountLogWrapper>;
381
+ /**
382
+ * The SPL/MPL Account Compression program that owns and manages the
383
+ * Merkle tree.
384
+ */
294
385
  compressionProgram?: Address<TAccountCompressionProgram>;
386
+ /** The Solana System program. */
295
387
  systemProgram?: Address<TAccountSystemProgram>;
296
388
  root: BurnInstructionDataArgs["root"];
297
389
  dataHash: BurnInstructionDataArgs["dataHash"];
298
390
  creatorHash: BurnInstructionDataArgs["creatorHash"];
299
391
  nonce: BurnInstructionDataArgs["nonce"];
300
392
  index: BurnInstructionDataArgs["index"];
301
- }
393
+ };
302
394
 
395
+ /**
396
+ * Burns a compressed NFT leaf, permanently removing it from the tree.
397
+ *
398
+ * The caller must be the leaf owner or delegate. The leaf's current state
399
+ * (root, dataHash, creatorHash, nonce, index) plus a Merkle proof passed
400
+ * as remaining accounts are required to prove the leaf exists before it
401
+ * is replaced with an empty node.
402
+ */
303
403
  export function getBurnInstruction<
304
404
  TAccountTreeAuthority extends string,
305
405
  TAccountLeafOwner extends string,
@@ -395,22 +495,44 @@ export function getBurnInstruction<
395
495
  >);
396
496
  }
397
497
 
398
- export interface ParsedBurnInstruction<
498
+ export type ParsedBurnInstruction<
399
499
  TProgram extends string = typeof BUBBLEGUM_PROGRAM_ADDRESS,
400
500
  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
401
- > {
501
+ > = {
402
502
  programAddress: Address<TProgram>;
403
503
  accounts: {
504
+ /**
505
+ * The tree's `TreeConfig` PDA, which stores its configuration and acts
506
+ * as the tree's authority for CPIs into the compression program.
507
+ */
404
508
  treeAuthority: TAccountMetas[0];
509
+ /** Owner of the compressed NFT leaf being operated on. */
405
510
  leafOwner: TAccountMetas[1];
511
+ /**
512
+ * Delegate authority for the leaf; defaults to the leaf owner when no
513
+ * delegate is set.
514
+ */
406
515
  leafDelegate: TAccountMetas[2];
516
+ /**
517
+ * The concurrent Merkle tree account storing the compressed leaves,
518
+ * owned by the account compression program.
519
+ */
407
520
  merkleTree: TAccountMetas[3];
521
+ /**
522
+ * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
523
+ * can reconstruct the tree.
524
+ */
408
525
  logWrapper: TAccountMetas[4];
526
+ /**
527
+ * The SPL/MPL Account Compression program that owns and manages the
528
+ * Merkle tree.
529
+ */
409
530
  compressionProgram: TAccountMetas[5];
531
+ /** The Solana System program. */
410
532
  systemProgram: TAccountMetas[6];
411
533
  };
412
534
  data: BurnInstructionData;
413
- }
535
+ };
414
536
 
415
537
  export function parseBurnInstruction<
416
538
  TProgram extends string,
@@ -6,26 +6,6 @@
6
6
  * @see https://github.com/codama-idl/codama
7
7
  */
8
8
 
9
- import type {
10
- AccountMeta,
11
- AccountSignerMeta,
12
- Address,
13
- Codec,
14
- Decoder,
15
- Encoder,
16
- Instruction,
17
- InstructionWithAccounts,
18
- InstructionWithData,
19
- Option,
20
- OptionOrNullable,
21
- ReadonlyAccount,
22
- ReadonlySignerAccount,
23
- ReadonlyUint8Array,
24
- TransactionSigner,
25
- WritableAccount,
26
- WritableSignerAccount,
27
- } from "@solana/kit";
28
- import type { ResolvedInstructionAccount } from "@solana/program-client-core";
29
9
  import {
30
10
  combineCodec,
31
11
  fixDecoderSize,
@@ -38,19 +18,37 @@ import {
38
18
  getOptionEncoder,
39
19
  getStructDecoder,
40
20
  getStructEncoder,
41
- getU8Decoder,
42
- getU8Encoder,
43
21
  getU32Decoder,
44
22
  getU32Encoder,
45
23
  getU64Decoder,
46
24
  getU64Encoder,
25
+ getU8Decoder,
26
+ getU8Encoder,
47
27
  SOLANA_ERROR__PROGRAM_CLIENTS__INSUFFICIENT_ACCOUNT_METAS,
48
28
  SolanaError,
49
29
  transformEncoder,
30
+ type AccountMeta,
31
+ type AccountSignerMeta,
32
+ type Address,
33
+ type Codec,
34
+ type Decoder,
35
+ type Encoder,
36
+ type Instruction,
37
+ type InstructionWithAccounts,
38
+ type InstructionWithData,
39
+ type Option,
40
+ type OptionOrNullable,
41
+ type ReadonlyAccount,
42
+ type ReadonlySignerAccount,
43
+ type ReadonlyUint8Array,
44
+ type TransactionSigner,
45
+ type WritableAccount,
46
+ type WritableSignerAccount,
50
47
  } from "@solana/kit";
51
48
  import {
52
49
  getAccountMetaFactory,
53
50
  getAddressFromResolvedInstructionAccount,
51
+ type ResolvedInstructionAccount,
54
52
  } from "@solana/program-client-core";
55
53
  import { findTreeConfigPda } from "../pdas/index.js";
56
54
  import { BUBBLEGUM_PROGRAM_ADDRESS } from "../programs/index.js";
@@ -128,26 +126,84 @@ export type BurnV2Instruction<
128
126
  ]
129
127
  >;
130
128
 
131
- export interface BurnV2InstructionData {
129
+ export type BurnV2InstructionData = {
132
130
  discriminator: ReadonlyUint8Array;
133
- root: number[];
134
- dataHash: number[];
135
- creatorHash: number[];
136
- assetDataHash: Option<number[]>;
131
+ /**
132
+ * Current Merkle root of the tree, used together with the Merkle proof
133
+ * (passed as remaining accounts) to verify the leaf being operated on.
134
+ */
135
+ root: Array<number>;
136
+ /**
137
+ * Keccak256 hash of the leaf's metadata, used together with `root` to
138
+ * verify the leaf before it is modified.
139
+ */
140
+ dataHash: Array<number>;
141
+ /**
142
+ * Keccak256 hash of the leaf's creators array, used together with
143
+ * `root` to verify the leaf before it is modified.
144
+ */
145
+ creatorHash: Array<number>;
146
+ /**
147
+ * Expected current `assetDataHash` of the `LeafSchema` V2 leaf, if any,
148
+ * carried through unchanged by this instruction.
149
+ */
150
+ assetDataHash: Option<Array<number>>;
151
+ /**
152
+ * Expected current status flags (e.g. frozen, non-transferable) of the
153
+ * `LeafSchema` V2 leaf, verified before this instruction updates them.
154
+ */
137
155
  flags: Option<number>;
156
+ /**
157
+ * Tree-scoped nonce identifying the leaf, equal to the tree's
158
+ * `numMinted` at the time the leaf was minted. Combined with the tree
159
+ * address to derive the leaf's asset id.
160
+ */
138
161
  nonce: bigint;
162
+ /**
163
+ * Position of the leaf within the Merkle tree, used with the Merkle
164
+ * proof to locate and verify the leaf.
165
+ */
139
166
  index: number;
140
- }
167
+ };
141
168
 
142
- export interface BurnV2InstructionDataArgs {
143
- root: number[];
144
- dataHash: number[];
145
- creatorHash: number[];
146
- assetDataHash: OptionOrNullable<number[]>;
169
+ export type BurnV2InstructionDataArgs = {
170
+ /**
171
+ * Current Merkle root of the tree, used together with the Merkle proof
172
+ * (passed as remaining accounts) to verify the leaf being operated on.
173
+ */
174
+ root: Array<number>;
175
+ /**
176
+ * Keccak256 hash of the leaf's metadata, used together with `root` to
177
+ * verify the leaf before it is modified.
178
+ */
179
+ dataHash: Array<number>;
180
+ /**
181
+ * Keccak256 hash of the leaf's creators array, used together with
182
+ * `root` to verify the leaf before it is modified.
183
+ */
184
+ creatorHash: Array<number>;
185
+ /**
186
+ * Expected current `assetDataHash` of the `LeafSchema` V2 leaf, if any,
187
+ * carried through unchanged by this instruction.
188
+ */
189
+ assetDataHash: OptionOrNullable<Array<number>>;
190
+ /**
191
+ * Expected current status flags (e.g. frozen, non-transferable) of the
192
+ * `LeafSchema` V2 leaf, verified before this instruction updates them.
193
+ */
147
194
  flags: OptionOrNullable<number>;
195
+ /**
196
+ * Tree-scoped nonce identifying the leaf, equal to the tree's
197
+ * `numMinted` at the time the leaf was minted. Combined with the tree
198
+ * address to derive the leaf's asset id.
199
+ */
148
200
  nonce: number | bigint;
201
+ /**
202
+ * Position of the leaf within the Merkle tree, used with the Merkle
203
+ * proof to locate and verify the leaf.
204
+ */
149
205
  index: number;
150
- }
206
+ };
151
207
 
152
208
  export function getBurnV2InstructionDataEncoder(): Encoder<BurnV2InstructionDataArgs> {
153
209
  return transformEncoder(
@@ -194,7 +250,7 @@ export function getBurnV2InstructionDataCodec(): Codec<
194
250
  );
195
251
  }
196
252
 
197
- export interface BurnV2AsyncInput<
253
+ export type BurnV2AsyncInput<
198
254
  TAccountTreeAuthority extends string = string,
199
255
  TAccountPayer extends string = string,
200
256
  TAccountAuthority extends string = string,
@@ -207,23 +263,48 @@ export interface BurnV2AsyncInput<
207
263
  TAccountCompressionProgram extends string = string,
208
264
  TAccountMplCoreProgram extends string = string,
209
265
  TAccountSystemProgram extends string = string,
210
- > {
266
+ > = {
267
+ /**
268
+ * The tree's `TreeConfig` PDA, which stores its configuration and acts
269
+ * as the tree's authority for CPIs into the compression program.
270
+ */
211
271
  treeAuthority?: Address<TAccountTreeAuthority>;
272
+ /** Account that pays for the transaction and any account rent. */
212
273
  payer: TransactionSigner<TAccountPayer>;
213
274
  /**
214
- * Optional authority, defaults to `payer`. Must be either
215
- * the leaf owner or collection collection permanent burn delegate.
275
+ * Optional authority, defaults to `payer`. Must be either the leaf
276
+ * owner or a permanent burn delegate plugin on the collection.
216
277
  */
217
278
  authority?: TransactionSigner<TAccountAuthority>;
279
+ /** Owner of the compressed NFT leaf being operated on. */
218
280
  leafOwner: Address<TAccountLeafOwner>;
219
- /** Defaults to `leaf_owner` */
281
+ /** Defaults to `leafOwner`. */
220
282
  leafDelegate?: Address<TAccountLeafDelegate>;
283
+ /**
284
+ * The concurrent Merkle tree account storing the compressed leaves,
285
+ * owned by the account compression program.
286
+ */
221
287
  merkleTree: Address<TAccountMerkleTree>;
288
+ /** MPL Core collection account the asset belongs to (V2 collections). */
222
289
  coreCollection?: Address<TAccountCoreCollection>;
290
+ /**
291
+ * PDA Bubblegum uses to sign CPIs into the MPL Core program on behalf
292
+ * of a core collection.
293
+ */
223
294
  mplCoreCpiSigner?: Address<TAccountMplCoreCpiSigner>;
295
+ /**
296
+ * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
297
+ * can reconstruct the tree.
298
+ */
224
299
  logWrapper?: Address<TAccountLogWrapper>;
300
+ /**
301
+ * The SPL/MPL Account Compression program that owns and manages the
302
+ * Merkle tree.
303
+ */
225
304
  compressionProgram?: Address<TAccountCompressionProgram>;
305
+ /** The MPL Core program, invoked for V2 collection CPIs. */
226
306
  mplCoreProgram?: Address<TAccountMplCoreProgram>;
307
+ /** The Solana System program. */
227
308
  systemProgram?: Address<TAccountSystemProgram>;
228
309
  root: BurnV2InstructionDataArgs["root"];
229
310
  dataHash: BurnV2InstructionDataArgs["dataHash"];
@@ -232,8 +313,15 @@ export interface BurnV2AsyncInput<
232
313
  flags: BurnV2InstructionDataArgs["flags"];
233
314
  nonce: BurnV2InstructionDataArgs["nonce"];
234
315
  index: BurnV2InstructionDataArgs["index"];
235
- }
316
+ };
236
317
 
318
+ /**
319
+ * Burns a `LeafSchema` V2 leaf node from the tree.
320
+ *
321
+ * Like `burn`, but for V2 trees created with `createTreeV2`. The signing
322
+ * authority may be the leaf owner or, if the asset belongs to an MPL Core
323
+ * collection, a permanent burn delegate plugin on that collection.
324
+ */
237
325
  export async function getBurnV2InstructionAsync<
238
326
  TAccountTreeAuthority extends string,
239
327
  TAccountPayer extends string,
@@ -382,7 +470,7 @@ export async function getBurnV2InstructionAsync<
382
470
  >);
383
471
  }
384
472
 
385
- export interface BurnV2Input<
473
+ export type BurnV2Input<
386
474
  TAccountTreeAuthority extends string = string,
387
475
  TAccountPayer extends string = string,
388
476
  TAccountAuthority extends string = string,
@@ -395,23 +483,48 @@ export interface BurnV2Input<
395
483
  TAccountCompressionProgram extends string = string,
396
484
  TAccountMplCoreProgram extends string = string,
397
485
  TAccountSystemProgram extends string = string,
398
- > {
486
+ > = {
487
+ /**
488
+ * The tree's `TreeConfig` PDA, which stores its configuration and acts
489
+ * as the tree's authority for CPIs into the compression program.
490
+ */
399
491
  treeAuthority: Address<TAccountTreeAuthority>;
492
+ /** Account that pays for the transaction and any account rent. */
400
493
  payer: TransactionSigner<TAccountPayer>;
401
494
  /**
402
- * Optional authority, defaults to `payer`. Must be either
403
- * the leaf owner or collection collection permanent burn delegate.
495
+ * Optional authority, defaults to `payer`. Must be either the leaf
496
+ * owner or a permanent burn delegate plugin on the collection.
404
497
  */
405
498
  authority?: TransactionSigner<TAccountAuthority>;
499
+ /** Owner of the compressed NFT leaf being operated on. */
406
500
  leafOwner: Address<TAccountLeafOwner>;
407
- /** Defaults to `leaf_owner` */
501
+ /** Defaults to `leafOwner`. */
408
502
  leafDelegate?: Address<TAccountLeafDelegate>;
503
+ /**
504
+ * The concurrent Merkle tree account storing the compressed leaves,
505
+ * owned by the account compression program.
506
+ */
409
507
  merkleTree: Address<TAccountMerkleTree>;
508
+ /** MPL Core collection account the asset belongs to (V2 collections). */
410
509
  coreCollection?: Address<TAccountCoreCollection>;
510
+ /**
511
+ * PDA Bubblegum uses to sign CPIs into the MPL Core program on behalf
512
+ * of a core collection.
513
+ */
411
514
  mplCoreCpiSigner?: Address<TAccountMplCoreCpiSigner>;
515
+ /**
516
+ * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
517
+ * can reconstruct the tree.
518
+ */
412
519
  logWrapper?: Address<TAccountLogWrapper>;
520
+ /**
521
+ * The SPL/MPL Account Compression program that owns and manages the
522
+ * Merkle tree.
523
+ */
413
524
  compressionProgram?: Address<TAccountCompressionProgram>;
525
+ /** The MPL Core program, invoked for V2 collection CPIs. */
414
526
  mplCoreProgram?: Address<TAccountMplCoreProgram>;
527
+ /** The Solana System program. */
415
528
  systemProgram?: Address<TAccountSystemProgram>;
416
529
  root: BurnV2InstructionDataArgs["root"];
417
530
  dataHash: BurnV2InstructionDataArgs["dataHash"];
@@ -420,8 +533,15 @@ export interface BurnV2Input<
420
533
  flags: BurnV2InstructionDataArgs["flags"];
421
534
  nonce: BurnV2InstructionDataArgs["nonce"];
422
535
  index: BurnV2InstructionDataArgs["index"];
423
- }
536
+ };
424
537
 
538
+ /**
539
+ * Burns a `LeafSchema` V2 leaf node from the tree.
540
+ *
541
+ * Like `burn`, but for V2 trees created with `createTreeV2`. The signing
542
+ * authority may be the leaf owner or, if the asset belongs to an MPL Core
543
+ * collection, a permanent burn delegate plugin on that collection.
544
+ */
425
545
  export function getBurnV2Instruction<
426
546
  TAccountTreeAuthority extends string,
427
547
  TAccountPayer extends string,
@@ -560,32 +680,57 @@ export function getBurnV2Instruction<
560
680
  >);
561
681
  }
562
682
 
563
- export interface ParsedBurnV2Instruction<
683
+ export type ParsedBurnV2Instruction<
564
684
  TProgram extends string = typeof BUBBLEGUM_PROGRAM_ADDRESS,
565
685
  TAccountMetas extends readonly AccountMeta[] = readonly AccountMeta[],
566
- > {
686
+ > = {
567
687
  programAddress: Address<TProgram>;
568
688
  accounts: {
689
+ /**
690
+ * The tree's `TreeConfig` PDA, which stores its configuration and acts
691
+ * as the tree's authority for CPIs into the compression program.
692
+ */
569
693
  treeAuthority: TAccountMetas[0];
694
+ /** Account that pays for the transaction and any account rent. */
570
695
  payer: TAccountMetas[1];
571
696
  /**
572
- * Optional authority, defaults to `payer`. Must be either
573
- * the leaf owner or collection collection permanent burn delegate.
697
+ * Optional authority, defaults to `payer`. Must be either the leaf
698
+ * owner or a permanent burn delegate plugin on the collection.
574
699
  */
575
700
  authority?: TAccountMetas[2] | undefined;
701
+ /** Owner of the compressed NFT leaf being operated on. */
576
702
  leafOwner: TAccountMetas[3];
577
- /** Defaults to `leaf_owner` */
703
+ /** Defaults to `leafOwner`. */
578
704
  leafDelegate?: TAccountMetas[4] | undefined;
705
+ /**
706
+ * The concurrent Merkle tree account storing the compressed leaves,
707
+ * owned by the account compression program.
708
+ */
579
709
  merkleTree: TAccountMetas[5];
710
+ /** MPL Core collection account the asset belongs to (V2 collections). */
580
711
  coreCollection?: TAccountMetas[6] | undefined;
712
+ /**
713
+ * PDA Bubblegum uses to sign CPIs into the MPL Core program on behalf
714
+ * of a core collection.
715
+ */
581
716
  mplCoreCpiSigner?: TAccountMetas[7] | undefined;
717
+ /**
718
+ * The SPL/MPL Noop program, used to log leaf data so off-chain indexers
719
+ * can reconstruct the tree.
720
+ */
582
721
  logWrapper: TAccountMetas[8];
722
+ /**
723
+ * The SPL/MPL Account Compression program that owns and manages the
724
+ * Merkle tree.
725
+ */
583
726
  compressionProgram: TAccountMetas[9];
727
+ /** The MPL Core program, invoked for V2 collection CPIs. */
584
728
  mplCoreProgram: TAccountMetas[10];
729
+ /** The Solana System program. */
585
730
  systemProgram: TAccountMetas[11];
586
731
  };
587
732
  data: BurnV2InstructionData;
588
- }
733
+ };
589
734
 
590
735
  export function parseBurnV2Instruction<
591
736
  TProgram extends string,