Add friendly output to dumpwallet #9740

aideca · 2017-02-11T05:47:29Z

Add friendly output to dumpwallet #9564.

Add help message.
Show created dumpfile path.
Add rpc test.

laanwj · 2017-02-11T07:32:10Z

src/wallet/rpcdump.cpp

@@ -572,7 +576,9 @@ UniValue dumpwallet(const JSONRPCRequest& request)
    EnsureWalletIsUnlocked();

    ofstream file;
-    file.open(request.params[0].get_str().c_str());
+    boost::filesystem::path filepath = request.params[0].get_str();
+    filepath = absolute(filepath);


Interesting. Shouldn't it be only accepting absolute paths in the first place?
Otherwise it will depend on the directory that bitcoind happens to have been started in, that'd be pretty crappy API design.

Thanx.
IMO, it is better to inform users that path argument is from the viewpoint of bitcoind either absolute nor relative.
The problem is that users expects path argument is the viewpoint of RPC-caller, but actually the one of bitcoind. The former is not same as the latter even if absolute path if they executed on different docker.
So i added doc and output at this time.

Maybe an absolute path or if not, relative to the data-dir? If possible?

Also is there a "namespaced" name for this function? E.g., boost::filesystem::absolute? It'd be good to use the fully qualified name, otherwise it's difficult to hunt down such dependencies/lookup documentation.

I don't have a firm opinion to add to the above conversation though, except that I would add a way to get dumpwallet to serialize results across network (although dangerous if unencrypted/authenticated link) in case the user wants the wallet dump locally (RPC may even be called on a different machine let alone different directory as @aideca points out).

Maybe an absolute path or if not, relative to the data-dir? If possible?

Good idea. It's our (effective) convention for command line arguments as well. I think it would be good to chdir the daemon to the data directory at start. This also avoids issues with the daemon holding on to resources (e.g. the starting directory could be deleted later) discussed in #8278.

RPC may even be called on a different machine

A way to dump the wallet over the network could be useful. The practical problem is that there is currently no way to do streaming writes to the network from RPC code, so the entire wallet would have to be dumped in memory, which would result in huge memory and parsing/generating overhead. I looked at streaming to the HTTP in a different context here: #7759.

Also yes there's a bit of a security concern though it's no different from dumpprivkey and friends...

maflcko · 2017-02-11T11:43:08Z

utACK 48abaea

JeremyRubin · 2017-02-14T12:59:40Z

utACK 48abaea.

I also want to explicitly approve of the returning of a JSON rather than a plain string, it may be useful (in future work?) to augment this call's return value with other data as well (e.g., which user owns the dump file, how many keys were dumped, etc).

laanwj · 2017-02-14T13:23:02Z

This seems ready to be merged once 0.14 is branched off.

jnewbery

Definite concept ACK. A couple of nitty comments about language.

I agree that it'd be better to change the default location to be the bitcoin datadir if possible, but that might be out of scope of this small PR.

jnewbery · 2017-02-17T19:46:34Z

src/wallet/rpcdump.cpp

+            "1. \"filename\"    (string, required) The filename (if not full path, relative to bitcoind path)\n"
+            "\nResult:\n"
+            "{                           (json object)\n"
+            "  \"dumpfilepath\" : {        (string) The filename\n"


I'd prefer to use the name "filename" (since this isn't just the path). You could change the help text to say "The filename with full absolute path"

jnewbery · 2017-02-17T19:47:34Z

src/wallet/rpcdump.cpp

@@ -561,7 +561,11 @@ UniValue dumpwallet(const JSONRPCRequest& request)
            "dumpwallet \"filename\"\n"
            "\nDumps all wallet keys in a human-readable format.\n"
            "\nArguments:\n"
-            "1. \"filename\"    (string, required) The filename\n"
+            "1. \"filename\"    (string, required) The filename (if not full path, relative to bitcoind path)\n"


The text is a bit clunky here. Perhaps "The filename with path (either absolute or relative to bitcoind)" is better?

aideca · 2017-03-12T11:53:39Z

Thank you for your comments and sorry for my late reply.

I just updated help text and qualified function name.
"chdir daemon to the data-dir" and "dump the wallet over the network" are quite interesting. But it's out of scope of this PR as jnewbery said.

achow101 · 2017-04-10T22:00:52Z

Needs rebase.

aideca · 2017-04-13T10:09:39Z

Thanx! rebased & fixuped.

paveljanik · 2017-04-17T16:08:58Z

ACK 164019d

164019d Add dumpwallet output test (aideca) 9f82134 Add friendly output to dumpwallet refs #9564 (aideca) Tree-SHA512: 913fcf18d42eebe34173f1f2519973494b1ad2d86d125ff4bf566d6c64aa501c02f8831e6f44812cd87a46916f61c6f510146af406865b31856d8336c173569f

164019d Add dumpwallet output test (aideca) 9f82134 Add friendly output to dumpwallet refs bitcoin#9564 (aideca) Tree-SHA512: 913fcf18d42eebe34173f1f2519973494b1ad2d86d125ff4bf566d6c64aa501c02f8831e6f44812cd87a46916f61c6f510146af406865b31856d8336c173569f

laanwj added the RPC/REST/ZMQ label Feb 11, 2017

laanwj reviewed Feb 11, 2017

View reviewed changes

laanwj added this to the 0.15.0 milestone Feb 14, 2017

jnewbery reviewed Feb 17, 2017

View reviewed changes

laanwj mentioned this pull request Mar 7, 2017

rpc: Prevent dumpwallet from overwriting files #9937

Merged

aideca added 2 commits April 13, 2017 08:39

Add friendly output to dumpwallet refs bitcoin#9564

9f82134

Add dumpwallet output test

164019d

aideca force-pushed the dumpwallet branch from 6a5279c to 164019d Compare April 13, 2017 09:05

laanwj merged commit 164019d into bitcoin:master Jun 5, 2017

laanwj mentioned this pull request Jun 5, 2017

TODO for release notes 0.15.0 #9889

Closed

12 tasks

cdecker mentioned this pull request Sep 3, 2017

dumpwallet behavior #9564

Closed

bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add friendly output to dumpwallet #9740

Add friendly output to dumpwallet #9740

aideca commented Feb 11, 2017

laanwj Feb 11, 2017

aideca Feb 13, 2017

jonasschnelli Feb 13, 2017

JeremyRubin Feb 14, 2017

laanwj Feb 14, 2017

maflcko commented Feb 11, 2017

JeremyRubin commented Feb 14, 2017

laanwj commented Feb 14, 2017

jnewbery left a comment

jnewbery Feb 17, 2017

jnewbery Feb 17, 2017

aideca commented Mar 12, 2017

achow101 commented Apr 10, 2017

aideca commented Apr 13, 2017

paveljanik commented Apr 17, 2017

Add friendly output to dumpwallet #9740

Add friendly output to dumpwallet #9740

Conversation

aideca commented Feb 11, 2017

laanwj Feb 11, 2017

Choose a reason for hiding this comment

aideca Feb 13, 2017

Choose a reason for hiding this comment

jonasschnelli Feb 13, 2017

Choose a reason for hiding this comment

JeremyRubin Feb 14, 2017

Choose a reason for hiding this comment

laanwj Feb 14, 2017

Choose a reason for hiding this comment

maflcko commented Feb 11, 2017

JeremyRubin commented Feb 14, 2017

laanwj commented Feb 14, 2017

jnewbery left a comment

Choose a reason for hiding this comment

jnewbery Feb 17, 2017

Choose a reason for hiding this comment

jnewbery Feb 17, 2017

Choose a reason for hiding this comment

aideca commented Mar 12, 2017

achow101 commented Apr 10, 2017

aideca commented Apr 13, 2017

paveljanik commented Apr 17, 2017