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

Inheritance Wallet Reference Design - Chapter 2 - Backup #1087

Open
wants to merge 75 commits into
base: master
Choose a base branch
from

Conversation

rabbitholiness
Copy link
Collaborator

@rabbitholiness rabbitholiness commented May 2, 2024

This PR builds on Part 1 of the Family Inheritance Wallet reference design.

This page discusses how the backup process works and how the Joneses store and distribute different components of the backup material.

👁️ Check the preview here 👁️

@rabbitholiness rabbitholiness marked this pull request as ready for review May 6, 2024 09:26
Copy link
Collaborator

@mouxdesign mouxdesign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read through the copy, quite an intricate topic here but the diagrams are a great thing which accompany the copy.
Added in some ideas about the images mostly and how they compliment the copy itself.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the diagram the word wallet descriptor is used, however in the copy wallet configuration is used in the opening paragraph and the copy below the image. Might be good to choose one term and use to it both with image and copy.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wallet descriptor copy in image:
"A small piece of text", further below in the copy it seems that the small piece of text is the backup kit. Might be worth changing the copy in the image to keep it consistent.

If I understand correctly the backup kit is exportable as a ZIP file.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion to image copy:
Heading: Wallet configuration.
Body copy: A pdf file as well as wallet backup files in various contexts that a wallet would need to recover a multi-key wallet.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might make more sense here to create an example of one wallet, for understanding the context of the image more. one wallet name then showing many different file types. The image used does make sense as it seems you are trying to convey that different wallets can use different file types but the relatedness of those file types is confusing visually. If that relatedness could be grouped or shown, might make more sense.


<div class="center" markdown="1">

{% include image.html
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This image does not seem to show up on my end.
Screenshot 2024-05-13 101624


---

As we have covered in the time-based recovery [reference design](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup) there are two parts to backing up a multi-key wallet: the private keys as well as the wallet configuration.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As we have covered in the time-based recovery [reference design](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup) there are two parts to backing up a multi-key wallet: the private keys as well as the wallet configuration.
As we have covered in the time-based recovery [reference design](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup) there are two parts to backing up a multi-key wallet: the private keys as well as the wallet configuration.
Suggested change
As we have covered in the time-based recovery [reference design](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup) there are two parts to backing up a multi-key wallet: the private keys as well as the wallet configuration.
As we have covered in the time-based recovery [reference design](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup) there are two parts to backing up a multi-key wallet:
1. Private keys
2. Wallet configuration

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adds a good introductory sentence and fixes some awkward phrasing and sentence structure. Just a suggestion.

@mouxdesign this addresses your suggestion about a one-line mention of the use-case.

Suggested change
As we have covered in the time-based recovery [reference design](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup) there are two parts to backing up a multi-key wallet: the private keys as well as the wallet configuration.
The inheritance wallet described in this reference design is a multi-key wallet with time-based recovery. When backing up such a wallet, users must back up not only their own private keys but also the wallet configuration, as covered [here](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup).


Users need not only to back up the individual private keys that are used to sign transactions. But they also have to back up the wallet configuration as such. This is needed for recovery, because the wallet application needs to know how to generate addresses and the rules that define how bitcoin can be spent from these addresses.

This means that, in our use case, the Joneses need to safely backup and store six private keys as well as the wallet configuration.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Idea to remind the reader of the use case here, could mention it as one sentence or link back to it.

guide/inheritance-wallet/backup.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yashrajd yashrajd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd been eagerly waiting for the backup page PR, so happy to see how it's turning out. The sections on backup distribution & assembly are especially great IMO.

Hope my inputs are helpful, if some of them look convoluted to do reach out.

guide/inheritance-wallet/backup.md Outdated Show resolved Hide resolved

---

As we have covered in the time-based recovery [reference design](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup) there are two parts to backing up a multi-key wallet: the private keys as well as the wallet configuration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adds a good introductory sentence and fixes some awkward phrasing and sentence structure. Just a suggestion.

@mouxdesign this addresses your suggestion about a one-line mention of the use-case.

Suggested change
As we have covered in the time-based recovery [reference design](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup) there are two parts to backing up a multi-key wallet: the private keys as well as the wallet configuration.
The inheritance wallet described in this reference design is a multi-key wallet with time-based recovery. When backing up such a wallet, users must back up not only their own private keys but also the wallet configuration, as covered [here](https://bitcoin.design/guide/savings-wallet/time-based-recovery/#wallet-backup).

Comment on lines +62 to +64
Users need not only to back up the individual private keys that are used to sign transactions. But they also have to back up the wallet configuration as such. This is needed for recovery, because the wallet application needs to know how to generate addresses and the rules that define how bitcoin can be spent from these addresses.

This means that, in our use case, the Joneses need to safely backup and store six private keys as well as the wallet configuration.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removes repetition and improves phrasing.

Suggested change
Users need not only to back up the individual private keys that are used to sign transactions. But they also have to back up the wallet configuration as such. This is needed for recovery, because the wallet application needs to know how to generate addresses and the rules that define how bitcoin can be spent from these addresses.
This means that, in our use case, the Joneses need to safely backup and store six private keys as well as the wallet configuration.
The wallet configuration allows a recovery application to generate addresses and identify the rules that define how bitcoin can be spent from these addresses. The private keys are required to sign transactions & spend the bitcoin.
Thus, the Joneses need to safely backup and store six private keys as well as the wallet configuration.

guide/inheritance-wallet/backup.md Outdated Show resolved Hide resolved
guide/inheritance-wallet/backup.md Outdated Show resolved Hide resolved
guide/inheritance-wallet/backup.md Outdated Show resolved Hide resolved

## Assembling the backup material

The illustration above reveals that Christina and David can access in two different ways.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I initially thought there was an illustration missing here, but it seems this sentence refers to the one on lines 99-108. I suggest this sentence can be moved to the previous section where it is closer to the illustration itself and also fits in context of the excellent advice you're providing there.

guide/inheritance-wallet/backup.md Outdated Show resolved Hide resolved
guide/inheritance-wallet/backup.md Outdated Show resolved Hide resolved
guide/inheritance-wallet/backup.md Outdated Show resolved Hide resolved
@rabbitholiness rabbitholiness added the Inheritance wallet Referring to the inheritance wallet reference design. label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Inheritance wallet Referring to the inheritance wallet reference design.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants