xrpl
    Preparing search index...

    Interface MPTokenIssuance

    interface MPTokenIssuance {
        AssetScale?: number;
        AuditorEncryptionKey?: string;
        ConfidentialOutstandingAmount?: string;
        DomainID?: string;
        Flags: number;
        ImmutableFlags?: number;
        index: string;
        Issuer: string;
        IssuerEncryptionKey?: string;
        LedgerEntryType: "MPTokenIssuance";
        LockedAmount?: string;
        MaximumAmount?: string;
        MPTokenMetadata?: string;
        OutstandingAmount: string;
        OwnerNode: string;
        PreviousTxnID: string;
        PreviousTxnLgrSeq: number;
        ReferenceHolding?: string;
        Sequence: number;
        Sponsor?: string;
        TransferFee?: number;
    }

    Hierarchy

    • BaseLedgerEntry
    • HasPreviousTxnID
      • MPTokenIssuance
    Index

    Properties

    AssetScale? AuditorEncryptionKey? ConfidentialOutstandingAmount? DomainID? Flags ImmutableFlags? index Issuer IssuerEncryptionKey? LedgerEntryType LockedAmount? MaximumAmount? MPTokenMetadata? OutstandingAmount OwnerNode PreviousTxnID PreviousTxnLgrSeq ReferenceHolding? Sequence Sponsor? TransferFee?

    Properties

    AssetScale?: number

    An asset scale is a non-negative integer (0, 1, 2, ...) such that one MPT unit equals 10^(-scale) of a corresponding standard unit.

    AuditorEncryptionKey?: string

    The auditor's registered compressed ElGamal encryption key.

    ConfidentialOutstandingAmount?: string

    The total confidential (encrypted) outstanding amount for this issuance.

    DomainID?: string

    The PermissionedDomain object ID that gates who may hold this MPT.

    Flags: number

    A set of flags indicating properties or other options associated with this MPTokenIssuance object.

    ImmutableFlags?: number

    A set of XLS-94D immutability flags (lsifMPT*) indicating which capabilities or fields have been permanently made immutable and can no longer be enabled or modified via MPTokenIssuanceSet. Absent (equivalent to 0) on issuances where nothing has been made immutable, and on objects that predate the DynamicMPT amendment.

    index: string
    Issuer: string

    The address of the account that controls both the issuance amounts and characteristics of a particular fungible token.

    IssuerEncryptionKey?: string

    The issuer's registered compressed ElGamal encryption key.

    LedgerEntryType: "MPTokenIssuance"
    LockedAmount?: string

    The total amount of this MPT that is currently locked across all holders via Escrow or PaymentChannel.

    MaximumAmount?: string

    An unsigned 64-bit number that specifies the maximum number of MPTs that can be distributed to non-issuing accounts (i.e., minted). The default and maximum value is 0x7FFFFFFFFFFFFFFF.

    MPTokenMetadata?: string

    Arbitrary metadata about this issuance, in hex format. The limit for this field is 1024 bytes.

    OutstandingAmount: string

    An unsigned 64-bit number that specifies the sum of all token amounts that have been minted to all token holders. This value is increased whenever an issuer pays MPTs to a non-issuer account, and decreased whenever a non-issuer pays MPTs into the issuing account.

    OwnerNode: string

    Identifies the page in the owner's directory where this item is referenced.

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    ReferenceHolding?: string

    Hash256 pointing to the vault pseudo-account's holding for the underlying asset. Present for IOU and MPT-backed vaults. Absent for XRP-backed vaults.

    Sequence: number

    A 32-bit unsigned integer that is used to ensure issuances from a given sender may only ever exist once, even if an issuance is later deleted. Whenever a new issuance is created, this value must match the account's current Sequence number.

    Sponsor?: string

    (Optional) The account sponsoring the reserve for this MPTokenIssuance. If present, the sponsor is responsible for the reserve requirement of this object instead of the owner.

    TransferFee?: number

    This value specifies the fee, in tenths of a basis point, charged by the issuer for secondary sales of the token, if such sales are allowed at all. Valid values for this field are between 0 and 50,000 inclusive. A value of 1 is equivalent to 1/10 of a basis point or 0.001%, allowing transfer rates between 0% and 50%. A TransferFee of 50,000 corresponds to 50%.

    Settings

    Member Visibility

    On This Page

    Properties