diff --git a/docs-src/src/create.md b/docs-src/src/create.md index dce75b8..8c8c42e 100644 --- a/docs-src/src/create.md +++ b/docs-src/src/create.md @@ -36,6 +36,17 @@ Use the `--initial-suply` option to mint the specified amount directly to your k metaboss create fungible -d 3 -m crab.json --initial-supply 10.1 ``` +#### Vanity Mints + +You can specify a vanity mint address by using the `--mint-path` option to specify a path to a keypair on your file system. +It will use this for the mint account instead of creating a new one. + +```bash +metaboss create fungible -d -m --mint-path +``` + +```bash + ### Metadata Decorate an existing SPL token mint with metadata. diff --git a/docs-src/src/mint.md b/docs-src/src/mint.md index 4475b49..ebd8ea1 100644 --- a/docs-src/src/mint.md +++ b/docs-src/src/mint.md @@ -44,6 +44,11 @@ If `receiver` is set, the NFT will be minted directly to the receiver's address, Use the `--sign` option to sign the metadata with the keypair immediately after minting. +#### Vanity Mints + +You can specify a vanity mint address by using the `--mint-path` option to specify a path to a keypair on your file system. +It will use this for the mint account instead of creating a new one. + #### Editions To mint a NFT with the ability to print editions from it use the `--max-editions ` option. This defaults to `0` meaning no editions are allowed. Setting it to a positive integer means you can print up to that many editions. Setting to a value of `-1` means unlimited editions. Because of how the CLI interprets the `-` symbol to set max editions to infinite you should use the `=` sign for the `--max-editions` option: `metaboss mint one -a --max-editions='-1'`. @@ -98,12 +103,15 @@ OPTIONS: Amount of tokens to mint, for NonFungible types this must be 1 [default: 1] -d, --asset-data Asset data - --decimals Mint decimals for fungible tokens + --decimals Mint decimals for fungible tokens [default: 0] -k, --keypair Path to the update_authority keypair file -l, --log-level Log level [default: off] -s, --max-print-edition-supply Max supply of print editions. Only applies to NonFungible types. 0 for no prints, n for n prints, 'unlimited' for unlimited prints + -m, --mint-path + Path to mint keypair file, if minting from existing keypair + -R, --receiver Receiving address, if different from update authority -r, --rpc RPC endpoint url to override using the Solana config or the hard-coded default @@ -141,7 +149,6 @@ You need an asset json file of this format: Substitute appropriate values for each field. The creator can only be set as verified if it is the same keypair as the one used to mint the asset, otherwise leave it as `false`. - ```bash metaboss mint asset -d -k -R -s ``` @@ -159,3 +166,8 @@ Leave off the `--receiver` option to mint to your keypair. All non-fungible type assets: currently `NonFungible` and `ProgrammableNonFungible`, require the `print-supply` option to be specified to set the maximum number of print editions that can be minted from the asset. For most PFP, 1/1, style NFTs, this should be set to `0` to prevent any editions being minted. Other options are: `n` for a limited number of `n` editions (e.g. `10`), or `unlimited` to allow unlimited editions to be minted. Fungible types such as `Fungible` and `FungibleAsset` should leave this value off as it has no meaning for them and the `mint asset` command will fail if that is specified for a fungible type. + +#### Vanity Mints + +You can specify a vanity mint address by using the `--mint-path` option to specify a path to a keypair on your file system. +It will use this for the mint account instead of creating a new one. \ No newline at end of file diff --git a/docs/create.html b/docs/create.html index 98e965d..0c7a99f 100644 --- a/docs/create.html +++ b/docs/create.html @@ -193,13 +193,25 @@

Usage

```bash metaboss create fungible -d 3 -m crab.json --initial-supply 10.1 -

Metadata

-

Decorate an existing SPL token mint with metadata.

-

Usage

-

Specify the token decimals and path to a metadata file that contains the name, symbol and uri fields in a JSON format.

-

E.g. (Note the snake_case field name):

-

// crab.json

-
{
+
Vanity Mints

+
You can specify a vanity mint address by using the --mint-path option to specify a path to a keypair on your file system.
+It will use this for the mint account instead of creating a new one.

+
metaboss create fungible -d <decimals> -m <metadata_file> --mint-path <path_to_keypair>
+

+

+### Metadata
+
+Decorate an existing SPL token mint with metadata.
+
+#### Usage
+
+Specify the token decimals and path to a metadata file that contains the `name`, `symbol` and `uri` fields in a JSON format.
+
+E.g. (Note the snake_case field name):
+
+// crab.json
+```json
+{
   "name": "Crabbie",
   "symbol": "CRAB",
   "uri": "https://arweave.net/KZDlKw8aCG4kfZtj9Qmh8tmYpH4Q287P_jmUtkl2s-k"
diff --git a/docs/mint.html b/docs/mint.html
index 6a3ebb5..1a55450 100644
--- a/docs/mint.html
+++ b/docs/mint.html
@@ -200,6 +200,9 @@ 
Usage

 
The --external-metadata-uri option takes a URI to an external metadata file such as an Arweave link pointing to a JSON file.

 
If receiver is set, the NFT will be minted directly to the receiver's address, otherwise it is minted to keypair. Observant users may note that with a simple bash script this allows airdrops to be deployed with Metaboss.

 
Use the --sign option to sign the metadata with the keypair immediately after minting.

+
Vanity Mints

+
You can specify a vanity mint address by using the --mint-path option to specify a path to a keypair on your file system.
+It will use this for the mint account instead of creating a new one.

 
Editions

 
To mint a NFT with the ability to print editions from it use the --max-editions <max-editions> option. This defaults to 0 meaning no editions are allowed. Setting it to a positive integer means you can print up to that many editions. Setting to a value of -1 means unlimited editions. Because of how the CLI interprets the - symbol to set max editions to infinite you should use the = sign for the --max-editions option: metaboss mint one -a <master_account> --max-editions='-1'.

 
To mint editions from a master NFT use themetaboss mint editions command to either mint the next n editions sequentially using --next-editions <int> or mint specific edition numbers using --specific-editions <int> <int> <int> with a list of integer edition numbers to mint.

@@ -231,12 +234,15 @@ 
Mint Asset

             Amount of tokens to mint, for NonFungible types this must be 1 [default: 1]
 
     -d, --asset-data <asset-data>                                Asset data
-        --decimals <decimals>                                    Mint decimals for fungible tokens
+        --decimals <decimals>                                    Mint decimals for fungible tokens [default: 0]
     -k, --keypair <keypair>                                      Path to the update_authority keypair file
     -l, --log-level <log-level>                                  Log level [default: off]
     -s, --max-print-edition-supply <max-print-edition-supply>
             Max supply of print editions. Only applies to NonFungible types. 0 for no prints, n for n prints,
             'unlimited' for unlimited prints
+    -m, --mint-path <mint-path>
+            Path to mint keypair file, if minting from existing keypair
+
     -R, --receiver <receiver>                                    Receiving address, if different from update authority
     -r, --rpc <rpc>
             RPC endpoint url to override using the Solana config or the hard-coded default
@@ -277,6 +283,9 @@ 
Usage

 
Print Supply

 
All non-fungible type assets: currently NonFungible and ProgrammableNonFungible, require the print-supply option to be specified to set the maximum number of print editions that can be minted from the asset. For most PFP, 1/1, style NFTs, this should be set to 0 to prevent any editions being minted. Other options are: n for a limited number of n editions (e.g. 10), or unlimited to allow unlimited editions to be minted.

 
Fungible types such as Fungible and FungibleAsset should leave this value off as it has no meaning for them and the mint asset command will fail if that is specified for a fungible type.

+
Vanity Mints

+
You can specify a vanity mint address by using the --mint-path option to specify a path to a keypair on your file system.
+It will use this for the mint account instead of creating a new one.

 
                     
 
diff --git a/docs/print.html b/docs/print.html
index 10708fe..c9cd35d 100644
--- a/docs/print.html
+++ b/docs/print.html
@@ -558,13 +558,25 @@ 
Usage

 ```bash
 metaboss create fungible -d 3 -m crab.json --initial-supply 10.1
 

-
Metadata

-
Decorate an existing SPL token mint with metadata.

-
Usage

-
Specify the token decimals and path to a metadata file that contains the name, symbol and uri fields in a JSON format.

-
E.g. (Note the snake_case field name):

-
// crab.json

-
{
+
Vanity Mints

+
You can specify a vanity mint address by using the --mint-path option to specify a path to a keypair on your file system.
+It will use this for the mint account instead of creating a new one.

+
metaboss create fungible -d <decimals> -m <metadata_file> --mint-path <path_to_keypair>
+

+

+### Metadata
+
+Decorate an existing SPL token mint with metadata.
+
+#### Usage
+
+Specify the token decimals and path to a metadata file that contains the `name`, `symbol` and `uri` fields in a JSON format.
+
+E.g. (Note the snake_case field name):
+
+// crab.json
+```json
+{
   "name": "Crabbie",
   "symbol": "CRAB",
   "uri": "https://arweave.net/KZDlKw8aCG4kfZtj9Qmh8tmYpH4Q287P_jmUtkl2s-k"
@@ -575,7 +587,7 @@ 
Usage

 
Decode

 
Decode Mint

 
Decodes a mint account's metadata into a JSON file. It accepts either a single account or a list of accounts.

-
Usage

+
Usage

 
metaboss decode mint --account <MINT_ACCOUNT> -o <OUPUT_DIRECTORY>
 

 
The command will write the metadata JSON file to the output directory with the mint account as the name: e.g. CQNKXw1rw2eWwi812Exk4cKUjKuomZ2156STGRyXd2Mp.json. The output option defaults to the current directory.

@@ -589,34 +601,34 @@ 
Usage

 
Use --raw to get the account data as raw bytes for debugging purposes.

 
Decode Edition

 
Decodes a single Print Edition account from a mint account into a JSON file. This is a Print Edition PDA.

-
Usage

+
Usage

 
metaboss decode edition --account <MINT_ACCOUNT> 
 

 
Decode Edition Marker

 
Decodes a single Edition Marker PDA account from a mint account into a JSON file. This takes the Master Edition NFT mint account and either the edition number or the desired edition marker number, zero-indexed.

-
Usage

+
Usage

 
In this example, it will decode the 2nd Edition Marker PDA which corresponds to Edition numbers 248-495.

 
metaboss decode edition-marker --account <MASTER_EDITION_MINT_ACCOUNT> -m 1
 

 
Decode Master

 
Decodes a single Master Edition account from a mint account into a JSON file. This is a Master Edition PDA.

-
Usage

+
Usage

 
metaboss decode master --account <MINT_ACCOUNT> 
 

 
Decode Rulset

 
Decode a programmable NFT rule set from a pubkey.

-
Usage

+
Usage

 
metaboss decode rule-set AdH2Utn6Fus15ZhtenW4hZBQnvtLgM1YCW2MfVp7pYS5
 

 
Decode Pubkey

 
Decode a pubkey from a u8 array.

-
Usage

+
Usage

 
metaboss decode pubkey "[198,63,89,223,232,36,128,201,194,84,163,124,239,91,140,18,189,137,137,47,53,111,44,226,53,45,91,202,241,224,183,205]"
 

 
Derive

 
Derive Candy Machine V2 Creator

 
Derive the candy machine creator PDA from the candy machine id.

-
Usage

+
Usage

 
metaboss derive cmv2-creator <candy_machine_id>
 

 
Derive Edition

@@ -629,7 +641,7 @@ 
Derive Metada
 

 
Derive PDA

 
Derive a generic PDA from a list of seeds and a program id.

-
Usage

+
Usage

 
metaboss derive pda <seed1>,<seed2>,<seed3> <program_id>
 

 
Find

@@ -665,7 +677,7 @@ 
Missing Edi
 
For both subcommands the --immutable flag sets the NFT data to be immutable and the --primary-sale-happened flag sets the primary sale happened bool to true.

 
Mint One

 
Mint a single NFT from a JSON file.

-
Usage

+
Usage

 
metaboss mint one --keypair <KEYPAIR> --nft-data-file <PATH_TO_NFT_DATA_FILE> --receiver <RECEIVER_ADDRESS>
 

 
metaboss mint one --keypair <KEYPAIR> --external-metadata-uri <EXTERNAL_METADATA_URI> --receiver <RECEIVER_ADDRESS> --immutable --primary-sale-happened
@@ -689,6 +701,9 @@ 
Usage

 
The --external-metadata-uri option takes a URI to an external metadata file such as an Arweave link pointing to a JSON file.

 
If receiver is set, the NFT will be minted directly to the receiver's address, otherwise it is minted to keypair. Observant users may note that with a simple bash script this allows airdrops to be deployed with Metaboss.

 
Use the --sign option to sign the metadata with the keypair immediately after minting.

+
Vanity Mints

+
You can specify a vanity mint address by using the --mint-path option to specify a path to a keypair on your file system.
+It will use this for the mint account instead of creating a new one.

 
Editions

 
To mint a NFT with the ability to print editions from it use the --max-editions <max-editions> option. This defaults to 0 meaning no editions are allowed. Setting it to a positive integer means you can print up to that many editions. Setting to a value of -1 means unlimited editions. Because of how the CLI interprets the - symbol to set max editions to infinite you should use the = sign for the --max-editions option: metaboss mint one -a <master_account> --max-editions='-1'.

 
To mint editions from a master NFT use themetaboss mint editions command to either mint the next n editions sequentially using --next-editions <int> or mint specific edition numbers using --specific-editions <int> <int> <int> with a list of integer edition numbers to mint.

@@ -697,7 +712,7 @@ 
Editions

 
To find the full list of options for each command use -h or --help as normal.

 
Mint List

 
Mint multiple NFTs from a list of JSON files.

-
Usage

+
Usage

 
metaboss mint list --keypair <KEYPAIR> --nft-data-dir <PATH_TO_NFT_DATA_FILE> --receiver <RECEIVER_ADDRESS>
 

 
This command functions the same as mint one except instead of a single JSON file, provide a path to a directory with multiple JSON files, one for each NFT to be minted.

@@ -720,12 +735,15 @@ 
Mint Asset

             Amount of tokens to mint, for NonFungible types this must be 1 [default: 1]
 
     -d, --asset-data <asset-data>                                Asset data
-        --decimals <decimals>                                    Mint decimals for fungible tokens
+        --decimals <decimals>                                    Mint decimals for fungible tokens [default: 0]
     -k, --keypair <keypair>                                      Path to the update_authority keypair file
     -l, --log-level <log-level>                                  Log level [default: off]
     -s, --max-print-edition-supply <max-print-edition-supply>
             Max supply of print editions. Only applies to NonFungible types. 0 for no prints, n for n prints,
             'unlimited' for unlimited prints
+    -m, --mint-path <mint-path>
+            Path to mint keypair file, if minting from existing keypair
+
     -R, --receiver <receiver>                                    Receiving address, if different from update authority
     -r, --rpc <rpc>
             RPC endpoint url to override using the Solana config or the hard-coded default
@@ -733,7 +751,7 @@ 
Mint Asset

     -T, --timeout <timeout>
             Timeout to override default value of 90 seconds [default: 90]
 

-
Usage

+
Usage

 
You need an asset json file of this format:

 
    {
         "name": "Studious Crab #1",
@@ -766,6 +784,9 @@ 
Usage

 
Print Supply

 
All non-fungible type assets: currently NonFungible and ProgrammableNonFungible, require the print-supply option to be specified to set the maximum number of print editions that can be minted from the asset. For most PFP, 1/1, style NFTs, this should be set to 0 to prevent any editions being minted. Other options are: n for a limited number of n editions (e.g. 10), or unlimited to allow unlimited editions to be minted.

 
Fungible types such as Fungible and FungibleAsset should leave this value off as it has no meaning for them and the mint asset command will fail if that is specified for a fungible type.

+
Vanity Mints

+
You can specify a vanity mint address by using the --mint-path option to specify a path to a keypair on your file system.
+It will use this for the mint account instead of creating a new one.

 
Set

 
Warning: These commands modify your NFT and are for advanced users. Use with caution. 
 Set commands are either irreversible or require a new update authority to reverse.

@@ -816,7 +837,7 @@ 
Set Tok
     -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]
 

-
Usage

+
Usage

 
metaboss set token-standard --keypair <PATH_TO_KEYPAIR> --account <MINT_ACCOUNT>
 

 
Set Token Standard-All

@@ -838,7 +859,7 @@ 

-
Usage

+
Usage

 
metaboss set token-standard-all --keypair <PATH_TO_KEYPAIR> --mint-list <PATH_TO_MINT_ACCOUNTS>
 

 
Sign

@@ -846,13 +867,13 @@ 
Usage

 
Sign metadata for an unverified creator.

 
Sign One

 
Sign the metadata for a single mint account.

-
Usage

+
Usage

 
metaboss sign one --keypair <PATH_TO_KEYPAIR> --account <MINT_ACCOUNT>
 

 
Outputs a TxId to the command line so you can check the result.

 
Sign All

 
Sign all metadata from a JSON list or for a given first verified creator. First verified creator can be the candy machine creator id or whatever the first verified creator in the creators array is for your NFTs.

-
Usage

+
Usage

 
metaboss sign all --keypair <PATH_TO_KEYPAIR> --creator <FIRST_CREATOR>
 

 
For candy machine v2, you can add the --v2 option when using it with the candy machine id.
@@ -877,7 +898,7 @@ 
Usage

 
Get snapshots of various blockchain states.

 
Snapshot CM-Accounts

 
Snapshot all candy machine config and state accounts for a given update_authority.

-
Usage

+
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:

@@ -907,7 +928,7 @@ 
Usage

 
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

+
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).

@@ -938,7 +959,7 @@ 
Usage

Snapshot Mints

Snapshot all mint accounts for a given verified candy machine id/first creator or update authority

-

Usage

+

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).

@@ -960,11 +981,11 @@

Usage

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

+

Usage

metaboss snapshot indexed-mints --creator <FIRST_VERIFIED_CREATOR> --api-key <THEINDEX.IO_API_KEY>

Snapshot Indexed Holders

-

Usage

+

Usage

metaboss snapshot indexed-holders --creator <FIRST_VERIFIED_CREATOR> --api-key <THEINDEX.IO_API_KEY>

Snapshot Prints

@@ -1003,7 +1024,7 @@

Snapshot Prin

The user can optionally pass in a first verified creator to use instead of deriving it from the master edition.

Limitations:

For master editions that have had prints minted, and then had their first verified creator changed and then more prints minted, it will take multiple runs of this command with each of the first verified creators to find all the prints and the user will need to track them in separate files and merge them manually as it will overwrite the default output file each time.

-

Usage

+

Usage

metaboss snapshot prints -m <MASTER_EDITION_MINT> -c <OPTIONAL_FIRST_VERIFIED_CREATOR>

Transfer

@@ -1025,7 +1046,7 @@

Transfer Asset< -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] -

Usage

+

Usage

metaboss transfer asset --mint <asset_mint_address> --receiver <receiver_wallet_address>

E.g.:

@@ -1040,7 +1061,7 @@

Usage

See also Set commands for updatable values that cannot be reversed (e.g. set immutable).

Update Data

Update the Data struct on a NFT from a JSON file.

-

Usage

+

Usage

metaboss update data --keypair <PATH_TO_KEYPAIR> --account <MINT_ACCOUNT> --new-data-file <PATH_TO_NEW_DATA_FILE>

The JSON file should include all the fields of the metadata Data struct and should match creator verified bools for existing creators. E.g. if your NFT was minted by the Metaplex Candy Machine program, and you wish to keep your candy machine as a verified creator you must add the candy machine to your creators array with verified set to true.

@@ -1073,7 +1094,7 @@

Usage

Outputs a TxId to the command line so you can check the result.

Update Data All

Update the Data struct on a list of NFTs from JSON files.

-

Usage

+

Usage

metaboss update data-all --keypair <PATH_TO_KEYPAIR> --data-dir <PATH_TO_DATA_DIR>

Each JSON file in the data directory should include the mint account and all the fields of the metadata Data struct and should match creator verified bools for existing creators. E.g. if your NFT was minted by the Metaplex Candy Machine program, and you wish to keep your candy machine as a verified creator you must add the candy machine to your creators array with verified set to true.

@@ -1109,22 +1130,22 @@

Usage

Outputs a TxId to the command line so you can check the result.

Update Name

Update the on-chain name of a NFT, keeping the rest of the Data struct the same.

-

Usage

+

Usage

 metaboss update name --keypair <PATH_TO_KEYPAIR> --account <MINT_ACCOUNT> --new-name <NEW_NAME>

Update Symbol

Update the on-chain symbol of a NFT, keeping the rest of the Data struct the same.

-

Usage

+

Usage

 metaboss update symbol --keypair <PATH_TO_KEYPAIR> --account <MINT_ACCOUNT> --new-symbol <NEW_SYMBOL>

Update Symbol All

Update the on-chain symbol of a list of NFTs, keeping the rest of the Data struct the same.

-

Usage

+

Usage

 metaboss update symbol-all --keypair <PATH_TO_KEYPAIR> -L <PATH_TO_LIST_MINT_ADDRESSES> --new-symbol <NEW_SYMBOL>

Update Creators

Update the creators of a NFT, keeping the rest of the Data struct the same.

-

Usage

+

Usage

metaboss update creators -k <PATH_TO_KEYPAIR> -a <MINT_ACCOUNT> -n <CREATOR1:SHARE:VERIFIED,CREATOR2:SHARE:VERIFIED>

Creators should be a comma-delimited list of creator:share:verified. E.g.

@@ -1138,12 +1159,12 @@

Updat

Update URI

Update the metadata URI, keeping the rest of the Data struct the same.

-

Usage

+

Usage

metaboss update uri --keypair <PATH_TO_KEYPAIR> --account <MINT_ACCOUNT> --new-uri <NEW_URI>

Update URI All

Update the metadata URI for a list of mint accounts, keeping the rest of the Data struct the same.

-

Usage

+

Usage

metaboss update uri-all --keypair <PATH_TO_KEYPAIR> --new-uris-file <PATH_TO_JSON_FILE>
 
[
@@ -1159,12 +1180,12 @@ 
Usage

Update Seller Fee Basis Points

Update the seller fee basis points field on an NFT, keeping the rest of the Data struct the same.

-

Usage

+

Usage

metaboss update sfbp --keypair <PATH_TO_KEYPAIR> -a <MINT_ACCOUNT> -n <NEW_SELLER_FEE_BASIS_POINTS_VALUE>

Update Seller Fee Basis Points All

Update the seller fee basis points field on a list of NFTs, keeping the rest of the Data struct the same.

-

Usage

+

Usage

metaboss update sfbp-all --keypair <PATH_TO_KEYPAIR> -L <PATH_TO_MINT_LIST.json> -n <NEW_SELLER_FEE_BASIS_POINTS_VALUE>

Update Rule Set

@@ -1184,7 +1205,7 @@

Update Rule S -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] -

Usage

+

Usage

metaboss update rule-set --mint <MINT_ADDRESS> --new-rule-set <NEW_RULE_SET_PUBKEY>

E.g.:

@@ -1210,7 +1231,7 @@

Updat -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] -

Usage

+

Usage

metaboss update rule-set-all -L <MINT_LIST> -n <NEW_RULE_SET_ADDRESS>

E.g.:

@@ -1232,7 +1253,7 @@

U -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] -

Usage

+

Usage

metaboss update clear-rule-set --mint <MINT_ADDRESS>

E.g.:

@@ -1257,7 +1278,7 @@

Usage

+

Usage

metaboss update clear-rule-set-all -L <MINT_LIST>

E.g.:

@@ -1299,7 +1320,7 @@

Creator

-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] -

Usage

+

Usage

metaboss verify creator --account <MINT_ACCOUNT> --keypair <CREATOR_KEYPAIR_FILE>

Creator All

@@ -1321,7 +1342,7 @@

Creator All

-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] -

Usage

+

Usage

metaboss verify creator-all --mint-list <MINT_LIST_FILE> --keypair <CREATOR_KEYPAIR_FILE>

Unverify

@@ -1360,7 +1381,7 @@

Creator

-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] -

Usage

+

Usage

metaboss unverify creator --account <MINT_ACCOUNT> --keypair <CREATOR_KEYPAIR_FILE>

Creator All

@@ -1382,7 +1403,7 @@

Creator All -

Usage

+

Usage

metaboss unverify creator-all --mint-list <MINT_LIST_FILE> --keypair <CREATOR_KEYPAIR_FILE>

Withdraw (Deprecated)

diff --git a/docs/searchindex.js b/docs/searchindex.js index 5da54fe..1705a3e 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Object.assign(window.search, {"doc_urls":["overview.html#metaboss","quick_start.html#quick-start","quick_start.html#install-binary","quick_start.html#install-with-cargo","quick_start.html#see-usage-commands","installation.html#installation","installation.html#recommended-way-to-install","installation.html#binaries","installation.html#cratesio","installation.html#install-from-source","installation.html#set-up-your-solana-config","examples.html#examples","examples.html#update-the-uri-of-an-existing-nft","examples.html#mint-a-new-nft","examples.html#snapshot-candy-machine-mint-accounts","recipes.html#update-list-of-nft-metadata","global_options.html#global-options","global_options.html#options","airdrop.html#airdrop","airdrop.html#airdrop-sol","burn.html#burn","burn.html#burn-one","burn.html#burn-all","burn.html#burn-print","burn.html#burn-print-one","burn.html#burn-print-all","check.html#check","check.html#metadata-values","check.html#usage","collections.html#collections","collections.html#migrate","collections.html#running-the-commands","collections.html#output-file","collections.html#get-and-check-collection-items","collections.html#get-items","collections.html#check-items","create.html#create","create.html#fungible","create.html#metadata","decode.html#decode","decode.html#decode-mint","decode.html#decode-edition","decode.html#decode-edition-marker","decode.html#decode-master","decode.html#decode-rulset","decode.html#decode-pubkey","derive.html#derive","derive.html#derive-candy-machine-v2-creator","derive.html#derive-edition","derive.html#derive-metadata","derive.html#derive-pda","find.html#find","find.html#error","find.html#missing-editions","mint.html#mint","mint.html#mint-one","mint.html#mint-list","mint.html#mint-asset","set.html#set","set.html#set-secondary-sale","set.html#set-secondary-sale-all","set.html#set-update-authority","set.html#set-update-authority-all","set.html#set-immutable","set.html#set-immutable-all","set.html#set-token-standard","set.html#set-token-standard-all","sign.html#sign","sign.html#sign-one","sign.html#sign-all","snapshot.html#snapshot","snapshot.html#snapshot-cm-accounts","snapshot.html#snapshot-holders","snapshot.html#snapshot-mints","snapshot.html#indexed-data","snapshot.html#snapshot-indexed-mints","snapshot.html#snapshot-indexed-holders","snapshot.html#snapshot-prints","transfer.html#transfer","transfer.html#transfer-asset","transfer.html#usage","update.html#update","update.html#update-data","update.html#update-data-all","update.html#update-name","update.html#update-symbol","update.html#update-symbol-all","update.html#update-creators","update.html#update-creators-all","update.html#update-uri","update.html#update-uri-all","update.html#update-seller-fee-basis-points","update.html#update-seller-fee-basis-points-all","update.html#update-rule-set","update.html#update-rule-set-all","update.html#update-clear-rule-set","update.html#update-clear-rule-set-all","verify_unverify.html#verify","verify_unverify.html#creator","verify_unverify.html#creator-all","verify_unverify.html#unverify","verify_unverify.html#creator-1","verify_unverify.html#creator-all-1","withdraw.html#withdraw-deprecated","contact.html#contact"],"index":{"documentStore":{"docInfo":{"0":{"body":161,"breadcrumbs":2,"title":1},"1":{"body":0,"breadcrumbs":4,"title":2},"10":{"body":20,"breadcrumbs":5,"title":4},"100":{"body":60,"breadcrumbs":2,"title":1},"101":{"body":82,"breadcrumbs":2,"title":1},"102":{"body":116,"breadcrumbs":2,"title":1},"103":{"body":8,"breadcrumbs":3,"title":2},"104":{"body":9,"breadcrumbs":2,"title":1},"11":{"body":0,"breadcrumbs":2,"title":1},"12":{"body":8,"breadcrumbs":5,"title":4},"13":{"body":40,"breadcrumbs":4,"title":3},"14":{"body":21,"breadcrumbs":6,"title":5},"15":{"body":58,"breadcrumbs":5,"title":4},"16":{"body":17,"breadcrumbs":4,"title":2},"17":{"body":63,"breadcrumbs":3,"title":1},"18":{"body":49,"breadcrumbs":2,"title":1},"19":{"body":184,"breadcrumbs":3,"title":2},"2":{"body":28,"breadcrumbs":4,"title":2},"20":{"body":12,"breadcrumbs":2,"title":1},"21":{"body":18,"breadcrumbs":3,"title":2},"22":{"body":31,"breadcrumbs":2,"title":1},"23":{"body":8,"breadcrumbs":3,"title":2},"24":{"body":20,"breadcrumbs":4,"title":3},"25":{"body":45,"breadcrumbs":3,"title":2},"26":{"body":0,"breadcrumbs":2,"title":1},"27":{"body":7,"breadcrumbs":3,"title":2},"28":{"body":140,"breadcrumbs":2,"title":1},"29":{"body":0,"breadcrumbs":2,"title":1},"3":{"body":6,"breadcrumbs":4,"title":2},"30":{"body":105,"breadcrumbs":2,"title":1},"31":{"body":265,"breadcrumbs":3,"title":2},"32":{"body":38,"breadcrumbs":3,"title":2},"33":{"body":0,"breadcrumbs":4,"title":3},"34":{"body":68,"breadcrumbs":2,"title":1},"35":{"body":46,"breadcrumbs":3,"title":2},"36":{"body":0,"breadcrumbs":2,"title":1},"37":{"body":85,"breadcrumbs":2,"title":1},"38":{"body":39,"breadcrumbs":2,"title":1},"39":{"body":0,"breadcrumbs":2,"title":1},"4":{"body":21,"breadcrumbs":5,"title":3},"40":{"body":100,"breadcrumbs":3,"title":2},"41":{"body":18,"breadcrumbs":3,"title":2},"42":{"body":44,"breadcrumbs":4,"title":3},"43":{"body":18,"breadcrumbs":3,"title":2},"44":{"body":12,"breadcrumbs":3,"title":2},"45":{"body":8,"breadcrumbs":3,"title":2},"46":{"body":0,"breadcrumbs":2,"title":1},"47":{"body":14,"breadcrumbs":6,"title":5},"48":{"body":9,"breadcrumbs":3,"title":2},"49":{"body":9,"breadcrumbs":3,"title":2},"5":{"body":0,"breadcrumbs":2,"title":1},"50":{"body":13,"breadcrumbs":3,"title":2},"51":{"body":0,"breadcrumbs":2,"title":1},"52":{"body":60,"breadcrumbs":2,"title":1},"53":{"body":12,"breadcrumbs":3,"title":2},"54":{"body":23,"breadcrumbs":2,"title":1},"55":{"body":225,"breadcrumbs":3,"title":2},"56":{"body":80,"breadcrumbs":3,"title":2},"57":{"body":263,"breadcrumbs":3,"title":2},"58":{"body":22,"breadcrumbs":2,"title":1},"59":{"body":22,"breadcrumbs":4,"title":3},"6":{"body":92,"breadcrumbs":4,"title":3},"60":{"body":12,"breadcrumbs":4,"title":3},"61":{"body":21,"breadcrumbs":4,"title":3},"62":{"body":37,"breadcrumbs":4,"title":3},"63":{"body":13,"breadcrumbs":3,"title":2},"64":{"body":13,"breadcrumbs":3,"title":2},"65":{"body":84,"breadcrumbs":4,"title":3},"66":{"body":113,"breadcrumbs":4,"title":3},"67":{"body":12,"breadcrumbs":2,"title":1},"68":{"body":19,"breadcrumbs":3,"title":2},"69":{"body":103,"breadcrumbs":2,"title":1},"7":{"body":12,"breadcrumbs":2,"title":1},"70":{"body":4,"breadcrumbs":2,"title":1},"71":{"body":49,"breadcrumbs":4,"title":3},"72":{"body":130,"breadcrumbs":3,"title":2},"73":{"body":89,"breadcrumbs":3,"title":2},"74":{"body":26,"breadcrumbs":3,"title":2},"75":{"body":10,"breadcrumbs":4,"title":3},"76":{"body":10,"breadcrumbs":4,"title":3},"77":{"body":169,"breadcrumbs":3,"title":2},"78":{"body":6,"breadcrumbs":2,"title":1},"79":{"body":85,"breadcrumbs":3,"title":2},"8":{"body":3,"breadcrumbs":2,"title":1},"80":{"body":36,"breadcrumbs":2,"title":1},"81":{"body":21,"breadcrumbs":2,"title":1},"82":{"body":120,"breadcrumbs":3,"title":2},"83":{"body":169,"breadcrumbs":3,"title":2},"84":{"body":20,"breadcrumbs":3,"title":2},"85":{"body":20,"breadcrumbs":3,"title":2},"86":{"body":21,"breadcrumbs":3,"title":2},"87":{"body":46,"breadcrumbs":3,"title":2},"88":{"body":17,"breadcrumbs":3,"title":2},"89":{"body":19,"breadcrumbs":3,"title":2},"9":{"body":50,"breadcrumbs":3,"title":2},"90":{"body":29,"breadcrumbs":3,"title":2},"91":{"body":21,"breadcrumbs":6,"title":5},"92":{"body":23,"breadcrumbs":6,"title":5},"93":{"body":108,"breadcrumbs":4,"title":3},"94":{"body":137,"breadcrumbs":4,"title":3},"95":{"body":86,"breadcrumbs":5,"title":4},"96":{"body":118,"breadcrumbs":5,"title":4},"97":{"body":60,"breadcrumbs":2,"title":1},"98":{"body":82,"breadcrumbs":2,"title":1},"99":{"body":116,"breadcrumbs":2,"title":1}},"docs":{"0":{"body":"Stars Forks Crate Downloads 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 --help and metaboss --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.","breadcrumbs":"Overview » Metaboss","id":"0","title":"Metaboss"},"1":{"body":"","breadcrumbs":"Quick Start » Quick Start","id":"1","title":"Quick Start"},"10":{"body":"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 --keypair ","breadcrumbs":"Installation » Set Up Your Solana Config","id":"10","title":"Set Up Your Solana Config"},"100":{"body":"Unverify Creators USAGE: metaboss unverify [OPTIONS] FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -l, --log-level Log level [default: off] -r, --rpc RPC endpoint url to override using the Solana config or the hard-coded default -T, --timeout Timeout to override default value of 90 seconds [default: 90] SUBCOMMANDS: creator creator-all help Prints this message or the help of the given subcommand(s)","breadcrumbs":"Verify/Unverify » Unverify","id":"100","title":"Unverify"},"101":{"body":"Unverify a creator in the metadata creators array by signing for it with its keypair. Creators can only unverify themselves. USAGE: metaboss unverify creator [OPTIONS] --mint FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -k, --keypair Path to the update_authority keypair file -l, --log-level Log level [default: off] -a, --mint Mint account of token to transfer -r, --rpc RPC endpoint url to override using the Solana config or the hard-coded default -T, --timeout Timeout to override default value of 90 seconds [default: 90] Usage metaboss unverify creator --account --keypair ","breadcrumbs":"Verify/Unverify » Creator","id":"101","title":"Creator"},"102":{"body":"Unverify a creator in the metadata creators array of a list of metadata accounts, by signing for it with its keypair. Creators can only unverify themselves. USAGE: metaboss unverify creator-all [OPTIONS] FLAGS: -h, --help Prints help information -V, --version Prints version information OPTIONS: -c, --cache-file Cache file -k, --keypair Path to the update_authority keypair file -l, --log-level Log level [default: off] -L, --mint-list Mint list -R, --rate-limit Maximum number of requests per second [default: 10] --retries Maximum retries: retry failed items up to this many times [default: 0] -r, --rpc RPC endpoint url to override using the Solana config or the hard-coded default -T, --timeout Timeout to override default value of 90 seconds [default: 90] Usage metaboss unverify creator-all --mint-list --keypair ","breadcrumbs":"Verify/Unverify » Creator All","id":"102","title":"Creator All"},"103":{"body":"Use Metaplex's Sugar tool for withdrawing from candy machines instead.","breadcrumbs":"Withdraw » Withdraw (Deprecated)","id":"103","title":"Withdraw (Deprecated)"},"104":{"body":"Email: sam@vanderwaal.dev Twitter: @samvwaal Discord: @archaeopteryx#7615 Metaboss Discord Server","breadcrumbs":"Contact » Contact","id":"104","title":"Contact"},"11":{"body":"","breadcrumbs":"Examples » Examples","id":"11","title":"Examples"},"12":{"body":"metaboss update uri -k ~/.config/solana/devnet.json -a CQNKXw1rw2eWwi812Exk4cKUjKuomZ2156STGRyXd2Mp -u https://arweave.net/N36gZYJ6PEH8OE11i0MppIbPG4VXKV4iuQw1zaq3rls","breadcrumbs":"Examples » Update the URI of an existing NFT","id":"12","title":"Update the URI of an existing NFT"},"13":{"body":"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 } ]\n} 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","breadcrumbs":"Examples » Mint a new NFT","id":"13","title":"Mint a new NFT"},"14":{"body":"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\"\n]","breadcrumbs":"Examples » Snapshot Candy Machine Mint Accounts","id":"14","title":"Snapshot Candy Machine Mint Accounts"},"15":{"body":"Get your NFT mint list using metaboss snapshot or another tool. Decode all the metadata into files using metaboss decode mint -L --full -o . Update the specific data you want changed in each file in the . Update the NFTs with metaboss update data-all -d . Note : many fields have specific update -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.","breadcrumbs":"Recipes » Update List of NFT Metadata","id":"15","title":"Update List of NFT Metadata"},"16":{"body":"These are the options that apply to all subcommands and can be passed in at any level. metaboss