mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-20 12:15:51 +00:00
71 lines
35 KiB
HTML
71 lines
35 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NFTokenCreateOffer | 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="NFTokenCreateOffer.html">NFTokenCreateOffer</a></li></ul><h1>Interface NFTokenCreateOffer</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The NFTokenCreateOffer transaction creates either an offer to buy an
|
|
NFT the submitting account does not own, or an offer to sell an NFT
|
|
the submitting account does own.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseTransaction</span><ul class="tsd-hierarchy"><li><span class="target">NFTokenCreateOffer</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="NFTokenCreateOffer.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#Amount" class="tsd-kind-icon">Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#Expiration" class="tsd-kind-icon">Expiration</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="NFTokenCreateOffer.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#NFTokenID" class="tsd-kind-icon">NFTokenID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#Owner" class="tsd-kind-icon">Owner</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="NFTokenCreateOffer.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</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 BaseTransaction.Account</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L95">packages/xrpl/src/models/transactions/common.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The unique address of the account that initiated the transaction.</p>
|
|
</div></div></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"><span class="tsd-flag ts-flagOptional">Optional</span> Account<wbr/>TxnID<a href="#AccountTxnID" 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<wbr/>TxnID<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.AccountTxnID</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L121">packages/xrpl/src/models/transactions/common.ts:121</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Amount<a href="#Amount" 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">Amount<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/bbe2e76e/packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts#L56">packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Indicates the amount expected or offered for the Token.</p>
|
|
</div><div><p>The amount must be non-zero, except when this is a sell
|
|
offer and the asset is XRP. This would indicate that the current
|
|
owner of the token is giving it away free, either to anyone at all,
|
|
or to the account identified by the Destination field.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Destination" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Destination<a href="#Destination" 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">Destination<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/bbe2e76e/packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts#L82">packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:82</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If present, indicates that this offer may only be
|
|
accepted by the specified account. Attempts by other
|
|
accounts to accept this offer MUST fail.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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"><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts#L76">packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:76</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Indicates the time after which the offer will no longer
|
|
be valid. The value is the number of 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="Fee" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Fee<a href="#Fee" 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">Fee<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Fee</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L108">packages/xrpl/src/models/transactions/common.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="Flags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> 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><span class="tsd-signature-symbol"> | </span><a href="NFTokenCreateOfferFlagsInterface.html" class="tsd-signature-type" data-tsd-kind="Interface">NFTokenCreateOfferFlagsInterface</a></div><aside class="tsd-sources"><p>Overrides BaseTransaction.Flags</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts#L83">packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:83</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"><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr/>Ledger<wbr/>Sequence<a href="#LastLedgerSequence" 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">Last<wbr/>Ledger<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.LastLedgerSequence</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L129">packages/xrpl/src/models/transactions/common.ts:129</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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></div></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"><span class="tsd-flag ts-flagOptional">Optional</span> Memos<a href="#Memos" 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">Memos<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Memo</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Memos</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L133">packages/xrpl/src/models/transactions/common.ts:133</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Additional arbitrary information used to identify this transaction.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="NFTokenID" class="tsd-anchor"></a><h3 class="tsd-anchor-link">NFTokenID<a href="#NFTokenID" 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">NFTokenID<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/bbe2e76e/packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts#L47">packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Identifies the NFTokenID of the NFToken object that the
|
|
offer references.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Owner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Owner<a href="#Owner" 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<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/bbe2e76e/packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts#L70">packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:70</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Indicates the AccountID of the account that owns the
|
|
corresponding NFToken.</p>
|
|
</div><div><p>If the offer is to buy a token, this field must be present
|
|
and it must be different than Account (since an offer to
|
|
buy a token one already holds is meaningless).</p>
|
|
<p>If the offer is to sell a token, this field must not be
|
|
present, as the owner is, implicitly, the same as Account
|
|
(since an offer to sell a token one doesn't already hold
|
|
is meaningless).</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"><span class="tsd-flag ts-flagOptional">Optional</span> 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 BaseTransaction.Sequence</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L115">packages/xrpl/src/models/transactions/common.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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></div></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"><span class="tsd-flag ts-flagOptional">Optional</span> Signers<a href="#Signers" 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">Signers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.Signers</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L138">packages/xrpl/src/models/transactions/common.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Array of objects that represent a multi-signature which authorizes this
|
|
transaction.</p>
|
|
</div></div></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"><span class="tsd-flag ts-flagOptional">Optional</span> Signing<wbr/>Pub<wbr/>Key<a href="#SigningPubKey" 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">Signing<wbr/>Pub<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SigningPubKey</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L151">packages/xrpl/src/models/transactions/common.ts:151</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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></div></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"><span class="tsd-flag ts-flagOptional">Optional</span> Source<wbr/>Tag<a href="#SourceTag" 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">Source<wbr/>Tag<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.SourceTag</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L145">packages/xrpl/src/models/transactions/common.ts:145</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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></div></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"><span class="tsd-flag ts-flagOptional">Optional</span> Ticket<wbr/>Sequence<a href="#TicketSequence" 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">Ticket<wbr/>Sequence<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TicketSequence</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L156">packages/xrpl/src/models/transactions/common.ts:156</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="TransactionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Transaction<wbr/>Type<a href="#TransactionType" 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">Transaction<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"NFTokenCreateOffer"</span></div><aside class="tsd-sources"><p>Overrides BaseTransaction.TransactionType</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts#L42">packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts:42</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"><span class="tsd-flag ts-flagOptional">Optional</span> Txn<wbr/>Signature<a href="#TxnSignature" 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">Txn<wbr/>Signature<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseTransaction.TxnSignature</p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/bbe2e76e/packages/xrpl/src/models/transactions/common.ts#L161">packages/xrpl/src/models/transactions/common.ts:161</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The signature that verifies this transaction as originating from the
|
|
account it says it is from.</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="NFTokenCreateOffer.html" class="tsd-kind-icon">NFToken<wbr/>Create<wbr/>Offer</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#Account" class="tsd-kind-icon">Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#AccountTxnID" class="tsd-kind-icon">Account<wbr/>TxnID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#Amount" class="tsd-kind-icon">Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#Destination" class="tsd-kind-icon">Destination</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#Expiration" class="tsd-kind-icon">Expiration</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#Fee" class="tsd-kind-icon">Fee</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="NFTokenCreateOffer.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#LastLedgerSequence" class="tsd-kind-icon">Last<wbr/>Ledger<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#Memos" class="tsd-kind-icon">Memos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#NFTokenID" class="tsd-kind-icon">NFTokenID</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="NFTokenCreateOffer.html#Owner" class="tsd-kind-icon">Owner</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#Sequence" class="tsd-kind-icon">Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#Signers" class="tsd-kind-icon">Signers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#SigningPubKey" class="tsd-kind-icon">Signing<wbr/>Pub<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#SourceTag" class="tsd-kind-icon">Source<wbr/>Tag</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#TicketSequence" class="tsd-kind-icon">Ticket<wbr/>Sequence</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="NFTokenCreateOffer.html#TransactionType" class="tsd-kind-icon">Transaction<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="NFTokenCreateOffer.html#TxnSignature" class="tsd-kind-icon">Txn<wbr/>Signature</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> |