forked from bitcoin/bitcoin
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
…itcoin#18787, bitcoin#18805, bitcoin#18888, bitcoin#19502, bitcoin#19077, bitcoin#20125, bitcoin#20153, bitcoin#20198, bitcoin#20262, bitcoin#20266, bitcoin#23608, bitcoin#29510 - native descriptor wallets 6b71f27 Merge bitcoin#29510: wallet: `getrawchangeaddress` and `getnewaddress` failures should not affect keypools for descriptor wallets (Ava Chow) 85fa370 refactor: use Params().ExtCoinType() for descriptor wallets (Konstantin Akimov) da8e563 fix: skip functional tests which requires BDB if no bdb (see 20267) (Konstantin Akimov) 4ba44fa fix: skip interface_zmq.py which is not ready to work without bdb (Konstantin Akimov) 45fc8a4 fix: autobackup influences an exclusive locks made by SQLite (Konstantin Akimov) e542cd2 fix: missing changes from bitcoin#21634 (Konstantin Akimov) 2de7aec Merge bitcoin#19502: Bugfix: Wallet: Soft-fail exceptions within ListWalletDir file checks (Samuel Dobson) c172605 Merge bitcoin#19077: wallet: Add sqlite as an alternative wallet database and use it for new descriptor wallets (Samuel Dobson) 2439247 Merge bitcoin#23608: test: fix `feature_rbf.py --descriptors` and add to test runner (fanquake) f6b3614 fix: descriptor wallets follow-up to merge bitcoin#20202: Make BDB support optional (Konstantin Akimov) a340ad6 Merge bitcoin#20262: tests: Skip --descriptor tests if sqlite is not compiled (Samuel Dobson) 7d55046 Merge bitcoin#20125: rpc, wallet: Expose database format in getwalletinfo (Samuel Dobson) 343d4b0 fix: descriptor wallets follow-up for bitcoin#20156: Make sqlite support optional (compile-time) (Konstantin Akimov) fa30777 Merge bitcoin#20198: Show name, format and if uses descriptors in bitcoin-wallet tool (MarcoFalke) 14121ec Merge bitcoin#18888: test: Remove RPCOverloadWrapper boilerplate (MarcoFalke) b18351e Merge bitcoin#20153: wallet: do not import a descriptor with hardened derivations into a watch-only wallet (Wladimir J. van der Laan) c995e5d Merge bitcoin#20266: wallet: fix change detection of imported internal descriptors (Wladimir J. van der Laan) c864582 Merge bitcoin#18787: wallet: descriptor wallet release notes and cleanups (Samuel Dobson) 0949c08 Merge bitcoin#18782: wallet: Make sure no DescriptorScriptPubKeyMan or WalletDescriptor members are left uninitialized after construction (Samuel Dobson) baa6959 Merge bitcoin#18805: tests: Add missing sync_all to wallet_importdescriptors.py (MarcoFalke) 76e08f9 Merge bitcoin#18027: "PSBT Operations" dialog (Samuel Dobson) c1b94b6 fix: wallet should be unlocked before generating keys for Descriptor wallet (Konstantin Akimov) f293c04 Merge bitcoin#16528: Native Descriptor Wallets using DescriptorScriptPubKeyMan (Andrew Chow) 4064334 fix: get receiving address for Descriptor Wallets (Konstantin Akimov) bdbd0b1 chore: dashification of descriptor implementation in dash (UdjinM6) b02fc0b fix: counting calculation of internal keys for Descriptor Wallets (Konstantin Akimov) Pull request description: ## Issue being fixed or feature implemented This PR is a batch of backports and related fixes to add a support of native descriptor wallets to Dash Core. There're more related backports, but this PR is a minimal package of backports to get descriptor wallets working and unit/functional tests to succeed. To do: bitcoin#20226, bitcoin#21049, bitcoin#18788, bitcoin#20267, bitcoin#19230, bitcoin#19239, bitcoin#19441, bitcoin#19568, bitcoin#19979, bitcoin-core/gui#96, bitcoin#19136, bitcoin#21277, bitcoin#21063, bitcoin#21302, bitcoin#19651, bitcoin#20191, bitcoin#22446 and other. Prior work: - #5580 - #5807 ## What was done? backports: - bitcoin#16528 - bitcoin#18027 - bitcoin#18805 - bitcoin#18782 - bitcoin#18787 - bitcoin#20266 - bitcoin#20153 - bitcoin#18888 - bitcoin#20198 - bitcoin#20125 - bitcoin#20262 - bitcoin#23608 - bitcoin#19077 - bitcoin#19502 - bitcoin#29510 and extra fixes and missing changes for bitcoin#20156, bitcoin#20202, bitcoin#20267, bitcoin#21634 + fix of auto-backup for sqlite wallets. ## How Has This Been Tested? There're 2 new functional tests: `wallet_importdescriptors.py` and `wallet_descriptor.py` Beside that many functional tests run twice now: using legacy wallet and descriptor wallets: `wallet_hd.py`, `wallet_basic.py`, `wallet_labels.py`, `wallet_keypool_topup.py`, `wallet_avoidreuse.py`, `rpc_psbt.py`, `wallet_keypool_hd.py`, `rpc_createmultisig.py`, `wallet_encryption.py`. With bitcoin#18788 expected to more tests run. ## Breaking Changes N/A ## Checklist: - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have added or updated relevant unit/integration/functional/e2e tests - [x] I have made corresponding changes to the documentation - [x] I have assigned this pull request to a milestone ACKs for top commit: PastaPastaPasta: Rebase looks good; utACK 6b71f27 PastaPastaPasta: utACK 6b71f27 UdjinM6: utACK 6b71f27 kwvg: utACK 6b71f27 Tree-SHA512: 776c5dfe1eec2b5bebc8d606476cd981c810ac81965b348e78c13e96fff23be500c495ae68c93f669403941c96eccdd3775f2b96572163c34175900e15549b5d
- Loading branch information
Showing
51 changed files
with
3,017 additions
and
463 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
Wallet | ||
------ | ||
|
||
### Experimental Descriptor Wallets | ||
|
||
Please note that Descriptor Wallets are still experimental and not all expected functionality | ||
is available. Additionally there may be some bugs and current functions may change in the future. | ||
Bugs and missing functionality can be reported to the [issue tracker](https://github.com/dashpay/dash/issues). | ||
|
||
v21 introduces a new type of wallet - Descriptor Wallets. Descriptor Wallets store | ||
scriptPubKey information using descriptors. This is in contrast to the Legacy Wallet | ||
structure where keys are used to generate scriptPubKeys and addresses. Because of this | ||
shift to being script based instead of key based, many of the confusing things that Legacy | ||
Wallets do are not possible with Descriptor Wallets. Descriptor Wallets use a definition | ||
of "mine" for scripts which is simpler and more intuitive than that used by Legacy Wallets. | ||
Descriptor Wallets also uses different semantics for watch-only things and imports. | ||
|
||
As Descriptor Wallets are a new type of wallet, their introduction does not affect existing wallets. | ||
Users who already have a Dash Core wallet can continue to use it as they did before without | ||
any change in behavior. Newly created Legacy Wallets (which is the default type of wallet) will | ||
behave as they did in previous versions of Dash Core. | ||
|
||
The differences between Descriptor Wallets and Legacy Wallets are largely limited to non user facing | ||
things. They are intended to behave similarly except for the import/export and watchonly functionality | ||
as described below. | ||
|
||
#### Creating Descriptor Wallets | ||
|
||
Descriptor Wallets are not created by default. They must be explicitly created using the | ||
`createwallet` RPC or via the GUI. A `descriptors` option has been added to `createwallet`. | ||
Setting `descriptors` to `true` will create a Descriptor Wallet instead of a Legacy Wallet. | ||
|
||
In the GUI, a checkbox has been added to the Create Wallet Dialog to indicate that a | ||
Descriptor Wallet should be created. | ||
|
||
Without those options being set, a Legacy Wallet will be created instead. | ||
|
||
#### `IsMine` Semantics | ||
|
||
`IsMine` refers to the function used to determine whether a script belongs to the wallet. | ||
This is used to determine whether an output belongs to the wallet. `IsMine` in Legacy Wallets | ||
returns true if the wallet would be able to sign an input that spends an output with that script. | ||
Since keys can be involved in a variety of different scripts, this definition for `IsMine` can | ||
lead to many unexpected scripts being considered part of the wallet. | ||
|
||
With Descriptor Wallets, descriptors explicitly specify the set of scripts that are owned by | ||
the wallet. Since descriptors are deterministic and easily enumerable, users will know exactly | ||
what scripts the wallet will consider to belong to it. Additionally the implementation of `IsMine` | ||
in Descriptor Wallets is far simpler than for Legacy Wallets. Notably, in Legacy Wallets, `IsMine` | ||
allowed for users to take one type of address (e.g. P2PKH), mutate it into another address type | ||
and the wallet would still detect outputs sending to the new address type | ||
even without that address being requested from the wallet. Descriptor Wallets does not | ||
allow for this and will only watch for the addresses that were explicitly requested from the wallet. | ||
|
||
These changes to `IsMine` will make it easier to reason about what scripts the wallet will | ||
actually be watching for in outputs. However for the vast majority of users, this change is | ||
largely transparent and will not have noticeable effect. | ||
|
||
#### Imports and Exports | ||
|
||
In Legacy Wallets, raw scripts and keys could be imported to the wallet. Those imported scripts | ||
and keys are treated separately from the keys generated by the wallet. This complicates the `IsMine` | ||
logic as it has to distinguish between spendable and watchonly. | ||
|
||
Descriptor Wallets handle importing scripts and keys differently. Only complete descriptors can be | ||
imported. These descriptors are then added to the wallet as if it were a descriptor generated by | ||
the wallet itself. This simplifies the `IsMine` logic so that it no longer has to distinguish | ||
between spendable and watchonly. As such, the watchonly model for Descriptor Wallets is also | ||
different and described in more detail in the next section. | ||
|
||
To import into a Descriptor Wallet, a new `importdescriptors` RPC has been added that uses a syntax | ||
similar to that of `importmulti`. | ||
|
||
As Legacy Wallets and Descriptor Wallets use different mechanisms for storing and importing scripts and keys | ||
the existing import RPCs have been disabled for descriptor wallets. | ||
New export RPCs for Descriptor Wallets have not yet been added. | ||
|
||
The following RPCs are disabled for Descriptor Wallets: | ||
|
||
* importprivkey | ||
* importpubkey | ||
* importaddress | ||
* importwallet | ||
* importelectrumwallet | ||
* dumpprivkey | ||
* dumpwallet | ||
* dumphdinfo | ||
* importmulti | ||
* addmultisigaddress | ||
|
||
#### Watchonly Wallets | ||
|
||
A Legacy Wallet contains both private keys and scripts that were being watched. | ||
Those watched scripts would not contribute to your normal balance. In order to see the watchonly | ||
balance and to use watchonly things in transactions, an `include_watchonly` option was added | ||
to many RPCs that would allow users to do that. However it is easy to forget to include this option. | ||
|
||
Descriptor Wallets move to a per-wallet watchonly model. Instead an entire wallet is considered to be | ||
watchonly depending on whether it was created with private keys disabled. This eliminates the need | ||
to distinguish between things that are watchonly and things that are not within a wallet itself. | ||
|
||
This change does have a caveat. If a Descriptor Wallet with private keys *enabled* has | ||
a multiple key descriptor without all of the private keys (e.g. `multi(...)` with only one private key), | ||
then the wallet will fail to sign and broadcast transactions. Such wallets would need to use the PSBT | ||
workflow but the typical GUI Send, `sendtoaddress`, etc. workflows would still be available, just | ||
non-functional. | ||
|
||
This issue is worsened if the wallet contains both single key (e.g. `pkh(...)`) descriptors and such | ||
multiple key descriptors as some transactions could be signed and broadast and others not. This is | ||
due to some transactions containing only single key inputs, while others would contain both single | ||
key and multiple key inputs, depending on which are available and how the coin selection algorithm | ||
selects inputs. However this is not considered to be a supported use case; multisigs | ||
should be in their own wallets which do not already have descriptors. Although users cannot export | ||
descriptors with private keys for now as explained earlier. | ||
|
||
|
||
## RPC changes | ||
- `createwallet` has changed list of arguments: `createwallet "wallet_name" ( disable_private_keys blank "passphrase" avoid_reuse descriptors load_on_startup )` | ||
`load_on_startup` used to be an argument 5 but now has a number 6. |
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
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
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
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
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
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
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
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
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
Oops, something went wrong.