hopper-metaplex 0.2.1

Hopper-owned Metaplex Token Metadata program builders, PDA helpers, and account read helpers. Powers the metadata::* / master_edition::* field keywords on #[derive(Accounts)] and #[hopper::context].
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# hopper-metaplex


Hopper-owned Metaplex Token Metadata builders, PDA helpers, and a stack-buffer
Borsh encoder. Powers the `metadata::*` / `master_edition::*` field keywords on
`#[derive(Accounts)]` contexts and the
[`hopper-nft-mint`](../../examples/hopper-nft-mint/src/lib.rs) reference
program. The lower-level `#[hopper::context]` spelling remains supported for
older migration code.

[![Crates.io](https://img.shields.io/crates/v/hopper-metaplex.svg)](https://crates.io/crates/hopper-metaplex)
[![Docs.rs](https://img.shields.io/docsrs/hopper-metaplex)](https://docs.rs/crate/hopper-metaplex/0.2.1)

Part of the **[Hopper](https://hopperzero.dev)** framework.

## When to reach for this


Anything that mints, updates, or reads NFT metadata on Solana through the
Metaplex Token Metadata program. The crate ships the three calls every NFT
program reaches for:

- `CreateMetadataAccountV3` - initialise the metadata PDA for a mint.
- `CreateMasterEditionV3` - lock a mint as a master edition (set
  `max_supply = Some(0)` for a 1-of-1 NFT).
- `UpdateMetadataAccountV2` - mutate an existing metadata account.

Each builder uses a stack buffer to encode the Borsh payload. No heap, no
`Vec`, no `alloc::String`. Buffer overflow returns
`ProgramError::InvalidInstructionData` so a malicious oversized name can't
push the program into UB.

## Quick start


```toml
[dependencies]
hopper = { package = "hopper-lang", version = "0.2.1", features = ["metaplex"] }
```

```rust
use hopper::prelude::*;

CreateMetadataAccountV3 {
    metadata,
    mint,
    mint_authority: authority,
    payer: authority,
    update_authority: authority,
    system_program,
    rent: None,
    data: DataV2::simple("Boobies #001", "BOOB", "https://...", 500),
    is_mutable: true,
}
.invoke()?;

CreateMasterEditionV3 {
    edition: master_edition,
    mint,
    update_authority: authority,
    mint_authority: authority,
    payer: authority,
    metadata,
    token_program,
    system_program,
    rent: None,
    max_supply: Some(0), // 1-of-1 NFT
}
.invoke()?;
```

PDA helpers:

```rust
let (metadata, _bump) = hopper_metaplex::metadata_pda(&mint_address);
let (master_edition, _) = hopper_metaplex::master_edition_pda(&mint_address);
```

## Optional, opt-in


The crate is gated behind the `metaplex` feature on the root `hopper` crate.
Programs that don't touch Metaplex get no extra compile time and no extra
dependencies pulled in. Enable with:

```toml
hopper = { package = "hopper-lang", version = "0.2.1", features = ["metaplex"] }
```

## What's not (yet) shipped


- Bubblegum compressed NFTs.
- pNFT (programmable NFT) lifecycle.
- Edition prints (`MintNewEditionFromMasterEditionViaToken`).
- Collection verification (`VerifyCollection`, `SetAndVerifyCollection`).

Each of these is mechanical given the existing `BorshTape` encoder. Open an
issue if you want one prioritised.

Docs: <https://docs.rs/crate/hopper-metaplex/0.2.1>

## Support


Public-goods support and donations can be sent to `solanadevdao.sol` /
`F42ZovBoRJZU4av5MiESVwJWnEx8ZQVFkc1RM29zMxNT`.

## License


Apache-2.0. See [LICENSE](../../LICENSE).