docs: Update to match new default wallet type

bitcoinhodler commented at 6:02 am on February 7, 2022: contributor

#23002 changed the default wallet type to descriptors, so this doc was out of date.

fanquake added the label Docs on Feb 7, 2022

fanquake requested review from achow101 on Feb 7, 2022

shaavan approved

shaavan commented at 6:50 am on February 7, 2022: contributor

ACK 2a8cb264a6b6df063d4abb304cd36ec46c94f383

I have checked that the default wallet_type is set to descriptor wallet after #23002. The managing-wallets documentation is the first thing one would see if they intend to create a wallet, and I think it makes sense to update it along with the latest changes regarding the creation of wallets. The wording used in this PR is concise and to the point while clearly intending the working of the RPC argument.

p.s.: I shall look through the codebase for other probable updates related to this PR.

kristapsk approved

kristapsk commented at 7:51 am on February 7, 2022: contributor

ACK 2a8cb264a6b6df063d4abb304cd36ec46c94f383

MarcoFalke added this to the milestone 23.0 on Feb 7, 2022

in doc/managing-wallets.md:15 in 2a8cb264a6 outdated

14@@ -15,7 +15,7 @@ The following command, for example, creates a descriptor wallet. More informatio
15 $ bitcoin-cli -named createwallet wallet_name="wallet-01" descriptors=true

Sjors commented at 1:16 pm on February 7, 2022:

Might as well drop descriptors=true from this example. That also removes the need for -named arguments: $ bitcoin-cli createwallet "wallet-01" (quotes can probably be dropped too)

bitcoinhodler commented at 7:39 am on February 9, 2022:

Took your advice except I left the quotes since "wallet-01" is quoted everywhere else in this doc.

in doc/managing-wallets.md:18 in 2a8cb264a6 outdated

14@@ -15,7 +15,7 @@ The following command, for example, creates a descriptor wallet. More informatio
15 $ bitcoin-cli -named createwallet wallet_name="wallet-01" descriptors=true
16 ```
17 
18-The `descriptors` parameter can be omitted if the intention is to create a legacy wallet. For now, the default type is the legacy wallet, but that is expected to change in a future release.
19+The `descriptors` parameter can be set to false if the intention is to create a legacy wallet.

Sjors commented at 1:16 pm on February 7, 2022:

If anyone wants to to this, they can read the docs. So maybe just drop this paragraph.

shaavan commented at 10:28 am on February 9, 2022:

@Sjors

I tried to find information on creating a legacy wallet, but I couldn’t easily find one other than this file. If our goal is to discourage users from creating a new wallet as a legacy wallet, I think it makes to remove this line. However, if that’s not our goal, I think this line shouldn’t be removed.

This file is documentation on managing wallets. I don’t think it’s optimal not to mention how to create a legacy wallet in this file unless our goal is to make it challenging for the user to create a legacy wallet.

Sjors commented at 8:54 am on February 18, 2022:

The goal is not to make it challenging. But this “chapter” is called “Backing Up and Restoring The Wallet”. That seems the wrong context to discuss legacy wallets. Any distraction in an explanation of backups can cause users to think “oh it’s complicated” and end up not making a backup.

Sjors commented at 1:18 pm on February 7, 2022: member

Concept ACK for updating this.

brunoerg commented at 0:22 am on February 8, 2022: member

Concept ACK

RandyMcMillan commented at 0:40 am on February 8, 2022: contributor

Concept ACK

Note: It may be useful to emphasize a few of these warnings.

Screen Shot 2022-02-07 at 7 21 44 PM

https://github.com/RandyMcMillan/bitcoin/commit/9a31565a2565992b1f545e464f07d3bdaf46f10d

Github mutes the bold text but it has good contrast in a desktop markdown viewer.

Update doc to match new default wallet type

Which changed in #23002.

8e9699cb10

bitcoinhodler force-pushed on Feb 9, 2022

bitcoinhodler commented at 7:42 am on February 9, 2022: contributor

Note: It may be useful to emphasize a few of these warnings.

I don’t disagree but it’s a little beyond the scope of what I was trying to do in this PR.

laanwj commented at 5:11 pm on February 9, 2022: member

p.s.: I shall look through the codebase for other probable updates related to this PR.

FWIW there’s further occurences of descriptors=true in doc/multisig-tutorial.md.

in doc/managing-wallets.md:18 in 8e9699cb10

11@@ -12,11 +12,9 @@ In the GUI, the `Create a new wallet` button is displayed on the main screen whe
12 The following command, for example, creates a descriptor wallet. More information about this command may be found by running `bitcoin-cli help createwallet`.
13 
14 ```
15-$ bitcoin-cli -named createwallet wallet_name="wallet-01" descriptors=true
16+$ bitcoin-cli createwallet "wallet-01"
17 ```
18 
19-The `descriptors` parameter can be omitted if the intention is to create a legacy wallet. For now, the default type is the legacy wallet, but that is expected to change in a future release.

luke-jr commented at 1:45 am on February 12, 2022:

Concept ACK removing this one line

luke-jr changes_requested

luke-jr commented at 1:45 am on February 12, 2022: member

Probably better to leave the explicit descriptors=true around as long as the legacy-default versions are supported.

shaavan commented at 10:38 am on February 14, 2022: contributor

FWIW there’s further occurences of descriptors=true in doc/multisig-tutorial.md.

I looked through it, and I think removing the descriptors=true in this documentation would be the right way forward. @bitcoinhodler, this change seems related to this PR. You could probably consider including them here.

laanwj commented at 11:23 am on February 14, 2022: member

Probably better to leave the explicit descriptors=true around as long as the legacy-default versions are supported.

I don’t think this matters. Documentation on the master branch refers only to the code on the master branch.

achow101 commented at 9:49 pm on February 17, 2022: member

ACK 8e9699cb10db9cce9f03675c4a5b625ff2f34fd0

achow101 merged this on Feb 17, 2022

achow101 closed this on Feb 17, 2022

sidhujag referenced this in commit c44b25a950 on Feb 18, 2022

bitcoinhodler deleted the branch on Feb 19, 2022

achow101 referenced this in commit 114754adf4 on Mar 16, 2022

DrahtBot locked this on Feb 19, 2023

docs: Update to match new default wallet type #24281