xrpl
    Preparing search index...

    Interface MPTokenIssuanceSet

    The MPTokenIssuanceSet transaction is used to globally lock/unlock a MPTokenIssuance, or lock/unlock an individual's MPToken.

    interface MPTokenIssuanceSet {
        Account: string;
        AccountTxnID?: string;
        Delegate?: string;
        DomainID?: string;
        Fee?: string;
        Flags?: number | MPTokenIssuanceSetFlagsInterface;
        Holder?: string;
        ImmutableFlags?: number;
        LastLedgerSequence?: number;
        Memos?: Memo[];
        MPTokenIssuanceID: string;
        MPTokenMetadata?: string;
        NetworkID?: number;
        Sequence?: number;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        TicketSequence?: number;
        TransactionType: "MPTokenIssuanceSet";
        TransferFee?: number;
        TxnSignature?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account AccountTxnID? Delegate? DomainID? Fee? Flags? Holder? ImmutableFlags? LastLedgerSequence? Memos? MPTokenIssuanceID MPTokenMetadata? NetworkID? Sequence? Signers? SigningPubKey? SourceTag? TicketSequence? TransactionType TransferFee? TxnSignature?

    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.

    Delegate?: string

    The delegate account that is sending the transaction.

    DomainID?: string

    The PermissionedDomain object ID that gates who may hold this MPT. Cannot be set together with the Holder field.

    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 | MPTokenIssuanceSetFlagsInterface

    Set of bit-flags for this transaction.

    Holder?: string

    An optional XRPL Address of an individual token holder balance to lock/unlock. If omitted, this transaction will apply to all any accounts holding MPTs.

    ImmutableFlags?: number

    Declares which fields or flags are immutable, via a bitmask of MPTokenIssuanceCreateImmutableFlags (tif*). Once a bit is set, the corresponding field or flag can never be set or modified again. The ImmutableFlags provided here are added to the current ledger object's ImmutableFlags; it is not a complete replacement. (XLS-94D)

    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.

    MPTokenIssuanceID: string

    Identifies the MPTokenIssuance

    MPTokenMetadata?: string

    New metadata to replace the existing value, in hex format (max 1024 bytes). The transaction will be rejected if lsifMPTMetadata has been set in ImmutableFlags. Setting an empty MPTokenMetadata removes the field. Should follow the XLS-89 standard.

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

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

    TransferFee?: number

    New transfer fee value, between 0 and 50,000 inclusive (in increments of 0.001%). The transaction will be rejected if lsifMPTTransferFee has been set in ImmutableFlags. A non-zero value requires lsfMPTCanTransfer to already be set on the ledger, or to be enabled by this same transaction via tfMPTSetCanTransfer. Setting TransferFee to zero removes the field.

    TxnSignature?: string

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

    Settings

    Member Visibility

    On This Page

    Properties