npm - @meterio/sumer-js - Versions diffs - 0.0.13 → 0.1.0 - Mend

@meterio/sumer-js 0.0.13 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1062) hide show

package/docs/modules/_vtoken_.html DELETED Viewed

@@ -1,423 +0,0 @@
-<!doctype html>
-<html class="default no-js">
-<head>
-	<meta charset="utf-8">
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>&quot;vToken&quot; | Sumer.js - v0.0.5</title>
-	<meta name="description" content="Documentation for Sumer.js - v0.0.5">
-	<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">Sumer.js - v0.0.5</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="_vtoken_.html">&quot;vToken&quot;</a>
-				</li>
-			</ul>
-			<h1>Module &quot;vToken&quot;</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="_vtoken_.html#borrow" class="tsd-kind-icon">borrow</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_vtoken_.html#redeem" class="tsd-kind-icon">redeem</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_vtoken_.html#repayborrow" class="tsd-kind-icon">repay<wbr>Borrow</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_vtoken_.html#supply" class="tsd-kind-icon">supply</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="borrow" class="tsd-anchor"></a>
-					<h3>borrow</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">borrow<span class="tsd-signature-symbol">(</span>asset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumber</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">&lt;</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">&gt;</span></li>
-					</ul>
-					<ul class="tsd-descriptions">
-						<li class="tsd-description">
-							<aside class="tsd-sources">
-								<ul>
-									<li>Defined in <a href="https://github.com/dfinlab/sumer-js/blob/e3c14e5/src/vToken.ts#L242">vToken.ts:242</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Borrows an Binance Smart Chain asset from the Sumer Protocol for the user.
-										The user&#39;s address must first have supplied collateral and entered a
-									corresponding market.</p>
-								</div>
-								<dl class="tsd-comment-tags">
-									<dt>example</dt>
-									<dd><pre><code><span class="hljs-keyword">const</span> sumer = <span class="hljs-keyword">new</span> Sumer(<span class="hljs-built_in">window</span>.ethereum);
-(<span class="hljs-keyword">async</span> <span class="hljs-keyword">function</span>() {
-  <span class="hljs-keyword">const</span> sxpScaledUp = <span class="hljs-string">&#x27;32000000000000000000&#x27;</span>;
-  <span class="hljs-keyword">const</span> trxOptions = { mantissa: <span class="hljs-literal">true</span> };
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Borrowing 32 SXP...&#x27;</span>);
-  <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> sumer.borrow(Sumer.SXP, sxpScaledUp, trxOptions);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Ethers.js transaction object&#x27;</span>, trx);
-})().<span class="hljs-keyword">catch</span>(<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>asset: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>A string of the asset to borrow (must be a supported
-										underlying asset).</p>
-									</div>
-								</li>
-								<li>
-									<h5>amount: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumber</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>A string, number, or BigNumber
-											object of the amount of an asset to borrow. Use the <code>mantissa</code> boolean in
-											the <code>options</code> parameter to indicate if this value is scaled up (so there
-										are no decimals) or in its natural scale.</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">&lt;</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns an Ethers.js transaction object of the borrow
-							transaction.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="redeem" class="tsd-anchor"></a>
-					<h3>redeem</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">redeem<span class="tsd-signature-symbol">(</span>asset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumber</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">&lt;</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">&gt;</span></li>
-					</ul>
-					<ul class="tsd-descriptions">
-						<li class="tsd-description">
-							<aside class="tsd-sources">
-								<ul>
-									<li>Defined in <a href="https://github.com/dfinlab/sumer-js/blob/e3c14e5/src/vToken.ts#L158">vToken.ts:158</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Redeems the user&#39;s Binance Smart Chain asset from the Sumer Protocol.</p>
-								</div>
-								<dl class="tsd-comment-tags">
-									<dt>example</dt>
-									<dd><pre><code><span class="hljs-keyword">const</span> sumer = <span class="hljs-keyword">new</span> Sumer(<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-built_in">console</span>.log(<span class="hljs-string">&#x27;Redeeming SXP...&#x27;</span>);
-  <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> sumer.redeem(Sumer.SXP, <span class="hljs-number">1</span>); <span class="hljs-comment">// also accepts sdrToken args</span>
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Ethers.js transaction object&#x27;</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>asset: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>A string of the asset to redeem, or its sdrToken name.</p>
-									</div>
-								</li>
-								<li>
-									<h5>amount: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumber</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>A string, number, or BigNumber
-											object of the amount of an asset to redeem. Use the <code>mantissa</code> boolean in
-											the <code>options</code> parameter to indicate if this value is scaled up (so there
-											are no decimals) or in its natural scale. This can be an amount of
-										sdrTokens or underlying asset (use the <code>asset</code> parameter to specify).</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">&lt;</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns an Ethers.js transaction object of the redeem
-							transaction.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="repayborrow" class="tsd-anchor"></a>
-					<h3>repay<wbr>Borrow</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">repay<wbr>Borrow<span class="tsd-signature-symbol">(</span>asset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumber</span>, borrower<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, noApprove<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">&lt;</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">&gt;</span></li>
-					</ul>
-					<ul class="tsd-descriptions">
-						<li class="tsd-description">
-							<aside class="tsd-sources">
-								<ul>
-									<li>Defined in <a href="https://github.com/dfinlab/sumer-js/blob/e3c14e5/src/vToken.ts#L321">vToken.ts:321</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Repays a borrowed Binance Smart Chain asset for the user or on behalf of
-									another Binance Smart Chain address.</p>
-								</div>
-								<dl class="tsd-comment-tags">
-									<dt>example</dt>
-									<dd><pre><code><span class="hljs-keyword">const</span> sumer = <span class="hljs-keyword">new</span> Sumer(<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-built_in">console</span>.log(<span class="hljs-string">&#x27;Repaying SXP borrow...&#x27;</span>);
-  <span class="hljs-keyword">const</span> address = <span class="hljs-literal">null</span>; <span class="hljs-comment">// set this to any address to repayBorrowBehalf</span>
-  <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> sumer.repayBorrow(Sumer.SXP, <span class="hljs-number">32</span>, address);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Ethers.js transaction object&#x27;</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>asset: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>A string of the asset that was borrowed (must be a
-										supported underlying asset).</p>
-									</div>
-								</li>
-								<li>
-									<h5>amount: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumber</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>A string, number, or BigNumber
-											object of the amount of an asset to borrow. Use the <code>mantissa</code> boolean in
-											the <code>options</code> parameter to indicate if this value is scaled up (so there
-										are no decimals) or in its natural scale.</p>
-									</div>
-								</li>
-								<li>
-									<h5>borrower: <span class="tsd-signature-type">string</span></h5>
-								</li>
-								<li>
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> noApprove: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>Explicitly prevent this method from attempting an
-											ERC-20 <code>approve</code> transaction prior to sending the subsequent repayment
-										transaction.</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">&lt;</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns an Ethers.js transaction object of the repayBorrow
-							or repayBorrowBehalf transaction.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="supply" class="tsd-anchor"></a>
-					<h3>supply</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">supply<span class="tsd-signature-symbol">(</span>asset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumber</span>, noApprove<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">&lt;</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">&gt;</span></li>
-					</ul>
-					<ul class="tsd-descriptions">
-						<li class="tsd-description">
-							<aside class="tsd-sources">
-								<ul>
-									<li>Defined in <a href="https://github.com/dfinlab/sumer-js/blob/e3c14e5/src/vToken.ts#L50">vToken.ts:50</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Supplies the user&#39;s Heco Smart Chain asset to the Sumer Protocol.</p>
-								</div>
-								<dl class="tsd-comment-tags">
-									<dt>example</dt>
-									<dd><pre><code><span class="hljs-keyword">const</span> sumer = <span class="hljs-keyword">new</span> Sumer(<span class="hljs-built_in">window</span>.ethereum);
-<span class="hljs-comment">// Ethers.js overrides are an optional 3rd parameter for `supply`</span>
-<span class="hljs-comment">// const trxOptions = { gasLimit: 250000, mantissa: false };</span>
-(<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-built_in">console</span>.log(<span class="hljs-string">&#x27;Supplying SXP to the Sumer Protocol...&#x27;</span>);
-  <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> sumer.supply(Sumer.SXP, <span class="hljs-number">1</span>);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Ethers.js transaction object&#x27;</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>asset: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>A string of the asset to supply.</p>
-									</div>
-								</li>
-								<li>
-									<h5>amount: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BigNumber</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>A string, number, or BigNumber
-											object of the amount of an asset to supply. Use the <code>mantissa</code> boolean in
-											the <code>options</code> parameter to indicate if this value is scaled up (so there
-										are no decimals) or in its natural scale.</p>
-									</div>
-								</li>
-								<li>
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> noApprove: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>Explicitly prevent this method from attempting an
-										HRC-20 <code>approve</code> transaction prior to sending the <code>mint</code> transaction.</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">&lt;</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns an Ethers.js transaction object of the supply
-							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">&quot;api&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="_comp_.html">&quot;comp&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="_comptroller_.html">&quot;comptroller&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="_eth_.html">&quot;eth&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="_gov_.html">&quot;gov&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="_index_.html">&quot;index&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="_pricefeed_.html">&quot;price<wbr>Feed&quot;</a>
-					</li>
-					<li class=" tsd-kind-module">
-						<a href="_util_.html">&quot;util&quot;</a>
-					</li>
-					<li class="current tsd-kind-module">
-						<a href="_vtoken_.html">&quot;v<wbr>Token&quot;</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="_vtoken_.html#borrow" class="tsd-kind-icon">borrow</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_vtoken_.html#redeem" class="tsd-kind-icon">redeem</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_vtoken_.html#repayborrow" class="tsd-kind-icon">repay<wbr>Borrow</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_vtoken_.html#supply" class="tsd-kind-icon">supply</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>

package/examples/README.md DELETED Viewed

@@ -1,18 +0,0 @@
-# Code Examples
-Be sure to **build the SDK** from the root directory before running the Node.js examples: `npm run build`.
-- [Node.js](https://github.com/meterio/sumer-js/tree/master/examples/nodejs) Source code files.
-- [Web Browser](https://github.com/meterio/sumer-js/examples/web/) Easiest to surf in the GitHub Pages webpage.
-## Use Ganache
-Run [ganache-cli](https://www.npmjs.com/package/ganache-cli) or [Ganache](https://www.trufflesuite.com/ganache) in another command line window before running the `eth_sendTransaction` type examples. Be sure to fork mainnet.
-```
-npm install -g ganache-cli
-ganache-cli \
-  -f https://cloudflare-eth.com/ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
-```

package/examples/nodejs/balanceOf.js DELETED Viewed

@@ -1,23 +0,0 @@
-// Example of calling JSON RPC's eth_call with Sumer.js
-const Sumer = require('../../dist/nodejs/index.js');
-const config = require('./config');
-const token = Sumer.sdrHETH;
-const tokenAddress = Sumer.util.getAddress(token, 'HECO-testnet');
-const myAddress = '0xF30320537817d49Ddb4f3f6878296E046dE0a6FE';
-(async function() {
-  console.log(`${token} Address: `, tokenAddress)
-  const srpb = await Sumer.eth.read(
-    tokenAddress,
-    'function balanceOf(address) returns (uint256)',
-    [myAddress],// [], // [optional] parameters
-    {
-      provider: config.url,
-    }// {}  // [optional] call options, provider, network, plus ethers "overrides"
-  );
-  console.log(`${token} balance:`, srpb.toString());
-})().catch(console.error);

package/examples/nodejs/borrow.js DELETED Viewed

@@ -1,52 +0,0 @@
-/**
- * Example of supplying HT to the Sumer protocol with Sumer.js
- *
- * Run ganache-cli in another command line window before running this script. Be
- *     sure to fork mainnet.
-ganache-cli \
-  -f https://mainnet.infura.io/v3/_YOUR_INFURA_ID_ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
- */
-const Sumer = require('../../dist/nodejs/index.js');
-const myAddress = '0xa0df350d2637096571F7A701CBc1C5fdE30dF76A';
-const privateKey = '0xb8c1b5c1d81f9475fdf2e334517d29f733bdfa40682207571b12fc1142cbf329';
-const provider = 'http://localhost:8545';
-const sumer = new Sumer(provider, { privateKey });
-const getDaiBalance = (address) => {
-  const daiAddress = Sumer.util.getAddress(Sumer.DAI);
-  return Sumer.eth.read(
-    daiAddress,
-    'function balanceOf(address) returns (uint256)',
-    [ address ],
-    { provider }
-  );
-};
-(async function() {
-  let myDaiBalance = await getDaiBalance(myAddress);
-  console.log(`My Dai Balance: ${ (myDaiBalance / 1e18).toString() }`);
-  console.log('Supplying 10 HT...');
-  const trx1 = await sumer.supply(Sumer.HT, 10);
-  console.log('Entering HT market (use as collateral)...');
-  const trx2 = await sumer.enterMarkets(Sumer.HT); // also accepts []
-  console.log('Borrowing Dai against HT...');
-  const trx3 = await sumer.borrow(Sumer.DAI, 32, { gasLimit: 500000 });
-  myDaiBalance = await getDaiBalance(myAddress);
-  console.log(`My Dai Balance: ${ (myDaiBalance / 1e18).toString() }`);
-  // Exit a market (string argument of only 1 market at a time)
-  // const trx = await sumer.exitMarket(Sumer.HT);
-})().catch(console.error);

package/examples/nodejs/config.js DELETED Viewed

@@ -1,3 +0,0 @@
-module.exports = {
-    url : 'https://http-testnet.hecochain.com'
-}

package/examples/nodejs/eth_call.js DELETED Viewed

@@ -1,21 +0,0 @@
-// Example of calling JSON RPC's eth_call with Sumer.js
-const Sumer = require('../../dist/nodejs/index.js');
-const config = require('./config');
-const token = Sumer.sdrHETH;
-const tokenAddress = Sumer.util.getAddress(token, 'HECO-testnet');
-(async function() {
-  console.log(`${token} Address: `, tokenAddress)
-  const srpb = await Sumer.eth.read(
-    tokenAddress,
-    'function supplyRatePerBlock() returns (uint256)',
-    [],// [], // [optional] parameters
-    {
-      provider: config.url,
-    }// {}  // [optional] call options, provider, network, plus ethers "overrides"
-  );
-  console.log(`${token} market supply rate per block:`, srpb.toString());
-})().catch(console.error);

package/examples/nodejs/eth_sendTransaction.js DELETED Viewed

@@ -1,42 +0,0 @@
-/**
- * Example of calling JSON RPC's eth_sendTransaction with Sumer.js
- *
- * Run ganache-cli in another command line window before running this script. Be
- *     sure to fork mainnet.
-ganache-cli \
-  -f https://mainnet.infura.io/v3/_YOUR_INFURA_ID_ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
- */
-const Sumer = require('../../dist/nodejs/index.js');
-const oneEthInWei = '1000000000000000000';
-const vSxpAddress = Sumer.util.getAddress(Sumer.vSXP);
-const provider = 'http://localhost:8545';
-const privateKey = '0xb8c1b5c1d81f9475fdf2e334517d29f733bdfa40682207571b12fc1142cbf329';
-// const mnemonic = 'clutch captain shoe salt awake harvest setup primary inmate ugly among become';
-(async function() {
-  console.log('Supplying HT to the Sumer Protocol...');
-  // Mint some vSXP by supplying SXP to the Sumer Protocol
-  const trx = await Sumer.eth.trx(
-    vSxpAddress,
-    'function mint() payable',
-    [],
-    {
-      provider,
-      gasLimit: 250000,
-      value: oneEthInWei,
-      privateKey,
-      // mnemonic,
-    }
-  );
-  // const result = await trx.wait(1); // JSON object of trx info, once mined
-  console.log('Ethers.js transaction object', trx);
-})().catch(console.error);

package/examples/nodejs/getAddress.js DELETED Viewed

@@ -1,8 +0,0 @@
-// Example of fetching a Sumer protocol contract address with Sumer.js
-const Sumer = require('../../dist/nodejs/index.js');
-const htAddress = Sumer.util.getAddress(Sumer.HT, 'HECO-Testnet')
-const sdrHTAddress = Sumer.util.getAddress(Sumer.sdrHT, 'HECO-Testnet');
-console.log('HT (mainnet)', htAddress);
-console.log('sdrETH (mainnet)', sdrHTAddress);

package/examples/nodejs/getPrice.js DELETED Viewed

@@ -1,21 +0,0 @@
-// Example of fetching prices from the Sumer protocol's open price feed using
-// Sumer.js
-const Sumer = require('../../dist/nodejs/index.js');
-const sumer = new Sumer();
-let price;
-(async function() {
-  price = await sumer.getPrice(Sumer.SXP);
-  console.log('SXP in USDC', price);
-  price = await sumer.getPrice(Sumer.vSXP);
-  console.log('vSXP in USDC', price);
-  price = await sumer.getPrice(Sumer.SXP, Sumer.vUSDC);
-  console.log('SXP in vUSDC', price);
-  price = await sumer.getPrice(Sumer.SXP, Sumer.BNB);
-  console.log('SXP in BNB', price);
-})().catch(console.error);