Token Vault IDL
Metaplex Token Vault manages fractional ownership of NFTs and token bundles on Solana. Enables combining multiple tokens into a vault and issuing fractional shares representing proportional ownership.
Program address
vau1zxA2LbssAUEF7Gpw91zMM1LvXrvpzJtmZ58rPsn- Instructions
- 11
- Accounts
- 5
- Events
- 0
- Types
- 4
What the program exposes
Instructions 11
- InitVault
- AddTokenToInactiveVault
- ActivateVault
- CombineVault
- RedeemShares
- WithdrawTokenFromSafetyDepositBox
- MintFractionalShares
- WithdrawSharesFromTreasury
- AddSharesToTreasury
- UpdateExternalPriceAccount
- SetAuthority
Accounts 5
- Key
- VaultState
- Vault
- SafetyDepositBox
- ExternalPriceAccount
Use it in your code
Load the Token Vault 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 Token Vault IDL
import idl from "./token vault.json";
const PROGRAM_ID = new PublicKey("vau1zxA2LbssAUEF7Gpw91zMM1LvXrvpzJtmZ58rPsn");
// 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.token_Vault
.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;
// Token Vault program ID
const PROGRAM_ID: &str = "vau1zxA2LbssAUEF7Gpw91zMM1LvXrvpzJtmZ58rPsn";
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: Token_VaultAccount = program.account(account_pubkey)?;
println!("Account data: {:?}", account);
// Build and send a transaction
let tx = program
.request()
.accounts(token__vault::accounts::Initialize {
// ...required accounts
})
.args(token__vault::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 Token Vault IDL
with open("token vault.json") as f:
idl_data = json.load(f)
PROGRAM_ID = Pubkey.from_string("vau1zxA2LbssAUEF7Gpw91zMM1LvXrvpzJtmZ58rPsn")
# 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["Token_Vault"].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 token vault.json.
{
"version": "0.0.0",
"name": "token-vault",
"docs": [],
"ref": "https://github.com/metaplex-foundation/metaplex-program-library/blob/821e5aac0780fe45525dae72b9ad6f8dc2ba8e5b/token-vault/program/src/instruction.rs",
"instructions": [
{
"name": "InitVault",
"docs": [
"Initialize a token vault, starts inactivate. Add tokens in subsequent instructions, then activate."
],
"accounts": [
{
"name": "initializedFractionalShareMint",
"isMut": true,
"isSigner": false,
"docs": [
"Initialized fractional share mint with 0 tokens in supply, authority on mint must be pda of program with seed [prefix, programid]"
]
},
{
"name": "initializedRedeemTreasuryTokenAccount",
"isMut": true,
"isSigner": false,
"docs": [
"Initialized redeem treasury token account with 0 tokens in supply, owner of account must be pda of program like above"
]
},
{
"name": "initializedFractionTreasuryTokenAccount",
...Frequently asked questions
What is the Token Vault IDL?
The Token Vault IDL (Interface Definition Language) is a JSON schema that describes the on-chain program interface for the Token Vault smart contract on Solana. It defines all available instructions, account structures, events, and types needed to interact with the program. This one has 11 instructions, 5 account types, 0 events and 4 type definitions.
How do I use the Token Vault IDL in my project?
You can use the Token Vault 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 Token Vault program address on Solana?
The Token Vault program is deployed at address vau1zxA2LbssAUEF7Gpw91zMM1LvXrvpzJtmZ58rPsn on Solana mainnet.
What version of the Token Vault IDL is this?
This is version 0.0.0 of the Token Vault 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 Token Vault 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