Namespace Xrpl.Models.Transaction

Classes

AccountDelete

An AccountDelete transaction deletes an account and any objects it owns in the XRP Ledger, if possible, sending the account's remaining XRP to a specified destination account.

AccountDeleteResponse

An AccountDelete transaction deletes an account and any objects it owns in the XRP Ledger, if possible, sending the account's remaining XRP to a specified destination account.

AccountSet

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

AccountSetResponse

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

AffectedNode

The AffectedNodes array contains a complete list of the objects in the ledger that this transaction modified in some way.

BaseTransactionResponse

This information is added to Transactions in request responses, but is not part of the canonical Transaction information on ledger.
These fields are denoted with lowercase letters to indicate this in the rippled responses.

BinaryTransaction

BinaryTransactionResponse

BookOffers

• Expected response from a BookOffersRequest.

CheckCancel

Cancels an unredeemed Check, removing it from the ledger without sending any money.
The source or the destination of the check can cancel a Check at any time using this transaction type.
If the Check has expired, any address can cancel it.

CheckCancelResponse

Cancels an unredeemed Check, removing it from the ledger without sending any money.
The source or the destination of the check can cancel a Check at any time using this transaction type.
If the Check has expired, any address can cancel it.

CheckCash

Attempts to redeem a Check object in the ledger to receive up to the amount authorized by the corresponding CheckCreate transaction.
Only the Destination address of a Check can cash it with a CheckCash transaction.

CheckCashResponse

Attempts to redeem a Check object in the ledger to receive up to the amount authorized by the corresponding CheckCreate transaction.
Only the Destination address of a Check can cash it with a CheckCash transaction.

CheckCreate

Create a Check object in the ledger, which is a deferred payment that can be cashed by its intended destination.
The sender of this transaction is the sender of the Check.

CheckCreateResponse

Create a Check object in the ledger, which is a deferred payment that can be cashed by its intended destination.
The sender of this transaction is the sender of the Check.

Common

DepositPreauth

A DepositPreauth transaction gives another account pre-approval to deliver payments to the sender of this transaction.
This is only useful if the sender of this transaction is using (or plans to use) Deposit Authorization.

DepositPreauthResponse

A DepositPreauth transaction gives another account pre-approval to deliver payments to the sender of this transaction.
This is only useful if the sender of this transaction is using (or plans to use) Deposit Authorization.

EscrowCancel

Return escrowed XRP to the sender.

EscrowCancelResponse

Return escrowed XRP to the sender.

EscrowCreate

Sequester XRP until the escrow process either finishes or is canceled.

EscrowCreateResponse

Sequester XRP until the escrow process either finishes or is canceled.

EscrowFinish

Deliver XRP from a held payment to the recipient.

EscrowFinishResponse

Deliver XRP from a held payment to the recipient.

Memo

The Memos field includes arbitrary messaging data with the transaction.

MemoWrapper

Additional arbitrary information used to identify transaction.

Meta

Transaction metadata is a section of data that gets added to a transaction after it is processed.
Any transaction that gets included in a ledger has metadata, regardless of whether it is successful.
The transaction metadata describes the outcome of the transaction in detail.
Warning: The changes described in transaction metadata are only final if the transaction is in a validated ledger version.

NFTokenAcceptOffer

The NFTokenOfferAccept transaction is used to accept offers to buy or sell an NFToken.
It can either:
1.
Allow one offer to be accepted.
This is called direct mode.
2.
Allow two distinct offers, one offering to buy a given NFToken and the other offering to sell the same NFToken, to be accepted in an atomic fashion.
This is called brokered mode.
To indicate direct mode, use either the sell_offer or buy_offer fields, but not both.
To indicate brokered mode, use both the sell_offer and buy_offer fields.
If you use neither sell_offer nor buy_offer, the transaction is invalid.

NFTokenAcceptOfferResponse

The NFTokenOfferAccept transaction is used to accept offers to buy or sell an NFToken.
It can either:
1.
Allow one offer to be accepted.
This is called direct mode.
2.
Allow two distinct offers, one offering to buy a given NFToken and the other offering to sell the same NFToken, to be accepted in an atomic fashion.
This is called brokered mode.
To indicate direct mode, use either the sell_offer or buy_offer fields, but not both.
To indicate brokered mode, use both the sell_offer and buy_offer fields.
If you use neither sell_offer nor buy_offer, the transaction is invalid.

NFTokenBurn

The NFTokenBurn transaction is used to remove an NFToken object from the NFTokenPage in which it is being held, effectively removing the token from the ledger ("burning" it).
If this operation succeeds, the corresponding NFToken is removed.
If this operation empties the NFTokenPage holding the NFToken or results in the consolidation, thus removing an NFTokenPage, the owner’s reserve requirement is reduced by one.

NFTokenBurnResponse

The NFTokenBurn transaction is used to remove an NFToken object from the NFTokenPage in which it is being held, effectively removing the token from the ledger ("burning" it).
If this operation succeeds, the corresponding NFToken is removed.
If this operation empties the NFTokenPage holding the NFToken or results in the consolidation, thus removing an NFTokenPage, the owner’s reserve requirement is reduced by one.

NFTokenCancelOffer

The NFTokenCancelOffer transaction deletes existing NFTokenOffer objects.
It is useful if you want to free up space on your account to lower your reserve requirement.
The transaction can be executed by the account that originally created the NFTokenOffer, the account in the Recipient field of the NFTokenOffer (if present), or any account if the NFTokenOffer has an Expiration and the NFTokenOffer has already expired.

NFTokenCancelOfferResponse

The NFTokenCancelOffer transaction deletes existing NFTokenOffer objects.
It is useful if you want to free up space on your account to lower your reserve requirement.
The transaction can be executed by the account that originally created the NFTokenOffer, the account in the Recipient field of the NFTokenOffer (if present), or any account if the NFTokenOffer has an Expiration and the NFTokenOffer has already expired.

NFTokenCreateOffer

The NFTokenCreateOffer transaction creates either an offer to buy an NFT the submitting account does not own, or an offer to sell an NFT the submitting account does own.

NFTokenCreateOfferResponse

The NFTokenCreateOffer transaction creates either an offer to buy an NFT the submitting account does not own, or an offer to sell an NFT the submitting account does own.

NFTokenMint

The NFTokenMint transaction creates an NFToken object and adds it to the relevant NFTokenPage object of the minter.
If the transaction is successful, the newly minted token will be owned by the minter account specified by the transaction.

NFTokenMintResponse

The NFTokenMint transaction creates an NFToken object and adds it to the relevant NFTokenPage object of the minter.
If the transaction is successful, the newly minted token will be owned by the minter account specified by the transaction.

NodeInfo

transaction object

Offer

The Offer object type describes an offer to exchange currencies, more traditionally known as an order, in the XRP Ledger's distributed exchange.
An OfferCreate transaction only creates an Offer object in the ledger when the offer cannot be fully executed immediately by consuming other offers already in the ledger.

OfferCancel

An OfferCancel transaction removes an Offer object from the XRP Ledger.

OfferCancelResponse

An OfferCancel transaction removes an Offer object from the XRP Ledger.

OfferCreate

An OfferCreate transaction is effectively a limit order.
It defines an intent to exchange currencies, and creates an Offer object if not completely.
Fulfilled when placed.
Offers can be partially fulfilled.

OfferCreateResponse

An OfferCreate transaction is effectively a limit order.
It defines an intent to exchange currencies, and creates an Offer object if not completely.
Fulfilled when placed.
Offers can be partially fulfilled.

Payment

A Payment transaction represents a transfer of value from one account to another.

PaymentChannelClaim

Claim XRP from a payment channel, adjust the payment channel's expiration, or both.

PaymentChannelClaimResponse

Claim XRP from a payment channel, adjust the payment channel's expiration, or both.

PaymentChannelCreate

Create a unidirectional channel and fund it with XRP.
The address sending this transaction becomes the "source address" of the payment channel.

PaymentChannelCreateResponse

Create a unidirectional channel and fund it with XRP.
The address sending this transaction becomes the "source address" of the payment channel.

PaymentChannelFund

Add additional XRP to an open payment channel, and optionally update the expiration time of the channel.
Only the source address of the channel can use this transaction.

PaymentChannelFundResponse

Add additional XRP to an open payment channel, and optionally update the expiration time of the channel.
Only the source address of the channel can use this transaction.

PaymentResponse

A Payment transaction represents a transfer of value from one account to another.

SetRegularKey

A SetRegularKey transaction assigns, changes, or removes the regular key pair associated with an account.

SetRegularKeyResponse

A SetRegularKey transaction assigns, changes, or removes the regular key pair associated with an account.

Signer

The Signers field contains a multi-signature, which has signatures from up to 8 key pairs, that together should authorize the transaction.

SignerListSet

The SignerListSet transaction creates, replaces, or removes a list of signers that can be used to multi-sign a transaction.

SignerListSetResponse

The SignerListSet transaction creates, replaces, or removes a list of signers that can be used to multi-sign a transaction.

Submit

Response expected from a SubmitRequest.

TicketCreate

A TicketCreate transaction sets aside one or more sequence numbers as Tickets.

TicketCreateResponse

A TicketCreate transaction sets aside one or more sequence numbers as Tickets.

TransactionCommon

Every transaction has the same set of common fields.

TransactionResponseCommon

Every transaction has the same set of common fields.

TrustSet

Create or modify a trust line linking two accounts.

TrustSetResponse

Create or modify a trust line linking two accounts.

Interfaces

IAccountDelete

An AccountDelete transaction deletes an account and any objects it owns in the XRP Ledger, if possible, sending the account's remaining XRP to a specified destination account.

IAccountSet

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

IBaseTransactionResponse

This information is added to Transactions in request responses, but is not part of the canonical Transaction information on ledger.
These fields are denoted with lowercase letters to indicate this in the rippled responses.

ICheckCancel

Cancels an unredeemed Check, removing it from the ledger without sending any money.
The source or the destination of the check can cancel a Check at any time using this transaction type.
If the Check has expired, any address can cancel it.

ICheckCash

Attempts to redeem a Check object in the ledger to receive up to the amount authorized by the corresponding CheckCreate transaction.
Only the Destination address of a Check can cash it with a CheckCash transaction.

ICheckCreate

Create a Check object in the ledger, which is a deferred payment that can be cashed by its intended destination.
The sender of this transaction is the sender of the Check.

IDepositPreauth

A DepositPreauth transaction gives another account pre-approval to deliver payments to the sender of this transaction.
This is only useful if the sender of this transaction is using (or plans to use) Deposit Authorization.

IEscrowCancel

Return escrowed XRP to the sender.

IEscrowCreate

Sequester XRP until the escrow process either finishes or is canceled.

IEscrowFinish

Deliver XRP from a held payment to the recipient.

INFTokenAcceptOffer

The NFTokenOfferAccept transaction is used to accept offers to buy or sell an NFToken.
It can either:
1.
Allow one offer to be accepted.
This is called direct mode.
2.
Allow two distinct offers, one offering to buy a given NFToken and the other offering to sell the same NFToken, to be accepted in an atomic fashion.
This is called brokered mode.
To indicate direct mode, use either the sell_offer or buy_offer fields, but not both.
To indicate brokered mode, use both the sell_offer and buy_offer fields.
If you use neither sell_offer nor buy_offer, the transaction is invalid.

INFTokenBurn

The NFTokenBurn transaction is used to remove an NFToken object from the NFTokenPage in which it is being held, effectively removing the token from the ledger ("burning" it).
If this operation succeeds, the corresponding NFToken is removed.
If this operation empties the NFTokenPage holding the NFToken or results in the consolidation, thus removing an NFTokenPage, the owner’s reserve requirement is reduced by one.

INFTokenCancelOffer

The NFTokenCancelOffer transaction deletes existing NFTokenOffer objects.
It is useful if you want to free up space on your account to lower your reserve requirement.
The transaction can be executed by the account that originally created the NFTokenOffer, the account in the Recipient field of the NFTokenOffer (if present), or any account if the NFTokenOffer has an Expiration and the NFTokenOffer has already expired.

INFTokenCreateOffer

The NFTokenCreateOffer transaction creates either an offer to buy an NFT the submitting account does not own, or an offer to sell an NFT the submitting account does own.

INFTokenMint

The NFTokenMint transaction creates an NFToken object and adds it to the relevant NFTokenPage object of the minter.
If the transaction is successful, the newly minted token will be owned by the minter account specified by the transaction.

IOfferCancel

An OfferCancel transaction removes an Offer object from the XRP Ledger.

IOfferCreate

An OfferCreate transaction is effectively a limit order.
It defines an intent to exchange currencies, and creates an Offer object if not completely.
Fulfilled when placed.
Offers can be partially fulfilled.

IPayment

A Payment transaction represents a transfer of value from one account to another.

IPaymentChannelClaim

Claim XRP from a payment channel, adjust the payment channel's expiration, or both.

IPaymentChannelCreate

Create a unidirectional channel and fund it with XRP.
The address sending this transaction becomes the "source address" of the payment channel.

IPaymentChannelFund

Add additional XRP to an open payment channel, and optionally update the expiration time of the channel.
Only the source address of the channel can use this transaction.

ISetRegularKey

A SetRegularKey transaction assigns, changes, or removes the regular key pair associated with an account.

ISignerListSet

The SignerListSet transaction creates, replaces, or removes a list of signers that can be used to multi-sign a transaction.

ITicketCreate

A TicketCreate transaction sets aside one or more sequence numbers as Tickets.

ITransactionCommon

Every transaction has the same set of common fields.

ITransactionResponseCommon

Every transaction has the same set of common fields.

ITrustSet

Create or modify a trust line linking two accounts.

Enums

AccountSetTfFlags

Enum for AccountSet Flags.

NFTokenCreateOfferFlags

Transaction Flags for an NFTokenCreateOffer Transaction.

NFTokenMintFlags

Transaction Flags for an NFTokenMint Transaction.

OfferCreateFlags

Transaction Flags for an OfferCreate Transaction.

OfferFlags

There are several options which can be either enabled or disabled when an OfferCreate transaction creates an offer object.
In the ledger, flags are represented as binary values that can be combined with bitwise-or operations.
The bit values for the flags in the ledger are different than the values used to enable or disable those flags in a transaction.
Ledger flags have names that begin with lsf.

PaymentChannelClaimFlags

Enum representing values for PaymentChannelClaim transaction flags.

PaymentFlags

Enum representing values for Payment Transaction Flags.

TrustSetFlags

Enum representing values of ITrustSet transaction flags.