Skip to content

Commit

Permalink
updated repo docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ajb413
ajb413 committed Sep 16, 2020
1 parent 0b4de92 commit c0f4339
Show file tree
Hide file tree
Showing 9 changed files with 57 additions and 58 deletions.
8 changes: 4 additions & 4 deletions docs/modules/_api_.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3>account</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/api.ts#L64">api.ts:64</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/api.ts#L64">api.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -149,7 +149,7 @@ <h3>c<wbr>Token</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/api.ts#L89">api.ts:89</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/api.ts#L89">api.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -194,7 +194,7 @@ <h3>governance</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/api.ts#L145">api.ts:145</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/api.ts#L145">api.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -247,7 +247,7 @@ <h3>market<wbr>History</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/api.ts#L117">api.ts:117</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/api.ts#L117">api.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
26 changes: 12 additions & 14 deletions docs/modules/_comp_.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h3>claim<wbr>Comp</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L156">comp.ts:156</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/comp.ts#L159">comp.ts:159</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -138,7 +138,7 @@ <h3>create<wbr>Delegate<wbr>Signature</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L336">comp.ts:336</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/comp.ts#L338">comp.ts:338</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -164,6 +164,10 @@ <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>
Expand All @@ -185,7 +189,7 @@ <h3>delegate</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L196">comp.ts:196</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/comp.ts#L199">comp.ts:199</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -209,7 +213,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<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 COMP accrued.</p>
<p>The address in which to delegate voting rights to.</p>
</div>
</li>
<li>
Expand All @@ -232,7 +236,7 @@ <h3>delegate<wbr>BySig</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L259">comp.ts:259</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/comp.ts#L262">comp.ts:262</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -308,7 +312,7 @@ <h3>get<wbr>Comp<wbr>Accrued</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L107">comp.ts:107</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/comp.ts#L107">comp.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -334,9 +338,6 @@ <h5>_address: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _provider: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;mainnet&quot;</span></h5>
<div class="tsd-comment tsd-typography">
<p>A valid Ethereum provider string.</p>
</div>
</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -355,7 +356,7 @@ <h3>get<wbr>Comp<wbr>Balance</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L62">comp.ts:62</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/comp.ts#L62">comp.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -381,9 +382,6 @@ <h5>_address: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> _provider: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;mainnet&quot;</span></h5>
<div class="tsd-comment tsd-typography">
<p>A valid Ethereum provider string.</p>
</div>
</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -402,7 +400,7 @@ <h3>to<wbr>Checksum<wbr>Address</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L22">comp.ts:22</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/comp.ts#L22">comp.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
14 changes: 10 additions & 4 deletions docs/modules/_comptroller_.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,13 @@ <h2>Functions</h2>
<a name="entermarkets" class="tsd-anchor"></a>
<h3>enter<wbr>Markets</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">enter<wbr>Markets<span class="tsd-signature-symbol">(</span>markets<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</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">any</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">enter<wbr>Markets<span class="tsd-signature-symbol">(</span>markets<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</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/compound-finance/compound-js/blob/ecc1c42/src/comptroller.ts#L32">comptroller.ts:32</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/comptroller.ts#L35">comptroller.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -117,6 +117,9 @@ <h5><span class="tsd-flag ts-flagDefault value">Default value</span> markets: <s
those supplied assets as collateral.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <span class="tsd-signature-type">any</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Returns an Ethers.js transaction object of the enterMarkets
Expand All @@ -128,13 +131,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a name="exitmarket" class="tsd-anchor"></a>
<h3>exit<wbr>Market</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">exit<wbr>Market<span class="tsd-signature-symbol">(</span>market<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><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">any</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">exit<wbr>Market<span class="tsd-signature-symbol">(</span>market<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</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">any</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/compound-finance/compound-js/blob/ecc1c42/src/comptroller.ts#L86">comptroller.ts:86</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/comptroller.ts#L91">comptroller.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -160,6 +163,9 @@ <h5>market: <span class="tsd-signature-type">string</span></h5>
<p>A string of the symbol of the market to exit.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <span class="tsd-signature-type">any</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Returns an Ethers.js transaction object of the exitMarket
Expand Down
31 changes: 11 additions & 20 deletions docs/modules/_ctoken_.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3>borrow</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/cToken.ts#L202">cToken.ts:202</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/cToken.ts#L224">cToken.ts:224</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -139,10 +139,6 @@ <h5>amount: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography">
<p>Call options and Ethers.js overrides for the
transaction.</p>
</div>
</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -161,7 +157,7 @@ <h3>redeem</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/cToken.ts#L122">cToken.ts:122</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/cToken.ts#L144">cToken.ts:144</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -202,10 +198,6 @@ <h5>amount: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography">
<p>Call options and Ethers.js overrides for the
transaction.</p>
</div>
</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -224,7 +216,7 @@ <h3>repay<wbr>Borrow</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/cToken.ts#L270">cToken.ts:270</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/cToken.ts#L292">cToken.ts:292</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -271,10 +263,6 @@ <h5>borrower: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography">
<p>Call options and Ethers.js overrides for the
transaction.</p>
</div>
</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -287,13 +275,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<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">any</span>, options<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
<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">any</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">any</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">any</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/compound-finance/compound-js/blob/ecc1c42/src/cToken.ts#L43">cToken.ts:43</a></li>
<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/cToken.ts#L46">cToken.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -335,12 +323,15 @@ <h5>amount: <span class="tsd-signature-type">any</span></h5>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></h5>
<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>Call options and Ethers.js overrides for the
transaction.</p>
<p>Explicitly prevent this method from attempting an
ERC-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">any</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">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Returns an Ethers.js transaction object of the supply
Expand Down
Loading

0 comments on commit c0f4339

Please sign in to comment.