rpc: add ability to export/import descriptor files in `listdescriptors` and `importdescriptors` #25747

w0xlt · 2022-07-30T05:30:26Z

This PR adds a new parameter save_to_file to listdescriptors RPC, allowing the user to save the descriptors directly to a file and also adds a new parameter desriptor_file to importdescriptors RPC, allowing the user to import the descriptors directly from a file.

The first and second commits add the options parameter in a way that maintains compatibility with the previous private parameter.

With this PR, exporting / importing descriptors and creating watch-only wallet is as simple as:

$ bitcoin-cli -rpcwallet="cold_wallet"  listdescriptors "{\"save_to_file\": \"/home/user/Downloads/desc.json\"}"
$ bitcoin-cli -rpcwallet="watch_only_wallet"  importdescriptors "{\"descriptor_file\": \"/home/user/Downloads/desc.json\"}"

Without this PR, the user can manually create a file from the listdescriptors output or use jq to extract the descriptor field from listdescriptors but the idea here is to make things more automated and standardized.

And this also opens the way to add the functionality of importing descriptors from files in the GUI,

author: Luke Dashjr <luke-jr+git@utopios.org>

This changes `listdescriptors` to accept `options` parameter but retains compatibility with the previous `private` parameter.

kristapsk · 2022-07-30T06:45:49Z

What's the point? Why can't you just redirect bitcoin-cli output to the file?

DrahtBot · 2022-07-30T14:03:29Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#26156 (test: check that listdescriptors descriptor strings are sorted by theStack)
#26074 (refactor: Set RPCArg options with designated initializers by MarcoFalke)
#22838 (descriptors: Be able to specify change and receiving in a single descriptor string by achow101)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

w0xlt · 2022-07-31T05:44:08Z

@kristapsk with #25757, perhaps the purpose of this PR has become clearer.

From the #25757 description:
With these PRs, exporting / importing descriptors and creating watch-only wallet is as simple as:

$ bitcoin-cli -rpcwallet="cold_wallet"  listdescriptors "{\"save_to_file\": \"/home/user/Downloads/desc.json\"}"
$ bitcoin-cli -rpcwallet="watch_only_wallet"  importdescriptors "{\"descriptor_file\": \"/home/user/Downloads/desc.json\"}"

Without these PRs, the user can manually create a file from the listdescriptors output or use jq to extract the descriptor field from listdescriptors but the idea here is to make things more automated and standardized.

And this also opens the way to add the functionality of importing descriptors from files in the GUI,

aureleoules · 2022-08-02T09:01:57Z

Concept ACK considering #25757 exists. I think you should add the other PR's commits to this one.
I believe this makes exporting and importing descriptors easier.

aureleoules

I was able to save the descriptor file with
./src/bitcoin-cli -regtest -rpcwallet=test listdescriptors '{"save_to_file": "my_desc"}'
But I feel like the syntax is a bit much, is there a way to simplify it?

In this case, it would be simplier to just do ./src/bitcoin-cli -regtest -rpcwallet=test listdescriptors > my_desc

aureleoules · 2022-08-02T09:10:43Z

test/functional/wallet_listdescriptors.py

+        desc_file = os.path.join(node.datadir, 'desc.json')
+        assert_equal({
+            'wallet_name': 'w2',
+            'descriptor_file': desc_file
+            }, wallet.listdescriptors({'save_to_file': desc_file}))
+
+        with open(desc_file, encoding="utf8") as json_file:
+            assert_equal(expected['descriptors'], json.load(json_file))



maybe add a case when the file already exists?

Done in dd96b3d.

This changes `importdescriptors` to accept `options` parameter but maintains compatibility with the previous `requests` parameter.

w0xlt · 2022-08-02T19:20:55Z

@aureleoules As suggested, I merged the other PR's commit to this one.

Note that ./src/bitcoin-cli -regtest -rpcwallet=test listdescriptors > my_desc does not create a descriptor file, but a file whose content is the RPC response. You cannot directly import the content of this file into importdescriptors.

The save_to_file option writes in the file only the descriptors attribute of the response.

S3RK · 2022-08-08T07:52:41Z

Concept NACK. Using shell redirection is enough for CLI. Probably this change is better fitting with the GUI.

luke-jr · 2022-08-09T23:30:46Z

Concept NACK. I think we're trying to eliminate file-based RPC methods? At the very least, we shouldn't make RPC methods that do both file-based and non-file-based access...

w0xlt · 2022-08-10T02:28:25Z

This PR assumes that using descriptor files is a less error-prone and less manual way of creating watch-only wallets than the current way.

If it is not the case, what is the current workflow to create a watch-only wallet ?

luke-jr · 2022-08-10T20:09:01Z

For that use case, I would suggest a RPC method that makes a watch-only copy of a loaded wallet.

DrahtBot · 2022-09-27T10:02:10Z

🐙 This pull request conflicts with the target branch and needs rebase.

_{Want to unsubscribe from rebase notifications on this pull request? Just convert this pull request to a "draft".}

achow101 · 2022-10-12T19:54:06Z

This PR does not seem to have conceptual support. Please leave a comment if you would like this to be reopened.

w0xlt added 2 commits July 30, 2022 01:17

RPC: Support specifying different types for param aliases

f7337ff

author: Luke Dashjr <luke-jr+git@utopios.org>

rpc: change listdescriptors to accept options parameter

9569ff9

This changes `listdescriptors` to accept `options` parameter but retains compatibility with the previous `private` parameter.

DrahtBot added the RPC/REST/ZMQ label Jul 30, 2022

DrahtBot mentioned this pull request Jul 30, 2022

mempool, refactor: add MemPoolBypass #25577

Closed

w0xlt force-pushed the desc_file branch from bd5a1b0 to c8840eb Compare July 31, 2022 02:01

w0xlt mentioned this pull request Jul 31, 2022

rpc: add a new parameter desriptor_file to importdescriptors RPC #25757

Closed

w0xlt mentioned this pull request Jul 31, 2022

ci: AssertionError: 1759238429.9936483 <= 1759238430 in wallet_encryption.py --descriptors #25758

Closed

aureleoules reviewed Aug 2, 2022

View reviewed changes

w0xlt added 3 commits August 2, 2022 16:08

rpc: add save_to_file option to listdescriptors

dd96b3d

rpc: change importdescriptors to accept options parameter

9c129d1

This changes `importdescriptors` to accept `options` parameter but maintains compatibility with the previous `requests` parameter.

rpc: add descriptor_file option to importdescriptors

28b26c4

w0xlt force-pushed the desc_file branch from 68eb11c to 28b26c4 Compare August 2, 2022 19:08

w0xlt changed the title ~~rpc: add a new parameter save_to_file to listdescriptors RPC~~ rpc: add ability to export/import descriptor files in listdescriptors and importdescriptors Aug 2, 2022

DrahtBot mentioned this pull request Aug 4, 2022

descriptors: Be able to specify change and receiving in a single descriptor string #22838

Merged

This was referenced Sep 8, 2022

refactor: Run type check against RPCArgs (1/2) #26039

Merged

refactor: Set RPCArg options with designated initializers #26074

Merged

DrahtBot mentioned this pull request Sep 26, 2022

test: check that listdescriptors descriptor strings are sorted #26156

Merged

DrahtBot added the Needs rebase label Sep 27, 2022

achow101 closed this Oct 12, 2022

bitcoin locked and limited conversation to collaborators Oct 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

rpc: add ability to export/import descriptor files in `listdescriptors` and `importdescriptors` #25747

rpc: add ability to export/import descriptor files in `listdescriptors` and `importdescriptors` #25747

Uh oh!

w0xlt commented Jul 30, 2022 •

edited

Loading

Uh oh!

kristapsk commented Jul 30, 2022

Uh oh!

DrahtBot commented Jul 30, 2022 •

edited

Loading

Uh oh!

w0xlt commented Jul 31, 2022 •

edited

Loading

Uh oh!

aureleoules commented Aug 2, 2022

Uh oh!

aureleoules left a comment

Uh oh!

aureleoules Aug 2, 2022

Uh oh!

w0xlt Aug 2, 2022 •

edited

Loading

Uh oh!

w0xlt commented Aug 2, 2022

Uh oh!

S3RK commented Aug 8, 2022

Uh oh!

luke-jr commented Aug 9, 2022

Uh oh!

w0xlt commented Aug 10, 2022

Uh oh!

luke-jr commented Aug 10, 2022

Uh oh!

DrahtBot commented Sep 27, 2022

Uh oh!

achow101 commented Oct 12, 2022

Uh oh!

Uh oh!

rpc: add ability to export/import descriptor files in listdescriptors and importdescriptors #25747

rpc: add ability to export/import descriptor files in listdescriptors and importdescriptors #25747

Uh oh!

Conversation

w0xlt commented Jul 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kristapsk commented Jul 30, 2022

Uh oh!

DrahtBot commented Jul 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Conflicts

Uh oh!

w0xlt commented Jul 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aureleoules commented Aug 2, 2022

Uh oh!

aureleoules left a comment

Choose a reason for hiding this comment

Uh oh!

aureleoules Aug 2, 2022

Choose a reason for hiding this comment

Uh oh!

w0xlt Aug 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

w0xlt commented Aug 2, 2022

Uh oh!

S3RK commented Aug 8, 2022

Uh oh!

luke-jr commented Aug 9, 2022

Uh oh!

w0xlt commented Aug 10, 2022

Uh oh!

luke-jr commented Aug 10, 2022

Uh oh!

DrahtBot commented Sep 27, 2022

Uh oh!

achow101 commented Oct 12, 2022

Uh oh!

Uh oh!

rpc: add ability to export/import descriptor files in `listdescriptors` and `importdescriptors` #25747

rpc: add ability to export/import descriptor files in `listdescriptors` and `importdescriptors` #25747

w0xlt commented Jul 30, 2022 •

edited

Loading

DrahtBot commented Jul 30, 2022 •

edited

Loading

w0xlt commented Jul 31, 2022 •

edited

Loading

w0xlt Aug 2, 2022 •

edited

Loading