2021-05-10 20:56:20 +02:00
<!doctype html>
< html class = "no-js" lang = "" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< title > CICADA< / title >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "icon" type = "image/x-icon" href = "../images/favicon.ico" >
2021-09-03 01:48:41 +02:00
< link rel = "stylesheet" href = "../styles/style.css" >
< link rel = "stylesheet" href = "../styles/dark.css" media = "(prefers-color-scheme: dark)" >
2021-05-10 20:56:20 +02:00
< / head >
< body >
< div class = "navbar navbar-default navbar-fixed-top visible-xs" >
< a href = "../" class = "navbar-brand" > CICADA< / a >
< button type = "button" class = "btn btn-default btn-menu ion-ios-menu" id = "btn-menu" > < / button >
< / div >
< div class = "xs-menu menu" id = "mobile-menu" >
< div id = "book-search-input" role = "search" > < input type = "text" placeholder = "Type to search" > < / div > < compodoc-menu > < / compodoc-menu >
< / div >
< div class = "container-fluid main" >
< div class = "row main" >
< div class = "hidden-xs menu" >
< compodoc-menu mode = "normal" > < / compodoc-menu >
< / div >
<!-- START CONTENT -->
< div class = "content class" >
< div class = "content-data" >
< ol class = "breadcrumb" >
< li > Classes< / li >
2021-09-03 01:48:41 +02:00
< li > AccountIndex< / li >
2021-05-10 20:56:20 +02:00
< / ol >
< ul class = "nav nav-tabs" role = "tablist" >
< li class = "active" >
< a href = "#info" role = "tab" id = "info-tab" data-toggle = "tab" data-link = "info" > Info< / a >
< / li >
< li >
< a href = "#source" role = "tab" id = "source-tab" data-toggle = "tab" data-link = "source" > Source< / a >
< / li >
< / ul >
< div class = "tab-content" >
< div class = "tab-pane fade active in" id = "c-info" >
< p class = "comment" >
< h3 > File< / h3 >
< / p >
< p class = "comment" >
< code > src/app/_eth/accountIndex.ts< / code >
< / p >
2021-09-03 01:48:41 +02:00
2021-05-11 11:05:04 +02:00
< p class = "comment" >
< h3 > Description< / h3 >
< / p >
< p class = "comment" >
< p > Provides an instance of the accounts registry contract.
Allows querying of accounts that have been registered as valid accounts in the network.< / p >
2021-09-03 01:48:41 +02:00
< p > This is our interface to the accounts registry contract.< / p >
2021-05-10 20:56:20 +02:00
2021-05-11 11:05:04 +02:00
< / p >
2021-05-10 20:56:20 +02:00
2021-05-11 11:05:04 +02:00
2021-05-10 20:56:20 +02:00
< section >
< h3 id = "index" > Index< / h3 >
< table class = "table table-sm table-bordered index-table" >
< tbody >
< tr >
< td class = "col-md-4" >
< h6 > < b > Properties< / b > < / h6 >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
< ul class = "index-list" >
< li >
2021-09-03 01:48:41 +02:00
< a href = "#contract" > contract< / a >
2021-05-10 20:56:20 +02:00
< / li >
< li >
2021-09-03 01:48:41 +02:00
< a href = "#contractAddress" > contractAddress< / a >
2021-05-10 20:56:20 +02:00
< / li >
< li >
2021-09-03 01:48:41 +02:00
< a href = "#signerAddress" > signerAddress< / a >
2021-05-10 20:56:20 +02:00
< / li >
< / ul >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
< h6 > < b > Methods< / b > < / h6 >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
< ul class = "index-list" >
< li >
< span class = "modifier" > Public< / span >
< span class = "modifier" > Async< / span >
2021-09-03 01:48:41 +02:00
< a href = "#addToAccountRegistry" > addToAccountRegistry< / a >
2021-05-10 20:56:20 +02:00
< / li >
< li >
< span class = "modifier" > Public< / span >
< span class = "modifier" > Async< / span >
2021-09-03 01:48:41 +02:00
< a href = "#haveAccount" > haveAccount< / a >
2021-05-10 20:56:20 +02:00
< / li >
< li >
< span class = "modifier" > Public< / span >
< span class = "modifier" > Async< / span >
2021-09-03 01:48:41 +02:00
< a href = "#last" > last< / a >
2021-05-10 20:56:20 +02:00
< / li >
< li >
< span class = "modifier" > Public< / span >
< span class = "modifier" > Async< / span >
2021-09-03 01:48:41 +02:00
< a href = "#totalAccounts" > totalAccounts< / a >
2021-05-10 20:56:20 +02:00
< / li >
< / ul >
< / td >
< / tr >
< / tbody >
< / table >
< / section >
< section >
< h3 id = "constructor" > Constructor< / h3 >
< table class = "table table-sm table-bordered" >
< tbody >
< tr >
< td class = "col-md-4" >
< code > constructor(contractAddress: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > , signerAddress?: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > )< / code >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-06-14 13:28:53 +02:00
< div class = "io-line" > Defined in < a href = "" data-line = "26" class = "link-to-prism" > src/app/_eth/accountIndex.ts:26< / a > < / div >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-05-11 11:05:04 +02:00
< div class = "io-description" > < p > Create a connection to the deployed account registry contract.< / p >
< / div >
2021-05-10 20:56:20 +02:00
< div >
< b > Parameters :< / b >
< table class = "params" >
< thead >
< tr >
< td > Name< / td >
< td > Type< / td >
< td > Optional< / td >
2021-05-11 11:05:04 +02:00
< td > Description< / td >
2021-05-10 20:56:20 +02:00
< / tr >
< / thead >
< tbody >
< tr >
< td > contractAddress< / td >
< td >
< code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > < / code >
< / td >
< td >
No
< / td >
2021-05-11 11:05:04 +02:00
< td >
< code > < ul >
< li > The deployed account registry contract' s address.< / li >
< / ul >
< / code >
< / td >
2021-05-10 20:56:20 +02:00
< / tr >
< tr >
< td > signerAddress< / td >
< td >
< code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > < / code >
< / td >
< td >
Yes
< / td >
2021-05-11 11:05:04 +02:00
< td >
< code > < ul >
< li > The account address of the account that deployed the account registry contract.< / li >
< / ul >
< / code >
< / td >
2021-05-10 20:56:20 +02:00
< / tr >
< / tbody >
< / table >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / section >
< section >
2021-09-03 01:48:41 +02:00
< h3 id = "inputs" >
Properties
< / h3 >
< table class = "table table-sm table-bordered" >
< tbody >
< tr >
< td class = "col-md-4" >
< a name = "contract" > < / a >
< span class = "name" >
< span > < b > contract< / b > < / span >
< a href = "#contract" > < span class = "icon ion-ios-link" > < / span > < / a >
< / span >
< / td >
< / tr >
2021-05-10 20:56:20 +02:00
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< i > Type : < / i > < code > < a href = "https://www.typescriptlang.org/docs/handbook/basic-types.html" target = "_blank" > any< / a > < / code >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< div class = "io-line" > Defined in < a href = "" data-line = "22" class = "link-to-prism" > src/app/_eth/accountIndex.ts:22< / a > < / div >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
2021-09-03 01:48:41 +02:00
< tr >
< td class = "col-md-4" >
< div class = "io-description" > < p > The instance of the account registry contract.< / p >
2021-05-11 11:05:04 +02:00
< / div >
2021-09-03 01:48:41 +02:00
< / td >
< / tr >
2021-05-10 20:56:20 +02:00
2021-09-03 01:48:41 +02:00
< / tbody >
< / table >
< table class = "table table-sm table-bordered" >
< tbody >
< tr >
< td class = "col-md-4" >
< a name = "contractAddress" > < / a >
< span class = "name" >
< span > < b > contractAddress< / b > < / span >
< a href = "#contractAddress" > < span class = "icon ion-ios-link" > < / span > < / a >
< / span >
< / td >
< / tr >
2021-05-10 20:56:20 +02:00
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< i > Type : < / i > < code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > < / code >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< div class = "io-line" > Defined in < a href = "" data-line = "24" class = "link-to-prism" > src/app/_eth/accountIndex.ts:24< / a > < / div >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
2021-09-03 01:48:41 +02:00
< tr >
< td class = "col-md-4" >
< div class = "io-description" > < p > The deployed account registry contract' s address.< / p >
2021-05-11 11:05:04 +02:00
< / div >
2021-09-03 01:48:41 +02:00
< / td >
< / tr >
2021-05-10 20:56:20 +02:00
2021-09-03 01:48:41 +02:00
< / tbody >
< / table >
< table class = "table table-sm table-bordered" >
< tbody >
< tr >
< td class = "col-md-4" >
< a name = "signerAddress" > < / a >
< span class = "name" >
< span > < b > signerAddress< / b > < / span >
< a href = "#signerAddress" > < span class = "icon ion-ios-link" > < / span > < / a >
< / span >
< / td >
< / tr >
2021-05-10 20:56:20 +02:00
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< i > Type : < / i > < code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > < / code >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< div class = "io-line" > Defined in < a href = "" data-line = "26" class = "link-to-prism" > src/app/_eth/accountIndex.ts:26< / a > < / div >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
2021-09-03 01:48:41 +02:00
< tr >
< td class = "col-md-4" >
< div class = "io-description" > < p > The account address of the account that deployed the account registry contract.< / p >
2021-05-11 11:05:04 +02:00
< / div >
2021-09-03 01:48:41 +02:00
< / td >
< / tr >
2021-05-10 20:56:20 +02:00
2021-09-03 01:48:41 +02:00
< / tbody >
< / table >
2021-05-10 20:56:20 +02:00
< / section >
< section >
< h3 id = "methods" >
Methods
< / h3 >
< table class = "table table-sm table-bordered" >
< tbody >
< tr >
< td class = "col-md-4" >
< a name = "addToAccountRegistry" > < / a >
< span class = "name" >
2021-09-03 01:48:41 +02:00
< span class = "modifier" > Public< / span >
< span class = "modifier" > Async< / span >
< span > < b > addToAccountRegistry< / b > < / span >
2021-05-10 20:56:20 +02:00
< a href = "#addToAccountRegistry" > < span class = "icon ion-ios-link" > < / span > < / a >
< / span >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
< span class = "modifier-icon icon ion-ios-reset" > < / span >
< code > addToAccountRegistry(address: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > )< / code >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< div class = "io-line" > Defined in < a href = "" data-line = "61"
class="link-to-prism">src/app/_eth/accountIndex.ts:61< / a > < / div >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-05-11 11:05:04 +02:00
< div class = "io-description" > < p > Registers an account to the accounts registry.
Requires availability of the signer address.< / p >
2021-09-03 01:48:41 +02:00
< p > Prints " true" for registration of ' 0xc0ffee254729296a45a3885639AC7E10F9d54979' :< / p >
< div > < pre class = "line-numbers" > < code class = "language-typescript" > console.log(await addToAccountRegistry(' 0xc0ffee254729296a45a3885639AC7E10F9d54979' ));< / code > < / pre > < / div > < / div >
2021-05-10 20:56:20 +02:00
< div class = "io-description" >
< b > Parameters :< / b >
< table class = "params" >
< thead >
< tr >
< td > Name< / td >
< td > Type< / td >
< td > Optional< / td >
2021-05-11 11:05:04 +02:00
< td > Description< / td >
2021-05-10 20:56:20 +02:00
< / tr >
< / thead >
< tbody >
< tr >
< td > address< / td >
< td >
< code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > < / code >
< / td >
< td >
No
< / td >
2021-05-11 11:05:04 +02:00
< td >
< ul >
< li > The account address to be registered to the accounts registry contract.< / li >
< / ul >
< / td >
2021-05-10 20:56:20 +02:00
< / tr >
< / tbody >
< / table >
< / div >
< div >
2021-05-11 11:05:04 +02:00
< b > Example :< / b >
< div >
< pre class = "line-numbers" > < code class = "language-html" > Prints & quot;true& quot; for registration of & #39;0xc0ffee254729296a45a3885639AC7E10F9d54979& #39;:< /p>
2021-09-03 01:48:41 +02:00
< pre> < code class=" language-typescript" > console.log(await addToAccountRegistry(& #39;0xc0ffee254729296a45a3885639AC7E10F9d54979& #39;));
< /code> < /pre> < / code > < / pre >
2021-05-11 11:05:04 +02:00
< / div >
2021-05-10 20:56:20 +02:00
< / div >
< div class = "io-description" >
< b > Returns : < / b > < code > Promise< boolean> < / code >
< / div >
< div class = "io-description" >
2021-05-11 11:05:04 +02:00
< p > true - If registration is successful or account had already been registered.< / p >
2021-05-10 20:56:20 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< table class = "table table-sm table-bordered" >
< tbody >
< tr >
< td class = "col-md-4" >
< a name = "haveAccount" > < / a >
< span class = "name" >
2021-09-03 01:48:41 +02:00
< span class = "modifier" > Public< / span >
< span class = "modifier" > Async< / span >
< span > < b > haveAccount< / b > < / span >
2021-05-10 20:56:20 +02:00
< a href = "#haveAccount" > < span class = "icon ion-ios-link" > < / span > < / a >
< / span >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
< span class = "modifier-icon icon ion-ios-reset" > < / span >
< code > haveAccount(address: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > )< / code >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< div class = "io-line" > Defined in < a href = "" data-line = "82"
class="link-to-prism">src/app/_eth/accountIndex.ts:82< / a > < / div >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-05-11 11:05:04 +02:00
< div class = "io-description" > < p > Checks whether a specific account address has been registered in the accounts registry.
Returns " true" for available and " false" otherwise.< / p >
2021-09-03 01:48:41 +02:00
< p > Prints " true" or " false" depending on whether ' 0xc0ffee254729296a45a3885639AC7E10F9d54979' has been registered:< / p >
< div > < pre class = "line-numbers" > < code class = "language-typescript" > console.log(await haveAccount(' 0xc0ffee254729296a45a3885639AC7E10F9d54979' ));< / code > < / pre > < / div > < / div >
2021-05-10 20:56:20 +02:00
< div class = "io-description" >
< b > Parameters :< / b >
< table class = "params" >
< thead >
< tr >
< td > Name< / td >
< td > Type< / td >
< td > Optional< / td >
2021-05-11 11:05:04 +02:00
< td > Description< / td >
2021-05-10 20:56:20 +02:00
< / tr >
< / thead >
< tbody >
< tr >
< td > address< / td >
< td >
< code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target = "_blank" > string< / a > < / code >
< / td >
< td >
No
< / td >
2021-05-11 11:05:04 +02:00
< td >
< ul >
< li > The account address to be validated.< / li >
< / ul >
< / td >
2021-05-10 20:56:20 +02:00
< / tr >
< / tbody >
< / table >
< / div >
< div >
2021-05-11 11:05:04 +02:00
< b > Example :< / b >
< div >
< pre class = "line-numbers" > < code class = "language-html" > Prints & quot;true& quot; or & quot;false& quot; depending on whether & #39;0xc0ffee254729296a45a3885639AC7E10F9d54979& #39; has been registered:< /p>
2021-09-03 01:48:41 +02:00
< pre> < code class=" language-typescript" > console.log(await haveAccount(& #39;0xc0ffee254729296a45a3885639AC7E10F9d54979& #39;));
< /code> < /pre> < / code > < / pre >
2021-05-11 11:05:04 +02:00
< / div >
2021-05-10 20:56:20 +02:00
< / div >
< div class = "io-description" >
< b > Returns : < / b > < code > Promise< boolean> < / code >
< / div >
< div class = "io-description" >
2021-05-11 11:05:04 +02:00
< p > true - If the address has been registered in the accounts registry.< / p >
2021-05-10 20:56:20 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< table class = "table table-sm table-bordered" >
< tbody >
< tr >
< td class = "col-md-4" >
< a name = "last" > < / a >
< span class = "name" >
2021-09-03 01:48:41 +02:00
< span class = "modifier" > Public< / span >
< span class = "modifier" > Async< / span >
< span > < b > last< / b > < / span >
2021-05-10 20:56:20 +02:00
< a href = "#last" > < span class = "icon ion-ios-link" > < / span > < / a >
< / span >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
< span class = "modifier-icon icon ion-ios-reset" > < / span >
< code > last(numberOfAccounts: < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target = "_blank" > number< / a > )< / code >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< div class = "io-line" > Defined in < a href = "" data-line = "99"
class="link-to-prism">src/app/_eth/accountIndex.ts:99< / a > < / div >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-05-11 11:05:04 +02:00
< div class = "io-description" > < p > Returns a specified number of the most recently registered accounts.< / p >
2021-09-03 01:48:41 +02:00
< p > Prints an array of accounts:< / p >
< div > < pre class = "line-numbers" > < code class = "language-typescript" > console.log(await last(5));< / code > < / pre > < / div > < / div >
2021-05-10 20:56:20 +02:00
< div class = "io-description" >
< b > Parameters :< / b >
< table class = "params" >
< thead >
< tr >
< td > Name< / td >
< td > Type< / td >
< td > Optional< / td >
2021-05-11 11:05:04 +02:00
< td > Description< / td >
2021-05-10 20:56:20 +02:00
< / tr >
< / thead >
< tbody >
< tr >
< td > numberOfAccounts< / td >
< td >
< code > < a href = "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target = "_blank" > number< / a > < / code >
< / td >
< td >
No
< / td >
2021-05-11 11:05:04 +02:00
< td >
< ul >
< li > The number of accounts to return from the accounts registry.< / li >
< / ul >
< / td >
2021-05-10 20:56:20 +02:00
< / tr >
< / tbody >
< / table >
< / div >
< div >
2021-05-11 11:05:04 +02:00
< b > Example :< / b >
< div >
< pre class = "line-numbers" > < code class = "language-html" > Prints an array of accounts:< /p>
2021-09-03 01:48:41 +02:00
< pre> < code class=" language-typescript" > console.log(await last(5));
< /code> < /pre> < / code > < / pre >
2021-05-11 11:05:04 +02:00
< / div >
2021-05-10 20:56:20 +02:00
< / div >
< div class = "io-description" >
< b > Returns : < / b > < code > Promise< Array< string> > < / code >
< / div >
< div class = "io-description" >
2021-05-11 11:05:04 +02:00
< p > An array of registered account addresses.< / p >
2021-05-10 20:56:20 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< table class = "table table-sm table-bordered" >
< tbody >
< tr >
< td class = "col-md-4" >
< a name = "totalAccounts" > < / a >
< span class = "name" >
2021-09-03 01:48:41 +02:00
< span class = "modifier" > Public< / span >
< span class = "modifier" > Async< / span >
< span > < b > totalAccounts< / b > < / span >
2021-05-10 20:56:20 +02:00
< a href = "#totalAccounts" > < span class = "icon ion-ios-link" > < / span > < / a >
< / span >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
< span class = "modifier-icon icon ion-ios-reset" > < / span >
< code > totalAccounts()< / code >
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-09-03 01:48:41 +02:00
< div class = "io-line" > Defined in < a href = "" data-line = "125"
class="link-to-prism">src/app/_eth/accountIndex.ts:125< / a > < / div >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
< tr >
< td class = "col-md-4" >
2021-05-11 11:05:04 +02:00
< div class = "io-description" > < p > Returns the total number of accounts that have been registered in the network.< / p >
2021-09-03 01:48:41 +02:00
< p > Prints the total number of registered accounts:< / p >
< div > < pre class = "line-numbers" > < code class = "language-typescript" > console.log(await totalAccounts());< / code > < / pre > < / div > < / div >
2021-05-10 20:56:20 +02:00
2021-05-11 11:05:04 +02:00
< div >
< b > Example :< / b >
< div >
< pre class = "line-numbers" > < code class = "language-html" > Prints the total number of registered accounts:< /p>
2021-09-03 01:48:41 +02:00
< pre> < code class=" language-typescript" > console.log(await totalAccounts());
< /code> < /pre> < / code > < / pre >
2021-05-11 11:05:04 +02:00
< / div >
< / div >
2021-05-10 20:56:20 +02:00
< div class = "io-description" >
< b > Returns : < / b > < code > Promise< number> < / code >
< / div >
2021-05-11 11:05:04 +02:00
< div class = "io-description" >
< p > The total number of registered accounts.< / p >
< / div >
2021-05-10 20:56:20 +02:00
< / td >
< / tr >
< / tbody >
< / table >
< / section >
< / div >
< div class = "tab-pane fade tab-source-code" id = "c-source" >
2021-05-11 11:05:04 +02:00
< pre class = "line-numbers compodoc-sourcecode" > < code class = "language-typescript" > import Web3 from ' web3' ;
// Application imports
2021-06-14 13:28:53 +02:00
import { Web3Service } from ' @app/_services/web3.service' ;
2021-05-11 19:51:48 +02:00
import { environment } from ' @src/environments/environment' ;
2021-05-10 20:56:20 +02:00
2021-05-11 11:05:04 +02:00
/** Fetch the account registry contract' s ABI. */
2021-05-15 11:17:11 +02:00
const abi: Array< any> = require(' @src/assets/js/block-sync/data/AccountsIndex.json' );
2021-05-11 11:05:04 +02:00
/** Establish a connection to the blockchain network. */
2021-06-14 13:28:53 +02:00
const web3: Web3 = Web3Service.getInstance();
2021-05-10 20:56:20 +02:00
2021-05-11 11:05:04 +02:00
/**
* Provides an instance of the accounts registry contract.
* Allows querying of accounts that have been registered as valid accounts in the network.
*
* @remarks
* This is our interface to the accounts registry contract.
*/
2021-05-10 20:56:20 +02:00
export class AccountIndex {
2021-05-11 11:05:04 +02:00
/** The instance of the account registry contract. */
contract: any;
/** The deployed account registry contract' s address. */
2021-05-10 20:56:20 +02:00
contractAddress: string;
2021-05-11 11:05:04 +02:00
/** The account address of the account that deployed the account registry contract. */
2021-05-10 20:56:20 +02:00
signerAddress: string;
2021-05-11 11:05:04 +02:00
/**
* Create a connection to the deployed account registry contract.
*
* @param contractAddress - The deployed account registry contract' s address.
* @param signerAddress - The account address of the account that deployed the account registry contract.
*/
2021-05-10 20:56:20 +02:00
constructor(contractAddress: string, signerAddress?: string) {
this.contractAddress = contractAddress;
this.contract = new web3.eth.Contract(abi, this.contractAddress);
2021-09-03 01:48:41 +02:00
// TODO this signer logic should be part of the web3service
// if signer address is not passed (for example in user service) then
// this fallsback to a web3 wallet that is not even connected???
2021-05-10 20:56:20 +02:00
if (signerAddress) {
this.signerAddress = signerAddress;
} else {
this.signerAddress = web3.eth.accounts[0];
}
}
2021-05-11 11:05:04 +02:00
/**
* Registers an account to the accounts registry.
* Requires availability of the signer address.
*
* @async
* @example
* Prints " true" for registration of ' 0xc0ffee254729296a45a3885639AC7E10F9d54979' :
* ` ` ` typescript
* console.log(await addToAccountRegistry(' 0xc0ffee254729296a45a3885639AC7E10F9d54979' ));
* ` ` `
*
* @param address - The account address to be registered to the accounts registry contract.
* @returns true - If registration is successful or account had already been registered.
*/
public async addToAccountRegistry(address: string): Promise< boolean> {
2021-05-11 19:51:48 +02:00
if (!(await this.haveAccount(address))) {
return await this.contract.methods.add(address).send({ from: this.signerAddress });
2021-05-11 11:05:04 +02:00
}
return true;
2021-05-10 20:56:20 +02:00
}
2021-05-11 11:05:04 +02:00
/**
* Checks whether a specific account address has been registered in the accounts registry.
* Returns " true" for available and " false" otherwise.
*
* @async
* @example
* Prints " true" or " false" depending on whether ' 0xc0ffee254729296a45a3885639AC7E10F9d54979' has been registered:
* ` ` ` typescript
* console.log(await haveAccount(' 0xc0ffee254729296a45a3885639AC7E10F9d54979' ));
* ` ` `
*
* @param address - The account address to be validated.
* @returns true - If the address has been registered in the accounts registry.
*/
2021-05-10 20:56:20 +02:00
public async haveAccount(address: string): Promise< boolean> {
2021-05-15 11:17:11 +02:00
return (await this.contract.methods.have(address).call()) != = 0;
2021-05-10 20:56:20 +02:00
}
2021-05-11 11:05:04 +02:00
/**
* Returns a specified number of the most recently registered accounts.
*
* @async
* @example
* Prints an array of accounts:
* ` ` ` typescript
* console.log(await last(5));
* ` ` `
*
* @param numberOfAccounts - The number of accounts to return from the accounts registry.
* @returns An array of registered account addresses.
*/
2021-05-10 20:56:20 +02:00
public async last(numberOfAccounts: number): Promise< Array< string> > {
const count: number = await this.totalAccounts();
2021-05-15 11:17:11 +02:00
let lowest: number = count - numberOfAccounts;
2021-05-10 20:56:20 +02:00
if (lowest < 0) {
lowest = 0;
}
const accounts: Array< string> = [];
2021-06-14 13:28:53 +02:00
for (let i = count - 1; i > = lowest; i--) {
2021-05-15 11:17:11 +02:00
const account: string = await this.contract.methods.entry(i).call();
2021-05-10 20:56:20 +02:00
accounts.push(account);
}
return accounts;
}
2021-05-11 11:05:04 +02:00
/**
* Returns the total number of accounts that have been registered in the network.
*
* @async
* @example
* Prints the total number of registered accounts:
* ` ` ` typescript
* console.log(await totalAccounts());
* ` ` `
*
* @returns The total number of registered accounts.
*/
public async totalAccounts(): Promise< number> {
2021-05-15 11:17:11 +02:00
return await this.contract.methods.entryCount().call();
2021-05-10 20:56:20 +02:00
}
}
< / code > < / pre >
< / div >
< / div >
< / div > < div class = "search-results" >
< div class = "has-results" >
< h1 class = "search-results-title" > < span class = 'search-results-count' > < / span > result-matching "< span class = 'search-query' > < / span > "< / h1 >
< ul class = "search-results-list" > < / ul >
< / div >
< div class = "no-results" >
< h1 class = "search-results-title" > No results matching "< span class = 'search-query' > < / span > "< / h1 >
< / div >
< / div >
< / div >
<!-- END CONTENT -->
< / div >
< / div >
< script >
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'AccountIndex.html';
var MAX_SEARCH_RESULTS = 15;
< / script >
< script src = "../js/libs/custom-elements.min.js" > < / script >
< script src = "../js/libs/lit-html.js" > < / script >
2021-09-03 01:48:41 +02:00
< script type = "module" src = "../js/menu-wc.js" defer > < / script >
< script nomodule src = "../js/menu-wc_es5.js" defer > < / script >
2021-05-10 20:56:20 +02:00
< script src = "../js/libs/bootstrap-native.js" > < / script >
< script src = "../js/libs/es6-shim.min.js" > < / script >
< script src = "../js/libs/EventDispatcher.js" > < / script >
< script src = "../js/libs/promise.min.js" > < / script >
< script src = "../js/libs/zepto.min.js" > < / script >
< script src = "../js/compodoc.js" > < / script >
< script src = "../js/tabs.js" > < / script >
< script src = "../js/menu.js" > < / script >
< script src = "../js/libs/clipboard.min.js" > < / script >
< script src = "../js/libs/prism.js" > < / script >
< script src = "../js/sourceCode.js" > < / script >
< script src = "../js/search/search.js" > < / script >
< script src = "../js/search/lunr.min.js" > < / script >
< script src = "../js/search/search-lunr.js" > < / script >
< script src = "../js/search/search_index.js" > < / script >
< script src = "../js/lazy-load-graphs.js" > < / script >
< / body >
< / html >
