Skip to content

Latest commit

 

History

History
46 lines (26 loc) · 7.8 KB

NFTMintRequest.md

File metadata and controls

46 lines (26 loc) · 7.8 KB
Raw

theblockchainapi.NFTMintRequest

Properties

Name Type Description Notes
waitForConfirmation Boolean Whether to wait for the NFT mint to be confirmed on the blockchain or simply be processed. Processed means that our node has picked up the transaction request, but not that it was confirmed by the Solana cluster. Confirmed means that the cluster voted on your transaction and approved it. To be completely sure that the NFT was minted, you can either set `wait_for_confirmation=True` (call takes 20 seconds with True; about 4 seconds for processed) or you can get the metadata from the mint returned. Once it returns the NFT metadata, then the NFT should have been successfully minted. [optional] [default to true]
wallet Wallet [optional]
name String The name of the token. Limited to 32 characters. Stored on the blockchain. [optional] [default to '']
symbol String The symbol of the token. Limited to 10 characters. Stored on the blockchain. [optional] [default to '']
description String The description of the NFT. Limited to 2000 characters. Not stored on the blockchain. If you are providing your own `uri` (see above), then you do not need to provide this. If you are not providing your own `uri` and you do not provide this, then there wills simply be no description. Only provide a value for `description` if the `upload_method` is set to `S3` (see the description for `upload_method` above). [optional] [default to '']
uploadMethod String When you choose `S3`, all of the `name`, `description`, `symbol`, `uri_metadata`, and `image_url` are put into a JSON dictionary and uploaded to S3 as a JSON file. This is uploaded to an AWS S3 bucket we own, and is an option we provide at no charge. The S3 link to this file is stored in the NFT's account on the blockchain. Learn more <a href=&quot;https://blockchainapi.com/2022/01/18/how-to-format-off-chain-nft-metadata.html\" target=&quot;_blank&quot;>here</a>. When you choose `URI`, the `uri` you provide is stored on the blockchain, and the `uri_metadata`, `description`, and `image_url` are ignored and not stored anywhere. `S3` is NOT involved in this case. An example of a `uri` you would provide is an Arweave URL, like this: `https://arweave.net/_Y8tETU3FbAFZSM1wXNeWPweWwrW9K6oSF1SYi_bH9A&#x60;. [optional] [default to 'S3']
uri String The `uri` you provide is stored on the blockchain, and the `uri_metadata`, `description`, and `image_url` are ignored and not stored anywhere. `S3` is NOT involved in this case. Read more <a href=&quot;https://blockchainapi.com/2022/01/18/how-to-format-off-chain-nft-metadata.html\" target=&quot;_blank&quot;>here</a>. An example of a `uri` you would provide is an Arweave URL, like this: `https://arweave.net/_Y8tETU3FbAFZSM1wXNeWPweWwrW9K6oSF1SYi_bH9A&#x60;. Only provide a value for `uri` if the `upload_method` is set to `URI` (see the description for `upload_method` above). [optional] [default to '']
imageUrl String The URL of the image of the NFT. If you are providing your own `uri` (see above), then you do not need to provide this. If you are not providing your own `uri` and you do not provide this, then there wills simply be no image. Only provide a value for `image_url` if the `upload_method` is set to `S3` (see the description for `upload_method` above). [optional] [default to '']
uriMetadata Object The off-chain metadata. If you are providing your own `uri` (see above), then you do not need to provide this. If you are not providing your own `uri` and you do not provide this, then there wills simply be no image. Only provide a value for `uri_metadata` if the `upload_method` is set to `S3` (see the description for `upload_method` above). Learn more about how to format this metadata <a href=&quot;https://blockchainapi.com/2022/01/18/how-to-format-off-chain-nft-metadata.html\" target=&quot;_blank&quot;>here</a>. [optional]
isMutable Boolean Indicates whether or not the NFT created is mutable. If mutable, the NFT can be updated later. Once set to immutable, the NFT is unable to be changed. [optional] [default to true]
isMasterEdition Boolean Whether or not the NFT is a master edition NFT. Saves about 0.001 SOL in transaction costs when set to false. [optional] [default to true]
sellerFeeBasisPoints Number Valid values from 0 to 10000. Must be an integer. Represents the number of basis points that the seller receives as a fee upon sale. E.g., 100 indicates a 1% seller fee. Seller does not receive a fee when &quot;primary_sale_has_happened&quot; is set to true. Will be set to false after first sale has occurred. [optional] [default to 0]
creators [String] A JSON encoded string representing an array / list. The designated creators of the NFT. Length of the creator list must match length of the list of share. Valid lengths of the list range from 1 to 5. Each item in the list must be a valid public key address. Only the public key corresponding to the seed phrase provided will be marked as verified. Any other creators supplied will be marked as unverified. [optional]
share [Number] A JSON encoded string representing an array / list. The share of the royalty that each creator gets. Valid values range from 0 to 100. Sum of the values must equal 100. Only integer value accepted. Length of the share list must match length of the list of creators. [optional]
mintToPublicKey String Assign ownership of the NFT to the public key address given by `mint_to_public_key` [optional] [default to 'The public key of the wallet provided']
network String This determines which network you choose to run the API calls on. We recommend first testing on the devnet, because minting an NFT costs a little above 0.01 SOL, which is about $1.60 at the time of this writing. When you run on the mainnet-beta, each successful call will deduct approximately that much. When you run on the devnet, that amount is deducted from a simulated amount, so you are not paying with real SOL. To get SOL on the devnet, airdrop SOL to this address using the CLI. Keep in mind that you can only do this every so often. If you are rate-limited, consider using a VPN and trying again, or just waiting. To get SOL on the mainnet-beta, you must transfer real SOL to this account from another wallet (e.g., from another wallet you own, from an exchange, etc.). We hope to make this process easier in the future, and if you have any suggestions, please add them as an issue on our <a href=&quot;https://github.com/BL0CK-X/the-blockchain-api\" target=&quot;_blank&quot;>GitHub repository</a> for the API. To get a fee estimate, make a GET requests to the <a href=&quot;#tag/Solana-NFT/paths/1solana1nft1mint1fee/get&quot;>v1/solana/nft/mint/fee endpoint</a> (details in sidebar). [optional] [default to 'devnet']

Enum: UploadMethodEnum

  • S3 (value: "S3")

  • URI (value: "URI")

Enum: NetworkEnum

  • devnet (value: "devnet")

  • mainnet-beta (value: "mainnet-beta")