Metaboss

The Solana Metaplex NFT 'Swiss Army Knife' tool.

Current Commands:

SUBCOMMANDS:
    airdrop         Airdrop assets to a list of addresses
    burn            Full Burn an asset
    burn-nft        Full Burn a NFT
    burn-print      Full Burn a print edition NFT
    check           Check specific metadata values for a list of NFTs
    collections     NFT collections commands
    create          Create accounts
    decode          Decode on-chain data into JSON format
    derive          Derive PDAs for various account types
    find            Find things
    help            Prints this message or the help of the given subcommand(s)
    mint            Mint new NFTs from JSON files
    parse-errors    Parse Errors commands
    set             Set non-Data struct values for a NFT
    sign            Sign metadata for an unverified creator
    snapshot        Get snapshots of various blockchain states
    transfer        Transfer Metaplex assets
    unverify        Unverify Creators
    update          Update various aspects of NFTs
    uses            NFT uses commands
    verify          Verify Creators

Each subcommand has additional commands. Run metaboss <subcommand> --help and metaboss <subcommand> <command> --help for more information on particular commands.

Suggestions and PRs welcome!

Note: This is experimental software for a young ecosystem. Use at your own risk. The author is not responsible for misuse of the software or failing to test specific commands before using on production NFTs.

Test on devnet or localnet before using on mainnet.

Quick Start

Install Binary

Copy the following to a terminal:

bash <(curl -sSf https://raw.githubusercontent.com/samuelvanderwaal/metaboss/main/scripts/install.sh)

If you get errors you may need dependencies:

Ubuntu:

sudo apt install libssl-dev libudev-dev pkg-config

MacOS may need openssl:

brew install openssl@3

Or get the binary yourself: binary.

Install With Cargo

So you're a Rust dev. . .

cargo install metaboss

See Usage Commands

metaboss -h

Decode a mint account's metadata:

metaboss decode mint -a 23gaZq8578xHozMWADsmZ2hAFqZ15iyHmQtRw14meds2

Get a snapshot of mint accounts by first verified creator:

metaboss snapshot mint -c PanbgtcTiZ2PveV96t2FHSffiLHXXjMuhvoabUUKKm8

Installation

Recommended Way to Install

The recommended way to install is to use the install script to install on MacOs, Ubuntu, or other Unix-like OS, by copying the following into a terminal:

bash <(curl -sSf https://raw.githubusercontent.com/samuelvanderwaal/metaboss/main/scripts/install.sh)

This will download the appropriate binary for your system and install it. Feel free to inspect the install script directly at the link to see what you are running before you run the command.

For Windows, either use the prebuilt binary in the following section, or install Windows Subsystem Linux (WSL) to use the Ubuntu terminal to run the above installation script.

To install WSL on Windows, either run wsl --install -d ubuntu in the cmd prompt terminal, or install "Ubuntu" from the Windows app store. Once you have that set up you can simply run the install script in the WSL terminal. You will then run all your Metaboss commands from WSL as well.

The Metaboss Discord has a step-by-step guide for installing on Windows in the #windows-install channel.

Binaries

Linux, MacOS and Windows binaries available in releases, thanks to CI work done by Kartik Soneji.

Crates.io

cargo install metaboss

Install From Source

Install Rust.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Clone the source:

git clone git@github.com:samuelvanderwaal/metaboss.git

git clone https://github.com/samuelvanderwaal/metaboss.git

On Ubuntu you may need some additional packages:

sudo apt install libssl-dev libudev-dev pkg-config

Change directory and check out the main branch:

cd metaboss
git checkout main

Install or build with Rust:

cargo install --path ./

cargo build --release

Set Up Your Solana Config

If you have the Solana CLI installed (recommended) you can setup your RPC and keypair so you don't have to pass them into Metaboss:

solana config set --url <rpc url> --keypair <path to keypair file>

Examples

Update the URI of an existing NFT

metaboss update uri -k ~/.config/solana/devnet.json -a CQNKXw1rw2eWwi812Exk4cKUjKuomZ2156STGRyXd2Mp -u https://arweave.net/N36gZYJ6PEH8OE11i0MppIbPG4VXKV4iuQw1zaq3rls

Mint a new NFT

Prepare a JSON file.

{
    "name": "TestNFT2",
    "symbol": "TNFT",
    "uri": "https://arweave.net/FPGAv1XnyZidnqquOdEbSY6_ES735ckcDTdaAtI7GFw",
    "seller_fee_basis_points": 200,
    "creators": [
        {
            "address": "AVdBTNhDqYgXGaaVkqiaUJ1Yqa61hMiFFaVRtqwzs5GZ",
            "verified": false,
            "share": 50
        },
        {
            "address": "42NevAWA6A8m9prDvZRUYReQmhNC3NtSZQNFUppPJDRB",
            "verified": false,
            "share": 50
        }
    ]
}

Call command. In this case we do not set --receiver so we mint directly to the keypair address.

metaboss mint one -k ~/.config/solana/devnet.json -d ./new_nft.json

Snapshot Candy Machine Mint Accounts

We call the command with no output specified so it creates the file in the current directory.

metaboss snapshot mints -c BHZWQEtGRMs7voC7vDyVQCXawB1P6UvxG899ATGwxmaR

The file BHZWQEtGRMs7voC7vDyVQCXawB1P6UvxG899ATGwxmaR_mint_accounts.json is created with the contents:

[
    "D5ycm2mgBWDR37QVkvM389x84V4ux48bSeHLeiHPtX28",
    "4kYdMRRYtXjmkusgKEBntSXLDhqkHNE57GF3RPdtx6MW",
    "J8xuCFCeBRESoXewtMwrrpVUGikUG3B1WznNdLffyymz",
    "4gRtRjrbD7g5ZKUvSVA1tYMK9LZqz6uWuSc3rKeinySh"
]

Update List of NFT Metadata

Get your NFT mint list using metaboss snapshot or another tool.
Decode all the metadata into files using metaboss decode mint -L <NFT_MINT_LIST_FILE> --full -o <DATA_FILES_DIR>.
Update the specific data you want changed in each file in the <DATA_FILES_DIR>.
Update the NFTs with metaboss update data-all -d <DATA_FILES_DIR>.

Note: many fields have specific update <field>-all commands which are easier to use as they don't require updating a bunch of metadata files manually. Check the update and set sections first to see if they have what you need.

Global Options

These are the options that apply to all subcommands and can be passed in at any level.

metaboss <option> <subcommand> <subcommand>

metaboss <subcommand> <option> <subcommand>

metaboss <subcommand> <subcommand> <option>

Options

-r, --rpc The RPC endpoint to use for commands.

Metaboss will try to read your Solana config settings for both the RPC endpoint and also the Commitment setting by reading from $HOME/.config/solana/cli/config.yml. If it can't find a config file it defaults to using https://dev.genesysgo.net and confirmed.

Running Metaboss with the --rpc option will override the above with whatever RPC endpoint the user provides.

-T, --timeout The timeout in seconds to use for RPC calls.

This defaults to 90 seconds which should be fine for most cases but can be overridden if needed.

Example:

metaboss snapshot holders -r https://ssc-dao.genesysgo.net/ -T 120 -u DC2mkgwhy56w3viNtHDjJQmc7SGu2QX785bS4aexojwX

Airdrop

This is an experimental feature that uses the TPU client to rapidly and efficiently make transfers. It relies on the Jib library for transmitting instructiosn via TPU. You should carefully test it on devnet prior to running it on mainnet.

The benefit of using the TPU client is that is can rapidly transmit the transactions directly to the consensus leader and the command does not require a high-throughput private RPC node and can use the public ones by default as the RPC node is only used for determining the current leader.

Airdrop SOL

Airdrop SOL to a list of accounts.

Airdrop SOL

USAGE:
    metaboss airdrop sol [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -c, --cache-file <cache-file>            Cache file
    -k, --keypair <keypair>                  Path to the owner keypair file
    -l, --log-level <log-level>              Log level [default: off]
    -n, --network <network>                  Network cluster to use, defaults to devnet [default: devnet]
    -L, --recipient-list <recipient-list>    Path to the mint list file
    -r, --rpc <rpc>                          RPC endpoint url to override using the Solana config or the hard-coded
                                             default
    -T, --timeout <timeout>                  Timeout to override default value of 90 seconds [default: 90]

This command requires a recipient list file that should be a hashmap/dictionary/object of addresses and the amount of lamports to send to them. (1 SOL = 1,000,000,000 lamports) E.g.:

{
  "HVtodaLcq6zVvqp7h6JwLLrsAGxeJ9BatvgpUfp9b4oM": 1000,
  "5VXU4QbhUZbkBqKxT3Mv55krE4MomMgtV68whNRotjk5": 1000,
  "GSFKDFeCe93aUscmG84ugtXXNPMGoMcbZwRaamPLXS9o": 5000,
  "DCYHBcWGgdUUCBbj7rjbkBJWkuoHAH88BzMKfbbkFUNJ": 7000,
  "8MUCm4HxRXQUKMyanyNcvcG4qbAmw5s6y9exiszFZgg": 5000,
  "sknqbvGgVFpniWRK9kM1e77Fuq5oEhSZ5He4PtbTeZh": 3000  
}