xrpl
    Preparing search index...

    Interface AccountSet

    An AccountSet transaction modifies the properties of an account in the XRP Ledger.

    interface AccountSet {
        Account: string;
        AccountTxnID?: string;
        ClearFlag?: number;
        Delegate?: string;
        Domain?: string;
        EmailHash?: string;
        Fee?: string;
        Flags?: number | AccountSetFlagsInterface;
        LastLedgerSequence?: number;
        Memos?: Memo[];
        MessageKey?: string;
        NetworkID?: number;
        NFTokenMinter?: string;
        Sequence?: number;
        SetFlag?: AccountSetAsfFlags;
        Signers?: Signer[];
        SigningPubKey?: string;
        SourceTag?: number;
        TicketSequence?: number;
        TickSize?: number;
        TransactionType: "AccountSet";
        TransferRate?: number;
        TxnSignature?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    Account AccountTxnID? ClearFlag? Delegate? Domain? EmailHash? Fee? Flags? LastLedgerSequence? Memos? MessageKey? NetworkID? NFTokenMinter? Sequence? SetFlag? Signers? SigningPubKey? SourceTag? TicketSequence? TickSize? TransactionType TransferRate? 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.

    ClearFlag?: number

    Unique identifier of a flag to disable for this account.

    Delegate?: string

    The delegate account that is sending the transaction.

    Domain?: string

    The domain that owns this account, as a string of hex representing the. ASCII for the domain in lowercase.

    EmailHash?: string

    Hash of an email address to be used for generating an avatar image.

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

    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.

    Memos?: Memo[]

    Additional arbitrary information used to identify this transaction.

    MessageKey?: string

    Public key for sending encrypted messages to this account.

    NetworkID?: number

    The network id of the transaction.

    NFTokenMinter?: string

    Sets an alternate account that is allowed to mint NFTokens on this account's behalf using NFTokenMint's Issuer field.

    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.

    SetFlag?: AccountSetAsfFlags

    Integer flag to enable for this account.

    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.

    TickSize?: number

    Tick size to use for offers involving a currency issued by this address. The exchange rates of those offers is rounded to this many significant digits. Valid values are 3 to 15 inclusive, or 0 to disable.

    TransactionType: "AccountSet"

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

    TransferRate?: number

    The fee to charge when users transfer this account's issued currencies, represented as billionths of a unit. Cannot be more than 2000000000 or less than 1000000000, except for the special case 0 meaning no fee.

    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