Snapshot
Get snapshots of various blockchain states.
Snapshot CM-Accounts
Snapshot all candy machine config and state accounts for a given update_authority.
Usage
metaboss snapshot cm-accounts --update-authority <UPDATE_AUTHORITY> --output <OUTPUT_DIR>
Creates a JSON file in the output directory with the name format of <UPDATE_AUTHORITY>_accounts.json
, consisting of an object with the fields config_accounts
and candy_machine_accounts
:
{
"config_accounts": [
{
"address": "2XBqwwTLf24ACPR3BDSEKCB95PZiAwYySeX1LyN3FKDL",
"data_len": 1456
},
{
"address": "9tNkktGZhLiWHkc4JhoTYvMLXEVA8qauSVeFwyiRPCsT",
"data_len": 1216
}
],
"candy_machine_accounts": [
{
"address": "DwoPaGFxJpGRq3kZQBNfBroCGaS9Hdg2rpFHJpD2iBhW",
"data_len": 529
},
{
"address": "CpFAvcReAkmxWiL7jwDjBKD9jX1Bi1Lky4bHwMkgCuxc",
"data_len": 529
}
]
}
Snapshot Holders
Snapshot all current holders of NFTs filtered by verified candy_machine_id/first creator or update_authority. Note: Update authority can be faked so use that option with caution.
Usage
metaboss snapshot holders --creator <CREATOR_ADDRESS> -p <POSITION> --output <OUTPUT_DIR>
Use the position to indicate which creator in the creators array to filter by; defaults to the first one (position 0).
or
metaboss snapshot holders --update-authority <UPDATE_AUTHORITY> --output <OUTPUT_DIR>
For candy machine v2, you can add the --v2
option when using it with candy machine id.
Candy machine v2 has a separate creator id from the candy machine account id.
metaboss snapshot holders --creator <CANDY_MACHINE_ID> --v2 --output <OUTPUT_DIR>
where <CANDY_MACHINE_ID> is the candy machine id retrieved from the cache file.
Creates a JSON file in the output directory with the name format of <CREATOR/UPDATE_AUTHORITY>_holders.json
consisting of an array of objects with the following fields:
- owner wallet -- the holder of the token
- associated token account -- the token account the NFT is stored at
- mint account -- the token mint account for the NFT
- metadata account -- the metadata account decorating the mint account that defines the NFT
Example file:
[
{
"owner_wallet": "42NevAWA6A8m9prDvZRUYReQmhNC3NtSZQNFUppPJDRB",
"associated_token_address": "7yGA66LYDU7uoPW2x9jrUKaDWTs9jqZ5cSNKR1VaLQdw",
"mint_account": "C2eGm8iQPnKVWxakyo8QhwJUvYrZHKF52DPQuAejpTWG",
"metadata_account": "8WTA3sLxwRNDKHxZFbn2CFo3FX1ZP59EqrvuDPLbmmWV"
}
]
Snapshot Mints
Snapshot all mint accounts for a given verified candy machine id/first creator or update authority
Usage
metaboss snapshot mints --creator <FIRST_CREATOR> --output <OUTPUT_DIR>
Use the position to indicate which creator in the creators array to filter by; defaults to the first one (position 0).
or
metaboss snapshot mints --update-authority <UPDATE_AUTHORITY> --output <OUTPUT_DIR>
For candy machine v2, you can add the --v2
option when using it with candy machine id.
Candy machine v2 has a separate creator id from the candy machine account id.
metaboss snapshot mints --creator <CANDY_MACHINE_ID> --v2 --output <OUTPUT_DIR>
where <CANDY_MACHINE_ID> is the candy machine id retrieved from the cache file.
Creates a JSON file in the output directory with the name format of <CANDY_MACHINE_ID/UPDATE_AUTHORITY>_mint_accounts.json
consisting of an array of mint accounts.
[
"CQNKXw1rw2eWwi812Exk4cKUjKuomZ2156STGRyXd2Mp",
"5pgGJ5npeMxBzTiQctDgoofEVGSwZMYm3QMz4F4NDShz",
"8GcRqxy4VAocTcAkoxCXkPCEmM36HMtjBc8ZarWhAD6o"
]
Indexed Data
Metaboss now has experimental support for running snapshot commands using off-chain, indexed data from https://theindex.io/. Other indexers or methods may be supported later. To use this feature, you need to sign up for a free account with TheIndex to get an API key.
Snapshot Indexed Mints
Usage
metaboss snapshot indexed-mints --creator <FIRST_VERIFIED_CREATOR> --api-key <THEINDEX.IO_API_KEY>
Snapshot Indexed Holders
Usage
metaboss snapshot indexed-holders --creator <FIRST_VERIFIED_CREATOR> --api-key <THEINDEX.IO_API_KEY>