xrpl
    Preparing search index...

    Interface NFTokenMint

    The NFTokenMint transaction creates an NFToken object and adds it to the relevant NFTokenPage object of the minter. If the transaction is successful, the newly minted token will be owned by the minter account specified by the transaction.

    interface NFTokenMint {
        Account: string;
        AccountTxnID?: string;
        Amount?: Amount;
        Delegate?: string;
        Destination?: string;
        Expiration?: number;
        Fee?: string;
        Flags?: number | NFTokenMintFlagsInterface;
        Issuer?: string;
        LastLedgerSequence?: number;
        Memos?: Memo[];
        NetworkID?: number;
        NFTokenTaxon: number;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        TicketSequence?: number;
        TransactionType: "NFTokenMint";
        TransferFee?: number;
        TxnSignature?: string;
        URI?: null | string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account AccountTxnID? Amount? Delegate? Destination? Expiration? Fee? Flags? Issuer? LastLedgerSequence? Memos? NetworkID? NFTokenTaxon Sequence? Signers? SigningPubKey? SourceTag? TicketSequence? TransactionType TransferFee? TxnSignature? URI?

    Properties

    Account: string

    The unique address of the transaction sender.

    AccountTxnID?: string

    Hash value identifying another transaction. If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.

    Amount?: Amount

    Indicates the amount expected for the Token.

    The amount can be zero. This would indicate that the account is giving the token away free, either to anyone at all, or to the account identified by the Destination field.

    Delegate?: string

    The delegate account that is sending the transaction.

    Destination?: string

    If present, indicates that this offer may only be accepted by the specified account. Attempts by other accounts to accept this offer MUST fail.

    Expiration?: number

    Indicates the time after which the offer will no longer be valid. The value is the number of seconds since the Ripple Epoch.

    Fee?: string

    Integer amount of XRP, in drops, to be destroyed as a cost for distributing this transaction to the network. Some transaction types have different minimum requirements.

    Flags?: number | NFTokenMintFlagsInterface

    Set of bit-flags for this transaction.

    Issuer?: string

    Indicates the account that should be the issuer of this token. This value is optional and should only be specified if the account executing the transaction is not the Issuer of the NFToken object. If it is present, the MintAccount field in the AccountRoot of the Issuer field must match the Account, otherwise the transaction will fail.

    LastLedgerSequence?: number

    Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    NetworkID?: number

    The network id of the transaction.

    NFTokenTaxon: number

    Indicates the taxon associated with this token. The taxon is generally a value chosen by the minter of the token and a given taxon may be used for multiple tokens. The implementation reserves taxon identifiers greater than or equal to 2147483648 (0x80000000). If you have no use for this field, set it to 0.

    Sequence?: number

    The sequence number of the account sending the transaction. A transaction is only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account. The special case 0 means the transaction is using a Ticket instead.

    Signers?: Signer[]

    Array of objects that represent a multi-signature which authorizes this transaction.

    SigningPubKey?: string

    Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the Signers field instead.

    SourceTag?: number

    Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's SourceTag as the refund payment's DestinationTag.

    TicketSequence?: number

    The sequence number of the ticket to use in place of a Sequence number. If this is provided, Sequence must be 0. Cannot be used with AccountTxnID.

    TransactionType: "NFTokenMint"

    The type of transaction. Valid types include: Payment, OfferCreate, TrustSet, and many others.

    TransferFee?: number

    Specifies the fee charged by the issuer for secondary sales of the Token, if such sales are allowed. Valid values for this field are between 0 and 50000 inclusive, allowing transfer rates between 0.000% and 50.000% in increments of 0.001%. This field must NOT be present if the tfTransferable flag is not set.

    TxnSignature?: string

    The signature that verifies this transaction as originating from the account it says it is from.

    URI?: null | string

    URI that points to the data and/or metadata associated with the NFT. This field need not be an HTTP or HTTPS URL; it could be an IPFS URI, a magnet link, immediate data encoded as an RFC2379 "data" URL, or even an opaque issuer-specific encoding. The URI is NOT checked for validity, but the field is limited to a maximum length of 256 bytes.

    This field must be hex-encoded. You can use convertStringToHex to convert this field to the proper encoding.

    This field must not be an empty string. Omit it from the transaction or set to undefined value if you do not use it.

    Settings

    Member Visibility

    On This Page

    Properties