Get StartedMetaplex Auction IDL
auctxRXPeJoc4817jDhf4HbjnhEcr1cCXenosMhK5R8Metaplex Auction is the on-chain auction program for NFTs and digital assets on Solana. Manages English and open edition auctions with bid placement, cancellation, settlement, and prize claiming.
Instructions
Account Types
Integration Examples
Use the Metaplex Auction IDL in your application with these code examples for TypeScript, Rust, and Python.
import { Connection, PublicKey } from "@solana/web3.js";
import { Program, AnchorProvider, Idl } from "@coral-xyz/anchor";
// Load the Metaplex Auction IDL
import idl from "./metaplex auction.json";
const PROGRAM_ID = new PublicKey("auctxRXPeJoc4817jDhf4HbjnhEcr1cCXenosMhK5R8");
// 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_Auction
.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);IDL JSON Preview
{
"version": "0.0.0",
"name": "auction",
"docs": [],
"ref": "https://github.com/metaplex-foundation/metaplex-program-library/blob/821e5aac0780fe45525dae72b9ad6f8dc2ba8e5b/auction/program/src/instruction.rs",
"instructions": [
{
"name": "CancelBid",
"docs": [
"Cancel a bid on a running auction."
],
"accounts": [
{
"name": "biddersPrimaryAccount",
"isMut": false,
"isSigner": true,
"docs": [
"The bidders primary account, for PDA calculation/transit auth."
]
},
{
"name": "biddersTokenAccount",
"isMut": true,
"isSigner": false,
"docs": [
"The bidders token account they'll receive refund with"
]
},
{
"name": "pot",
...Frequently Asked Questions
What is the Metaplex Auction IDL?
The Metaplex Auction IDL (Interface Definition Language) is a JSON schema that defines the on-chain program interface for the Metaplex Auction smart contract on Solana. It describes all available instructions, account structures, events, and custom types that developers need to interact with the Metaplex Auction program. This IDL contains 8 instructions, 5 account types, 0 events, and 13 type definitions.
How do I use the Metaplex Auction IDL in my project?
Download the JSON file and import it in your project. With TypeScript, use the @coral-xyz/anchor package to create a Program instance. In Rust, use anchor-client. For Python, use anchorpy. See the integration examples above for complete code snippets in all three languages.
What is the Metaplex Auction program address on Solana?
The Metaplex Auction program is deployed at address auctxRXPeJoc4817jDhf4HbjnhEcr1cCXenosMhK5R8 on Solana mainnet. You can verify this on any Solana block explorer.
What version of the Metaplex Auction IDL is this?
This is version 0.0.0 of the Metaplex Auction IDL. IDL versions correspond to specific program deployments and may be updated as the protocol evolves. Always verify compatibility with the on-chain program version before integrating.