Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@solana/spl-token-metadata

solana-labs1.4mApache-2.00.1.6TypeScript support: included

SPL Token Metadata Interface JS API

readme

@solana/spl-token-metadata

A TypeScript interface describing the instructions required for a program to implement to be considered a "token-metadata" program for SPL token mints. The interface can be implemented by any program.

FAQs

How can I get support?

Please ask questions in the Solana Stack Exchange: https://solana.stackexchange.com/

If you've found a bug or you'd like to request a feature, please open an issue.

Install

npm install --save @solana/spl-token-metadata @solana/web3.js

OR

yarn add @solana/spl-token-metadata @solana/web3.js

Build from Source

  1. Prerequisites

  2. Node 16+

  3. NPM 8+

  4. Clone the project:

    git clone https://github.com/solana-labs/solana-program-library.git
  5. Navigate to the library:

    cd solana-program-library/token-metadata/js
  6. Install the dependencies:

    npm install
  7. Build the library:

    npm run build
  8. Build the on-chain programs:

    npm run test:build-programs