Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom HD path address generation #156

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,17 @@ The simplest usage is `ks.generateNewAddress(pwDerivedKey)`.

Generates `num` new address/private key pairs (defaults to 1) in the keystore from the seed phrase, which will be returned with calls to `ks.getAddresses()`.

### `keystore.generateNewAddressOnPath(pwDerivedKey, [hdPathString], [index])`

Allows the vault to generate and export custom HD path address/private key pairs.

The simplest usage is `ks.generateNewAddressOnPath(pwDerivedKey)`, this would generate first index of the default hdPathString.

This function is more useful when a secondary backend app is using eth-lightwallet library to generate and manage addresses and the actual keys are not stored by eth-lightwallet.

Checkout `/test/keystore/ generateNewAddressOnPath` for an example.


### `keystore.deserialize(serialized_keystore)`

Takes a serialized keystore string `serialized_keystore` and returns a new keystore object.
Expand Down
Loading