2023-05-25 05:43:20 -07:00
|
|
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SwapParams | @blockworks-foundation/mango-v4</title><meta name="description" content="Documentation for @blockworks-foundation/mango-v4"/><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">@blockworks-foundation/mango-v4</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="../index.html">@blockworks-foundation/mango-v4</a></li><li><a href="SwapParams.html">SwapParams</a></li></ul><h1>Interface SwapParams</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SwapParams</span><ul class="tsd-hierarchy"><li><a href="ExactOutSwapParams.html" class="tsd-signature-type" data-tsd-kind="Interface">ExactOutSwapParams</a></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"><a href="SwapParams.html#amount" class="tsd-kind-icon">amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SwapParams.html#destinationMint" class="tsd-kind-icon">destination<wbr/>Mint</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SwapParams.html#openOrdersAddress" class="tsd-kind-icon">open<wbr/>Orders<wbr/>Address</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SwapParams.html#quoteMintToReferrer" class="tsd-kind-icon">quote<wbr/>Mint<wbr/>To<wbr/>Referrer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SwapParams.html#sourceMint" class="tsd-kind-icon">source<wbr/>Mint</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SwapParams.html#swapMode" class="tsd-kind-icon">swap<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SwapParams.html#userDestinationTokenAccount" class="tsd-kind-icon">user<wbr/>Destination<wbr/>Token<wbr/>Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SwapParams.html#userSourceTokenAccount" class="tsd-kind-icon">user<wbr/>Source<wbr/>Token<wbr/>Account</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SwapParam
|
2023-04-25 04:56:08 -07:00
|
|
|
<p>amount is used for instruction and can be null when it is an intermediate swap, only the first swap has an amount</p>
|
2023-05-25 05:43:20 -07:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="destinationMint" class="tsd-anchor"></a><h3 class="tsd-anchor-link">destination<wbr/>Mint<a href="#destinationMint" 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<wbr/>Mint<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/blockworks-foundation/mango-v4/blob/7a7dd1c/ts/client/src/router.ts#L36">router.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="openOrdersAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> open<wbr/>Orders<wbr/>Address<a href="#openOrdersAddress" 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">open<wbr/>Orders<wbr/>Address<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/blockworks-foundation/mango-v4/blob/7a7dd1c/ts/client/src/router.ts#L45">router.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="quoteMintToReferrer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> quote<wbr/>Mint<wbr/>To<wbr/>Referrer<a href="#quoteMintToReferrer" 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">quote<wbr/>Mint<wbr/>To<wbr/>Referrer<span class="tsd-signature-symbol">?:</span> <a href="../index.html#QuoteMintToReferrer" class="tsd-signature-type" data-tsd-kind="Type alias">QuoteMintToReferrer</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/7a7dd1c/ts/client/src/router.ts#L46">router.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sourceMint" class="tsd-anchor"></a><h3 class="tsd-anchor-link">source<wbr/>Mint<a href="#sourceMint" 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/>Mint<span class="tsd-signature-symbol">:</span> <span cla
|
