# @solana/spl-token-metadata

> SPL Token Metadata Interface JS API

Latest version **0.1.6** (published 2024-10-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @solana/spl-token-metadata
pnpm add @solana/spl-token-metadata
yarn add @solana/spl-token-metadata
bun add @solana/spl-token-metadata
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2024-10-17 |
| First published | 2023-10-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16 |
| Dependencies | 1 |
| Unpacked size | 72.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4239 |
| Author | Solana Labs Maintainers |
| Maintainers | nickfrosty, mcintyre94, 2501babe, lorisleiva, buffalojoec, ngundotra, _chido, steveluscher, seanyoung, tyera, joncinque, ryoqun, trent-solana, jordansexton |

## Links

- npm: https://www.npmjs.com/package/@solana/spl-token-metadata
- Repository: https://github.com/solana-labs/solana-program-library
- Homepage: https://github.com/solana-labs/solana-program-library#readme
- Issues: https://github.com/solana-labs/solana-program-library/issues
- npm.io page: https://npm.io/package/@solana/spl-token-metadata

## Dependencies (1)

- [@solana/codecs](https://npm.io/package/@solana/codecs.md) 2.0.0-rc.1

## Recent versions

- 0.1.6 (latest) — 2024-10-17
- 0.1.5 — 2024-08-28
- 0.1.4 — 2024-04-19
- 0.1.3 — 2024-04-18
- 0.1.2 — 2023-12-09
- 0.1.1 — 2023-11-14
- 0.1.0 — 2023-10-24
- 0.0.1 — 2023-10-24

## 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.

## Links

- [TypeScript Docs](https://solana-labs.github.io/solana-program-library/token-metadata/js/)
- [FAQs (Frequently Asked Questions)](#faqs)
- [Install](#install)
- [Build from Source](#build-from-source)

## 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](https://github.com/solana-labs/solana-program-library/issues/new).

## Install

```shell
npm install --save @solana/spl-token-metadata @solana/web3.js
```
_OR_
```shell
yarn add @solana/spl-token-metadata @solana/web3.js
```

## Build from Source

0. Prerequisites

* Node 16+
* NPM 8+

1. Clone the project:
```shell
git clone https://github.com/solana-labs/solana-program-library.git
```

2. Navigate to the library:
```shell
cd solana-program-library/token-metadata/js
```

3. Install the dependencies:
```shell
npm install
```

4. Build the library:
```shell
npm run build
```

5. Build the on-chain programs:
```shell
npm run test:build-programs
```

---
_Source: https://npm.io/package/@solana/spl-token-metadata · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._