Program to attach additional data to Fungible or Non-Fungible tokens on Solana. It achieves this using Program Derived Addresses (PDAs) that are derived from the address of Mint accounts.

The packages below can be use to interact with Token Metadata program.

npm install @metaplex-foundation/mpl-token-metadata@alpha

See typedoc documentation.

cargo add mpl-token-metadata

See crate documentation.

From the root directory of the repository:

• Install the required packges:

pnpm install

• Build the program:

pnpm programs:build

This will create the program binary at <ROOT>/programs/.bin

Token Metadata includes two set of tests: BPF and TypeScript.

From the root directory of the repository:

pnpm programs:test

From the root directory of the repository:

pnpm validator

This will start a local validator using Amman.

After starting the validator, go to the folder <ROOT>/clients/js and run:

pnpm install

This will install the required packages for the tests. Then, run:

pnpm build && pnpm test

Full documentation for Token Metadata can be found here.

To report a security issue, please follow the guidance on our bug bounty program page.

The Rust/Cargo programs are licensed under the "Apache-style" Metaplex(TM) NFT Open Source License and the JS/TS client libraries are licensed under either the MIT or the Apache licenses.