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

@meterio/sumer-js 0.0.12 → 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/_comp_.html DELETED Viewed

@@ -1,1016 +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;comp&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="_comp_.html">&quot;comp&quot;</a>
-				</li>
-			</ul>
-			<h1>Module &quot;comp&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="_comp_.html#claimsumer" class="tsd-kind-icon">claim<wbr>Sumer</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#createdelegatesignature" class="tsd-kind-icon">create<wbr>Delegate<wbr>Signature</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#delegate" class="tsd-kind-icon">delegate</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#delegatebysig" class="tsd-kind-icon">delegate<wbr>BySig</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#getmintablesuusd" class="tsd-kind-icon">get<wbr>MintablesuUSD</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#getsumeraccrued" class="tsd-kind-icon">get<wbr>Sumer<wbr>Accrued</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#getsumerbalance" class="tsd-kind-icon">get<wbr>Sumer<wbr>Balance</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#getsuusdmintrate" class="tsd-kind-icon">getsuUSDMint<wbr>Rate</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#mintedsuusdof" class="tsd-kind-icon">mintedsuUSDOf</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#mintedsuusds" class="tsd-kind-icon">mintedsuUSDs</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#mintsuusd" class="tsd-kind-icon">mintsuUSD</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#mintsuusdguardianpaused" class="tsd-kind-icon">mintsuUSDGuardian<wbr>Paused</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#repaysuusd" class="tsd-kind-icon">repaysuUSD</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#repaysuusdguardianpaused" class="tsd-kind-icon">repaysuUSDGuardian<wbr>Paused</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#suusdcontroller" class="tsd-kind-icon">suusd<wbr>Controller</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#suusdmintrate" class="tsd-kind-icon">suusd<wbr>Mint<wbr>Rate</a></li>
-								<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_comp_.html#tochecksumaddress" class="tsd-kind-icon">to<wbr>Checksum<wbr>Address</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="claimsumer" class="tsd-anchor"></a>
-					<h3>claim<wbr>Sumer</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">claim<wbr>Sumer<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">&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/comp.ts#L177">comp.ts:177</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Create a transaction to claim accrued SUMER tokens for the user.</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-built_in">console</span>.log(<span class="hljs-string">&#x27;Claiming Sumer...&#x27;</span>);
-  <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> sumer.claimSumer();
-  <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><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 vote
-							transaction.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="createdelegatesignature" class="tsd-anchor"></a>
-					<h3>create<wbr>Delegate<wbr>Signature</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">create<wbr>Delegate<wbr>Signature<span class="tsd-signature-symbol">(</span>delegatee<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, expiry<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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">Signature</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/comp.ts#L375">comp.ts:375</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Create a delegate signature for Sumer Governance using EIP-712. The
-										signature can be created without burning gas. Anyone can post it to the
-									blockchain using the <code>delegateBySig</code> method, which does have gas costs.</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> () =&gt; {
-  <span class="hljs-keyword">const</span> delegateSignature = <span class="hljs-keyword">await</span> sumer.createDelegateSignature(<span class="hljs-string">&#x27;0xa0df350d2637096571F7A701CBc1C5fdE30dF76A&#x27;</span>);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;delegateSignature&#x27;</span>, delegateSignature);
-})().<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>delegatee: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The address to delegate the user&#39;s voting rights
-										to.</p>
-									</div>
-								</li>
-								<li>
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> expiry: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10000000000</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">Signature</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns an object that contains the <code>v</code>, <code>r</code>, and <code>s</code>
-							components of an Ethereum signature as hexadecimal strings.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="delegate" class="tsd-anchor"></a>
-					<h3>delegate</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">delegate<span class="tsd-signature-symbol">(</span>_address<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">&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/comp.ts#L229">comp.ts:229</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Create a transaction to delegate Sumer Governance voting rights to an
-									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-keyword">const</span> delegateTx = <span class="hljs-keyword">await</span> sumer.delegate(<span class="hljs-string">&#x27;0xa0df350d2637096571F7A701CBc1C5fdE30dF76A&#x27;</span>);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Ethers.js transaction object&#x27;</span>, delegateTx);
-})().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>_address: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The address in which to delegate voting rights to.</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 vote
-							transaction.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="delegatebysig" class="tsd-anchor"></a>
-					<h3>delegate<wbr>BySig</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">delegate<wbr>BySig<span class="tsd-signature-symbol">(</span>_address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, nonce<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, expiry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, signature<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Signature</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/comp.ts#L297">comp.ts:297</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Delegate voting rights in Sumer Governance using an EIP-712 signature.</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> delegateTx = <span class="hljs-keyword">await</span> sumer.delegateBySig(
-    <span class="hljs-string">&#x27;0xa0df350d2637096571F7A701CBc1C5fdE30dF76A&#x27;</span>,
-    <span class="hljs-number">42</span>,
-    <span class="hljs-number">9999999999</span>,
-    {
-      v: <span class="hljs-string">&#x27;0x1b&#x27;</span>,
-      r: <span class="hljs-string">&#x27;0x130dbca2fafa07424c033b4479687cc1deeb65f08809e3ab397988cc4c6f2e78&#x27;</span>,
-      s: <span class="hljs-string">&#x27;0x1debeb8250262f23906b1177161f0c7c9aa3641e8bff5b6f5c88a6bb78d5d8cd&#x27;</span>
-    }
-  );
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Ethers.js transaction object&#x27;</span>, delegateTx);
-})().<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>_address: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The address to delegate the user&#39;s voting rights to.</p>
-									</div>
-								</li>
-								<li>
-									<h5>nonce: <span class="tsd-signature-type">number</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The contract state required to match the signature.
-										This can be retrieved from the SUMER contract&#39;s public nonces mapping.</p>
-									</div>
-								</li>
-								<li>
-									<h5>expiry: <span class="tsd-signature-type">number</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The time at which to expire the signature. A block
-										timestamp as seconds since the unix epoch.</p>
-									</div>
-								</li>
-								<li>
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> signature: <span class="tsd-signature-type">Signature</span><span class="tsd-signature-symbol"> = { v: &#x27;&#x27;, r: &#x27;&#x27;, s: &#x27;&#x27; }</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>An object that contains the v, r, and, s values of
-										an EIP-712 signature.</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 vote
-							transaction.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="getmintablesuusd" class="tsd-anchor"></a>
-					<h3>get<wbr>MintablesuUSD</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">get<wbr>MintablesuUSD<span class="tsd-signature-symbol">(</span>_address<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">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L454">comp.ts:454</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the mintable suUSD amount of 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> () =&gt; {
-  <span class="hljs-keyword">const</span> amount = <span class="hljs-keyword">await</span> sumer.getMintablesuUSD(<span class="hljs-string">&#x27;0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5&#x27;</span>);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;MintablesuUSD amount&#x27;</span>, amount);
-})().<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>_address: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The address in which to get mintable suUSD amount.</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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the numeric amount of mintable suUSD. The
-							value is scaled up by 18 decimal places.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="getsumeraccrued" class="tsd-anchor"></a>
-					<h3>get<wbr>Sumer<wbr>Accrued</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">get<wbr>Sumer<wbr>Accrued<span class="tsd-signature-symbol">(</span>_address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _provider<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Provider</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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L122">comp.ts:122</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the amount of SUMER tokens accrued but not yet claimed by an address.</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> acc = <span class="hljs-keyword">await</span> Sumer.sumer.getSumerAccrued(<span class="hljs-string">&#x27;0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5&#x27;</span>);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Accrued&#x27;</span>, acc);
-})().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>_address: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The address in which to find the SUMER accrued.</p>
-									</div>
-								</li>
-								<li>
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _provider: <span class="tsd-signature-type">Provider</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;mainnet&quot;</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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the numeric accruement of SUMER. The
-							value is scaled up by 18 decimal places.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="getsumerbalance" class="tsd-anchor"></a>
-					<h3>get<wbr>Sumer<wbr>Balance</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">get<wbr>Sumer<wbr>Balance<span class="tsd-signature-symbol">(</span>_address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _provider<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Provider</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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L73">comp.ts:73</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the balance of Sumer tokens held by an address.</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> bal = <span class="hljs-keyword">await</span> Sumer.sumer.getSumerBalance(<span class="hljs-string">&#x27;0x2775b1c75658Be0F640272CCb8c72ac986009e38&#x27;</span>);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Balance&#x27;</span>, bal);
-})().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>_address: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The address in which to find the SUMER balance.</p>
-									</div>
-								</li>
-								<li>
-									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _provider: <span class="tsd-signature-type">Provider</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;mainnet&quot;</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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the numeric balance of SUMER. The value
-							is scaled up by 18 decimal places.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="getsuusdmintrate" class="tsd-anchor"></a>
-					<h3>getsuUSDMint<wbr>Rate</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">getsuUSDMint<wbr>Rate<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">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L509">comp.ts:509</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the suUSD mint rate.</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> () =&gt; {
-  <span class="hljs-keyword">const</span> rate = <span class="hljs-keyword">await</span> sumer.getsuUSDMintRate();
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;suUSD mint rate&#x27;</span>, rate);
-})().<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><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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the numeric suUSD mint rate.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="mintedsuusdof" class="tsd-anchor"></a>
-					<h3>mintedsuUSDOf</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">mintedsuUSDOf<span class="tsd-signature-symbol">(</span>_address<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">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L622">comp.ts:622</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the minted suUSD amount of the 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> () =&gt; {
-  <span class="hljs-keyword">const</span> amount = <span class="hljs-keyword">await</span> sumer.mintedsuUSDOf(<span class="hljs-string">&#x27;0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5&#x27;</span>);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Minted suUSD amount&#x27;</span>, amount);
-})().<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>_address: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The address in which to get the minted suUSD amount.</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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the numeric amount of minted suUSD. The
-							value is scaled up by 18 decimal places.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="mintedsuusds" class="tsd-anchor"></a>
-					<h3>mintedsuUSDs</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">mintedsuUSDs<span class="tsd-signature-symbol">(</span>_address<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">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L675">comp.ts:675</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the minted suUSD amount of the 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> () =&gt; {
-  <span class="hljs-keyword">const</span> amount = <span class="hljs-keyword">await</span> sumer.mintedsuUSDs(<span class="hljs-string">&#x27;0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5&#x27;</span>);
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Minted suUSD amount&#x27;</span>, amount);
-})().<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>_address: <span class="tsd-signature-type">string</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The address in which to get the minted suUSD amount.</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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the numeric amount of minted suUSD. The
-							value is scaled up by 18 decimal places.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="mintsuusd" class="tsd-anchor"></a>
-					<h3>mintsuUSD</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">mintsuUSD<span class="tsd-signature-symbol">(</span>mintsuUSDAmount<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/comp.ts#L806">comp.ts:806</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Mint suUSD in 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">// 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;Minting suUSD in the Sumer Protocol...&#x27;</span>);
-  <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> sumer.mintsuUSD(<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>mintsuUSDAmount: <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 mintsuUSD. 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 mintsuUSD
-							transaction.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="mintsuusdguardianpaused" class="tsd-anchor"></a>
-					<h3>mintsuUSDGuardian<wbr>Paused</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">mintsuUSDGuardian<wbr>Paused<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">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L546">comp.ts:546</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the mintsuUSDGuardianPaused.</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> () =&gt; {
-  <span class="hljs-keyword">const</span> _mintsuUSDGuardianPaused = <span class="hljs-keyword">await</span> sumer.mintsuUSDGuardianPaused();
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;mintsuUSDGuardianPaused&#x27;</span>, _mintsuUSDGuardianPaused);
-})().<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><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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the boolean mintsuUSDGuardianPaused.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="repaysuusd" class="tsd-anchor"></a>
-					<h3>repaysuUSD</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">repaysuUSD<span class="tsd-signature-symbol">(</span>repaysuUSDAmount<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/comp.ts#L874">comp.ts:874</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Repay suUSD in 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">// 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;Repaying suUSD in the Sumer Protocol...&#x27;</span>);
-  <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> sumer.repaysuUSD(<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>repaysuUSDAmount: <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 repay. 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 repaysuUSD
-							transaction.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="repaysuusdguardianpaused" class="tsd-anchor"></a>
-					<h3>repaysuUSDGuardian<wbr>Paused</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">repaysuUSDGuardian<wbr>Paused<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">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L583">comp.ts:583</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the repaysuUSDGuardianPaused.</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> () =&gt; {
-  <span class="hljs-keyword">const</span> _repaysuUSDGuardianPaused = <span class="hljs-keyword">await</span> sumer.repaysuUSDGuardianPaused();
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;repaysuUSDGuardianPaused&#x27;</span>, _repaysuUSDGuardianPaused);
-})().<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><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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the boolean repaysuUSDGuardianPaused.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="suusdcontroller" class="tsd-anchor"></a>
-					<h3>suusd<wbr>Controller</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">suusd<wbr>Controller<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">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L726">comp.ts:726</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the suusdController.</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> () =&gt; {
-  <span class="hljs-keyword">const</span> suusdControllerAddress = <span class="hljs-keyword">await</span> sumer.suusdController();
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;suusdControllerAddress&#x27;</span>, suusdControllerAddress);
-})().<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><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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the suusdController address.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
-					<a name="suusdmintrate" class="tsd-anchor"></a>
-					<h3>suusd<wbr>Mint<wbr>Rate</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
-						<li class="tsd-signature tsd-kind-icon">suusd<wbr>Mint<wbr>Rate<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">&lt;</span><span class="tsd-signature-type">string</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/comp.ts#L763">comp.ts:763</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Get the suusdMintRate.</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> () =&gt; {
-  <span class="hljs-keyword">const</span> suusdMintRate = <span class="hljs-keyword">await</span> sumer.suusdMintRate();
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;suusdMintRate&#x27;</span>, suusdMintRate);
-})().<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><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">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
-							<p>Returns a string of the numeric suusdMintRate.</p>
-						</li>
-					</ul>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
-					<a name="tochecksumaddress" class="tsd-anchor"></a>
-					<h3>to<wbr>Checksum<wbr>Address</h3>
-					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
-						<li class="tsd-signature tsd-kind-icon">to<wbr>Checksum<wbr>Address<span class="tsd-signature-symbol">(</span>_address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/comp.ts#L32">comp.ts:32</a></li>
-								</ul>
-							</aside>
-							<div class="tsd-comment tsd-typography">
-								<div class="lead">
-									<p>Applies the EIP-55 checksum to an Ethereum address.</p>
-								</div>
-							</div>
-							<h4 class="tsd-parameters-title">Parameters</h4>
-							<ul class="tsd-parameters">
-								<li>
-									<h5>_address: <span class="tsd-signature-type">any</span></h5>
-									<div class="tsd-comment tsd-typography">
-										<p>The Ethereum address to apply the checksum.</p>
-									</div>
-								</li>
-							</ul>
-							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
-							<p>Returns a string of the Ethereum address.</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="current 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=" 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="_comp_.html#claimsumer" class="tsd-kind-icon">claim<wbr>Sumer</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#createdelegatesignature" class="tsd-kind-icon">create<wbr>Delegate<wbr>Signature</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#delegate" class="tsd-kind-icon">delegate</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#delegatebysig" class="tsd-kind-icon">delegate<wbr>BySig</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#getmintablesuusd" class="tsd-kind-icon">get<wbr>MintablesuUSD</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#getsumeraccrued" class="tsd-kind-icon">get<wbr>Sumer<wbr>Accrued</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#getsumerbalance" class="tsd-kind-icon">get<wbr>Sumer<wbr>Balance</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#getsuusdmintrate" class="tsd-kind-icon">getsuUSDMint<wbr>Rate</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#mintedsuusdof" class="tsd-kind-icon">mintedsuUSDOf</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#mintedsuusds" class="tsd-kind-icon">mintedsuUSDs</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#mintsuusd" class="tsd-kind-icon">mintsuUSD</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#mintsuusdguardianpaused" class="tsd-kind-icon">mintsuUSDGuardian<wbr>Paused</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#repaysuusd" class="tsd-kind-icon">repaysuUSD</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#repaysuusdguardianpaused" class="tsd-kind-icon">repaysuUSDGuardian<wbr>Paused</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#suusdcontroller" class="tsd-kind-icon">suusd<wbr>Controller</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module">
-						<a href="_comp_.html#suusdmintrate" class="tsd-kind-icon">suusd<wbr>Mint<wbr>Rate</a>
-					</li>
-					<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
-						<a href="_comp_.html#tochecksumaddress" class="tsd-kind-icon">to<wbr>Checksum<wbr>Address</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>