search

aeternity / hd-wallet-js

HD Wallet for the æternity blockchain
ISC License
2 stars 14 forks source link

Add documentation #4

Open kryztoval opened 5 years ago

kryztoval commented 5 years ago

I did all the steps in the beginning, and I am not sure what to expect or how to see it. :(

davidyuk commented 5 years ago

This package exposes two functions: generateHDWallet and getHDWalletAccounts, they are defined in this file.

In the Base app, generateHDWallet is used to generate wallet by mnemonic phrase. getHDWalletAccounts function is called every time when changes one of keystore, accountCount, or derivedKey.

Feel free to ask any additional questions if you have.

kryztoval commented 5 years ago

Does that mean I have to use this as a backend, and code a front end to use it?

davidyuk commented 5 years ago

This is not a complete application, this package exposes functions for the derivation of aeternity accounts. This functions can be used in both browser and nodejs.

kryztoval commented 5 years ago

Is there a full wallet? even a console wallet that can sign messages, sign transactions or something like that somewhere? Sorry if I ask too many questions.

I would suggest adding a "What hd-wallet is" in the readme.md explaining it is a library. 😄

davidyuk commented 5 years ago

Is there a full wallet?

No, this package implements only the derivation of aeternity accounts, firstly I propose to make it a part of aepp-sdk-js, but we decided to extract it into a separate package: https://github.com/aeternity/aepp-sdk-js/pull/41

even a console wallet that can sign messages, sign transactions or something like that somewhere?

please, check this repository: https://github.com/aeternity/aepp-sdk-js/

I would suggest adding a "What hd-wallet is" in the readme.md explaining it is a library

I agree that we have a lack of documentation in this repository.

kryztoval commented 5 years ago

I know I am new here and that I don't yet understand everything that there is around this repository, thanks for the patience!

davidyuk commented 5 years ago

Let's keep this issue opened until we add some documentation to this repository.