Metaplex Documentation

https://www.metaplex.com/docs
Admin
Metaplex Documentation provides guides, SDKs, and smart contract specifications for creating,...
Tokens:608,268
Snippets:6,796
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Launch the interactive setup wizard

Source: https://www.metaplex.com/docs/dev-tools/cli/genesis/create

Initiates a guided, interactive process for configuring the Genesis account.

```bash
mplx genesis create --wizard
```

--------------------------------

### Examples of Website Scaffolding

Source: https://www.metaplex.com/docs/dev-tools/cli/toolbox/scaffolding-website

These examples demonstrate both interactive template selection and direct cloning of a specified template. Ensure `git` is installed and accessible.

```bash
mplx toolbox template website
```

```bash
mplx toolbox template website --template "standard - nextjs-tailwind"
```

--------------------------------

### Initialize Umi with MPL-Hybrid

Source: https://www.metaplex.com/docs/smart-contracts/mpl-hybrid/sdk/javascript

Full setup example showing the import and registration of the mpl-hybrid plugin within a Umi instance.

```javascript
import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'

import { mplHybrid } from '@metaplex-foundation/mpl-hybrid'



// Use the RPC endpoint of your choice.

const umi = createUmi('http://api.devenet.solana.com')

... // additional umi settings and packages

.use(mplHybrid())
```

--------------------------------

### Amman Quick Setup

Source: https://www.metaplex.com/docs/solana/working-with-devnet-and-testnet

Installation and startup commands for the Amman local validator toolkit.

```bash
# Install

npm install -D @metaplex-foundation/amman



# Create config file .ammanrc.js

# Start

npx amman start
```

--------------------------------

### Clone and Setup Auction House CLI

Source: https://www.metaplex.com/docs/smart-contracts/auction-house/manage-using-cli

Initializes the repository and installs necessary dependencies for the CLI.

```bash
git clone https://github.com/metaplex-foundation/metaplex-program-library.git

cd auction-house/cli
```

```bash
cd js && yarn install && yarn bootstrap

cd src
```

--------------------------------

### Launchpool with Metadata and Allocations

Source: https://www.metaplex.com/docs/dev-tools/cli/genesis/launch

This example demonstrates a comprehensive launchpool setup including metadata (description, website, social links) and locked allocations specified in a JSON file.

```bash
mplx genesis launch create \
  --name "My Token" \
  --symbol "MTK" \
  --image "https://gateway.irys.xyz/abc123" \
  --description "A community token for builders" \
  --website "https://example.com" \
  --twitter "https://x.com/myproject" \
  --telegram "https://t.me/myproject" \
  --tokenAllocation 500000000 \
  --depositStartTime 2025-03-01T00:00:00Z \
  --raiseGoal 250 \
  --raydiumLiquidityBps 5000 \
  --fundsRecipient <WALLET_ADDRESS> \
  --lockedAllocations allocations.json
```

--------------------------------

### Fetch Asset Examples

Source: https://www.metaplex.com/docs/dev-tools/cli/core/fetch

Practical examples for fetching and downloading assets.

```bash
mplx core fetch asset 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa
```

```bash
mplx core fetch asset 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --download --output ./assets
```

```bash
mplx core fetch asset 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --download --image
```

--------------------------------

### Fetch Collection Examples

Source: https://www.metaplex.com/docs/dev-tools/cli/core/fetch

Practical examples for fetching and downloading collections.

```bash
mplx core fetch collection HaKyubAWuTS9AZkpUHtFkTKAHs1KKAJ3onZPmaP9zBpe
```

```bash
mplx core fetch collection HaKyubAWuTS9AZkpUHtFkTKAHs1KKAJ3onZPmaP9zBpe --output ./collections
```

--------------------------------

### Add Plugin Examples

Source: https://www.metaplex.com/docs/dev-tools/cli/core/plugins

Practical examples for adding plugins to assets and collections.

```bash
mplx core plugins add 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --wizard
```

```bash
mplx core plugins add 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --wizard --collection
```

```bash
mplx core plugins add 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa ./my-plugin.json
```

--------------------------------

### Usage Examples

Source: https://www.metaplex.com/docs/smart-contracts/genesis/integration-apis/get-launch

Implementation examples for fetching and accessing launch data.

```typescript
const response = await fetch(
  "https://api.metaplex.com/v1/launches/7nE9GvcwsqzYcPUYfm5gxzCKfmPqi68FM7gPaSfG6EQN"
);
const { data }: LaunchResponse = await response.json();
console.log(data.baseToken.name); // "My Token"
```

```rust
let response: LaunchResponse = reqwest::get(
    "https://api.metaplex.com/v1/launches/7nE9GvcwsqzYcPUYfm5gxzCKfmPqi68FM7gPaSfG6EQN"
)
.await?
.json()
.await?;

println!("{}", response.data.base_token.name); // "My Token"
```

--------------------------------

### Install @solana/kit Adapters

Source: https://www.metaplex.com/docs/dev-tools/umi/kit-adapters

Install the adapters package using npm.

```bash
npm i @metaplex-foundation/umi-kit-adapters
```

--------------------------------

### Update Plugin Examples

Source: https://www.metaplex.com/docs/dev-tools/cli/core/plugins

Practical examples for updating plugins on assets and collections.

```bash
mplx core plugins update 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --wizard
```

```bash
mplx core plugins update 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa --wizard --collection
```

```bash
mplx core plugins update 5avjMVza8SuMhgTfzEGNWJskDELMCQk9juAAc8zeQoNa ./updated-plugin.json
```

--------------------------------

### CLI Output Example

Source: https://www.metaplex.com/docs/dev-tools/cli/toolbox/update-token-metadata

Example output displayed after successfully updating token metadata.

```text
--------------------------------



    Token Update



--------------------------------

Fetching token data... ✓

Token data fetched: My Token

Uploading Image... ✓

Uploading JSON file... ✓

Updating Token... ✓

Update transaction sent and confirmed.

Token successfully updated!
```

--------------------------------

### Install Dependencies

Source: https://www.metaplex.com/docs/tokens/launch-token

Install the necessary Metaplex Foundation packages for token launching.

```bash
mkdir my-token-launch

cd my-token-launch

npm init -y

npm install @metaplex-foundation/genesis @metaplex-foundation/umi @metaplex-foundation/umi-bundle-defaults @metaplex-foundation/mpl-toolbox
```

--------------------------------

### Install Kit SDK

Source: https://www.metaplex.com/docs/smart-contracts/token-metadata/getting-started/kit

Install the required packages for the Kit SDK and Solana Kit.

```bash
npm install \
  @solana/kit \
  @metaplex-foundation/mpl-token-metadata-kit
```

--------------------------------

### Example: Upload Directory

Source: https://www.metaplex.com/docs/dev-tools/cli/toolbox/storage-upload

This example shows how to upload all files within an assets directory.

```bash
mplx toolbox storage upload ./assets --directory
```

--------------------------------

### Storage Fund Examples

Source: https://www.metaplex.com/docs/dev-tools/cli/toolbox/storage-fund

Examples demonstrating both fractional and whole-SOL deposits into the storage account.

```bash
mplx toolbox storage fund 0.1

mplx toolbox storage fund 1
```

--------------------------------

### Filled out CpiBuilder examples

Source: https://www.metaplex.com/docs/solana/rust/how-to-cpi-into-a-metaplex-program

Examples of fully configured TransferV1 and CreateV1 CpiBuilders.

```rust
TransferV1CpiBuilder::new()

        .asset(ctx.accounts.asset)

        .collection(context.accounts.collection)

        .payer(context.accounts.payer)

        .authority(context.accounts.authority)

        .new_owner(context.accounts.new_owner)

        .system_program(context.accounts.system_program)
```

```rust
CreateV1CpiBuilder::new()

        .asset(context.accounts.asset)

        .collection(context.accounts.collection)

        .authority(context.accounts.authority)

        .payer(context.accounts.payer)

        .owner(context.accounts.owner)

        .update_authority(context.accounts.update_authority)

        .system_program(context.accounts.system_program)

        .data_state(input.data_state.unwrap_or(DataState::AccountState))

        .name(args.asset_name)

        .uri(args.asset_uri)

        .plugins(args.plugins)
```

--------------------------------

### Install Required Packages

Source: https://www.metaplex.com/docs/smart-contracts/mpl-hybrid/guides/create-your-first-hybrid-collection

Install the necessary Metaplex Umi and MPL-Hybrid packages.

```bash
npm i @metaplex-foundation/umi
```

```bash
npm i @metaplex-foundation/umi-bundle-defaults
```

```bash
npm i @metaplex-foundation/mpl-core
```

```bash
npm i @metaplex-foundation/mpl-hybrid
```

```bash
npm i @metaplex-foundation/mpl-token-metadata
```

--------------------------------

### Install Dependencies

Source: https://www.metaplex.com/docs/smart-contracts/inscription/getting-started/js

Install the required Umi framework packages and the Metaplex Inscriptions library.

```bash
npm install \
  @metaplex-foundation/umi \
  @metaplex-foundation/umi-bundle-defaults \
  @solana/web3.js@1 \
  @metaplex-foundation/mpl-inscription
```

--------------------------------

### Install from Source

Source: https://www.metaplex.com/docs/dev-tools/cli/installation

Clone the repository and prepare the CLI for development use.

```bash
git clone https://github.com/metaplex-foundation/cli.git

cd cli
```

```bash
npm install
```

```bash
npm run build
```

```bash
npm link
```

--------------------------------

### Example Response Structure for Get Assets by Collection

Source: https://www.metaplex.com/docs/dev-tools/das-api/core-extension/methods/get-assets-by-collection

This is an example of the response when fetching assets for a collection. The array will contain multiple entries if the collection has more than one asset.

```json
[

  {

    publicKey: '8VrqN8b8Y7rqWsUXqUw7dxQw9J5UAoVyb6YDJs1mBCCz',

    header: {

      executable: false,

      owner: 'CoREENxT6tW1HoK8ypY1SxRMZTcVPm7R94rH4PZNhX7d',

      lamports: [Object],

      rentEpoch: 18446744073709551616n,

      exists: true

    },

    pluginHeader: { key: 3, pluginRegistryOffset: 179n },

    royalties: {

      authority: [Object],

      offset: 138n,

      basisPoints: 500,

      creators: [Array],

      ruleSet: [Object]

    },

    key: 1,

    updateAuthority: {

      type: 'Collection',

      address: 'FgEKkVTSfLQ7a7BFuApypy4KaTLh65oeNRn2jZ6fiBav'

    },

    name: 'Number 1',

    uri: 'https://arweave.net/TkklLLQKiO9t9_JPmt-eH_S-VBLMcRjFcgyvIrENBzA',

    content: {

      '$schema': 'https://schema.metaplex.com/nft1.0.json',

      json_uri: 'https://arweave.net/TkklLLQKiO9t9_JPmt-eH_S-VBLMcRjFcgyvIrENBzA',

      files: [Array],

      metadata: [Object],

      links: [Object]

    },

    owner: 'AUtnbwWJQfYZjJ5Mc6go9UancufcAuyqUZzR1jSe4esx',

    seq: { __option: 'None' }

  }

]

```

--------------------------------

### Get Grouping Umi Request

Source: https://www.metaplex.com/docs/dev-tools/das-api/methods/get-grouping

Example usage of the getGrouping method using the Umi framework.

```typescript
1import { publicKey } from '@metaplex-foundation/umi'
2import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
3import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'
4
5const umi = createUmi('https://api.devnet.solana.com').use(dasApi())
6
7const result = await umi.rpc.getGrouping({
8
9})
10console.log(result)
```

--------------------------------

### Create Tree Config V2 Builder Example

Source: https://www.metaplex.com/docs/smart-contracts/bubblegum-v2/sdk/rust

Example demonstrating how to use the `CreateTreeConfigV2Builder` for local scripts to create a new merkle tree configuration. Ensure you have the necessary RPC client and transaction setup.

```rust
use mpl_bubblegum::{instructions::CreateTreeConfigV2Builder, programs::{SPL_ACCOUNT_COMPRESSION_ID, SPL_NOOP_ID}};

use solana_client::{nonblocking::rpc_client, rpc_config::RpcSendTransactionConfig};

use solana_sdk::{commitment_config::CommitmentConfig, pubkey::Pubkey, signature::Keypair, signer::Signer, system_program, transaction::Transaction};



#[tokio::main]

pub async fn create_tree(keypair: Keypair) {

    let rpc_client = rpc_client::RpcClient::new("https://api.devnet.solana.com/".to_string());



    let payer = keypair;

        



    let asset = Keypair::new();



    let merkle_tree = Keypair::new();



    let tree_config = Pubkey::find_program_address(

        &[

            &merkle_tree.pubkey().to_bytes(),

        ],

        &mpl_bubblegum::ID,

    );



    let create_tree_config_ix = CreateTreeConfigV2Builder::new()

        .merkle_tree(merkle_tree.pubkey())

        .tree_config(tree_config.0)

        .payer(payer.pubkey())

        .max_depth(20)

        .max_buffer_size(1024)

        .public(false)

        .instruction();



    let signers = vec![&asset, &payer];



    let last_blockhash = rpc_client.get_latest_blockhash().await;



    let create_tree_config_tx = Transaction::new_signed_with_payer(

        &[create_tree_config_ix],

        Some(&payer.pubkey()),

        &signers,

        last_blockhash.unwrap(),

    );



    let res = rpc_client

        .send_transaction_with_config(&create_tree_config_tx, RpcSendTransactionConfig {

            skip_preflight: false,

            preflight_commitment: Some(CommitmentConfig::confirmed().commitment),

            encoding: None,

            max_retries: None,

            min_context_slot: None,

        })

        .await

        .unwrap();



    println!("Signature: {:?}", res);

}

```

--------------------------------

### Initialize Project

Source: https://www.metaplex.com/docs/smart-contracts/bubblegum/guides/javascript/how-to-create-1000000-nfts-on-solana

Initialize a new project using npm.

```bash
npm init
```

--------------------------------

### Get Assets By Group Umi Request

Source: https://www.metaplex.com/docs/dev-tools/das-api/methods/get-assets-by-group

Example usage of the getAssetsByGroup method using the Umi framework.

```typescript
import { publicKey } from '@metaplex-foundation/umi'
import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'

const umi = createUmi('https://api.devnet.solana.com').use(dasApi())

const result = await umi.rpc.getAssetsByGroup({
  groupKey: '',
  groupValue: ''
})
console.log(result)
```

--------------------------------

### Build and Install from Source

Source: https://www.metaplex.com/docs/smart-contracts/candy-machine/sugar/installation

Compiles the binary from the local source code and installs it to the Cargo bin directory.

```bash
cargo install --path ./
```

--------------------------------

### Get Assets By Authority Umi Request

Source: https://www.metaplex.com/docs/dev-tools/das-api/methods/get-assets-by-authority

Example usage of the getAssetsByAuthority method using the Umi framework.

```typescript
import { publicKey } from '@metaplex-foundation/umi'
import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'

const umi = createUmi('https://api.devnet.solana.com').use(dasApi())

const result = await umi.rpc.getAssetsByAuthority({

})
console.log(result)
```

--------------------------------

### Installing and Using Mock Storage

Source: https://www.metaplex.com/docs/dev-tools/umi/storage

Provides instructions for installing the mock storage package and integrating it with Umi. This allows for testing storage functionalities without a real backend.

```bash
npm install @metaplex-foundation/umi-storage-mock
```

--------------------------------

### Full SOL Transfer Example

Source: https://www.metaplex.com/docs/solana/javascript/how-to-transfer-sol-on-solana

A complete implementation including imports, setup, airdrop, transfer, and logging the signature.

```typescript
import { mplToolbox, transferSol } from '@metaplex-foundation/mpl-toolbox'

import {

  generateSigner,

  publicKey,

  signerIdentity,

  sol,

} from '@metaplex-foundation/umi'

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

import { base58 } from '@metaplex-foundation/umi/serializers'



const transfer = async () => {

  const umi = createUmi("https://api.devnet.solana.com").use(mplToolbox())



  const signer = generateSigner(umi)



  umi.use(signerIdentity(signer))



  // Airdrop 1 SOL to the identity

  // if you end up with a 429 too many requests error, you may have to use

  // the filesystem wallet method or change rpcs.

  await umi.rpc.airdrop(umi.identity.publicKey, sol(1))



  //

  // Transfer SOL

  //



  const res = await transferSol(umi, {

    source: umi.identity,

    destination: publicKey('111111111111111111111111111111'),

    amount: sol(1),

  }).sendAndConfirm(umi)



  // Log the signature of the transaction

  console.log(base58.deserialize(res.signature))

}



transfer()
```

--------------------------------

### Example cURL Request

Source: https://www.metaplex.com/docs/smart-contracts/genesis/integration-apis/get-launches-by-token

Use this cURL command to make a request to the API to get launches for a given token address.

```curl
curl https://api.metaplex.com/v1/tokens/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
```

--------------------------------

### Start Amman with Configuration

Source: https://www.metaplex.com/docs/dev-tools/amman/cli-commands

Launches Amman using a specific configuration file.

```bash
npx amman start <config.js>
```

--------------------------------

### Full Presale Lifecycle Example

Source: https://www.metaplex.com/docs/dev-tools/cli/genesis/presale

This script demonstrates the complete process of setting up and interacting with a presale, including token creation, defining deposit and claim windows, and user participation.

```bash
# 1. Create the token

 mplx genesis create \
  --name "Example Token" \
  --symbol "EXM" \
  --totalSupply 1000000000000000 \
  --decimals 9


GENESIS=<GENESIS_ADDRESS>


# 2. Timestamps

NOW=$(date +%s)
DEPOSIT_END=$((NOW + 86400))
CLAIM_START=$((DEPOSIT_END + 1))
CLAIM_END=$((NOW + 31536000))


# 3. Add presale bucket: 1M tokens at 100 SOL cap

 mplx genesis bucket add-presale $GENESIS \
  --allocation 1000000000000000 \
  --quoteCap 100000000000 \
  --bucketIndex 0 \
  --depositStart $NOW \
  --depositEnd $DEPOSIT_END \
  --claimStart $CLAIM_START \
  --claimEnd $CLAIM_END


# 4. Add unlocked bucket for team to receive SOL

 mplx genesis bucket add-unlocked $GENESIS \
  --recipient $(solana address) \
  --claimStart $CLAIM_START \
  --allocation 0


# 5. Finalize

 mplx genesis finalize $GENESIS


# 6. Verify

 mplx genesis fetch $GENESIS
 mplx genesis bucket fetch $GENESIS --bucketIndex 0 --type presale


# 7. Wrap SOL and deposit

 mplx toolbox sol wrap 1
 mplx genesis presale deposit $GENESIS --amount 1000000000 --bucketIndex 0


# 8. After deposit period, claim

 mplx genesis presale claim $GENESIS --bucketIndex 0

```

--------------------------------

### Validator, Relay, and Storage Configuration

Source: https://www.metaplex.com/docs/dev-tools/amman/configuration

Example configuration defining validator settings, relay enablement, and mock storage setup.

```javascript
import { LOCALHOST, tmpLedgerDir } from '@metaplex-foundation/amman'



module.exports = {

  validator: {

    killRunningValidators: true,

    programs: [

      {

        label: 'Token Metadata Program',

        programId: programIds.metadata,

        deployPath: localDeployPath('mpl_token_metadata'),

      },

    ],

    jsonRpcUrl: LOCALHOST,

    websocketUrl: '',

    commitment: 'confirmed',

    ledgerDir: tmpLedgerDir(),

    resetLedger: true,

    verifyFees: false,

    detached: process.env.CI != null,

  },

  relay: {

    enabled: process.env.CI == null,

    killRunningRelay: true,

  },

  storage: {

    enabled: process.env.CI == null,

    storageId: 'mock-storage',

    clearOnStart: true,

  },

}
```

--------------------------------

### Get Assets By Owner using Umi

Source: https://www.metaplex.com/docs/dev-tools/das-api/methods/get-assets-by-owner

Example demonstrating how to initialize the Umi instance with the DAS API plugin and call the getAssetsByOwner method.

```typescript
import { publicKey } from '@metaplex-foundation/umi'
import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'

const umi = createUmi('https://api.devnet.solana.com').use(dasApi())

const result = await umi.rpc.getAssetsByOwner({

})
console.log(result)
```

--------------------------------

### Full Launch Pool Lifecycle Example

Source: https://www.metaplex.com/docs/dev-tools/cli/genesis/launch-pool

A comprehensive example demonstrating the complete lifecycle of a launch pool, from creation to claiming tokens and revoking mint authority. This includes setting up accounts, buckets, deposits, and transitions.

```bash
# 1. Create the Genesis account

mplx genesis create \
  --name "My Token" \
  --symbol "MTK" \
  --totalSupply 1000000000000000 \
  --decimals 9


# (copy GENESIS_ADDRESS from output)
GENESIS=<GENESIS_ADDRESS>


# 2. Timestamps

NOW=$(date +%s)
DEPOSIT_END=$((NOW + 86400))
CLAIM_START=$((DEPOSIT_END + 1))
CLAIM_END=$((NOW + 31536000))


# 3. Add a launch pool bucket with end behavior

mplx genesis bucket add-launch-pool $GENESIS \
  --allocation 500000000000000 \
  --depositStart $NOW \
  --depositEnd $DEPOSIT_END \
  --claimStart $CLAIM_START \
  --claimEnd $CLAIM_END \
  --endBehavior "<UNLOCKED_BUCKET_ADDRESS>:10000"


# 4. Add an unlocked bucket to receive SOL

mplx genesis bucket add-unlocked $GENESIS \
  --recipient $(solana address) \
  --claimStart $CLAIM_START \
  --allocation 0


# 5. Finalize

mplx genesis finalize $GENESIS


# 6. Wrap SOL and deposit

mplx toolbox sol wrap 10
mplx genesis deposit $GENESIS --amount 10000000000 --bucketIndex 0


# 7. After deposit period, transition

mplx genesis transition $GENESIS --bucketIndex 0


# 8. Claim tokens

mplx genesis claim $GENESIS --bucketIndex 0


# 9. Revoke mint authority

mplx genesis revoke $GENESIS --revokeMint

```

--------------------------------

### Get Assets By Creator using Umi

Source: https://www.metaplex.com/docs/dev-tools/das-api/methods/get-assets-by-creator

Example demonstrating how to initialize the Umi instance with the DAS API plugin and call the getAssetsByCreator method.

```typescript
import { publicKey } from '@metaplex-foundation/umi'
import { createUmi } from '@metaplex-foundation/umi-bundle-defaults'
import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'

const umi = createUmi('https://api.devnet.solana.com').use(dasApi())

const result = await umi.rpc.getAssetsByCreator({

})
console.log(result)
```

--------------------------------

### Get Assets by Group (JavaScript)

Source: https://www.metaplex.com/docs/dev-tools/das-api/guides/get-collection-nfts

Use the `getAssetsByGroup` method to retrieve assets belonging to a specific collection. Ensure you have the necessary client setup.

```javascript
import { getAssetsByGroup } from '@metaplex-foundation/umi-collection-tools';

const assets = await getAssetsByGroup(umi, {
  groupType: 'collection',
  groupValue: 'YOUR_COLLECTION_ADDRESS',
  // Optional: Specify 'fungible' or 'nonFungible' to filter asset types
  // assetType: 'nonFungible',
});
```

--------------------------------

### Get Asset Proof with Umi

Source: https://www.metaplex.com/docs/dev-tools/das-api/methods/get-asset-proof

Use this snippet to fetch the Merkle tree proof for a compressed asset. Ensure you have the Umi library and DAS API plugin installed and configured.

```javascript
import { publicKey } from '@metaplex-foundation/umi'

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

import { dasApi } from '@metaplex-foundation/digital-asset-standard-api'

const umi = createUmi('https://api.devnet.solana.com').use(dasApi())

const result = await umi.rpc.getAssetProof()
console.log(result)
```

--------------------------------

### Install Genesis Packages

Source: https://www.metaplex.com/docs/smart-contracts/genesis/bonding-curve-launch

Install the required Metaplex Genesis, UMI, and UMI bundle defaults packages using npm. Ensure Node.js 18+ is installed.

```bash
npm install @metaplex-foundation/genesis \
  @metaplex-foundation/umi \
  @metaplex-foundation/umi-bundle-defaults
```

--------------------------------

### Install dependencies

Source: https://www.metaplex.com/docs/smart-contracts/inscription/getting-started/cli

Install required packages before running the CLI.

```bash
pnpm install
```

--------------------------------

### Storage Withdrawal Examples

Source: https://www.metaplex.com/docs/dev-tools/cli/toolbox/storage-withdraw

Practical examples demonstrating how to withdraw a fixed amount of SOL and how to drain the full storage account balance.

```bash
mplx toolbox storage withdraw 0.05
```

```bash
mplx toolbox storage withdraw --all
```

--------------------------------

### Install Kinobi

Source: https://www.metaplex.com/docs/dev-tools/umi/kinobi

Install the Kinobi package using npm.

```bash
npm install @metaplex-foundation/kinobi

```

--------------------------------

### Install MPL-Hybrid SDK

Source: https://www.metaplex.com/docs/smart-contracts/mpl-hybrid/sdk/javascript

Install the required package using npm.

```bash
npm install @metaplex-foundation/mpl-hybrid
```

--------------------------------

### Install Hydra SDK

Source: https://www.metaplex.com/docs/smart-contracts/hydra/quick-start

Install the required package via yarn.

```bash
yarn add @glasseaters/hydra-sdk
```

--------------------------------

### Initialize Kit SDK

Source: https://www.metaplex.com/docs/smart-contracts/token-metadata/getting-started/kit

Set up the RPC connection and generate a signer keypair.

```typescript
import { createSolanaRpc, createSolanaRpcSubscriptions, generateKeyPairSigner } from '@solana/kit';

// Create RPC connection
const rpc = createSolanaRpc('https://api.devnet.solana.com');
const rpcSubscriptions = createSolanaRpcSubscriptions('wss://api.devnet.solana.com');

// Generate or load a keypair
const authority = await generateKeyPairSigner();
```

--------------------------------

### Install Bubblegum SDK

Source: https://www.metaplex.com/docs/smart-contracts/bubblegum-v2/sdk/javascript

Install the required packages via npm.

```bash
npm install @metaplex-foundation/mpl-bubblegum @metaplex-foundation/umi-bundle-defaults
```

--------------------------------

### Navigate to Project Directory

Source: https://www.metaplex.com/docs/smart-contracts/token-metadata/guides/anchor/token-claimer-smart-contract

Command to enter the newly created project directory.

```bash
cd token-claimer-example
```

--------------------------------

### Verify Sugar Installation

Source: https://www.metaplex.com/docs/smart-contracts/candy-machine/sugar/getting-started

Check the installed version of the Sugar CLI.

```bash
sugar --version
```

--------------------------------

### CLI Output Example

Source: https://www.metaplex.com/docs/dev-tools/cli/bubblegum/create-cnft

The expected console output after successfully creating a compressed NFT.

```text
Uploading image... ✓

Uploading metadata... ✓

Creating compressed NFT... ✓



--------------------------------

Compressed NFT Created!



Tree: my-tree

Owner: YourWalletAddressHere

Asset ID: CNFTAssetIdHere



Signature: 5xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Explorer: https://solscan.io/tx/5xxx...

--------------------------------
```

--------------------------------

### Create a Core Candy Machine with configLineSettings

Source: https://www.metaplex.com/docs/smart-contracts/core-candy-machine/create

Implementation example for initializing a Core Candy Machine with specific configuration line settings.

```JavaScript
import { create } from '@metaplex-foundation/mpl-core-candy-machine'



const candyMachine = generateSigner(umi)



const coreCollection = publicKey('11111111111111111111111111111111')



const createIx = await create(umi, {

  candyMachine,

  collection: coreCollection,

  collectionUpdateAuthority: umi.identity,

  itemsAvailable: 5000,

  configLineSettings: some({

    prefixName: 'Example Asset #',

    nameLength: 15,

    prefixUri: 'https://example.com/metadata/',

    uriLength: 29,

    isSequential: false,

  }),

})



await createIx.sendAndConfirm(umi)
```

--------------------------------

### Create a Collection with Plugins

Source: https://www.metaplex.com/docs/smart-contracts/core/guides/javascript/how-to-create-a-core-collection-with-javascript

Demonstrates how to include plugins like PermanentFreezeDelegate and AppData during collection creation.

```javascript
const collection = generateSigner(umi)

const tx = await createCollection(umi, {

  collection: collection,

  name: 'My Collection',

  uri: 'https://example.com/my-collection.json',

  plugins: [

    {

      type: "PermanentFreezeDelegate",

      frozen: true,

      authority: { type: "UpdateAuthority"}

    },

    {

      type: "AppData",

      dataAuthority: { type: "UpdateAuthority"},

      schema: ExternalPluginAdapterSchema.Binary,

    }           

  ]

}).sendAndConfirm(umi)

const signature = base58.deserialize(tx.signature)[0]
```

--------------------------------

### Install Anchor CLI

Source: https://www.metaplex.com/docs/tokens/anchor/create-token

Installs the Anchor CLI tool via cargo.

```bash
cargo install --git https://github.com/coral-xyz/anchor anchor-cli
```

--------------------------------

### Create Web3.js Instructions

Source: https://www.metaplex.com/docs/dev-tools/umi/web3js-differences-and-adapters

Demonstrates creating a standard instruction using the Solana Web3.js library.

```typescript

import { SystemProgram } from '@solana/web3.js';



// Create a new instruction (like a lamport transfer)

const web3jsInstruction = SystemProgram.transfer({...TransferParams})



```

--------------------------------

### getMintV1InstructionAsync (Kit SDK)

Source: https://www.metaplex.com/docs/smart-contracts/token-metadata/mint

Generate a mint instruction using the Kit SDK.

```APIDOC
## getMintV1InstructionAsync (Kit SDK)

### Description
Asynchronously generate a Mint V1 instruction for the Token Metadata program.

### Parameters
- **mint** (PublicKey) - Required - The address of the asset's Mint account.
- **authority** (Signer) - Required - The authority that can authorize this instruction.
- **payer** (Signer) - Required - The account paying for the transaction.
- **amount** (number) - Required - The number of tokens to mint.
- **tokenOwner** (PublicKey) - Required - The address of the wallet to receive the token(s).
- **tokenStandard** (TokenStandard) - Required - The Token Standard of the asset.

### Request Example
```typescript
const mintIx = await getMintV1InstructionAsync({
  mint: mintAddress,
  authority,
  payer: authority,
  amount: 1,
  tokenOwner,
  tokenStandard: TokenStandard.NonFungible,
});
```
```

--------------------------------

### Install Umi for Library Authors

Source: https://www.metaplex.com/docs/dev-tools/umi/getting-started

Install the main Umi library as a peer dependency to minimize dependency bloat.

```bash
npm i @metaplex-foundation/umi --save-peer
```

--------------------------------

### Install Required Packages

Source: https://www.metaplex.com/docs/smart-contracts/core/guides/javascript/how-to-create-a-core-collection-with-javascript

Install the necessary Metaplex Umi and Core packages.

```bash
npm i @metaplex-foundation/umi
```

```bash
npm i @metaplex-foundation/umi-bundle-defaults
```

```bash
npm i @metaplex-foundation/mpl-core
```

```bash
npm i @metaplex-foundation/umi-uploader-irys;
```

--------------------------------

### Install MPL-Bubblegum SDK

Source: https://www.metaplex.com/docs/smart-contracts/bubblegum/sdk/javascript

Use a package manager to install the required library.

```bash
npm install @metaplex-foundation/mpl-bubblegum
```

--------------------------------

### Wrap SOL and Deposit to Presale

Source: https://www.metaplex.com/docs/dev-tools/cli/genesis/presale

This example first wraps SOL using the toolbox and then deposits it into a presale bucket. The deposit amount is specified in base units.

```bash
mplx toolbox sol wrap 10

mplx genesis presale deposit <GENESIS_ADDRESS> --amount 10000000000 --bucketIndex 0
```

--------------------------------

### Verify Shank Installation

Source: https://www.metaplex.com/docs/dev-tools/shank/getting-started

Verify the Shank CLI installation by checking its version.

```bash
shank --version
```

--------------------------------

### Configure Development Wallet via CLI

Source: https://www.metaplex.com/docs/solana/solana-keypairs-and-wallets

Steps to generate a local keypair, set it as the default, switch to devnet, and request an airdrop.

```bash
# 1. Create a devnet wallet (no passphrase for convenience)

solana-keygen new --no-bip39-passphrase --outfile ~/.config/solana/devnet.json



# 2. Set it as default

solana config set --keypair ~/.config/solana/devnet.json



# 3. Switch to devnet

solana config set --url devnet



# 4. Get some devnet SOL

solana airdrop 2



# 5. Verify

solana balance
```

--------------------------------

### Install Umi Web3.js Adapters

Source: https://www.metaplex.com/docs/dev-tools/umi/web3js-differences-and-adapters

Command to install the adapter package if not already included via the main Umi package.

```bash
npm i @metaplex-foundation/umi-web3js-adapters
```
Tokens:
Raw