This repository has been archived by the owner on Jan 1, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathpath---classes-contracts-models-vault-vault-60c4fdac98395ab8b1f1.js
2 lines (2 loc) · 50.6 KB
/
path---classes-contracts-models-vault-vault-60c4fdac98395ab8b1f1.js
1
2
webpackJsonp([0x8e64227863c1],{456:function(e,t){e.exports={data:{postBySlug:{html:'<p><a href="/quick_start">@rigoblock/api</a> > <a href="/modules/_contracts_models_vault_">"contracts/models/vault"</a> > <a href="/classes/_contracts_models_vault_.vault">Vault</a></p>\n<h1 id="class-vault"><a href="#class-vault" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Class: Vault</h1>\n<h2 id="hierarchy"><a href="#hierarchy" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Hierarchy</h2>\n<p> <a href="_contracts_basecontract_.basecontract">BaseContract</a><<a href="/enums/_contracts_models_vault_.vaultevents">VaultEvents</a>></p>\n<p><strong>↳ Vault</strong></p>\n<h2 id="index"><a href="#index" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Index</h2>\n<h3 id="constructors"><a href="#constructors" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Constructors</h3>\n<ul>\n<li><a href="_contracts_models_vault_.vault#constructor">constructor</a></li>\n</ul>\n<h3 id="properties"><a href="#properties" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Properties</h3>\n<ul>\n<li><a href="_contracts_models_vault_.vault#rawweb3contract">rawWeb3Contract</a></li>\n<li><a href="_contracts_models_vault_.vault#address">address</a></li>\n</ul>\n<h3 id="methods"><a href="#methods" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Methods</h3>\n<ul>\n<li><a href="_contracts_models_vault_.vault#newownerevent">NewOwnerEvent</a></li>\n<li><a href="_contracts_models_vault_.vault#allevents">allEvents</a></li>\n<li><a href="_contracts_models_vault_.vault#balanceof">balanceOf</a></li>\n<li><a href="_contracts_models_vault_.vault#buyvault">buyVault</a></li>\n<li><a href="_contracts_models_vault_.vault#buyvaultonbehalf">buyVaultOnBehalf</a></li>\n<li><a href="_contracts_models_vault_.vault#calcshareprice">calcSharePrice</a></li>\n<li><a href="_contracts_models_vault_.vault#changefeecollector">changeFeeCollector</a></li>\n<li><a href="_contracts_models_vault_.vault#changeminperiod">changeMinPeriod</a></li>\n<li><a href="_contracts_models_vault_.vault#changeratio">changeRatio</a></li>\n<li><a href="_contracts_models_vault_.vault#changevaultdao">changeVaultDao</a></li>\n<li><a href="_contracts_models_vault_.vault#depositlock">depositLock</a></li>\n<li><a href="_contracts_models_vault_.vault#deposittoken">depositToken</a></li>\n<li><a href="_contracts_models_vault_.vault#deposittokenonbehalf">depositTokenOnBehalf</a></li>\n<li><a href="_contracts_models_vault_.vault#getadmindata">getAdminData</a></li>\n<li><a href="_contracts_models_vault_.vault#getdata">getData</a></li>\n<li><a href="_contracts_models_vault_.vault#geteventful">getEventful</a></li>\n<li><a href="_contracts_models_vault_.vault#getpastevents">getPastEvents</a></li>\n<li><a href="_contracts_models_vault_.vault#once">once</a></li>\n<li><a href="_contracts_models_vault_.vault#owner">owner</a></li>\n<li><a href="_contracts_models_vault_.vault#sellvault">sellVault</a></li>\n<li><a href="_contracts_models_vault_.vault#setowner">setOwner</a></li>\n<li><a href="_contracts_models_vault_.vault#settransactionfee">setTransactionFee</a></li>\n<li><a href="_contracts_models_vault_.vault#timetounlock">timeToUnlock</a></li>\n<li><a href="_contracts_models_vault_.vault#tokenbalanceof">tokenBalanceOf</a></li>\n<li><a href="_contracts_models_vault_.vault#tokenbalances">tokenBalances</a></li>\n<li><a href="_contracts_models_vault_.vault#tokensinvault">tokensInVault</a></li>\n<li><a href="_contracts_models_vault_.vault#totalsupply">totalSupply</a></li>\n<li><a href="_contracts_models_vault_.vault#updateprice">updatePrice</a></li>\n<li><a href="_contracts_models_vault_.vault#withdrawtoken">withdrawToken</a></li>\n<li><a href="_contracts_models_vault_.vault#createandvalidate">createAndValidate</a></li>\n<li><a href="_contracts_models_vault_.vault#isdeployed">isDeployed</a></li>\n</ul>\n<hr>\n<h2 id="constructors-1"><a href="#constructors-1" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Constructors</h2>\n<p><a id="constructor"></a></p>\n<h3 id="constructor"><a href="#constructor" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>constructor</h3>\n<p>⊕ <strong>new Vault</strong>(web3: <em><code class="language-text">any</code></em>, address: <em><code class="language-text">string</code></em>): <a href="_contracts_models_vault_.vault">Vault</a></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>web3</td>\n<td><code class="language-text">any</code></td>\n</tr>\n<tr>\n<td>address</td>\n<td><code class="language-text">string</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <a href="_contracts_models_vault_.vault">Vault</a> Number of shares Bool the function executed correctly Bool the function executed correctly Time in seconds Number of tokens _value in custody Bool the transaction was successful</p>\n<hr>\n<h2 id="properties-1"><a href="#properties-1" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Properties</h2>\n<p><a id="rawweb3contract"></a></p>\n<h3 id="rawweb3contract"><a href="#rawweb3contract" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>rawWeb3Contract</h3>\n<p><strong>● rawWeb3Contract</strong>: <em><code class="language-text">any</code></em></p>\n<hr>\n<p><a id="address"></a></p>\n<h3 id="code-classlanguage-textltstaticgtcode-address"><a href="#code-classlanguage-textltstaticgtcode-address" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code class="language-text"><Static></code> address</h3>\n<p><strong>● address</strong>: <em><code class="language-text">string</code></em></p>\n<hr>\n<h2 id="methods-1"><a href="#methods-1" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Methods</h2>\n<p><a id="newownerevent"></a></p>\n<h3 id="newownerevent"><a href="#newownerevent" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>NewOwnerEvent</h3>\n<p>▸ <strong>NewOwnerEvent</strong>(options?: <em><a href="/interfaces/_contracts_basecontract_.eventoptions">EventOptions</a></em>, cb?: <em><code class="language-text">Function</code></em>): <code class="language-text">any</code></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class="language-text">Optional</code>\n options</td>\n<td><a href="/interfaces/_contracts_basecontract_.eventoptions">EventOptions</a></td>\n</tr>\n<tr>\n<td><code class="language-text">Optional</code>\n cb</td>\n<td><code class="language-text">Function</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">any</code></p>\n<hr>\n<p><a id="allevents"></a></p>\n<h3 id="allevents"><a href="#allevents" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>allEvents</h3>\n<p>▸ <strong>allEvents</strong>(options?: <em><a href="/interfaces/_contracts_basecontract_.eventoptions">EventOptions</a></em>, cb?: <em><code class="language-text">Function</code></em>): <code class="language-text">Promise</code><<code class="language-text">EventEmitter</code>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class="language-text">Optional</code>\n options</td>\n<td><a href="/interfaces/_contracts_basecontract_.eventoptions">EventOptions</a></td>\n</tr>\n<tr>\n<td><code class="language-text">Optional</code>\n cb</td>\n<td><code class="language-text">Function</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">EventEmitter</code>></p>\n<hr>\n<p><a id="balanceof"></a></p>\n<h3 id="balanceof"><a href="#balanceof" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>balanceOf</h3>\n<p>Calculates how many shares a user holds</p>\n<p>▸ <strong>balanceOf</strong>(_from: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_from</td>\n<td><code class="language-text">string</code></td>\n<td>Address of the target account</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<hr>\n<p><a id="buyvault"></a></p>\n<h3 id="buyvault"><a href="#buyvault" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>buyVault</h3>\n<p>Allows a user to buy into a vault</p>\n<p>▸ <strong>buyVault</strong>(): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<hr>\n<p><a id="buyvaultonbehalf"></a></p>\n<h3 id="buyvaultonbehalf"><a href="#buyvaultonbehalf" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>buyVaultOnBehalf</h3>\n<p>Allows a user to buy into a vault on behalf of an address</p>\n<p>▸ <strong>buyVaultOnBehalf</strong>(_hodler: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_hodler</td>\n<td><code class="language-text">string</code></td>\n<td>Address of the target user</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<hr>\n<p><a id="calcshareprice"></a></p>\n<h3 id="calcshareprice"><a href="#calcshareprice" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>calcSharePrice</h3>\n<p>Returns the price of a pool</p>\n<p>▸ <strong>calcSharePrice</strong>(): <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<hr>\n<p><a id="changefeecollector"></a></p>\n<h3 id="changefeecollector"><a href="#changefeecollector" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>changeFeeCollector</h3>\n<p>Allows owner to decide where to receive the fee</p>\n<p>▸ <strong>changeFeeCollector</strong>(_feeCollector: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_feeCollector</td>\n<td><code class="language-text">string</code></td>\n<td>Address of the fee receiver</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<hr>\n<p><a id="changeminperiod"></a></p>\n<h3 id="changeminperiod"><a href="#changeminperiod" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>changeMinPeriod</h3>\n<p>Allows vault dao/factory to change the minimum holding period</p>\n<p>▸ <strong>changeMinPeriod</strong>(_minPeriod: <em><code class="language-text">number</code> | <code class="language-text">BigNumber</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_minPeriod</td>\n<td><code class="language-text">number</code></td>\n<td><code class="language-text">BigNumber</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<hr>\n<p><a id="changeratio"></a></p>\n<h3 id="changeratio"><a href="#changeratio" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>changeRatio</h3>\n<p>Allows vault dao/factory to change fee split ratio</p>\n<p>▸ <strong>changeRatio</strong>(_ratio: <em><code class="language-text">BigNumber</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_ratio</td>\n<td><code class="language-text">BigNumber</code></td>\n<td>Number of ratio for wizard, from 0 to 100</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<hr>\n<p><a id="changevaultdao"></a></p>\n<h3 id="changevaultdao"><a href="#changevaultdao" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>changeVaultDao</h3>\n<p>Allows vault dao/factory to upgrade its address</p>\n<p>▸ <strong>changeVaultDao</strong>(_vaultDao: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_vaultDao</td>\n<td><code class="language-text">string</code></td>\n<td>Address of the new vault dao</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<hr>\n<p><a id="depositlock"></a></p>\n<h3 id="depositlock"><a href="#depositlock" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>depositLock</h3>\n<p>▸ <strong>depositLock</strong>(index<em>0: <em><code class="language-text">string</code></em>, index</em>1: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>index_0</td>\n<td><code class="language-text">string</code></td>\n</tr>\n<tr>\n<td>index_1</td>\n<td><code class="language-text">string</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<hr>\n<p><a id="deposittoken"></a></p>\n<h3 id="deposittoken"><a href="#deposittoken" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>depositToken</h3>\n<p>Allows anyone to deposit tokens to a vault</p>\n<p>▸ <strong>depositToken</strong>(_token: <em><code class="language-text">string</code></em>, _value: <em><code class="language-text">BigNumber</code></em>, _forTime: <em><code class="language-text">number</code> | <code class="language-text">BigNumber</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_token</td>\n<td><code class="language-text">string</code></td>\n<td>Address of the token</td>\n</tr>\n<tr>\n<td>_value</td>\n<td><code class="language-text">BigNumber</code></td>\n<td>Amount to deposit</td>\n</tr>\n<tr>\n<td>_forTime</td>\n<td><code class="language-text">number</code></td>\n<td><code class="language-text">BigNumber</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<hr>\n<p><a id="deposittokenonbehalf"></a></p>\n<h3 id="deposittokenonbehalf"><a href="#deposittokenonbehalf" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>depositTokenOnBehalf</h3>\n<p>Allows anyone to deposit tokens to a vault on behalf of someone</p>\n<p>▸ <strong>depositTokenOnBehalf</strong>(_token: <em><code class="language-text">string</code></em>, _hodler: <em><code class="language-text">string</code></em>, _value: <em><code class="language-text">BigNumber</code></em>, _forTime: <em><code class="language-text">number</code> | <code class="language-text">BigNumber</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_token</td>\n<td><code class="language-text">string</code></td>\n<td></td>\n</tr>\n<tr>\n<td>_hodler</td>\n<td><code class="language-text">string</code></td>\n<td></td>\n</tr>\n<tr>\n<td>_value</td>\n<td><code class="language-text">BigNumber</code></td>\n<td></td>\n</tr>\n<tr>\n<td>_forTime</td>\n<td><code class="language-text">number</code></td>\n<td><code class="language-text">BigNumber</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<hr>\n<p><a id="getadmindata"></a></p>\n<h3 id="getadmindata"><a href="#getadmindata" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>getAdminData</h3>\n<p>Finds the administrative data of the pool</p>\n<p>▸ <strong>getAdminData</strong>(): <code class="language-text">Promise</code><[<code class="language-text">string</code>, <code class="language-text">string</code>, <code class="language-text">string</code>, <code class="language-text">BigNumber</code>, <code class="language-text">BigNumber</code>, <code class="language-text">BigNumber</code>]></p>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><[<code class="language-text">string</code>, <code class="language-text">string</code>, <code class="language-text">string</code>, <code class="language-text">BigNumber</code>, <code class="language-text">BigNumber</code>, <code class="language-text">BigNumber</code>]></p>\n<hr>\n<p><a id="getdata"></a></p>\n<h3 id="getdata"><a href="#getdata" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>getData</h3>\n<p>Finds details of a vault pool</p>\n<p>▸ <strong>getData</strong>(): <code class="language-text">Promise</code><[<code class="language-text">string</code>, <code class="language-text">string</code>, <code class="language-text">BigNumber</code>, <code class="language-text">BigNumber</code>]></p>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><[<code class="language-text">string</code>, <code class="language-text">string</code>, <code class="language-text">BigNumber</code>, <code class="language-text">BigNumber</code>]></p>\n<hr>\n<p><a id="geteventful"></a></p>\n<h3 id="geteventful"><a href="#geteventful" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>getEventful</h3>\n<p>Gets the address of the logger contract</p>\n<p>▸ <strong>getEventful</strong>(): <code class="language-text">Promise</code><<code class="language-text">string</code>></p>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">string</code>></p>\n<hr>\n<p><a id="getpastevents"></a></p>\n<h3 id="getpastevents"><a href="#getpastevents" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>getPastEvents</h3>\n<p>▸ <strong>getPastEvents</strong>(eventName: <em><a href="/enums/_contracts_models_vault_.vaultevents">VaultEvents</a></em>, options?: <em><a href="/interfaces/_contracts_basecontract_.eventoptions">EventOptions</a></em>): <code class="language-text">Promise</code><<code class="language-text">EventLog</code>[]></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>eventName</td>\n<td><a href="/enums/_contracts_models_vault_.vaultevents">VaultEvents</a></td>\n</tr>\n<tr>\n<td><code class="language-text">Optional</code>\n options</td>\n<td><a href="/interfaces/_contracts_basecontract_.eventoptions">EventOptions</a></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">EventLog</code>[]></p>\n<hr>\n<p><a id="once"></a></p>\n<h3 id="once"><a href="#once" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>once</h3>\n<p>▸ <strong>once</strong>(eventName: <em><a href="/enums/_contracts_models_vault_.vaultevents">VaultEvents</a></em>, options?: <em><a href="/interfaces/_contracts_basecontract_.eventoptions">EventOptions</a></em>, cb?: <em><code class="language-text">Function</code></em>): <code class="language-text">Promise</code><<code class="language-text">EventEmitter</code>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>eventName</td>\n<td><a href="/enums/_contracts_models_vault_.vaultevents">VaultEvents</a></td>\n</tr>\n<tr>\n<td><code class="language-text">Optional</code>\n options</td>\n<td><a href="/interfaces/_contracts_basecontract_.eventoptions">EventOptions</a></td>\n</tr>\n<tr>\n<td><code class="language-text">Optional</code>\n cb</td>\n<td><code class="language-text">Function</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">EventEmitter</code>></p>\n<hr>\n<p><a id="owner"></a></p>\n<h3 id="owner"><a href="#owner" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>owner</h3>\n<p>▸ <strong>owner</strong>(): <code class="language-text">Promise</code><<code class="language-text">string</code>></p>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">string</code>></p>\n<hr>\n<p><a id="sellvault"></a></p>\n<h3 id="sellvault"><a href="#sellvault" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>sellVault</h3>\n<p>Allows a user to sell from a vault</p>\n<p>▸ <strong>sellVault</strong>(_amount: <em><code class="language-text">BigNumber</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_amount</td>\n<td><code class="language-text">BigNumber</code></td>\n<td>Number of shares to sell</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<hr>\n<p><a id="setowner"></a></p>\n<h3 id="setowner"><a href="#setowner" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>setOwner</h3>\n<p>▸ <strong>setOwner</strong>(_new: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_new</td>\n<td><code class="language-text">string</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<hr>\n<p><a id="settransactionfee"></a></p>\n<h3 id="settransactionfee"><a href="#settransactionfee" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>setTransactionFee</h3>\n<p>Allows vault owner to set the transaction fee</p>\n<p>▸ <strong>setTransactionFee</strong>(_transactionFee: <em><code class="language-text">BigNumber</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_transactionFee</td>\n<td><code class="language-text">BigNumber</code></td>\n<td>Value of the transaction fee in basis points</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<hr>\n<p><a id="timetounlock"></a></p>\n<h3 id="timetounlock"><a href="#timetounlock" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>timeToUnlock</h3>\n<p>Returns the time needed to withdraw</p>\n<p>▸ <strong>timeToUnlock</strong>(_token: <em><code class="language-text">string</code></em>, _user: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_token</td>\n<td><code class="language-text">string</code></td>\n<td></td>\n</tr>\n<tr>\n<td>_user</td>\n<td><code class="language-text">string</code></td>\n<td>Address of the user</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<hr>\n<p><a id="tokenbalanceof"></a></p>\n<h3 id="tokenbalanceof"><a href="#tokenbalanceof" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>tokenBalanceOf</h3>\n<p>Returns a user balance of a certain deposited token</p>\n<p>▸ <strong>tokenBalanceOf</strong>(_token: <em><code class="language-text">string</code></em>, _owner: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_token</td>\n<td><code class="language-text">string</code></td>\n<td></td>\n</tr>\n<tr>\n<td>_owner</td>\n<td><code class="language-text">string</code></td>\n<td>Address of the user</td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<hr>\n<p><a id="tokenbalances"></a></p>\n<h3 id="tokenbalances"><a href="#tokenbalances" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>tokenBalances</h3>\n<p>▸ <strong>tokenBalances</strong>(index<em>0: <em><code class="language-text">string</code></em>, index</em>1: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>index_0</td>\n<td><code class="language-text">string</code></td>\n</tr>\n<tr>\n<td>index_1</td>\n<td><code class="language-text">string</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<hr>\n<p><a id="tokensinvault"></a></p>\n<h3 id="tokensinvault"><a href="#tokensinvault" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>tokensInVault</h3>\n<p>Returns the amount of tokens of a certain token in vault</p>\n<p>▸ <strong>tokensInVault</strong>(_token: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_token</td>\n<td><code class="language-text">string</code></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<hr>\n<p><a id="totalsupply"></a></p>\n<h3 id="totalsupply"><a href="#totalsupply" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>totalSupply</h3>\n<p>Returns the total amount of issued tokens for this vault</p>\n<p>▸ <strong>totalSupply</strong>(): <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">BigNumber</code>></p>\n<hr>\n<p><a id="updateprice"></a></p>\n<h3 id="updateprice"><a href="#updateprice" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>updatePrice</h3>\n<p>Allows anyone to pay and update the priceThis function allows to write the new navNAV is provided by view functions</p>\n<p>▸ <strong>updatePrice</strong>(): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">void</code>>></p>\n<hr>\n<p><a id="withdrawtoken"></a></p>\n<h3 id="withdrawtoken"><a href="#withdrawtoken" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>withdrawToken</h3>\n<p>Allows anyone to withdraw tokens from a vault</p>\n<p>▸ <strong>withdrawToken</strong>(_token: <em><code class="language-text">string</code></em>, _value: <em><code class="language-text">BigNumber</code></em>): <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>_token</td>\n<td><code class="language-text">string</code></td>\n<td></td>\n</tr>\n<tr>\n<td>_value</td>\n<td><code class="language-text">BigNumber</code></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<code class="language-text">TransactionObject</code><<code class="language-text">boolean</code>>></p>\n<hr>\n<p><a id="createandvalidate"></a></p>\n<h3 id="code-classlanguage-textltstaticgtcode-createandvalidate"><a href="#code-classlanguage-textltstaticgtcode-createandvalidate" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code class="language-text"><Static></code> createAndValidate</h3>\n<p>▸ <strong>createAndValidate</strong>(web3: <em><code class="language-text">any</code></em>, address: <em><code class="language-text">string</code></em>): <code class="language-text">Promise</code><<a href="_contracts_models_vault_.vault">Vault</a>></p>\n<p><strong>Parameters:</strong></p>\n<table>\n<thead>\n<tr>\n<th>Name</th>\n<th>Type</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>web3</td>\n<td><code class="language-text">any</code></td>\n</tr>\n<tr>\n<td>address</td>\n<td><code class="language-text">string</code></td>\n</tr>\n</tbody>\n</table>\n<p><strong>Returns:</strong> <code class="language-text">Promise</code><<a href="_contracts_models_vault_.vault">Vault</a>></p>\n<hr>\n<p><a id="isdeployed"></a></p>\n<h3 id="code-classlanguage-textltstaticgtcode-isdeployed"><a href="#code-classlanguage-textltstaticgtcode-isdeployed" aria-hidden="true" class="anchor"><svg aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code class="language-text"><Static></code> isDeployed</h3>\n<p>▸ <strong>isDeployed</strong>(): <code class="language-text">boolean</code></p>\n<p><strong>Returns:</strong> <code class="language-text">boolean</code></p>\n<hr>'
}},pathContext:{slug:"/classes/_contracts_models_vault_.vault",category:"API reference"}}}});