1 line
19 KiB
HTML
1 line
19 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RouteInfo | @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="RouteInfo.html">RouteInfo</a></li></ul><h1>Interface RouteInfo</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">RouteInfo</span></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="RouteInfo.html#amount" class="tsd-kind-icon">amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#inAmount" class="tsd-kind-icon">in<wbr/>Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#instructions" class="tsd-kind-icon">instructions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#marketInfos" class="tsd-kind-icon">market<wbr/>Infos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#mints" class="tsd-kind-icon">mints</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#otherAmountThreshold" class="tsd-kind-icon">other<wbr/>Amount<wbr/>Threshold</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#outAmount" class="tsd-kind-icon">out<wbr/>Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#priceImpactPct" class="tsd-kind-icon">price<wbr/>Impact<wbr/>Pct</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#routerName" class="tsd-kind-icon">router<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#slippageBps" class="tsd-kind-icon">slippage<wbr/>Bps</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#swapMode" class="tsd-kind-icon">swap<wbr/>Mode</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"><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">number</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#L122">router.ts:122</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="inAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link">in<wbr/>Amount<a href="#inAmount" 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">in<wbr/>Amount<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/blockworks-foundation/mango-v4/blob/7a7dd1c/ts/client/src/router.ts#L123">router.ts:123</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="instructions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> instructions<a href="#instructions" 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">instructions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TransactionInstruction</span><span class="tsd-signature-symbol">[]</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#L130">router.ts:130</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="marketInfos" class="tsd-anchor"></a><h3 class="tsd-anchor-link">market<wbr/>Infos<a href="#marketInfos" 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">market<wbr/>Infos<span class="tsd-signature-symbol">:</span> <a href="MarketInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">MarketInfo</a><span class="tsd-signature-symbol">[]</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#L124">router.ts:124</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="mints" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> mints<a href="#mints" 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">mints<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">[]</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#L131">router.ts:131</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="otherAmountThreshold" class="tsd-anchor"></a><h3 class="tsd-anchor-link">other<wbr/>Amount<wbr/>Threshold<a href="#otherAmountThreshold" 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">other<wbr/>Amount<wbr/>Threshold<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/blockworks-foundation/mango-v4/blob/7a7dd1c/ts/client/src/router.ts#L125">router.ts:125</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="outAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link">out<wbr/>Amount<a href="#outAmount" 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">out<wbr/>Amount<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/blockworks-foundation/mango-v4/blob/7a7dd1c/ts/client/src/router.ts#L126">router.ts:126</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="priceImpactPct" class="tsd-anchor"></a><h3 class="tsd-anchor-link">price<wbr/>Impact<wbr/>Pct<a href="#priceImpactPct" 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">price<wbr/>Impact<wbr/>Pct<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/blockworks-foundation/mango-v4/blob/7a7dd1c/ts/client/src/router.ts#L127">router.ts:127</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="routerName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> router<wbr/>Name<a href="#routerName" 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">router<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"Mango"</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#L132">router.ts:132</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="slippageBps" class="tsd-anchor"></a><h3 class="tsd-anchor-link">slippage<wbr/>Bps<a href="#slippageBps" 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">slippage<wbr/>Bps<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/blockworks-foundation/mango-v4/blob/7a7dd1c/ts/client/src/router.ts#L128">router.ts:128</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="swapMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link">swap<wbr/>Mode<a href="#swapMode" 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">swap<wbr/>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/SwapMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SwapMode</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#L129">router.ts:129</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="RouteInfo.html" class="tsd-kind-icon">Route<wbr/>Info</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#amount" class="tsd-kind-icon">amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#inAmount" class="tsd-kind-icon">in<wbr/>Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#instructions" class="tsd-kind-icon">instructions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#marketInfos" class="tsd-kind-icon">market<wbr/>Infos</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#mints" class="tsd-kind-icon">mints</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#otherAmountThreshold" class="tsd-kind-icon">other<wbr/>Amount<wbr/>Threshold</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#outAmount" class="tsd-kind-icon">out<wbr/>Amount</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#priceImpactPct" class="tsd-kind-icon">price<wbr/>Impact<wbr/>Pct</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#routerName" class="tsd-kind-icon">router<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#slippageBps" class="tsd-kind-icon">slippage<wbr/>Bps</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RouteInfo.html#swapMode" class="tsd-kind-icon">swap<wbr/>Mode</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">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></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> |