mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 04:05:52 +00:00
271 lines
39 KiB
HTML
271 lines
39 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NFTokenAcceptOffer | 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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
<div class="tsd-toolbar-contents container">
|
|
<div class="table-cell" id="tsd-search" data-base="..">
|
|
<div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></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 menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
<div class="container container-main">
|
|
<div class="col-8 col-content">
|
|
<div class="tsd-page-title">
|
|
<ul class="tsd-breadcrumb">
|
|
<li><a href="../modules.html">xrpl</a></li>
|
|
<li><a href="NFTokenAcceptOffer.html">NFTokenAcceptOffer</a></li></ul>
|
|
<h1>Interface NFTokenAcceptOffer</h1></div>
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography"><p>The NFTokenOfferAccept transaction is used to accept offers
|
|
to buy or sell an NFToken. It can either:</p>
|
|
<ol>
|
|
<li>Allow one offer to be accepted. This is called direct
|
|
mode.</li>
|
|
<li>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.</li>
|
|
</ol>
|
|
<p> To indicate direct mode, use either the <code>sell_offer</code> or
|
|
<code>buy_offer</code> fields, but not both. To indicate brokered mode,
|
|
use both the <code>sell_offer</code> and <code>buy_offer</code> fields. If you use
|
|
neither <code>sell_offer</code> nor <code>buy_offer</code>, the transaction is invalid.</p>
|
|
</div></section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h4>Hierarchy</h4>
|
|
<ul class="tsd-hierarchy">
|
|
<li><span class="tsd-signature-type">BaseTransaction</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li><span class="target">NFTokenAcceptOffer</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts#L26">packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:26</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-index-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"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></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="NFTokenAcceptOffer.html#Account" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>Account</span></a>
|
|
<a href="NFTokenAcceptOffer.html#AccountTxnID" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Account<wbr/>TxnID</span></a>
|
|
<a href="NFTokenAcceptOffer.html#Fee" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Fee</span></a>
|
|
<a href="NFTokenAcceptOffer.html#Flags" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Flags</span></a>
|
|
<a href="NFTokenAcceptOffer.html#LastLedgerSequence" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Last<wbr/>Ledger<wbr/>Sequence</span></a>
|
|
<a href="NFTokenAcceptOffer.html#Memos" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Memos</span></a>
|
|
<a href="NFTokenAcceptOffer.html#NFTokenBrokerFee" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>NFToken<wbr/>Broker<wbr/>Fee</span></a>
|
|
<a href="NFTokenAcceptOffer.html#NFTokenBuyOffer" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>NFToken<wbr/>Buy<wbr/>Offer</span></a>
|
|
<a href="NFTokenAcceptOffer.html#NFTokenSellOffer" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>NFToken<wbr/>Sell<wbr/>Offer</span></a>
|
|
<a href="NFTokenAcceptOffer.html#Sequence" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Sequence</span></a>
|
|
<a href="NFTokenAcceptOffer.html#Signers" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Signers</span></a>
|
|
<a href="NFTokenAcceptOffer.html#SigningPubKey" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Signing<wbr/>Pub<wbr/>Key</span></a>
|
|
<a href="NFTokenAcceptOffer.html#SourceTag" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Source<wbr/>Tag</span></a>
|
|
<a href="NFTokenAcceptOffer.html#TicketSequence" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Ticket<wbr/>Sequence</span></a>
|
|
<a href="NFTokenAcceptOffer.html#TransactionType" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Transaction<wbr/>Type</span></a>
|
|
<a href="NFTokenAcceptOffer.html#TxnSignature" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Txn<wbr/>Signature</span></a>
|
|
</div></section></div></details></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"><span>Account</span><a href="#Account" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
|
|
<div class="tsd-signature">Account<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>The unique address of the account that initiated the transaction.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Account</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L95">packages/xrpl/src/models/transactions/common.ts:95</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="AccountTxnID" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Account<wbr/>TxnID</span><a href="#AccountTxnID" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Account<wbr/>TxnID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Hash value identifying another transaction. If provided, this transaction
|
|
is only valid if the sending account's previously-sent transaction matches
|
|
the provided hash.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.AccountTxnID</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L121">packages/xrpl/src/models/transactions/common.ts:121</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Fee" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Fee</span><a href="#Fee" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>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.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Fee</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L108">packages/xrpl/src/models/transactions/common.ts:108</a></li></ul></aside></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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Flags</span><a href="#Flags" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Flags<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalFlags</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Set of bit-flags for this transaction.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Flags</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L123">packages/xrpl/src/models/transactions/common.ts:123</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="LastLedgerSequence" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Last<wbr/>Ledger<wbr/>Sequence</span><a href="#LastLedgerSequence" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Last<wbr/>Ledger<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>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.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.LastLedgerSequence</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L129">packages/xrpl/src/models/transactions/common.ts:129</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Memos" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Memos</span><a href="#Memos" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Memos<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Additional arbitrary information used to identify this transaction.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Memos</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L133">packages/xrpl/src/models/transactions/common.ts:133</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="NFTokenBrokerFee" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>NFToken<wbr/>Broker<wbr/>Fee</span><a href="#NFTokenBrokerFee" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">NFToken<wbr/>Broker<wbr/>Fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Amount</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>This field is only valid in brokered mode. It specifies the
|
|
amount that the broker will keep as part of their fee for
|
|
bringing the two offers together; the remaining amount will
|
|
be sent to the seller of the NFToken being bought. If
|
|
specified, the fee must be such that, prior to accounting
|
|
for the transfer fee charged by the issuer, the amount that
|
|
the seller would receive is at least as much as the amount
|
|
indicated in the sell offer.</p>
|
|
<p>This functionality is intended to allow the owner of an
|
|
NFToken to offer their token for sale to a third party
|
|
broker, who may then attempt to sell the NFToken on for a
|
|
larger amount, without the broker having to own the NFToken
|
|
or custody funds.</p>
|
|
<p>Note: in brokered mode, the offers referenced by NFTokenBuyOffer
|
|
and NFTokenSellOffer must both specify the same NFTokenID; that is,
|
|
both must be for the same NFToken.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts#L64">packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:64</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="NFTokenBuyOffer" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>NFToken<wbr/>Buy<wbr/>Offer</span><a href="#NFTokenBuyOffer" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">NFToken<wbr/>Buy<wbr/>Offer<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Identifies the NFTokenOffer that offers to buy the NFToken.</p>
|
|
<p>In direct mode this field is optional, but either NFTokenSellOffer or
|
|
NFTokenBuyOffer must be specified. In brokered mode, both NFTokenSellOffer
|
|
and NFTokenBuyOffer must be specified.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts#L43">packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:43</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="NFTokenSellOffer" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>NFToken<wbr/>Sell<wbr/>Offer</span><a href="#NFTokenSellOffer" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">NFToken<wbr/>Sell<wbr/>Offer<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Identifies the NFTokenOffer that offers to sell the NFToken.</p>
|
|
<p> In direct mode this field is optional, but either NFTokenSellOffer or
|
|
NFTokenBuyOffer must be specified. In brokered mode, both NFTokenSellOffer
|
|
and NFTokenBuyOffer must be specified.</p>
|
|
</div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts#L35">packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:35</a></li></ul></aside></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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Sequence</span><a href="#Sequence" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>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.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Sequence</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L115">packages/xrpl/src/models/transactions/common.ts:115</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Signers" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Signers</span><a href="#Signers" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Signers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>Array of objects that represent a multi-signature which authorizes this
|
|
transaction.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.Signers</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L138">packages/xrpl/src/models/transactions/common.ts:138</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SigningPubKey" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Signing<wbr/>Pub<wbr/>Key</span><a href="#SigningPubKey" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Signing<wbr/>Pub<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>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.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.SigningPubKey</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L151">packages/xrpl/src/models/transactions/common.ts:151</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="SourceTag" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Source<wbr/>Tag</span><a href="#SourceTag" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Source<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>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.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.SourceTag</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L145">packages/xrpl/src/models/transactions/common.ts:145</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TicketSequence" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Ticket<wbr/>Sequence</span><a href="#TicketSequence" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Ticket<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>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.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.TicketSequence</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L156">packages/xrpl/src/models/transactions/common.ts:156</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="TransactionType" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>Transaction<wbr/>Type</span><a href="#TransactionType" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Transaction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"NFTokenAcceptOffer"</span></div><aside class="tsd-sources">
|
|
<p>Overrides BaseTransaction.TransactionType</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts#L27">packages/xrpl/src/models/transactions/NFTokenAcceptOffer.ts:27</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TxnSignature" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Txn<wbr/>Signature</span><a href="#TxnSignature" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">Txn<wbr/>Signature<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
<div class="tsd-comment tsd-typography"><p>The signature that verifies this transaction as originating from the
|
|
account it says it is from.</p>
|
|
</div><aside class="tsd-sources">
|
|
<p>Inherited from BaseTransaction.TxnSignature</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8921b6ac/packages/xrpl/src/models/transactions/common.ts#L161">packages/xrpl/src/models/transactions/common.ts:161</a></li></ul></aside></section></section></div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<div class="tsd-navigation settings">
|
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<div class="tsd-filter-visibility">
|
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
<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-private" name="private"/><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>Private</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></form></div>
|
|
<div class="tsd-theme-toggle">
|
|
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
<nav class="tsd-navigation primary">
|
|
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<ul>
|
|
<li><a href="../modules.html">xrpl</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></li></ul></div></details></nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul>
|
|
<li class="current tsd-kind-interface"><a href="NFTokenAcceptOffer.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>NFToken<wbr/>Accept<wbr/>Offer</span></a>
|
|
<ul>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#Account" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Account</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#AccountTxnID" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Account<wbr/>TxnID</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#Fee" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Fee</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#Flags" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Flags</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#LastLedgerSequence" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Last<wbr/>Ledger<wbr/>Sequence</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#Memos" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Memos</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenAcceptOffer.html#NFTokenBrokerFee" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>NFToken<wbr/>Broker<wbr/>Fee</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenAcceptOffer.html#NFTokenBuyOffer" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>NFToken<wbr/>Buy<wbr/>Offer</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenAcceptOffer.html#NFTokenSellOffer" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>NFToken<wbr/>Sell<wbr/>Offer</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#Sequence" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Sequence</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#Signers" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Signers</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#SigningPubKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Signing<wbr/>Pub<wbr/>Key</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#SourceTag" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Source<wbr/>Tag</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#TicketSequence" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Ticket<wbr/>Sequence</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenAcceptOffer.html#TransactionType" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Transaction<wbr/>Type</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenAcceptOffer.html#TxnSignature" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Txn<wbr/>Signature</a></li></ul></li></ul></nav></div></div>
|
|
<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> |