@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>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"> All <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> </ul> <h1>Venus.js - v0.0.4</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <a href="#venusjs" id="venusjs" style="color: inherit; text-decoration: none;"> <h1>Venus.js</h1> </a> A JavaScript SDK for Binance Smart Chain and the Venus Protocol. Wraps around <a href="https://github.com/ethers-io/ethers.js/">Ethers.js</a>. Works in the web browser and Node.js. <a href="https://docs.venus.io/docs/venus-js">Venus.js Documentation</a> This SDK is in open beta, and is constantly under development. USE AT YOUR OWN RISK. <a href="#binance-smart-chain-read-amp-write" id="binance-smart-chain-read-amp-write" style="color: inherit; text-decoration: none;"> <h2>Binance Smart Chain Read & Write</h2> </a> JSON RPC based Binance Smart Chain read and write. <a href="#read" id="read" style="color: inherit; text-decoration: none;"> <h3>Read</h3> </a> <pre><code class="language-js">const Venus = require('@swipewallet/venus-js'); // in Node.js const vUsdtAddress = Venus.util.getAddress(Venus.vUSDT); (async function() { let supplyRatePerBlock = await Venus.eth.read( vUsdtAddress, 'function supplyRatePerBlock() returns (uint)', [], // [optional] parameters {} // [optional] call options, provider, network, ethers.js "overrides" ); console.log('USDT supplyRatePerBlock:', supplyRatePerBlock.toString()); })().catch(console.error);</code></pre> <a href="#write" id="write" style="color: inherit; text-decoration: none;"> <h3>Write</h3> </a> <pre><code class="language-js">const toAddress = '0xa0df350d2637096571F7A701CBc1C5fdE30dF76A'; (async function() { const trx = await Venus.eth.trx( toAddress, 'function send() external payable', [], { value: Venus._ethers.utils.parseEther('1.0'), // 1 ETH provider: window.ethereum, // in a web browser } ); const toAddressEthBalance = await Venus.eth.getBalance(toAddress); })().catch(console.error);</code></pre> <a href="#venus-protocol" id="venus-protocol" style="color: inherit; text-decoration: none;"> <h2>Venus Protocol</h2> </a> Simple methods for using the Venus protocol. <pre><code class="language-js">const venus = new Venus(window.ethereum); // in a web browser // Ethers.js overrides are an optional 3rd parameter for `supply` // const trxOptions = { gasLimit: 250000, mantissa: false }; (async function() { console.log('Supplying ETH to the Venus protocol...'); const trx = await venus.supply(Venus.ETH, 1); console.log('Ethers.js transaction object', trx); })().catch(console.error);</code></pre> <a href="#install--import" id="install--import" style="color: inherit; text-decoration: none;"> <h2>Install / Import</h2> </a> Web Browser <pre><code class="language-html"><script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@swipewallet/venus-js@latest/dist/browser/venus.min.js"></script> <script type="text/javascript"> window.Venus; // or `Venus` </script></code></pre> Node.js <pre><code>npm install @swipewallet/venus-js</code></pre> <pre><code class="language-js">const Venus = require('@swipewallet/venus-js'); // or, when using ES6 import Venus from '@swipewallet/venus-js';</code></pre> <a href="#more-code-examples" id="more-code-examples" style="color: inherit; text-decoration: none;"> <h2>More Code Examples</h2> </a> <ul> <li><a href="https://github.com/venusprotocol/venus-js/tree/master/examples">Node.js</a></li> <li><a href="https://github.com/venusprotocol/venus-js/examples/web/">Web Browser</a></li> </ul> <a href="https://github.com/venusprotocol/venus-js/tree/master/examples">To run, boot Ganache fork of mainnet locally</a> <a href="#instance-creation" id="instance-creation" style="color: inherit; text-decoration: none;"> <h2>Instance Creation</h2> </a> The following are valid Binance Smart Chain providers for initialization of the SDK. <pre><code class="language-js">var venus = new Venus(window.ethereum); // web browser var venus = new Venus('http://127.0.0.1:8545'); // HTTP provider var venus = new Venus(); // Uses Ethers.js fallback mainnet (for testing only) var venus = new Venus('testnet'); // Uses Ethers.js fallback (for testing only) // Init with private key (server side) var venus = new Venus('http://127.0.0.1:8545', { privateKey: '0x_your_private_key_', // preferably with environment variable }); // Init with HD mnemonic (server side) var venus = new Venus('mainnet' { mnemonic: 'clutch captain shoe...', // preferably with environment variable });</code></pre> <a href="#constants-and-contract-addresses" id="constants-and-contract-addresses" style="color: inherit; text-decoration: none;"> <h2>Constants and Contract Addresses</h2> </a> Names of contracts, their addresses, ABIs, token decimals, and more can be found in <code>/src/constants.ts</code>. Addresses, for all networks, can be easily fetched using the <code>getAddress</code> function, combined with contract name constants. <pre><code class="language-js">console.log(Venus.BUSD, Venus.BNB, Venus.vSXP); // BUSD, BNB, vSXP const vUsdtAddress = Venus.util.getAddress(Venus.vUSDT); // Mainnet vUSDT address. Second parameter can be a network like 'testnet'.</code></pre> <a href="#mantissas" id="mantissas" style="color: inherit; text-decoration: none;"> <h2>Mantissas</h2> </a> Parameters of number values can be plain numbers or their scaled up mantissa values. There is a transaction option boolean to tell the SDK what the developer is passing. <pre><code class="language-js">// 1 BUSD await venus.borrow(Venus.BUSD, '1000000000000000000', { mantissa: true }); // `mantissa` defaults to false if it is not specified or if an options object is not passed await venus.borrow(Venus.BUSD, 1, { mantissa: false });</code></pre> <a href="#transaction-options" id="transaction-options" style="color: inherit; text-decoration: none;"> <h2>Transaction Options</h2> </a> Each method that interacts with the blockchain accepts a final optional parameter for overrides, much like <a href="https://docs.ethers.io/ethers.js/v5-beta/api-contract.html#overrides">Ethers.js overrides</a>. <pre><code class="language-js">// The options object itself and all options are optional const trxOptions = { mantissa, // Boolean, parameters array arg of 1 ETH would be '1000000000000000000' (true) vs 1 (false) abi, // Definition string or an ABI array from a solc build provider, // JSON RPC string, Web3 object, or Ethers.js fallback network (string) network, // Ethers.js fallback network provider, "provider" has precedence over "network" from, // Address that the Binance Smart Chain transaction is send from gasPrice, // Ethers.js override `Venus._ethers.utils.parseUnits('10.0', 'gwei')` gasLimit, // Ethers.js override - see https://docs.ethers.io/ethers.js/v5-beta/api-contract.html#overrides value, // Number or string data, // Number or string chainId, // Number nonce, // Number privateKey, // String, meant to be used with `Venus.eth.trx` (server side) mnemonic, // String, meant to be used with `Venus.eth.trx` (server side) };</code></pre> <a href="#api" id="api" style="color: inherit; text-decoration: none;"> <h2>API</h2> </a> The <a href="https://docs.venus.io/docs/api">Venus API</a> is accessible from Venus.js. The corresponding services are defined in the <code>api</code> namespace on the class. <ul> <li><code>Venus.api.account</code></li> <li><code>Venus.api.vToken</code></li> <li><code>Venus.api.marketHistory</code></li> <li><code>Venus.api.governance</code></li> </ul> The governance method requires a second parameter (string) for the corresponding endpoint shown in the <a href="https://docs.venus.io/docs/api#GovernanceService">documentation</a>. <ul> <li><code>proposals</code></li> <li><code>voteReceipts</code></li> <li><code>accounts</code></li> </ul> Here is an example for using the <code>account</code> endpoint. The <code>network</code> parameter in the request body is optional and defaults to <code>mainnet</code>. <pre><code class="language-js">const main = async () => { const account = await Venus.api.account({ "addresses": "0xB61C5971d9c0472befceFfbE662555B78284c307", "network": "testnet" }); let sxpBorrowBalance = 0; if (Object.isExtensible(account) && account.accounts) { account.accounts.forEach((acc) => { acc.tokens.forEach((tok) => { if (tok.symbol === Venus.vSXP) { sxpBorrowBalance = +tok.borrow_balance_underlying.value; } }); }); } console.log('sxpBorrowBalance', sxpBorrowBalance); } main().catch(console.error);</code></pre> <a href="#build-for-nodejs-amp-web-browser" id="build-for-nodejs-amp-web-browser" style="color: inherit; text-decoration: none;"> <h2>Build for Node.js & Web Browser</h2> </a> <pre><code>git clone git@github.com:venusprotocol/venus-js.git cd venus-js/ npm install npm run build</code></pre> <a href="#web-browser-build" id="web-browser-build" style="color: inherit; text-decoration: none;"> <h3>Web Browser Build</h3> </a> <pre><code class="language-html"> <script type="text/javascript" src="./dist/browser/venus.min.js"></script>  <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@swipewallet/venus-js@latest/dist/browser/venus.min.js"></script></code></pre> <a href="#nodejs-build" id="nodejs-build" style="color: inherit; text-decoration: none;"> <h3>Node.js Build</h3> </a> <pre><code class="language-js">// Local build (do `npm install` first) const Venus = require('./dist/nodejs/index.js'); // Public NPM build const Venus = require('@swipewallet/venus-js');</code></pre> </div> </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">Globals</a> </li> <li class=" tsd-kind-module"> <a href="modules/_api_.html">"api"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_comp_.html">"comp"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_comptroller_.html">"comptroller"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_eth_.html">"eth"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_gov_.html">"gov"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_index_.html">"index"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_pricefeed_.html">"priceFeed"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_util_.html">"util"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_vtoken_.html">"vToken"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </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">Function</li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="assets/js/main.js"></script> </body> </html>