Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountSet

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

Hierarchy

  • BaseTransaction
    • AccountSet

Index

Properties

Account

Account: string

The unique address of the account that initiated the transaction.

Optional AccountTxnID

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.

Optional ClearFlag

ClearFlag: number

Unique identifier of a flag to disable for this account.

Optional Domain

Domain: string

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

Optional EmailHash

EmailHash: string

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

Optional Fee

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.

Optional Flags

Flags: number | AccountSetFlagsInterface

Optional LastLedgerSequence

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.

Optional Memos

Memos: { Memo: Memo }[]

Additional arbitrary information used to identify this transaction.

Optional MessageKey

MessageKey: string

Public key for sending encrypted messages to this account.

Optional Sequence

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.

Optional SetFlag

Integer flag to enable for this account.

Optional Signers

Signers: Signer[]

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

Optional SigningPubKey

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.

Optional SourceTag

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.

Optional TickSize

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.

Optional TicketSequence

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

TransactionType: "AccountSet"

Optional TransferRate

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.

Optional TxnSignature

TxnSignature: string

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

Generated using TypeDoc