From 9aec1088c7fdefaba936c4f4d2b12c0da18b3474 Mon Sep 17 00:00:00 2001 From: GBKS Date: Wed, 12 May 2021 10:38:07 +0200 Subject: [PATCH 1/2] Fixes links that I broke in #283 --- guide/case-studies/cloud-backup.md | 2 +- guide/case-studies/multisig-wallet.md | 2 +- guide/onboarding/creating-a-new-wallet.md | 4 +-- guide/private-key-management/introduction.md | 36 +++++++++++++++---- guide/private-key-management/overview.md | 12 +++---- .../shared-multi-key.md | 2 +- 6 files changed, 41 insertions(+), 17 deletions(-) diff --git a/guide/case-studies/cloud-backup.md b/guide/case-studies/cloud-backup.md index 1cbdc4adb..50e841be0 100644 --- a/guide/case-studies/cloud-backup.md +++ b/guide/case-studies/cloud-backup.md @@ -18,7 +18,7 @@ Editor's notes Imagine a product which tries to solve the problem of quickly and easily sending smaller amounts of money to friends and family, or for small purchases. Ease and speed of use will be important as usage is likely to be on mobile devices and on the go. Users are not expected to be well versed in bitcoin technology or advanced private key management, which makes it reasonable to worry more about self-inflicted loss than from theft. -A single-key scheme with [automatic cloud backup]({{ '/guide/private-key-management/single-user-schemes/#automatic-cloud-backup' | relative_url }}) might be the best choice for the majority of users in this case. For more advanced users you could offer the option to opt-out of automatic cloud backup and instead use a recovery phrase. +A single-key scheme with [automatic cloud backup]({{ '/guide/private-key-management/cloud-backup/' | relative_url }}) might be the best choice for the majority of users in this case. For more advanced users you could offer the option to opt-out of automatic cloud backup and instead use a recovery phrase. {% include prototype.html link = "https://www.figma.com/proto/SRWlaxbDulsacpPQn2TTri/Case-study-prototypes?node-id=1%3A3&viewport=1357%2C576%2C1&scaling=scale-down" diff --git a/guide/case-studies/multisig-wallet.md b/guide/case-studies/multisig-wallet.md index bae9fa216..4662043cb 100644 --- a/guide/case-studies/multisig-wallet.md +++ b/guide/case-studies/multisig-wallet.md @@ -45,7 +45,7 @@ In this section, we are looking at a product that is meant to be a replacement f Safeguards against loss will be a higher priority than with a cash product, and we might therefore accept more friction both when setting up the wallet and when transacting. If users have no prior bitcoin knowledge we should expect to spend a significant effort educating them to put them in a position to safely operate the wallet product. -A 2-of-3 [multi-key setup]({{ '/guide/private-key-management/single-user-schemes/#multi-key' | relative_url }}) would seem the most appropriate here, although it will be a significant hurdle in onboarding. Other schemes could be considered but come with distinct downsides for amounts of value we can expect users to store in this use case. A single-key scheme with an automatic cloud backup, recovery phrase or single signing device could work at the lower end of the value scale, but start to look like less responsible recommendations with higher values due to their single points of failure. +A 2-of-3 [multi-key setup]({{ '/guide/private-key-management/multi-key/' | relative_url }}) would seem the most appropriate here, although it will be a significant hurdle in onboarding. Other schemes could be considered but come with distinct downsides for amounts of value we can expect users to store in this use case. A single-key scheme with an automatic cloud backup, recovery phrase or single signing device could work at the lower end of the value scale, but start to look like less responsible recommendations with higher values due to their single points of failure. An important question is the combination of key-storage devices and their distribution. We have many options here, and it might come down to the experience of the target audience and their expected access to the necessary hardware; diff --git a/guide/onboarding/creating-a-new-wallet.md b/guide/onboarding/creating-a-new-wallet.md index d53b615a9..71f946007 100644 --- a/guide/onboarding/creating-a-new-wallet.md +++ b/guide/onboarding/creating-a-new-wallet.md @@ -10,7 +10,7 @@ main_classes: -no-top-padding # Creating a new wallet -First, bitcoin [wallets]({{ 'guide/glossary/#wallet' | relative_url }}) are not analogous to their namesakes. Physical wallets are places to store physical currency, credit cards, IDs, and so on. Bitcoin wallets don't store bitcoin. However, the [self custodial]({{ 'guide/glossary/#self-custody' | relative_url }}) nature of bitcoin wallets gives users full control of what they do with their bitcoin. +First, bitcoin [wallets]({{ 'guide/glossary/#wallet' | relative_url }}) are not analogous to their namesakes. Physical wallets are places to store physical currency, credit cards, IDs, and so on. Bitcoin wallets don't store bitcoin. However, the [self custodial]({{ 'guide/glossary/#non-custodial--custodial-wallet' | relative_url }}) nature of bitcoin wallets gives users full control of what they do with their bitcoin. Instead, a Bitcoin wallet contains the "private keys" to a users bitcoin. The bitcoin is located on the Bitcoin network that contains a public ledger similar in many ways to a spreadsheet with a record of everyone's transactions and balances. Private keys let users access bitcoin associated with those keys. A more suitable analogy for a Bitcoin wallet would be a keychain. @@ -33,7 +33,7 @@ A few different types of wallets let you send, receive, store, and manage bitcoi Most wallets will begin the onboarding process by creating a new or restoring an existing wallet. New users to Bitcoin will usually be going through the flow of creating a new wallet. -Once an individual selects “create a new wallet”, you might present informational carousels that provide a high-level overview of the implications, benefits, and responsibility that comes with having a [self-custodial]({{ '/guide/glossary/#self-custody' | relative_url }}) wallet. Here you can explain to your user that access to the wallet will not require collecting any sensitive information such as usernames and passwords, which is often the case with traditional financial products. +Once an individual selects “create a new wallet”, you might present informational carousels that provide a high-level overview of the implications, benefits, and responsibility that comes with having a [self-custodial]({{ '/guide/glossary/#non-custodial--custodial-wallet' | relative_url }}) wallet. Here you can explain to your user that access to the wallet will not require collecting any sensitive information such as usernames and passwords, which is often the case with traditional financial products. Rather, the user can directly access their funds as long as they have access to the private key or recovery phrase. You should help your users understand that your team do not have the ability to recover their funds in the event they lose their private key. A self custodial wallet often means the user will have to take on greater responsibilty to safely protect their private key so they can always access their funds. diff --git a/guide/private-key-management/introduction.md b/guide/private-key-management/introduction.md index fad880e0d..8b2405081 100644 --- a/guide/private-key-management/introduction.md +++ b/guide/private-key-management/introduction.md @@ -37,21 +37,45 @@ This chapter is an overview of private key management schemes, including descrip --- -### [Private key schemes]({{ '/guide/private-key-management/schemes/' | relative_url }}) +### [Overview]({{ '/guide/private-key-management/overview/' | relative_url }}) Get to know the most common bitcoin private key management schemes, then follow our guidelines to pick the right one for your users. --- -### [Personal schemes]({{ '/guide/private-key-management/single-user-schemes/' | relative_url }}) +### [Automatic cloud backup]({{ '/guide/private-key-management/cloud-backup/' | relative_url }}) -An introduction to some of the common private key management schemes for individual users. +A scheme where no user action is required for backup. --- -### [Shared schemes]({{ '/guide/private-key-management/single-user-schemes/' | relative_url }}) +### [Manual backup]({{ '/guide/private-key-management/manual-backup/' | relative_url }}) -An introduction to some of the common private key management schemes for shared users. +Opposite to the automatic cloud backup, manual backup is highly involved for the user who takes full personal responsibility for all steps. + +--- + +### [External signing device]({{ '/guide/private-key-management/external-signing-device/' | relative_url }}) + +In this scheme, keys are managed on a device separate from the device a wallet application runs on. + +--- + +### [Key sharing]({{ '/guide/private-key-management/key-sharing/' | relative_url }}) + +A single key is split up and distributed. + +--- + +### [Multi-key]({{ '/guide/private-key-management/multi-key/' | relative_url }}) + +Mutliple keys are independently created and combined to form and manage a wallet. + +--- + +### [Shared multi-key]({{ '/guide/private-key-management/shared-multi-key/' | relative_url }}) + +Similar to the multi-key scheme, but with keys distributed to different people, requiring additional coordination. --- @@ -61,4 +85,4 @@ A straightforward guide to safe manual backups. --- -Start at the top with [private key schemes]({{ '/guide/private-key-management/schemes/' | relative_url }}). +Start at the top with [private key schemes]({{ '/guide/private-key-management/overview/' | relative_url }}). diff --git a/guide/private-key-management/overview.md b/guide/private-key-management/overview.md index d13acb095..b518acd01 100644 --- a/guide/private-key-management/overview.md +++ b/guide/private-key-management/overview.md @@ -103,11 +103,11 @@ Now let's dive in and look at the various schemes that might be suitable for a p height = 400 %} -- [Automatic cloud backup](/guide/private-key-management/automatic-cloud-backup) - no user action required for backup -- [Manual backup / Recovery phrase](/guide/private-key-management/manual-backup) - manual backup of a phrase of words -- [External signing device](/guide/private-key-management/external-signing-device) - keys are held on a separate device -- [Threshold signatures / Key-sharing](/guide/private-key-management/threshold-signatures) - one key is split and distributed -- [Multi-key](#multi-key) - several keys jointly control the wallet +- [Automatic cloud backup](/guide/private-key-management/cloud-backup/) - no user action required for backup +- [Manual backup / Recovery phrase](/guide/private-key-management/manual-backup/) - manual backup of a phrase of words +- [External signing device](/guide/private-key-management/external-signing-device/) - keys are held on a separate device +- [Threshold signatures / Key-sharing](/guide/private-key-management/key-sharing/) - one key is split and distributed +- [Multi-key](/guide/private-key-management/multi-key/) - several keys jointly control the wallet ### Shared schemes @@ -119,4 +119,4 @@ The use cases for shared schemes include spouses managing a joint account, group --- -Let's start by looking at the [automatic cloud backup](/guide/private-key-management/automatic-cloud-backup) scheme. +Let's start by looking at the [automatic cloud backup](/guide/private-key-management/cloud-backup/) scheme. diff --git a/guide/private-key-management/shared-multi-key.md b/guide/private-key-management/shared-multi-key.md index b1c5bdf6e..62a208ae4 100644 --- a/guide/private-key-management/shared-multi-key.md +++ b/guide/private-key-management/shared-multi-key.md @@ -32,7 +32,7 @@ Description of schemes suitable for multi-user scenarios. As we saw with multi-key setups for personal use, a multi-key wallet has several controlling keypairs attached, or what is often called co-signers. The number of keys and required co-signers will depend on the use case. With spouses sharing a *joint account*, a simple 1-of-2 multi-key setup might suffice, meaning there are two keys but only one is required to sign for a transaction to be valid. At the other end of a spectrum a company might require a more complex 3-of-5 setup, requiring three of the five co-signers to approve any transaction. -Just like with personal schemes, external signing devices can be used to hold one or several of the keys used for a shared multi-key setup. While this can increase [security](guide/foundations/principles/#security) if managed correctly, the same caveat applies in terms of adding significant complexity. +Just like with personal schemes, external signing devices can be used to hold one or several of the keys used for a shared multi-key setup. While this can increase [security](/guide/foundations/principles/#security) if managed correctly, the same caveat applies in terms of adding significant complexity. {% include image.html image = "/assets/images/guide/private-key-management/schemes/shared-multi-key.jpg" From 1bd77d31bb90ab033a07c5ab52c25e6a9d98ad18 Mon Sep 17 00:00:00 2001 From: GBKS Date: Wed, 12 May 2021 11:13:02 +0200 Subject: [PATCH 2/2] Page description updates per Daniels recommendations --- guide/private-key-management/introduction.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/guide/private-key-management/introduction.md b/guide/private-key-management/introduction.md index 8b2405081..1062f5908 100644 --- a/guide/private-key-management/introduction.md +++ b/guide/private-key-management/introduction.md @@ -45,37 +45,37 @@ Get to know the most common bitcoin private key management schemes, then follow ### [Automatic cloud backup]({{ '/guide/private-key-management/cloud-backup/' | relative_url }}) -A scheme where no user action is required for backup. +A single key is stored locally on the device. No user action is required for backup. --- ### [Manual backup]({{ '/guide/private-key-management/manual-backup/' | relative_url }}) -Opposite to the automatic cloud backup, manual backup is highly involved for the user who takes full personal responsibility for all steps. +A single key is stored locally on the device. User action is required for backup with a recovery phrase. --- ### [External signing device]({{ '/guide/private-key-management/external-signing-device/' | relative_url }}) -In this scheme, keys are managed on a device separate from the device a wallet application runs on. +A single key that is not stored on the same device as the wallet application. --- ### [Key sharing]({{ '/guide/private-key-management/key-sharing/' | relative_url }}) -A single key is split up and distributed. +A single key is split up, with each part stored in separate locations. --- ### [Multi-key]({{ '/guide/private-key-management/multi-key/' | relative_url }}) -Mutliple keys are independently created and combined to form and manage a wallet. +A wallet that is managed by multiple independent keys of which at least one is stored on a separated device from the wallet application. --- ### [Shared multi-key]({{ '/guide/private-key-management/shared-multi-key/' | relative_url }}) -Similar to the multi-key scheme, but with keys distributed to different people, requiring additional coordination. +Same as the multi-key scheme, but with keys managed by different people, requiring additional coordination. ---