@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>"api" | 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="_api_.html">"api"</a> </li> </ul> <h1>Module "api"</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="_api_.html#account" class="tsd-kind-icon">account</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_api_.html#governance" class="tsd-kind-icon">governance</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_api_.html#markethistory" class="tsd-kind-icon">market<wbr>History</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_api_.html#vtoken" class="tsd-kind-icon">v<wbr>Token</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="account" class="tsd-anchor"></a> <h3>account</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AccountServiceRequest</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">APIResponse</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/api.ts#L74">api.ts:74</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Makes a request to the AccountService API. The Account API retrieves information for various accounts which have interacted with the protocol. For more details, see the Venus API documentation.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code>(<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> account = <span class="hljs-keyword">await</span> Venus.api.account({ <span class="hljs-string">"addresses"</span>: <span class="hljs-string">"0xB61C5971d9c0472befceFfbE662555B78284c307"</span>, <span class="hljs-string">"network"</span>: <span class="hljs-string">"testnet"</span> }); <span class="hljs-keyword">let</span> sxpBorrowBalance = <span class="hljs-number">0</span>; <span class="hljs-keyword">if</span> (<span class="hljs-built_in">Object</span>.isExtensible(account) && account.accounts) { account.accounts.forEach(<span class="hljs-function">(<span class="hljs-params">acc</span>) =></span> { acc.tokens.forEach(<span class="hljs-function">(<span class="hljs-params">tok</span>) =></span> { <span class="hljs-keyword">if</span> (tok.symbol === Venus.vSXP) { sxpBorrowBalance = +tok.borrow_balance_underlying.value; } }); }); } <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'sxpBorrowBalance'</span>, sxpBorrowBalance); })().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>options: <span class="tsd-signature-type">AccountServiceRequest</span></h5> <div class="tsd-comment tsd-typography"> <p>A JavaScript object of API request parameters.</p> </div> </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">APIResponse</span><span class="tsd-signature-symbol">></span></h4> <p>Returns the HTTP response body or error.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="governance" class="tsd-anchor"></a> <h3>governance</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">governance<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GovernanceServiceRequest</span>, endpoint<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">APIResponse</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/api.ts#L156">api.ts:156</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Makes a request to the GovernanceService API. The Governance Service includes three endpoints to retrieve information about COMP accounts. For more details, see the Venus API documentation.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code>(<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> proposal = <span class="hljs-keyword">await</span> Venus.api.governance( { <span class="hljs-string">"proposal_ids"</span>: [ <span class="hljs-number">20</span> ] }, <span class="hljs-string">'proposals'</span> ); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'proposal'</span>, proposal); <span class="hljs-comment">// JavaScript Object</span> })().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>options: <span class="tsd-signature-type">GovernanceServiceRequest</span></h5> <div class="tsd-comment tsd-typography"> <p>A JavaScript object of API request parameters.</p> </div> </li> <li> <h5>endpoint: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A string of the name of the corresponding governance service endpoint. Valid values are <code>proposals</code>, <code>voteReceipts</code>, or <code>accounts</code>.</p> </div> </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">APIResponse</span><span class="tsd-signature-symbol">></span></h4> <p>Returns the HTTP response body or error.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="markethistory" class="tsd-anchor"></a> <h3>market<wbr>History</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">market<wbr>History<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MarketHistoryServiceRequest</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">APIResponse</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/api.ts#L127">api.ts:127</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Makes a request to the MarketHistoryService API. The market history service retrieves information about a market. For more details, see the Venus API documentation.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code>(<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> vUsdcMarketData = <span class="hljs-keyword">await</span> Venus.api.marketHistory({ <span class="hljs-string">"asset"</span>: Venus.util.getAddress(Venus.vUSDC), <span class="hljs-string">"min_block_timestamp"</span>: <span class="hljs-number">1559339900</span>, <span class="hljs-string">"max_block_timestamp"</span>: <span class="hljs-number">1598320674</span>, <span class="hljs-string">"num_buckets"</span>: <span class="hljs-number">10</span>, }); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'vUsdcMarketData'</span>, vUsdcMarketData); <span class="hljs-comment">// JavaScript Object</span> })().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>options: <span class="tsd-signature-type">MarketHistoryServiceRequest</span></h5> <div class="tsd-comment tsd-typography"> <p>A JavaScript object of API request parameters.</p> </div> </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">APIResponse</span><span class="tsd-signature-symbol">></span></h4> <p>Returns the HTTP response body or error.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="vtoken" class="tsd-anchor"></a> <h3>v<wbr>Token</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">v<wbr>Token<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CTokenServiceRequest</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">APIResponse</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/api.ts#L99">api.ts:99</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Makes a request to the CTokenService API. The vToken API retrieves information about vToken contract interaction. For more details, see the Venus API documentation.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code>(<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> vSxpData = <span class="hljs-keyword">await</span> Venus.api.vToken({ <span class="hljs-string">"addresses"</span>: Venus.util.getAddress(Venus.vSXP) }); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'vSxpData'</span>, vSxpData); <span class="hljs-comment">// JavaScript Object</span> })().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>options: <span class="tsd-signature-type">CTokenServiceRequest</span></h5> <div class="tsd-comment tsd-typography"> <p>A JavaScript object of API request parameters.</p> </div> </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">APIResponse</span><span class="tsd-signature-symbol">></span></h4> <p>Returns the HTTP response body or error.</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="current tsd-kind-module"> <a href="_api_.html">"api"</a> </li> <li class=" tsd-kind-module"> <a href="_comp_.html">"comp"</a> </li> <li class=" 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="_api_.html#account" class="tsd-kind-icon">account</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="_api_.html#governance" class="tsd-kind-icon">governance</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="_api_.html#markethistory" class="tsd-kind-icon">market<wbr>History</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="_api_.html#vtoken" class="tsd-kind-icon">v<wbr>Token</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>