Interface 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.

Hierarchy

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.

Expiration?: number

Time after which the offer is no longer active, in seconds since the. Ripple Epoch.

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

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.

NetworkID?: number

The network id of the transaction.

OfferSequence?: number

An offer to delete first, specified in the same way as OfferCancel.

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.

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.

TakerGets: Amount

The amount and type of currency being provided by the offer creator.

TakerPays: Amount

The amount and type of currency being requested by the offer creator.

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: "OfferCreate"

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

TxnSignature?: string

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

Generated using TypeDoc