JS keystore support #8096
Merged
JS keystore support #8096
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
AlexBHarley
reviewed
Jun 15, 2021
packages/sdk/wallets/wallet-keystore/src/keystore-wallet-wrapper.ts
Outdated
Show resolved
Hide resolved
AlexBHarley
reviewed
Jun 15, 2021
AlexBHarley
reviewed
Jun 15, 2021
AlexBHarley
reviewed
Jun 15, 2021
eelanagaraj
force-pushed
the
eelanagaraj/js-keystore
branch
3 times, most recently
from
dde7727 to
bb40112
Compare
nambrot
reviewed
Jun 21, 2021
packages/sdk/wallets/wallet-keystore/src/keystore-wallet-wrapper.ts
Outdated
Show resolved
Hide resolved
packages/sdk/wallets/wallet-keystore/src/keystore-wallet-wrapper.test.ts
Outdated
Show resolved
Hide resolved
packages/sdk/wallets/wallet-keystore/src/keystore-wallet-wrapper.test.ts
Outdated
Show resolved
Hide resolved
AlexBHarley
approved these changes
Jun 28, 2021
There was a problem hiding this comment.
This looks great. I think the most powerful thing here is the fact that we can plug our existing wallet abstraction into this, meaning now files, databases, what have you can back our wallets.
I'm very curious to see how this ends up being used with our other projects like the CLI and attestation service.
eelanagaraj
added
automerge
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
mergify bot
pushed a commit
that referenced
this pull request
Jul 8, 2021
(Up to date with new file structure) - Added autogenerated docs for keystore - Added a walkthrough with code/usage examples in `using-js-keystores.md` (note: will not work until first version is published); [this is what it will look like on gitbook](https://eela.gitbook.io/forked-monorepo-docs-test/~/revisions/-MczCo4GM6pOBxl1YTZq/v/docs-test%2Feelanagaraj%2Fjs-keystore-docs-new/developer-guide/start/using-js-keystores) Split so as to not clutter the first PR (#8096) (apologies for the messy commits here -- wanted to stack them to make the differences cleaner initially but didn't want to wait to land docs with the rest of the PR!)
This was referenced Oct 18, 2021
This was referenced Nov 8, 2021
This was referenced Dec 23, 2021
This was referenced Jun 30, 2023
This was referenced Jul 4, 2023
This was referenced Jul 12, 2023
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.
Description
ethereumjs-walletKeystoreabstraction should make it fairly straightforward to add additional IO formats (browser storage, DB, however valora wants to do this...)KeystoreWalletWrapperis a bare bones wrapper of a file keystore + theLocalWallet-- 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 senseTested
KeystoreWalletWrapper+ keystore filesFileKeystorecan be copied to the geth keystore directory, decrypted, and used to send txs)Related issues
JavaScript native keystore #7063
related autogenerated docs (split PR so as to not clutter this one) old file structure PR, docs PR new file structure
Backwards compatibility
New module, no changes to existing wallets or tools.
Remaining TODOs