Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OfferCreateFlagsInterface

Map of flags to boolean values representing OfferCreate transaction flags.

Hierarchy

  • GlobalFlags
    • OfferCreateFlagsInterface

Index

Properties

Optional tfFillOrKill

tfFillOrKill: boolean

Treat the offer as a Fill or Kill order . Only try to match existing offers in the ledger, and only do so if the entire TakerPays quantity can be obtained. If the fix1578 amendment is enabled and the offer cannot be executed when placed, the transaction has the result code tecKILLED; otherwise, the transaction uses the result code tesSUCCESS even when it was. killed without trading any currency.

Optional tfImmediateOrCancel

tfImmediateOrCancel: boolean

Treat the offer as an Immediate or Cancel order. If enabled, the offer never becomes a ledger object: it only tries to match existing offers in the ledger. If the offer cannot match any offers immediately, it executes "successfully" without trading any currency. In this case, the transaction. has the result code tesSUCCESS, but creates no Offer objects in the ledger.

Optional tfPassive

tfPassive: boolean

If enabled, the offer does not consume offers that exactly match it, and instead becomes an Offer object in the ledger. It still consumes offers. that cross it.

Optional tfSell

tfSell: boolean

Exchange the entire TakerGets amount, even if it means obtaining more than. the TakerPays amount in exchange.

Generated using TypeDoc