ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-04 21:15:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
aff6988f098ecc033a0cfa7974101f91de5cf948
xahau.js/docs/interfaces/BookOffer.html
Jackson Mills 4fddd8f41d Release xrpl packages (#2021) 
* Update HISTORY.md for release
* Run docgen
2022-06-02 11:03:56 -07:00

44 lines
32 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BookOffer | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="BookOffer.html">BookOffer</a></li></ul><h1>Interface BookOffer </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="LedgerEntry.Offer.html" class="tsd-signature-type" data-tsd-kind="Interface">Offer</a><ul class="tsd-hierarchy"><li><span class="target">BookOffer</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#BookDirectory" class="tsd-kind-icon">Book<wbr/>Directory</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#BookNode" class="tsd-kind-icon">Book<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#Expiration" class="tsd-kind-icon">Expiration</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#LedgerEntryType" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#OwnerNode" class="tsd-kind-icon">Owner<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#PreviousTxnID" class="tsd-kind-icon">Previous<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#PreviousTxnLgrSeq" class="tsd-kind-icon">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#TakerGets" class="tsd-kind-icon">Taker<wbr/>Gets</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#TakerPays" class="tsd-kind-icon">Taker<wbr/>Pays</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffer.html#owner_funds" class="tsd-kind-icon">owner_<wbr/>funds</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffer.html#quality" class="tsd-kind-icon">quality</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffer.html#taker_gets_funded" class="tsd-kind-icon">taker_<wbr/>gets_<wbr/>funded</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffer.html#taker_pays_funded" class="tsd-kind-icon">taker_<wbr/>pays_<wbr/>funded</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Account" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Account<a href="#Account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#Account">Account</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L10">packages/xrpl/src/models/ledger/Offer.ts:10</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The address of the account that placed this Offer.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="BookDirectory" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Book<wbr/>Directory<a href="#BookDirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Book<wbr/>Directory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#BookDirectory">BookDirectory</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L24">packages/xrpl/src/models/ledger/Offer.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ID of the Offer Directory that links to this Offer.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="BookNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Book<wbr/>Node<a href="#BookNode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Book<wbr/>Node<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#BookNode">BookNode</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L29">packages/xrpl/src/models/ledger/Offer.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A hint indicating which page of the Offer Directory links to this object,
in case the directory consists of multiple pages.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Expiration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Expiration<a href="#Expiration" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Expiration<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#Expiration">Expiration</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L46">packages/xrpl/src/models/ledger/Offer.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The time this Offer expires, in seconds since the Ripple Epoch.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Flags" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Flags<a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#Flags">Flags</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L8">packages/xrpl/src/models/ledger/Offer.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A bit-map of boolean flags enabled for this Offer.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="LedgerEntryType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Ledger<wbr/>Entry<wbr/>Type<a href="#LedgerEntryType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Offer&quot;</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#LedgerEntryType">LedgerEntryType</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L6">packages/xrpl/src/models/ledger/Offer.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="OwnerNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Owner<wbr/>Node<a href="#OwnerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Owner<wbr/>Node<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#OwnerNode">OwnerNode</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L34">packages/xrpl/src/models/ledger/Offer.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A hint indicating which page of the Owner Directory links to this object,
in case the directory consists of multiple pages.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="PreviousTxnID" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Previous<wbr/>TxnID<a href="#PreviousTxnID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Previous<wbr/>TxnID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#PreviousTxnID">PreviousTxnID</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L39">packages/xrpl/src/models/ledger/Offer.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The identifying hash of the transaction that most recently modified this
object.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="PreviousTxnLgrSeq" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq<a href="#PreviousTxnLgrSeq" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#PreviousTxnLgrSeq">PreviousTxnLgrSeq</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L44">packages/xrpl/src/models/ledger/Offer.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The index of the ledger that contains the transaction that most recently
modified this object.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Sequence" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Sequence<a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Sequence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#Sequence">Sequence</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L15">packages/xrpl/src/models/ledger/Offer.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The Sequence value of the OfferCreate transaction that created this Offer
object. Used in combination with the Account to identify this Offer.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TakerGets" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Taker<wbr/>Gets<a href="#TakerGets" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Taker<wbr/>Gets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Amount</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#TakerGets">TakerGets</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L22">packages/xrpl/src/models/ledger/Offer.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The remaining amount and type of currency being provided by the Offer
creator.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TakerPays" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Taker<wbr/>Pays<a href="#TakerPays" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Taker<wbr/>Pays<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Amount</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#TakerPays">TakerPays</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/Offer.ts#L17">packages/xrpl/src/models/ledger/Offer.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The remaining amount and type of currency requested by the Offer creator.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="index" class="tsd-anchor"></a><h3 class="tsd-anchor-link">index<a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="LedgerEntry.Offer.html">Offer</a>.<a href="LedgerEntry.Offer.html#index">index</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L2">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="owner_funds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> owner_<wbr/>funds<a href="#owner_funds" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">owner_<wbr/>funds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/methods/bookOffers.ts#L58">packages/xrpl/src/models/methods/bookOffers.ts:58</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Amount of the TakerGets currency the side placing the offer has available
to be traded. (XRP is represented as drops; any other currency is
represented as a decimal value.) If a trader has multiple offers in the
same book, only the highest-ranked offer includes this field.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="quality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> quality<a href="#quality" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">quality<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/methods/bookOffers.ts#L74">packages/xrpl/src/models/methods/bookOffers.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The exchange rate, as the ratio taker_pays divided by taker_gets. For
fairness, offers that have the same quality are automatically taken
first-in, first-out.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="taker_gets_funded" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> taker_<wbr/>gets_<wbr/>funded<a href="#taker_gets_funded" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">taker_<wbr/>gets_<wbr/>funded<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Amount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/methods/bookOffers.ts#L63">packages/xrpl/src/models/methods/bookOffers.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum amount of currency that the taker can get, given the funding
status of the offer.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="taker_pays_funded" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> taker_<wbr/>pays_<wbr/>funded<a href="#taker_pays_funded" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">taker_<wbr/>pays_<wbr/>funded<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Amount</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f132744/packages/xrpl/src/models/methods/bookOffers.ts#L68">packages/xrpl/src/models/methods/bookOffers.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum amount of currency that the taker would pay, given the funding
status of the offer.</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="BookOffer.html" class="tsd-kind-icon">Book<wbr/>Offer</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#BookDirectory" class="tsd-kind-icon">Book<wbr/>Directory</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#BookNode" class="tsd-kind-icon">Book<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#Expiration" class="tsd-kind-icon">Expiration</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#LedgerEntryType" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#OwnerNode" class="tsd-kind-icon">Owner<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#PreviousTxnID" class="tsd-kind-icon">Previous<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#PreviousTxnLgrSeq" class="tsd-kind-icon">Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#TakerGets" class="tsd-kind-icon">Taker<wbr/>Gets</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#TakerPays" class="tsd-kind-icon">Taker<wbr/>Pays</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="BookOffer.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffer.html#owner_funds" class="tsd-kind-icon">owner_<wbr/>funds</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffer.html#quality" class="tsd-kind-icon">quality</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffer.html#taker_gets_funded" class="tsd-kind-icon">taker_<wbr/>gets_<wbr/>funded</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BookOffer.html#taker_pays_funded" class="tsd-kind-icon">taker_<wbr/>pays_<wbr/>funded</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink