soroswap-utils
Version:
Utilities for interacting with Soroswap, the decentralized exchange (DEX) on Soroban, which is the smart contracts platform of the Stellar network.
12 lines (9 loc) • 9.81 kB
HTML
<html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>soroswap-utils</title><meta name="description" content="Documentation for soroswap-utils"/><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></head><body><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" data-base="."><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"><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">soroswap-utils</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"><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"><h1>soroswap-utils</h1></div><div class="tsd-panel tsd-typography"><a id="md:soroswap-utils" class="tsd-anchor"></a><h1 class="tsd-anchor-link">soroswap-utils<a href="#md:soroswap-utils" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This library provides utilities to interact with Soroswap, the decentralized exchange (DEX) on Soroban, which is the smart contracts platform of the Stellar network.</p>
<a id="md:configuration" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Configuration<a href="#md:configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Before using the library, you must initialize it with your configuration (see <code>.env.example</code>):</p>
<pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">initializeSoroswap</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'soroswap-utils'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">initializeSoroswap</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-2">assets:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">url:</span><span class="hl-1"> </span><span class="hl-5">// Provide if interacting with the Stellar mainnet</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-2">contracts:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">factory:</span><span class="hl-1"> </span><span class="hl-5">// Provide if interacting with the Stellar mainnet</span><br/><span class="hl-1"> </span><span class="hl-2">router</span><span class="hl-1">: </span><span class="hl-5">// Provide if interacting with the Stellar mainnet</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-2">mercury:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">apiKey:</span><span class="hl-1"> </span><span class="hl-3">"YOUR_MERCURY_API_KEY"</span><span class="hl-1">, </span><span class="hl-5">// Required</span><br/><span class="hl-1"> </span><span class="hl-2">backendEndpoint:</span><span class="hl-1"> </span><span class="hl-3">"MERCURY_BACKEND"</span><span class="hl-1">, </span><span class="hl-5">// Required</span><br/><span class="hl-1"> </span><span class="hl-2">graphqlEndpoint:</span><span class="hl-1"> </span><span class="hl-3">"MERCURY_GRAPHQL"</span><span class="hl-1"> </span><span class="hl-5">// Required</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-2">rpc:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">url:</span><span class="hl-1"> </span><span class="hl-5">// Provide if interacting with the Stellar mainnet</span><br/><span class="hl-1"> </span><span class="hl-2">wallet</span><span class="hl-1">: </span><span class="hl-3">"YOUR_STELLAR_WALLET"</span><span class="hl-1">, </span><span class="hl-5">// Required</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
</code><button type="button">Copy</button></pre>
<a id="md:mercury-sdk-dependencies" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Mercury SDK Dependencies<a href="#md:mercury-sdk-dependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>This library depends on the Mercury SDK. The Mercury API key and endpoints are usually set up during the Mercury SDK installation. If you haven't installed and configured the Mercury SDK, please refer to their documentation first.</p>
<a id="md:docs" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Docs<a href="#md:docs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>For library documentation, run:</p>
<pre><code><span class="hl-2">$</span><span class="hl-1"> </span><span class="hl-2">bun</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-6">docs</span><span class="hl-1">:</span><span class="hl-2">serve</span>
</code><button>Copy</button></pre>
</div></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"><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"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:soroswap-utils"><span>soroswap-<wbr/>utils</span></a><ul><li><a href="#md:configuration"><span>Configuration</span></a></li><li><ul><li><a href="#md:mercury-sdk-dependencies"><span>Mercury SDK <wbr/>Dependencies</span></a></li></ul></li><li><a href="#md:docs"><span>Docs</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>soroswap-utils</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><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>