search

hubiinetwork / nahmii-sdk

Javascript SDK for using the hubii nahmii APIs
http://hubii.com
GNU Lesser General Public License v3.0
8 stars 0 forks source link

Undocumented public method #72

Closed morfj closed 5 years ago

morfj commented 5 years ago

https://github.com/hubiinetwork/nahmii-sdk/blob/13b6010b6a488df1d591be1cccda46b5ad87659c/lib/wallet/wallet.js#L91

This method should be documented like the other methods. Does it really belong in the Wallet class though? Does it require a signature for anything? Maybe better located in the provider or a dedicated "BalanceTracker" class?

katat commented 5 years ago

Sorry, I should have added the documentation for this function.

This function is meant to get the staged balance from the contract for a currency under the wallet object. It returns the value in BigNumber type. As it queries the currency balance for a wallet, I put it inside the wallet class for convenience usage.

If these make senses, I will create a PR for the documentation.