Metaplex IDL
Metaplex is the core program that orchestrates NFT storefronts, auction houses, and marketplace operations on Solana. Manages store whitelisting, auction managers, and prize redemption.
Program address
p1exdMJcjVao65QdewkaZRUnU6VPSXhus9n2GzWfh98- Instructions
- 24
- Accounts
- 34
- Events
- 0
- Types
- 15
What the program exposes
Instructions 24
- DeprecatedInitAuctionManagerV1
- DeprecatedValidateSafetyDepositBoxV1
- RedeemBid
- RedeemFullRightsTransferBid
- DeprecatedRedeemParticipationBid
- StartAuction
- ClaimBid
- EmptyPaymentAccount
- SetStore
- SetWhitelistedCreator
- DeprecatedValidateParticipation
- DeprecatedPopulateParticipationPrintingAccount
- and 12 more
Accounts 34
- Key
- CommonWinningIndexReturn
- PrintingV2CalculationCheckReturn
- AuctionManagerV2
- AuctionManagerStateV2
- ParticipationStateV2
- ParticipationConfigV2
- WinningConstraint
- and 26 more
Use it in your code
Load the Metaplex IDL with Anchor in TypeScript, Rust or Python.
import { Connection, PublicKey } from "@solana/web3.js";
import { Program, AnchorProvider, Idl } from "@coral-xyz/anchor";
// Load the Metaplex IDL
import idl from "./metaplex.json";
const PROGRAM_ID = new PublicKey("p1exdMJcjVao65QdewkaZRUnU6VPSXhus9n2GzWfh98");
// Set up the provider and program
const connection = new Connection("https://api.mainnet-beta.solana.com");
const provider = new AnchorProvider(connection, wallet, {
commitment: "confirmed",
});
const program = new Program(idl as Idl, provider);
// Fetch and decode an account
const accountData = await program.account.metaplex
.fetch(accountPublicKey);
console.log("Account data:", accountData);
// Build and send an instruction
const tx = await program.methods
.initialize(/* ...args */)
.accounts({
/* ...required accounts */
})
.rpc();
console.log("Transaction signature:", tx);use anchor_client::solana_sdk::pubkey::Pubkey;
use anchor_client::solana_sdk::signature::Keypair;
use anchor_client::{Client, Cluster};
use std::str::FromStr;
// Metaplex program ID
const PROGRAM_ID: &str = "p1exdMJcjVao65QdewkaZRUnU6VPSXhus9n2GzWfh98";
fn main() -> anyhow::Result<()> {
let payer = Keypair::new();
let client = Client::new(Cluster::Mainnet, &payer);
let program_id = Pubkey::from_str(PROGRAM_ID)?;
let program = client.program(program_id)?;
// Fetch and deserialize an account
let account: MetaplexAccount = program.account(account_pubkey)?;
println!("Account data: {:?}", account);
// Build and send a transaction
let tx = program
.request()
.accounts(metaplex::accounts::Initialize {
// ...required accounts
})
.args(metaplex::instruction::Initialize {
// ...instruction args
})
.send()?;
println!("Transaction signature: {}", tx);
Ok(())
}from solana.rpc.api import Client
from solders.pubkey import Pubkey
from anchorpy import Program, Provider, Wallet
import json
# Load the Metaplex IDL
with open("metaplex.json") as f:
idl_data = json.load(f)
PROGRAM_ID = Pubkey.from_string("p1exdMJcjVao65QdewkaZRUnU6VPSXhus9n2GzWfh98")
# Set up the provider and program
client = Client("https://api.mainnet-beta.solana.com")
provider = Provider(client, Wallet.local())
program = Program(idl_data, PROGRAM_ID, provider)
# Fetch and decode an account
account = await program.account["Metaplex"].fetch(account_pubkey)
print(f"Account data: {account}")
# Build and send an instruction
tx = await program.rpc["initialize"](
# ...instruction args
ctx=program.context(
accounts={
# ...required accounts
}
)
)
print(f"Transaction signature: {tx}")The JSON
The first 30 lines of metaplex.json.
{
"version": "0.0.0",
"name": "metaplex",
"docs": [],
"ref": "https://github.com/metaplex-foundation/metaplex-program-library/blob/821e5aac0780fe45525dae72b9ad6f8dc2ba8e5b/metaplex/program/src/instruction.rs",
"instructions": [
{
"name": "DeprecatedInitAuctionManagerV1",
"docs": [
"Initializes an Auction Manager V1"
],
"accounts": [
{
"name": "uninitializedUnallocatedAuctionManager",
"isMut": true,
"isSigner": false,
"docs": [
"Uninitialized, unallocated auction manager account with pda of ['metaplex', auction_key from auction referenced below]"
]
},
{
"name": "combinedVault",
"isMut": false,
"isSigner": false,
"docs": [
"Combined vault account with authority set to auction manager account (this will be checked)",
"Note in addition that this vault account should have authority set to this program's pda of ['metaplex', auction_key]"
]
},
{
...Frequently asked questions
What is the Metaplex IDL?
The Metaplex IDL (Interface Definition Language) is a JSON schema that describes the on-chain program interface for the Metaplex smart contract on Solana. It defines all available instructions, account structures, events, and types needed to interact with the program. This one has 24 instructions, 34 account types, 0 events and 15 type definitions.
How do I use the Metaplex IDL in my project?
You can use the Metaplex IDL with Anchor framework clients in TypeScript (@coral-xyz/anchor), Rust (anchor-client), or Python (anchorpy). Download the JSON file, import it in your project, and use it to create a Program instance that can call instructions and decode accounts.
What is the Metaplex program address on Solana?
The Metaplex program is deployed at address p1exdMJcjVao65QdewkaZRUnU6VPSXhus9n2GzWfh98 on Solana mainnet.
What version of the Metaplex IDL is this?
This is version 0.0.0 of the Metaplex IDL. IDL versions follow program deployments and change as the protocol evolves, so check it against the program on-chain before you integrate.
Build on Metaplex with AllenHark
Stream the program's accounts and transactions with Yellowstone gRPC, read its state over Solana RPC, or see its transactions before the block is built with ShredStream. To trade against it, try the trading bots or the PumpFun sniper.
Browse all Solana IDLs