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

adds cli command to restore ledger multisig backup #5401

Conversation

hughy
Copy link
Contributor

@hughy hughy commented Sep 20, 2024

Summary

if the ironfish dkg ledger app is uninstalled, or if it is used to create a second set of keys, then the multisig keys on the device may be lost

the 'wallet:multisig:ledger:backup' command creates an encrypted key backup that can be restored to the device

the 'wallet:multisig:ledger:restore' command restores the backed up keys to the ledger

Testing Plan

manual testing:

  • created backup using 'wallet:multisig:ledger:backup' (implements ledger multisig backup command #5400 )
  • uninstalled and reinstalled ironfish dkg app
  • ran 'wallet:multisig:ledger:restore' to restore keys and printed our keys to verify that they are the same as before

Documentation

Does this change require any updates to the Iron Fish Docs (ex. the RPC API
Reference
)? If yes, link a
related documentation pull request for the website.

[ ] Yes

Breaking Change

Is this a breaking change? If yes, add notes below on why this is breaking and label it with breaking-change-rpc or breaking-change-sdk.

[ ] Yes

if the ironfish dkg ledger app is uninstalled, or if it is used to create a
second set of keys, then the multisig keys on the device may be lost

the 'wallet:multisig:ledger:backup' command creates an encrypted key backup that
can be restored to the device

the 'wallet:multisig:ledger:restore' command restores the backed up keys to the
ledger
@hughy hughy requested a review from a team as a code owner September 20, 2024 00:31
@hughy hughy merged commit 50de9b7 into feat/hughy/ifl-2952/ledger-backup-cli Sep 20, 2024
4 checks passed
@hughy hughy deleted the feat/hughy/ifl-2953/ledger-restore-cli branch September 20, 2024 17:53
hughy added a commit that referenced this pull request Sep 20, 2024
* implements ledger multisig backup command

adds a CLI command, 'wallet:multisig:ledger:backup', to create an encrypted
backup of multisig keys from the ironfish dkg ledger app

users can restore the keys to their ledger app if they reinstall the app on
their device or overwrite the multisig keys in the app

* adds cli command to restore ledger multisig backup (#5401)

* adds cli command to restore ledger multisig backup

if the ironfish dkg ledger app is uninstalled, or if it is used to create a
second set of keys, then the multisig keys on the device may be lost

the 'wallet:multisig:ledger:backup' command creates an encrypted key backup that
can be restored to the device

the 'wallet:multisig:ledger:restore' command restores the backed up keys to the
ledger

* Update ironfish-cli/src/commands/wallet/multisig/ledger/restore.ts

Co-authored-by: mat-if <[email protected]>

---------

Co-authored-by: mat-if <[email protected]>

* updates command description

adds additional log output asking the user to save the backup and explaining how
to restore the keys

* fixes lint

---------

Co-authored-by: mat-if <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants