Skip to main content

LaunchNftCollectionAdvancedAdminParams

txTypeNftTransactionType (string)

Must be "nft:launch"

Possible values: [nft:launch]

collectionAddressstring

Optional. The address of the collection.

nftAddressstring

Optional. The address of the NFT.

senderstringrequired

The address (public key) of the sender.

senderPrivateKeystring

The private key of the sender. It is NOT recommended to use this field. Please use the sender field instead. Use this field at your own risk and only if you know what you are doing and do not have access to mina-signer or wallet to get the signature.

nonceint64

Optional. The nonce for the transaction.

memostring

Optional. A memo for the transaction.

developerFeedouble

Optional. The developer fee for the transaction.

adminContractstringrequired

Must be "advanced" for advanced admin contract.

Possible values: [advanced]

symbolstring

The symbol of the NFT collection. Use NFT as a default value.

urluri

The URL of the NFT collection.

collectionNamestringrequired

The name of the NFT collection.

creatorstring

The creator of the NFT collection. Should be the public key of the creator starting with B62.

baseURLuri

The base URL of the NFT collection, can be 'ipfs' or url with or without https://. Default is 'ipfs'.

collectionData object
royaltyFeeint32

The royalty fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%)

transferFeeint64

The transfer fee amount

requireTransferApprovalboolean

If true, transferring NFTs requires approval from the admin contract

mintingIsLimitedboolean

If true, the minting is stopped and cannot be resumed

isPausedboolean

Indicates whether the collection is currently paused

masterNFT objectrequired
namestringrequired

The name of the NFT

addressstring

The address of the NFT contract

addressPrivateKeystring

The private key of the NFT contract

tokenIdint64

The token ID of the NFT

data objectrequired

The data associated with the NFT, including owner, approved, version, id, permissions and flags

ownerstringrequired

The public key of the owner of the NFT

approvedstring

The public key of the approved address of the NFT

versionint32

The version number of the NFT state

idstring

The unique identifier of the NFT within the collection. A bigint encoded as a string.

canChangeOwnerByProofboolean

Determines whether the NFT's ownership can be changed via a zero-knowledge proof (readonly)

canTransferboolean

Specifies if the NFT's ownership can be transferred (readonly)

canApproveboolean

Specifies if the NFT's approved address can be changed (readonly)

canChangeMetadataboolean

Indicates whether the NFT's metadata can be updated (readonly)

canChangeStorageboolean

Determines whether the storage associated with the NFT can be altered (readonly)

canChangeNameboolean

Specifies if the name of the NFT can be changed (readonly)

canChangeMetadataVerificationKeyHashboolean

Indicates whether the verification key hash for the metadata can be changed (readonly)

canPauseboolean

Specifies if the NFT contract can be paused, preventing certain operations (readonly)

isPausedboolean

Indicates whether the NFT contract is currently paused

requireOwnerAuthorizationToUpgradeboolean

Determines whether the owner's authorization is required to upgrade the NFT's verification key (readonly)

feeint64

The fee associated with minting the NFT

metadata objectrequired

The metadata associated with the NFT, Field as a string or NftMetadata object

oneOf
string
storagestring

The off-chain storage information (e.g., IPFS hash)

metadataVerificationKeyHashstring

The hash of the verification key used for metadata proofs, Field as a string

expiryint32

The expiry time slot for minting the NFT

adminContractAddressstring

Optional. The address of the admin contract.

collectionContractPrivateKeystring

Optional. Private key for the collection contract.

adminContractPrivateKeystring

Optional. Private key for the admin contract.

upgradeAuthoritystringrequired

The address of the upgrade authority contract

adminData object

The admin data for the NFT collection

canPauseboolean

Indicates whether the contract can be paused

isPausedboolean

Indicates whether the contract is currently paused

allowChangeRoyaltyboolean

Indicates whether the contract can change the royalty fee

allowChangeTransferFeeboolean

Indicates whether the contract can change the transfer fee

allowChangeBaseUriboolean

Indicates whether the contract can change the base URI

allowChangeCreatorboolean

Indicates whether the contract can change the creator

allowChangeAdminboolean

Indicates whether the contract can change the admin

allowChangeNameboolean

Indicates whether the contract can change the name

whitelist object

Optional. List of whitelisted addresses with optional amounts, or a string.

oneOf
  • Array [
  • addressstringrequired

    The whitelisted address.

    amountdouble

    Optional. The amount allowed to bid.

  • ]
  • LaunchNftCollectionAdvancedAdminParams
    {
    "txType": "nft:launch",
    "collectionAddress": "string",
    "nftAddress": "string",
    "sender": "string",
    "senderPrivateKey": "string",
    "nonce": 0,
    "memo": "string",
    "developerFee": 0,
    "adminContract": "advanced",
    "symbol": "string",
    "url": "string",
    "collectionName": "string",
    "creator": "string",
    "baseURL": "string",
    "collectionData": {
    "royaltyFee": 0,
    "transferFee": 0,
    "requireTransferApproval": true,
    "mintingIsLimited": true,
    "isPaused": true
    },
    "masterNFT": {
    "name": "string",
    "address": "string",
    "addressPrivateKey": "string",
    "tokenId": 0,
    "data": {
    "owner": "string",
    "approved": "string",
    "version": 0,
    "id": "string",
    "canChangeOwnerByProof": true,
    "canTransfer": true,
    "canApprove": true,
    "canChangeMetadata": true,
    "canChangeStorage": true,
    "canChangeName": true,
    "canChangeMetadataVerificationKeyHash": true,
    "canPause": true,
    "isPaused": true,
    "requireOwnerAuthorizationToUpgrade": true
    },
    "fee": 0,
    "metadata": "string",
    "storage": "string",
    "metadataVerificationKeyHash": "string",
    "expiry": 0
    },
    "adminContractAddress": "string",
    "collectionContractPrivateKey": "string",
    "adminContractPrivateKey": "string",
    "upgradeAuthority": "string",
    "adminData": {
    "canPause": true,
    "isPaused": true,
    "allowChangeRoyalty": true,
    "allowChangeTransferFee": true,
    "allowChangeBaseUri": true,
    "allowChangeCreator": true,
    "allowChangeAdmin": true,
    "allowChangeName": true
    },
    "whitelist": [
    {
    "address": "string",
    "amount": 0
    }
    ]
    }