@swipewallet/venus-js

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"comptroller" | Venus.js - v0.0.4</title> <meta name="description" content="Documentation for Venus.js - v0.0.4"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </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">Venus.js - v0.0.4</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-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> </li> <li> <a href="_comptroller_.html">"comptroller"</a> </li> </ul> <h1>Module "comptroller"</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <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>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comptroller_.html#entermarkets" class="tsd-kind-icon">enter<wbr>Markets</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comptroller_.html#exitmarket" class="tsd-kind-icon">exit<wbr>Market</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="entermarkets" class="tsd-anchor"></a> <h3>enter<wbr>Markets</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">enter<wbr>Markets<span class="tsd-signature-symbol">(</span>markets<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CallOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/VenusProtocol/venus-js/blob/f412301/src/comptroller.ts#L35">comptroller.ts:35</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enters the user's address into Venus Protocol markets.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> venus = <span class="hljs-keyword">new</span> Venus(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) </span>{ <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> venus.enterMarkets(Venus.SXP); <span class="hljs-comment">// Use [] for multiple</span> <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Ethers.js transaction object'</span>, trx); })().catch(<span class="hljs-built_in">console</span>.error);</code></pre> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> markets: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5> <div class="tsd-comment tsd-typography"> <p>An array of strings of markets to enter, meaning use those supplied assets as collateral.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <span class="tsd-signature-type">CallOptions</span><span class="tsd-signature-symbol"> = {}</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></h4> <p>Returns an Ethers.js transaction object of the enterMarkets transaction.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="exitmarket" class="tsd-anchor"></a> <h3>exit<wbr>Market</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">exit<wbr>Market<span class="tsd-signature-symbol">(</span>market<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CallOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/VenusProtocol/venus-js/blob/f412301/src/comptroller.ts#L96">comptroller.ts:96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Exits the user's address from a Venus Protocol market.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> venus = <span class="hljs-keyword">new</span> Venus(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params"></span>) </span>{ <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> venus.exitMarket(Venus.SXP); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Ethers.js transaction object'</span>, trx); })().catch(<span class="hljs-built_in">console</span>.error);</code></pre> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>market: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A string of the symbol of the market to exit.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <span class="tsd-signature-type">CallOptions</span><span class="tsd-signature-symbol"> = {}</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></h4> <p>Returns an Ethers.js transaction object of the exitMarket transaction.</p> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-module"> <a href="_api_.html">"api"</a> </li> <li class=" tsd-kind-module"> <a href="_comp_.html">"comp"</a> </li> <li class="current tsd-kind-module"> <a href="_comptroller_.html">"comptroller"</a> </li> <li class=" tsd-kind-module"> <a href="_eth_.html">"eth"</a> </li> <li class=" tsd-kind-module"> <a href="_gov_.html">"gov"</a> </li> <li class=" tsd-kind-module"> <a href="_index_.html">"index"</a> </li> <li class=" tsd-kind-module"> <a href="_pricefeed_.html">"price<wbr>Feed"</a> </li> <li class=" tsd-kind-module"> <a href="_util_.html">"util"</a> </li> <li class=" tsd-kind-module"> <a href="_vtoken_.html">"v<wbr>Token"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="_comptroller_.html#entermarkets" class="tsd-kind-icon">enter<wbr>Markets</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="_comptroller_.html#exitmarket" class="tsd-kind-icon">exit<wbr>Market</a> </li> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>