Class TransactionRequest
Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
Inheritance
Namespace: Xrpl.Models.Transactions
Assembly: Xrpl.dll
Syntax
[JsonConverter(typeof(TransactionRequestConverter))]
public abstract class TransactionRequest : ITransactionRequest, ITransactionCommon
Properties
| Edit this page View SourceAccount
This is a required field The unique address of the account that initiated the transaction.
Declaration
public string Account { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
AccountTxnID
Hash value identifying another transaction.
If provided, this transaction is only valid if the sending account's previously-sent transaction matches the provided hash.
Declaration
public string AccountTxnID { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Delegate
(Optional) The account submitting this transaction on behalf of Account, under permissions granted by DelegateSet (sfDelegate, a rippled common field).
Declaration
public string Delegate { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Fee
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.
Declaration
[JsonConverter(typeof(CurrencyConverter))]
public Currency Fee { get; set; }
Property Value
| Type | Description |
|---|---|
| Currency |
Flags
Set of bit-flags for this transaction.
number | GlobalFlags
Declaration
public uint? Flags { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
LastLedgerSequence
Although optional, the LastLedgerSequence is strongly recommended on every transaction to ensure it's validated or rejected promptly.
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.
Declaration
public uint? LastLedgerSequence { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
Memos
Additional arbitrary information used to identify this transaction.
Declaration
public List<MemoWrapper> Memos { get; set; }
Property Value
| Type | Description |
|---|---|
| List<MemoWrapper> |
NetworkID
Declaration
public uint? NetworkID { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
OperationLimit
(Optional) sfOperationLimit, a rippled common field accepted on every transaction type. No XRPL transactor reads it; on Xahau a Burn-2-Mint burn carries the destination network id here.
Declaration
public uint? OperationLimit { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
Sequence
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.
Declaration
public uint? Sequence { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
Signers
Array of objects that represent a multi-signature which authorizes this transaction.
Declaration
public List<SignerWrapper> Signers { get; set; }
Property Value
| Type | Description |
|---|---|
| List<SignerWrapper> |
SigningPublicKey
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.
Declaration
[JsonPropertyName("SigningPubKey")]
public string SigningPublicKey { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
SourceTag
(Optional) 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.
Declaration
public uint? SourceTag { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
Sponsor
XLS-68: the account sponsoring this transaction's fee and/or reserve.
Declaration
public string Sponsor { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
SponsorFlags
XLS-68: what the sponsor covers (serialized as the numeric sfSponsorFlags value).
Declaration
public SponsorCoverage? SponsorFlags { get; set; }
Property Value
| Type | Description |
|---|---|
| SponsorCoverage? |
SponsorSignature
XLS-68: the sponsor's co-signature (sfSponsorSignature) - SigningPubKey and
TxnSignature, or Signers for a multisig sponsor. It is not part of what
any party signs. Inside a Batch it is an unsigned marker (an empty object) on an inner
transaction whose sponsor co-signs the batch through BatchSigners.
Declaration
public SignatureObject SponsorSignature { get; set; }
Property Value
| Type | Description |
|---|---|
| SignatureObject |
Remarks
Produced by SponsorSigningHelper and XrplWallet.SignAsSponsor.
TicketSequence
(Optional) 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.
Declaration
public uint? TicketSequence { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
TransactionSignature
The signature that verifies this transaction as originating from the account it says it is from.
Declaration
[JsonPropertyName("TxnSignature")]
public string TransactionSignature { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
TransactionType
The type of transaction.
Valid types include: Payment, OfferCreate, SignerListSet,
EscrowCreate, EscrowFinish, EscrowCancel, PaymentChannelCreate,
PaymentChannelFund, PaymentChannelClaim, and DepositPreauth.
Declaration
[JsonIgnore]
public TransactionType TransactionType { get; set; }
Property Value
| Type | Description |
|---|---|
| TransactionType |
TransactionTypeName
The name of the transaction's type: the JSON form of TransactionType. For a type this SDK does not know, where TransactionType is Unknown, this is the name the node sent, and the transaction writes that name back to JSON.
Declaration
[JsonPropertyName("TransactionType")]
[JsonConverter(typeof(TransactionTypeNameConverter))]
public string TransactionTypeName { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
| Edit this page View SourceToDictionary()
Declaration
public Dictionary<string, object> ToDictionary()
Returns
| Type | Description |
|---|---|
| Dictionary<string, object> |
ToJson()
convert transaction to string json value
Declaration
public string ToJson()
Returns
| Type | Description |
|---|---|
| string |