Interface MPTokenIssuanceCreate

The MPTokenIssuanceCreate transaction creates a MPTokenIssuance object and adds it to the relevant directory node of the creator account. This transaction is the only opportunity an issuer has to specify any token fields that are defined as immutable (e.g., MPT Flags). If the transaction is successful, the newly created token will be owned by the account (the creator account) which executed the transaction.

interface MPTokenIssuanceCreate {
    Account: string;
    AccountTxnID?: string;
    AssetScale?: number;
    Fee?: string;
    Flags?: number | MPTokenIssuanceCreateFlagsInterface;
    LastLedgerSequence?: number;
    MaximumAmount?: string;
    Memos?: Memo[];
    MPTokenMetadata?: null | string;
    NetworkID?: number;
    Sequence?: number;
    Signers?: Signer[];
    SigningPubKey?: string;
    SourceTag?: number;
    TicketSequence?: number;
    TransactionType: "MPTokenIssuanceCreate";
    TransferFee?: number;
    TxnSignature?: string;
}

Hierarchy (View Summary)

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.

AssetScale?: number

An asset scale is the difference, in orders of magnitude, between a standard unit and a corresponding fractional unit. More formally, the asset scale is a non-negative integer (0, 1, 2, …) such that one standard unit equals 10^(-scale) of a corresponding fractional unit. If the fractional unit equals the standard unit, then the asset scale is 0. Note that this value is optional, and will default to 0 if not supplied.

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.

Set of bit-flags for this transaction.

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.

MaximumAmount?: string

Specifies the maximum asset amount of this token that should ever be issued. It is a non-negative integer string that can store a range of up to 63 bits. If not set, the max amount will default to the largest unsigned 63-bit integer (0x7FFFFFFFFFFFFFFF or 9223372036854775807)

Example:

MaximumAmount: '9223372036854775807'
Memos?: Memo[]

Additional arbitrary information used to identify this transaction.

MPTokenMetadata?: null | string

Arbitrary metadata about this issuance, in hex format.

NetworkID?: number

The network id of the transaction.

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: "MPTokenIssuanceCreate"

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

TransferFee?: number

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

TxnSignature?: string

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