ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-11 16:25:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
xahau.js/docs/interfaces/AMMCreate.html
Raj Patel 8995e3d579 Docgen issue fix (#2910) 
* fix: use .mts extension to emit ES Modules

* add comments and Apppliction type

* update docs
2025-03-07 20:07:47 -05:00

71 lines
39 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>AMMCreate | 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="AMMCreate.html">AMMCreate</a></li></ul><h1>Interface AMMCreate</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Create a new Automated Market Maker (AMM) instance for trading a pair of assets (fungible tokens or XRP).</p>
<p>Creates both an AMM object and a special AccountRoot object to represent the AMM.
Also transfers ownership of the starting balance of both assets from the sender to the created AccountRoot
and issues an initial balance of liquidity provider tokens (LP Tokens) from the AMM account to the sender.</p>
<p>CAUTION: When you create the AMM, you should fund it with (approximately) equal-value amounts of each asset.
Otherwise, other users can profit at your expense by trading with this AMM (performing arbitrage).
The currency risk that liquidity providers take on increases with the volatility (potential for imbalance) of the asset pair.
The higher the trading fee, the more it offsets this risk,
so it's best to set the trading fee based on the volatility of the asset pair.</p>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AMMCreate</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="AMMCreate.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="AMMCreate.html#accounttxnid">AccountTxnID</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="AMMCreate.html#amount">Amount</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="AMMCreate.html#amount2">Amount2</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="AMMCreate.html#fee">Fee</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="AMMCreate.html#flags">Flags</a><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><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="AMMCreate.html#lastledgersequence">LastLedgerSequence</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="AMMCreate.html#memos">Memos</a><span class="tsd-signature-symbol">?:</span> <a href="Memo.html" class="tsd-signature-type tsd-kind-interface">Memo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="AMMCreate.html#networkid">NetworkID</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="AMMCreate.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="AMMCreate.html#signers">Signers</a><span class="tsd-signature-symbol">?:</span> <a href="Signer.html" class="tsd-signature-type tsd-kind-interface">Signer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="AMMCreate.html#signingpubkey">SigningPubKey</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="AMMCreate.html#sourcetag">SourceTag</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="AMMCreate.html#ticketsequence">TicketSequence</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="AMMCreate.html#tradingfee">TradingFee</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="AMMCreate.html#transactiontype">TransactionType</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AMMCreate&quot;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="AMMCreate.html#txnsignature">TxnSignature</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="2508"><h4>Hierarchy (<a href="../hierarchy.html#AMMCreate">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BaseTransaction.html" class="tsd-signature-type tsd-kind-interface">BaseTransaction</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">AMMCreate</span></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/transactions/AMMCreate.ts#L21">packages/xrpl/src/models/transactions/AMMCreate.ts:21</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="AMMCreate.html#account" 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>Account</span></a>
<a href="AMMCreate.html#accounttxnid" 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>Account<wbr/>TxnID?</span></a>
<a href="AMMCreate.html#amount" 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>Amount</span></a>
<a href="AMMCreate.html#amount2" 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>Amount2</span></a>
<a href="AMMCreate.html#fee" 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>Fee?</span></a>
<a href="AMMCreate.html#flags" 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>Flags?</span></a>
<a href="AMMCreate.html#lastledgersequence" 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>Last<wbr/>Ledger<wbr/>Sequence?</span></a>
<a href="AMMCreate.html#memos" 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>Memos?</span></a>
<a href="AMMCreate.html#networkid" 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>NetworkID?</span></a>
<a href="AMMCreate.html#sequence" 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>Sequence?</span></a>
<a href="AMMCreate.html#signers" 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>Signers?</span></a>
<a href="AMMCreate.html#signingpubkey" 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>Signing<wbr/>Pub<wbr/>Key?</span></a>
<a href="AMMCreate.html#sourcetag" 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>Source<wbr/>Tag?</span></a>
<a href="AMMCreate.html#ticketsequence" 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>Ticket<wbr/>Sequence?</span></a>
<a href="AMMCreate.html#tradingfee" 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>Trading<wbr/>Fee</span></a>
<a href="AMMCreate.html#transactiontype" 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>Transaction<wbr/>Type</span></a>
<a href="AMMCreate.html#txnsignature" 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>Txn<wbr/>Signature?</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 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 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 unique address of the transaction sender.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#account">Account</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L271">packages/xrpl/src/models/transactions/common.ts:271</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="accounttxnid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Account<wbr/>TxnID</span><a href="#accounttxnid" 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">AccountTxnID</span><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#accounttxnid">AccountTxnID</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L295">packages/xrpl/src/models/transactions/common.ts:295</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="amount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Amount</span><a href="#amount" 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">Amount</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 first of the two assets to fund this AMM with. This must be a positive amount.</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/transactions/AMMCreate.ts#L27">packages/xrpl/src/models/transactions/AMMCreate.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="amount2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Amount2</span><a href="#amount2" 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">Amount2</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 second of the two assets to fund this AMM with. This must be a positive amount.</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/transactions/AMMCreate.ts#L32">packages/xrpl/src/models/transactions/AMMCreate.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="fee" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Fee</span><a href="#fee" 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">Fee</span><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#fee">Fee</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L282">packages/xrpl/src/models/transactions/common.ts:282</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="flags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><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> <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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#flags">Flags</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L297">packages/xrpl/src/models/transactions/common.ts:297</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="lastledgersequence" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Last<wbr/>Ledger<wbr/>Sequence</span><a href="#lastledgersequence" 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">LastLedgerSequence</span><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#lastledgersequence">LastLedgerSequence</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L303">packages/xrpl/src/models/transactions/common.ts:303</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="memos" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Memos</span><a href="#memos" 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">Memos</span><span class="tsd-signature-symbol">?:</span> <a href="Memo.html" class="tsd-signature-type tsd-kind-interface">Memo</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Additional arbitrary information used to identify this transaction.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#memos">Memos</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L307">packages/xrpl/src/models/transactions/common.ts:307</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="networkid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>NetworkID</span><a href="#networkid" 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">NetworkID</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The network id of the transaction.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#networkid">NetworkID</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L339">packages/xrpl/src/models/transactions/common.ts:339</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="sequence" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><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 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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#sequence">Sequence</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L289">packages/xrpl/src/models/transactions/common.ts:289</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="signers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Signers</span><a href="#signers" 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">Signers</span><span class="tsd-signature-symbol">?:</span> <a href="Signer.html" class="tsd-signature-type tsd-kind-interface">Signer</a><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#signers">Signers</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L312">packages/xrpl/src/models/transactions/common.ts:312</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="signingpubkey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Signing<wbr/>Pub<wbr/>Key</span><a href="#signingpubkey" 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">SigningPubKey</span><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#signingpubkey">SigningPubKey</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L325">packages/xrpl/src/models/transactions/common.ts:325</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="sourcetag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Source<wbr/>Tag</span><a href="#sourcetag" 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">SourceTag</span><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#sourcetag">SourceTag</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L319">packages/xrpl/src/models/transactions/common.ts:319</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="ticketsequence" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Ticket<wbr/>Sequence</span><a href="#ticketsequence" 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">TicketSequence</span><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#ticketsequence">TicketSequence</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L330">packages/xrpl/src/models/transactions/common.ts:330</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tradingfee" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Trading<wbr/>Fee</span><a href="#tradingfee" 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">TradingFee</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The fee to charge for trades against this AMM instance, in units of 1/100,000; a value of 1 is equivalent to 0.001%.
The maximum value is 1000, indicating a 1% fee.
The minimum value is 0.</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/transactions/AMMCreate.ts#L39">packages/xrpl/src/models/transactions/AMMCreate.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member"><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 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">TransactionType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AMMCreate&quot;</span></div><div class="tsd-comment tsd-typography"><p>The type of transaction. Valid types include: <code>Payment</code>, <code>OfferCreate</code>,
<code>TrustSet</code>, and many others.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#transactiontype">TransactionType</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/AMMCreate.ts#L22">packages/xrpl/src/models/transactions/AMMCreate.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="txnsignature" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>Txn<wbr/>Signature</span><a href="#txnsignature" 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">TxnSignature</span><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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="BaseTransaction.html">BaseTransaction</a>.<a href="BaseTransaction.html#txnsignature">TxnSignature</a></p><ul><li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/9d74cf958dce4f0004d702b706d1d198974ee150/packages/xrpl/src/models/transactions/common.ts#L335">packages/xrpl/src/models/transactions/common.ts:335</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="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>Account</span></a><a href="#accounttxnid" 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>Account<wbr/>TxnID</span></a><a href="#amount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Amount</span></a><a href="#amount2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Amount2</span></a><a href="#fee" 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>Fee</span></a><a href="#flags" 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>Flags</span></a><a href="#lastledgersequence" 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>Last<wbr/>Ledger<wbr/>Sequence</span></a><a href="#memos" 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>Memos</span></a><a href="#networkid" 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>NetworkID</span></a><a href="#sequence" 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>Sequence</span></a><a href="#signers" 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>Signers</span></a><a href="#signingpubkey" 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>Signing<wbr/>Pub<wbr/>Key</span></a><a href="#sourcetag" 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>Source<wbr/>Tag</span></a><a href="#ticketsequence" 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>Ticket<wbr/>Sequence</span></a><a href="#tradingfee" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Trading<wbr/>Fee</span></a><a href="#transactiontype" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Transaction<wbr/>Type</span></a><a href="#txnsignature" 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>Txn<wbr/>Signature</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>
Reference in New Issue View Git Blame Copy Permalink