fortress-js

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"comp" | Fortress.js - v1.0.0</title> <meta name="description" content="Documentation for Fortress.js - v1.0.0"> <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">Fortress.js - v1.0.0</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">"comp"</a> </li> </ul> <h1>Module "comp"</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#claimfortress" class="tsd-kind-icon">claim<wbr>Fortress</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#faicontroller" class="tsd-kind-icon">fai<wbr>Controller</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#faimintrate" class="tsd-kind-icon">fai<wbr>Mint<wbr>Rate</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#getfaimintrate" class="tsd-kind-icon">getFAIMint<wbr>Rate</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#getfortressaccrued" class="tsd-kind-icon">get<wbr>Fortress<wbr>Accrued</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#getfortressbalance" class="tsd-kind-icon">get<wbr>Fortress<wbr>Balance</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#getmintablefai" class="tsd-kind-icon">get<wbr>MintableFAI</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#mintfai" class="tsd-kind-icon">mintFAI</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#mintfaiguardianpaused" class="tsd-kind-icon">mintFAIGuardian<wbr>Paused</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#mintedfaiof" class="tsd-kind-icon">mintedFAIOf</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#mintedfais" class="tsd-kind-icon">mintedFAIs</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#repayfai" class="tsd-kind-icon">repayFAI</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_comp_.html#repayfaiguardianpaused" class="tsd-kind-icon">repayFAIGuardian<wbr>Paused</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="claimfortress" class="tsd-anchor"></a> <h3>claim<wbr>Fortress</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">claim<wbr>Fortress<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"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/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 FORTRESS tokens for the user.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> fortress = <span class="hljs-keyword">new</span> Fortress(<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">'Claiming Fortress...'</span>); <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> fortress.claimFortress(); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Ethers.js transaction object'</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><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"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">Signature</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/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 Fortress 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> fortress = <span class="hljs-keyword">new</span> Fortress(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> () => { <span class="hljs-keyword">const</span> delegateSignature = <span class="hljs-keyword">await</span> fortress.createDelegateSignature(<span class="hljs-string">'0xa0df350d2637096571F7A701CBc1C5fdE30dF76A'</span>); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'delegateSignature'</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'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"><</span><span class="tsd-signature-type">Signature</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/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 Fortress 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> fortress = <span class="hljs-keyword">new</span> Fortress(<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> fortress.delegate(<span class="hljs-string">'0xa0df350d2637096571F7A701CBc1C5fdE30dF76A'</span>); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Ethers.js transaction object'</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"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/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 Fortress 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> fortress = <span class="hljs-keyword">new</span> Fortress(<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> fortress.delegateBySig( <span class="hljs-string">'0xa0df350d2637096571F7A701CBc1C5fdE30dF76A'</span>, <span class="hljs-number">42</span>, <span class="hljs-number">9999999999</span>, { <span class="hljs-attr">v</span>: <span class="hljs-string">'0x1b'</span>, <span class="hljs-attr">r</span>: <span class="hljs-string">'0x130dbca2fafa07424c033b4479687cc1deeb65f08809e3ab397988cc4c6f2e78'</span>, <span class="hljs-attr">s</span>: <span class="hljs-string">'0x1debeb8250262f23906b1177161f0c7c9aa3641e8bff5b6f5c88a6bb78d5d8cd'</span> } ); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Ethers.js transaction object'</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 to delegate the user'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 FORTRESS contract'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: '', r: '', s: '' }</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"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></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="faicontroller" class="tsd-anchor"></a> <h3>fai<wbr>Controller</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">fai<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/src/comp.ts#L726">comp.ts:726</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the faiController.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> fortress = <span class="hljs-keyword">new</span> Fortress(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> () => { <span class="hljs-keyword">const</span> faiControllerAddress = <span class="hljs-keyword">await</span> fortress.faiController(); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'faiControllerAddress'</span>, faiControllerAddress); })().<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a string of the faiController address.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="faimintrate" class="tsd-anchor"></a> <h3>fai<wbr>Mint<wbr>Rate</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">fai<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/src/comp.ts#L763">comp.ts:763</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the faiMintRate.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> fortress = <span class="hljs-keyword">new</span> Fortress(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> () => { <span class="hljs-keyword">const</span> faiMintRate = <span class="hljs-keyword">await</span> fortress.faiMintRate(); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'faiMintRate'</span>, faiMintRate); })().<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a string of the numeric faiMintRate.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="getfaimintrate" class="tsd-anchor"></a> <h3>getFAIMint<wbr>Rate</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">getFAIMint<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/src/comp.ts#L509">comp.ts:509</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the FAI mint rate.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> fortress = <span class="hljs-keyword">new</span> Fortress(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> () => { <span class="hljs-keyword">const</span> rate = <span class="hljs-keyword">await</span> fortress.getFAIMintRate(); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'FAI mint rate'</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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a string of the numeric FAI mint rate.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="getfortressaccrued" class="tsd-anchor"></a> <h3>get<wbr>Fortress<wbr>Accrued</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>Fortress<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/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 FORTRESS 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> Fortress.fortress.getFortressAccrued(<span class="hljs-string">'0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5'</span>); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Accrued'</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 FORTRESS 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"> = "mainnet"</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a string of the numeric accruement of FORTRESS. 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="getfortressbalance" class="tsd-anchor"></a> <h3>get<wbr>Fortress<wbr>Balance</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>Fortress<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/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 FORTRESS 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> Fortress.fortress.getFortressBalance(<span class="hljs-string">'0x2775b1c75658Be0F640272CCb8c72ac986009e38'</span>); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Balance'</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 FORTRESS 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"> = "mainnet"</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a string of the numeric balance of FORTRESS. 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="getmintablefai" class="tsd-anchor"></a> <h3>get<wbr>MintableFAI</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">get<wbr>MintableFAI<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/src/comp.ts#L454">comp.ts:454</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the mintable FAI amount of address.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> fortress = <span class="hljs-keyword">new</span> Fortress(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> () => { <span class="hljs-keyword">const</span> amount = <span class="hljs-keyword">await</span> fortress.getMintableFAI(<span class="hljs-string">'0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5'</span>); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'MintableFAI amount'</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 FAI 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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a string of the numeric amount of mintable FAI. 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="mintfai" class="tsd-anchor"></a> <h3>mintFAI</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">mintFAI<span class="tsd-signature-symbol">(</span>mintFAIAmount<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"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/src/comp.ts#L806">comp.ts:806</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Mint FAI in the Fortress Protocol.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> fortress = <span class="hljs-keyword">new</span> Fortress(<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">'Minting FAI in the Fortress Protocol...'</span>); <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> fortress.mintFAI(<span class="hljs-number">1</span>); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Ethers.js transaction object'</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>mintFAIAmount: <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 mintFAI. 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"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></h4> <p>Returns an Ethers.js transaction object of the mintFAI transaction.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="mintfaiguardianpaused" class="tsd-anchor"></a> <h3>mintFAIGuardian<wbr>Paused</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">mintFAIGuardian<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/src/comp.ts#L546">comp.ts:546</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the mintFAIGuardianPaused.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> fortress = <span class="hljs-keyword">new</span> Fortress(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> () => { <span class="hljs-keyword">const</span> _mintFAIGuardianPaused = <span class="hljs-keyword">await</span> fortress.mintFAIGuardianPaused(); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'mintFAIGuardianPaused'</span>, _mintFAIGuardianPaused); })().<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a string of the boolean mintFAIGuardianPaused.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="mintedfaiof" class="tsd-anchor"></a> <h3>mintedFAIOf</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">mintedFAIOf<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/src/comp.ts#L622">comp.ts:622</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the minted FAI amount of the address.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> fortress = <span class="hljs-keyword">new</span> Fortress(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> () => { <span class="hljs-keyword">const</span> amount = <span class="hljs-keyword">await</span> fortress.mintedFAIOf(<span class="hljs-string">'0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5'</span>); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Minted FAI amount'</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 FAI 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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a string of the numeric amount of minted FAI. 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="mintedfais" class="tsd-anchor"></a> <h3>mintedFAIs</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">mintedFAIs<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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/src/comp.ts#L675">comp.ts:675</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get the minted FAI amount of the address.</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><pre><code><span class="hljs-keyword">const</span> fortress = <span class="hljs-keyword">new</span> Fortress(<span class="hljs-built_in">window</span>.ethereum); (<span class="hljs-keyword">async</span> () => { <span class="hljs-keyword">const</span> amount = <span class="hljs-keyword">await</span> fortress.mintedFAIs(<span class="hljs-string">'0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5'</span>); <span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Minted FAI amount'</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 FAI 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"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> <p>Returns a string of the numeric amount of minted FAI. 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="repayfai" class="tsd-anchor"></a> <h3>repayFAI</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">repayFAI<span class="tsd-signature-symbol">(</span>repayFAIAmount<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"><</span><span class="tsd-signature-type">TrxResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/Smart-Cookie-Group/fortress.js/blob/96b4c93/src/comp.ts#L874">comp.ts:874</a></li> </ul> </aside> <div class="tsd-comment tsd-typography">