mirror of
https://github.com/Xahau/xahau.js.git
synced 2026-04-29 15:37:50 +00:00
8995e3d579
* fix: use .mts extension to emit ES Modules * add comments and Apppliction type * update docs
38 lines
28 KiB
HTML
38 lines
28 KiB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><script src="https://cmp.osano.com/AzyjT6TIZMlgyLyy8/ad2447d5-f101-40df-b92e-d6452b5ecac0/osano.js"></script><script>
|
||
(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
|
||
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
|
||
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
|
||
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
|
||
})(window,document,'script','dataLayer','GTM-M7HKJJ3');
|
||
</script><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Offer | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M7HKJJ3" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="../modules/LedgerEntry.html">LedgerEntry</a></li><li><a href="LedgerEntry.Offer.html">Offer</a></li></ul><h1>Interface Offer</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Offer</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#account">Account</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#bookdirectory">BookDirectory</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#booknode">BookNode</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#expiration">Expiration</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#flags">Flags</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#index">index</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#ledgerentrytype">LedgerEntryType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Offer"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#ownernode">OwnerNode</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#previoustxnid">PreviousTxnID</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#previoustxnlgrseq">PreviousTxnLgrSeq</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#sequence">Sequence</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#takergets">TakerGets</a><span class="tsd-signature-symbol">:</span> <a href="../types/Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="LedgerEntry.Offer.html#takerpays">TakerPays</a><span class="tsd-signature-symbol">:</span> <a href="../types/Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="608"><h4>Hierarchy (<a href="../hierarchy.html#LedgerEntry.Offer">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">BaseLedgerEntry</span></li><li class="tsd-hierarchy-item"><span class="tsd-signature-type">HasPreviousTxnID</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Offer</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BookOffer.html" class="tsd-signature-type tsd-kind-interface">BookOffer</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L5">packages/xrpl/src/models/ledger/Offer.ts:5</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="LedgerEntry.Offer.html#account" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Account</span></a>
|
||
<a href="LedgerEntry.Offer.html#bookdirectory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Book<wbr/>Directory</span></a>
|
||
<a href="LedgerEntry.Offer.html#booknode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Book<wbr/>Node</span></a>
|
||
<a href="LedgerEntry.Offer.html#expiration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Expiration?</span></a>
|
||
<a href="LedgerEntry.Offer.html#flags" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Flags</span></a>
|
||
<a href="LedgerEntry.Offer.html#index" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>index</span></a>
|
||
<a href="LedgerEntry.Offer.html#ledgerentrytype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Ledger<wbr/>Entry<wbr/>Type</span></a>
|
||
<a href="LedgerEntry.Offer.html#ownernode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Owner<wbr/>Node</span></a>
|
||
<a href="LedgerEntry.Offer.html#previoustxnid" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Previous<wbr/>TxnID</span></a>
|
||
<a href="LedgerEntry.Offer.html#previoustxnlgrseq" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</span></a>
|
||
<a href="LedgerEntry.Offer.html#sequence" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Sequence</span></a>
|
||
<a href="LedgerEntry.Offer.html#takergets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Taker<wbr/>Gets</span></a>
|
||
<a href="LedgerEntry.Offer.html#takerpays" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Taker<wbr/>Pays</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="account" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Account</span><a href="#account" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Account</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The address of the account that placed this Offer.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L10">packages/xrpl/src/models/ledger/Offer.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="bookdirectory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Book<wbr/>Directory</span><a href="#bookdirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">BookDirectory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the Offer Directory that links to this Offer.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L24">packages/xrpl/src/models/ledger/Offer.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="booknode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Book<wbr/>Node</span><a href="#booknode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">BookNode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L29">packages/xrpl/src/models/ledger/Offer.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="expiration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Expiration</span><a href="#expiration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Expiration</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The time this Offer expires, in seconds since the Ripple Epoch.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L36">packages/xrpl/src/models/ledger/Offer.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="flags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Flags</span><a href="#flags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>A bit-map of boolean flags enabled for this Offer.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L8">packages/xrpl/src/models/ledger/Offer.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>index</span><a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">index</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseLedgerEntry.index</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/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"><a id="ledgerentrytype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Ledger<wbr/>Entry<wbr/>Type</span><a href="#ledgerentrytype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">LedgerEntryType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Offer"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/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"><a id="ownernode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Owner<wbr/>Node</span><a href="#ownernode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">OwnerNode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L34">packages/xrpl/src/models/ledger/Offer.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="previoustxnid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Previous<wbr/>TxnID</span><a href="#previoustxnid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">PreviousTxnID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The identifying hash of the transaction that most recently modified this
|
||
object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from HasPreviousTxnID.PreviousTxnID</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L10">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="previoustxnlgrseq" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</span><a href="#previoustxnlgrseq" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">PreviousTxnLgrSeq</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The index of the ledger that contains the transaction that most recently
|
||
modified this object.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from HasPreviousTxnID.PreviousTxnLgrSeq</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L15">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sequence" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Sequence</span><a href="#sequence" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Sequence</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L15">packages/xrpl/src/models/ledger/Offer.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="takergets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Taker<wbr/>Gets</span><a href="#takergets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">TakerGets</span><span class="tsd-signature-symbol">:</span> <a href="../types/Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></div><div class="tsd-comment tsd-typography"><p>The remaining amount and type of currency being provided by the Offer
|
||
creator.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L22">packages/xrpl/src/models/ledger/Offer.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="takerpays" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Taker<wbr/>Pays</span><a href="#takerpays" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">TakerPays</span><span class="tsd-signature-symbol">:</span> <a href="../types/Amount.html" class="tsd-signature-type tsd-kind-type-alias">Amount</a></div><div class="tsd-comment tsd-typography"><p>The remaining amount and type of currency requested by the Offer creator.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/ledger/Offer.ts#L17">packages/xrpl/src/models/ledger/Offer.ts:17</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#account" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Account</span></a><a href="#bookdirectory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Book<wbr/>Directory</span></a><a href="#booknode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Book<wbr/>Node</span></a><a href="#expiration" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Expiration</span></a><a href="#flags" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Flags</span></a><a href="#index" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>index</span></a><a href="#ledgerentrytype" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Ledger<wbr/>Entry<wbr/>Type</span></a><a href="#ownernode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Owner<wbr/>Node</span></a><a href="#previoustxnid" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Previous<wbr/>TxnID</span></a><a href="#previoustxnlgrseq" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Previous<wbr/>Txn<wbr/>Lgr<wbr/>Seq</span></a><a href="#sequence" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Sequence</span></a><a href="#takergets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Taker<wbr/>Gets</span></a><a href="#takerpays" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Taker<wbr/>Pays</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">xrpl</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|