From a8fef29b7d900c99f47e81d2358355df7a2d7140 Mon Sep 17 00:00:00 2001 From: Overtorment Date: Sun, 17 Jun 2018 11:46:19 +0100 Subject: [PATCH] DOC --- class/app-storage.js | 24 ++++++++++++++++++++++++ class/legacy-wallet.js | 15 +++++++++++++-- 2 files changed, 37 insertions(+), 2 deletions(-) diff --git a/class/app-storage.js b/class/app-storage.js index 70b66b121..e529ffd53 100644 --- a/class/app-storage.js +++ b/class/app-storage.js @@ -206,12 +206,26 @@ export class AppStorage { return AsyncStorage.setItem('data', JSON.stringify(data)); } + /** + * For each wallet, fetches balance from remote endpoint. + * Use getter for a specific wallet to get actual balance. + * Returns void. + * + * @return {Promise.} + */ async fetchWalletBalances() { for (let wallet of this.wallets) { await wallet.fetchBalance(); } } + /** + * Fetches from remote endpoint all transactions for each wallet. + * Returns void. + * To access transactions - get them from each respective wallet. + * + * @return {Promise.} + */ async fetchWalletTransactions() { for (let wallet of this.wallets) { await wallet.fetchTransactions(); @@ -226,6 +240,11 @@ export class AppStorage { return this.wallets; } + /** + * Getter for all transactions in all wallets + * + * @return {Array} + */ getTransactions() { let txs = []; for (let wallet of this.wallets) { @@ -240,6 +259,11 @@ export class AppStorage { listUnconfirmed() {} + /** + * Getter for a sum of all balances of all wallets + * + * @return {number} + */ getBalance() { let finalBalance = 0; for (let wal of this.wallets) { diff --git a/class/legacy-wallet.js b/class/legacy-wallet.js index aea58c318..faaeb60fa 100644 --- a/class/legacy-wallet.js +++ b/class/legacy-wallet.js @@ -62,8 +62,8 @@ export class LegacyWallet extends AbstractWallet { } /** - * Fetches balance o the Wallet via API. - * Returns VOID. Get the balance from getter. + * Fetches balance of the Wallet via API. + * Returns VOID. Get the actual balance via getter. * * @returns {Promise.} */ @@ -107,6 +107,11 @@ export class LegacyWallet extends AbstractWallet { } } + /** + * Fetches UTXO from API. Returns VOID. + * + * @return {Promise.} + */ async fetchUtxo() { const api = new Frisbee({ baseURI: 'https://api.blockcypher.com/v1/btc/main/addrs/', @@ -162,6 +167,12 @@ export class LegacyWallet extends AbstractWallet { } } + /** + * Fetches transactions via API. Returns VOID. + * Use getter to get the actual list. + * + * @return {Promise.} + */ async fetchTransactions() { let response; let token = (array => {