js keystore docs #8160
Closed
js keystore docs #8160
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eelanagaraj
requested review from
barbaraliau,
critesjosh and
timmoreton
as code owners
eelanagaraj
requested review from
asaj,
cmcewen,
gastonponti,
mcortesi,
medhakothari and
a team
as code owners
eelanagaraj
removed request for
asaj,
cmcewen,
gastonponti,
mcortesi,
medhakothari and
a team
eelanagaraj
force-pushed
the
eelanagaraj/js-keystore
branch
2 times, most recently
from
c84540f to
8f4bd9c
Compare
eelanagaraj
force-pushed
the
eelanagaraj/js-keystore-docs
branch
from
3f3ae06 to
7f5788b
Compare
Merged
mergify bot
pushed a commit
that referenced
this pull request
Jun 28, 2021
### Description - Implements most basic keystore functionality (encrypt, decrypt, change password) base class (+ file system for data persistence), based on `ethereumjs-wallet` - `Keystore` abstraction should make it fairly straightforward to add additional IO formats (browser storage, DB, however valora wants to do this...) - `KeystoreWalletWrapper` is a bare bones wrapper of a file keystore + the `LocalWallet` -- I expect this to change (+ maybe move into its own directory), but would wait until implementing attestation service/CLI-relevant changes before adding more here, in order to see what's necessary/makes sense ### Tested - Unit tests - Tested instantiating, signing, sending txs via the `KeystoreWalletWrapper` + keystore files - Tested that keystore files created by geth can be copied into this keystore directory and decrypted with the same passphrase; same with the reverse (i.e. keystore files created + encrypted with the `FileKeystore` can be copied to the geth keystore directory, decrypted, and used to send txs) ### Related issues - #7063 - related autogenerated docs (split PR so as to not clutter this one) [old file structure PR](#8160), [docs PR new file structure](#8185) ### Backwards compatibility New module, no changes to existing wallets or tools. ### Remaining TODOs - [later PR] modify KeystoreWalletWrapper as makes sense with future use cases
tkporter
pushed a commit
that referenced
this pull request
Jul 8, 2021
### Description - Implements most basic keystore functionality (encrypt, decrypt, change password) base class (+ file system for data persistence), based on `ethereumjs-wallet` - `Keystore` abstraction should make it fairly straightforward to add additional IO formats (browser storage, DB, however valora wants to do this...) - `KeystoreWalletWrapper` is a bare bones wrapper of a file keystore + the `LocalWallet` -- I expect this to change (+ maybe move into its own directory), but would wait until implementing attestation service/CLI-relevant changes before adding more here, in order to see what's necessary/makes sense ### Tested - Unit tests - Tested instantiating, signing, sending txs via the `KeystoreWalletWrapper` + keystore files - Tested that keystore files created by geth can be copied into this keystore directory and decrypted with the same passphrase; same with the reverse (i.e. keystore files created + encrypted with the `FileKeystore` can be copied to the geth keystore directory, decrypted, and used to send txs) ### Related issues - #7063 - related autogenerated docs (split PR so as to not clutter this one) [old file structure PR](#8160), [docs PR new file structure](#8185) ### Backwards compatibility New module, no changes to existing wallets or tools. ### Remaining TODOs - [later PR] modify KeystoreWalletWrapper as makes sense with future use cases
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add autogenerated docs for keystore
Note: this does not include use-case docs, which will be in a later PR
Split so as to not clutter the first PR (#8096)