diff --git a/docs-src/src/create.md b/docs-src/src/create.md index 0fd8383..f2e9f56 100644 --- a/docs-src/src/create.md +++ b/docs-src/src/create.md @@ -44,7 +44,7 @@ Decorate an existing SPL token mint with metadata. Specify the existing mint address and path to a metadata file that contains the `Data` sub-struct of the metadata struct in a JSON format. -E.g.: +E.g. (Note the snake_case field name): // crab.json ```json @@ -52,7 +52,7 @@ E.g.: "name": "Crabbie", "symbol": "CRAB", "uri": "https://arweave.net/KZDlKw8aCG4kfZtj9Qmh8tmYpH4Q287P_jmUtkl2s-k", - "sellerFeeBasisPoints": 0, + "seller_fee_basis_points": 0, "creators": null } ``` diff --git a/docs/create.html b/docs/create.html index 81fbed7..21c13a6 100644 --- a/docs/create.html +++ b/docs/create.html @@ -192,13 +192,13 @@

Metadata

Decorate an existing SPL token mint with metadata.

Usage

Specify the existing mint address and path to a metadata file that contains the Data sub-struct of the metadata struct in a JSON format.

-

E.g.:

+

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

// crab.json

{
   "name": "Crabbie",
   "symbol": "CRAB",
   "uri": "https://arweave.net/KZDlKw8aCG4kfZtj9Qmh8tmYpH4Q287P_jmUtkl2s-k",
-  "sellerFeeBasisPoints": 0,
+  "seller_fee_basis_points": 0,
   "creators": null
 }
 
diff --git a/docs/print.html b/docs/print.html index 247cf67..1ed4e31 100644 --- a/docs/print.html +++ b/docs/print.html @@ -557,13 +557,13 @@

Metadata

Decorate an existing SPL token mint with metadata.

Usage

Specify the existing mint address and path to a metadata file that contains the Data sub-struct of the metadata struct in a JSON format.

-

E.g.:

+

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

// crab.json

{
   "name": "Crabbie",
   "symbol": "CRAB",
   "uri": "https://arweave.net/KZDlKw8aCG4kfZtj9Qmh8tmYpH4Q287P_jmUtkl2s-k",
-  "sellerFeeBasisPoints": 0,
+  "seller_fee_basis_points": 0,
   "creators": null
 }
 
diff --git a/docs/searchindex.js b/docs/searchindex.js index fd9da2f..f1401e4 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":41,"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":38,"breadcrumbs":4,"title":3},"63":{"body":13,"breadcrumbs":3,"title":2},"64":{"body":14,"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":167,"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":28,"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