MPL-Core Javascript SDK

Metaplex provides a JavaScript library that can be used to interact with the MPL-Core program. Thanks to the Umi Framework, it ships without many opinionated dependencies thus providing a lightweight library that can be used in any JavaScript project.

To get started, you'll need to install the Umi framework and the MPL-Core JavaScript library.

Installation

Installation can be executed with any of the JS package managers, npm, yarn, bun etc...

npm install @metaplex-foundation/mpl-core

Umi Setup

An umi instance is required to interact with the Metaplex Javascript SDKs. If you haven't set up and configured an umi instance yet then you can get checkout the Umi Getting Started page and configure your RPC endpoint and your umi identity/signer.

During the initialization of the umi instance you can add the mpl-core package to umi using

.use(mplCore())

You can add the mplCore() package anywhere in your umi instance creation with .use().

import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
import { mplCore } from '@metaplex-foundation/mpl-core'

// Use the RPC endpoint of your choice.
const umi = createUmi('http://api.devenet.solana.com')
... // additional umi settings, packages, and signers
.use(mplCore())

From here your umi instance will have access to the mpl-core package and you start to explore the mpl-core feature set.