RPC: Add parameter to addmultisigaddress / createmultisig to sort public keys #8751

afk11 · 2016-09-17T15:44:45Z

I figured it may be useful for these RPC methods to allow sorting public keys (BIP67) The PR adds a new boolean to createmultisig / addmultisigaddress at the end of their parameter list. By default, this is set to false to avoid a BC break.

I added a RPC test file sort_multisig.py for testing createmultisig. Tests for addmultisigaddress went in wallet-accounts.py.

Note: Code to check whether sorting is desired had to be replicated in both RPC methods (not in _createmultisig_redeemScript) because addmultisigaddress already takes a parameter at position 3.

dcousens · 2016-09-18T07:46:23Z

concept ACK

laanwj · 2016-09-22T04:58:58Z

Concept ACK, although I really don't like multiple-optional-positional-boolean APIs. Wish we switched to named arguments any day.

One nit: the RPC help should mention BIP67 by name.

maflcko · 2016-11-08T10:30:24Z

Needs rebase

afk11 · 2016-11-08T15:53:02Z

@MarcoFalke thanks, done. @laanwj I should have mentioned, nits addressed.

One travis run failed due to the compactblocks RPC test.

ryanofsky · 2016-11-08T16:11:23Z

I can't see anything on travis right now (503 errors), but the compactblocks error is probably just the spurious #8842 / #9058 failures.

maflcko · 2016-11-08T17:24:05Z

qa/rpc-tests/sort_multisig.py

+class SortMultisigTest(BitcoinTestFramework):
+    def __init__(self):
+        super().__init__()
+        self.num_nodes = 4


Nit: A single node should be enough?

maflcko · 2016-11-08T17:26:44Z

Concept ACK 7d7a64726991ff087cb8125e0c7277173a688dc7

luke-jr · 2016-11-24T06:08:28Z

src/rpc/misc.cpp

@@ -293,6 +294,7 @@ UniValue createmultisig(const JSONRPCRequest& request)
            "       \"key\"    (string) bitcoin address or hex-encoded public key\n"
            "       ,...\n"
            "     ]\n"
+            "3. \"fSort\"      (bool, optional) Whether to sort public keys according to BIP67. Default setting is false.\n"


Is it a string or a boolean?

It should be a boolean. Just observed they aren't usually quoted in RPC output, fixing now.

afk11 · 2016-11-24T10:25:39Z

I probably shouldn't have squashed @MarcoFalke, I'm sorry for rebasing out the commit you reviewed. The only thing to change this time was the removal of "'s from the RPC help message.

luke-jr

Code looks reasonably correct, just a few nits. Did not verify tests.

luke-jr · 2016-11-25T08:57:56Z

src/rpc/misc.cpp

            "2. \"keys\"       (string, required) A json array of keys which are bitcoin addresses or hex-encoded public keys\n"
            "     [\n"
            "       \"key\"    (string) bitcoin address or hex-encoded public key\n"
            "       ,...\n"
            "     ]\n"
+            "3. fSort        (bool, optional) Whether to sort public keys according to BIP67. Default setting is false.\n"


Rather have a named-options Object interface here.

luke-jr · 2016-11-25T08:59:54Z

src/script/standard.cpp

+    vEncoded.resize(keys.size());
+    BOOST_FOREACH(const CPubKey& key, keys) {
+        vEncoded[nEncoded++] = ToByteVector(key);
+    }


Seems like the loop would be better as:

for (size_t n = 0; n < keys.size(); ++n) { vEncoded[n] = ToByteVector(keys[n]); }

luke-jr · 2016-11-25T09:00:46Z

src/script/standard.cpp

-    CScript script;
+    int nEncoded = 0;
+    std::vector<std::vector<unsigned char>> vEncoded;
+    vEncoded.resize(keys.size());


Wouldn't it be better to reserve and then emplace_back?

luke-jr · 2016-11-25T09:02:54Z

src/script/standard.cpp

+    }
+
+    if (fSorted) {
+        std::sort(vEncoded.begin(), vEncoded.end());


I think this should do what BIP 67 requires, but someone more familiar with C++ and its locale support (or lack thereof) should probably confirm.

luke-jr · 2016-11-25T09:03:41Z

src/script/standard.h

@@ -78,7 +78,7 @@ bool ExtractDestinations(const CScript& scriptPubKey, txnouttype& typeRet, std::

 CScript GetScriptForDestination(const CTxDestination& dest);
 CScript GetScriptForRawPubKey(const CPubKey& pubkey);
-CScript GetScriptForMultisig(int nRequired, const std::vector<CPubKey>& keys);
+CScript GetScriptForMultisig(int nRequired, const std::vector<CPubKey>& keys, bool fSorted);


Maybe default fSorted to false here rather than modify all the tests?

luke-jr · 2016-11-25T09:04:20Z

src/wallet/rpcwallet.cpp

            "2. \"keysobject\"   (string, required) A json array of bitcoin addresses or hex-encoded public keys\n"
            "     [\n"
            "       \"address\"  (string) bitcoin address or hex-encoded public key\n"
            "       ...,\n"
            "     ]\n"
            "3. \"account\"      (string, optional) DEPRECATED. An account to assign the addresses to.\n"
+            "4. fSort          (bool, optional) Whether to sort public keys according to BIP67. Default setting is false.\n"


As before, rather turn param 3 into an options Object.

…g_redeemScript to allow sorting of public keys (BIP67) addmultisig/createmultisig RPC documentation: Remove stray quotes from fSort parameter Github-Pull: bitcoin#8751 Rebased-From: 7439562df15db643253c6ac734aeaa0ef66c0c88

luke-jr · 2016-12-21T09:14:19Z

Should update doc/bips.md also.

luke-jr · 2017-02-04T20:51:08Z

I rebased and addressed all the nits; pushed this to luke-jr/sort-multisigs

@afk11 Are you still maintaining this? Can you pull my changes?

git checkout sort-multisigs
git fetch git://github.com/luke-jr/bitcoin sort-multisigs
git reset --hard FETCH_HEAD
git push ...

afk11 · 2017-02-06T20:10:21Z

Sorry, yep I can pull these!

I wanted to wait until named parameters was merged before hand, so I could avoid adding a positional parameter before the accounts parameters were changed

I'll look at this in the next day or so (away from internet atm) wanna finish this up

afk11 · 2017-03-08T19:55:28Z

Merged commits and rebased. Apologies for the delay!

afk11 · 2017-03-08T20:21:22Z

The Apple build failed because the job time exceeded the maximum :/

afk11 · 2017-03-14T08:47:01Z

Rebased

jnewbery · 2017-06-15T14:20:34Z

Perhaps I'm missing something, but I don't see the need for this. The addmultisigaddress RPC creates the multisig script with the keys in the order provided. Why not just have the client provide keys in sorted order if you want the script to be BIP-67 compliant?

It doesn't look like this PR is enforcing that the provided keys are compressed, so even with this PR, there are still expectations placed on the client.

afk11 · 2017-06-16T14:30:15Z

I think if developers are already committing to using the RPC to make a multisig script, making it easier to produce the same representation is more important than not.

You are correct the PR as it stands doesn't validate it.. fixing this now.

jnewbery · 2017-06-16T15:23:09Z

I'm still a weak concept NACK for this. I don't agree that we should add complexity to the server when the same outcome can be achieved by simply running a sort() function on the client before calling the RPC. Sometimes there's good reason to add that complexity to the server - see for example #9991 which adds a filter to save significantly on bandwidth and server resources. In this case I don't see the benefit.

Sorry if that sounds negative - I think there needs to be some bar for adding new RPCs and arguments to avoid bloat.

However, if I'm wrong and there's widespread consensus that this is useful functionality and should be merged, can I at least ask that you use named arguments instead of an Options object? There's really no need for Options objects in RPC calls since named args were added in #8811.

afk11 · 2017-06-19T08:53:10Z

Both RPC methods take an options object for this (sorry, the PR description wasn't updated with this)
https://github.com/bitcoin/bitcoin/pull/8751/files#diff-ad6efdc354b57bd1fa29fc3abb6e2872R353
https://github.com/bitcoin/bitcoin/pull/8751/files#diff-df7d84ff2f53fcb2a0dc15a3a51e55ceR1050

I appreciate where you are coming from and agree that most people can probably sort themselves, but they could also build a multisig script out of the keys and m/n. It's been a while since I've even used the RPC, but remember well the time when I didn't have a bitcoin library to do it all.

I think it's worth including since once they continue using the flag, requests which mistakenly use the wrong order will reproduce the same redeem script (instead of always having a stateful order of public keys), and likewise with libraries that support it.

luke-jr · 2017-08-18T14:49:24Z

src/script/standard.cpp

-    CScript script;
+    std::vector<std::vector<unsigned char>> vEncoded;
+    vEncoded.reserve(keys.size());
+    BOOST_FOREACH(const CPubKey& key, keys) {


We're not using BOOST_FOREACH anymore I think. (Also below)

luke-jr · 2017-08-21T21:33:58Z

Rebased and squashed a bit.

git checkout sort-multisigs && git fetch git://github.com/luke-jr/bitcoin sort-multisigs && git reset --hard FETCH_HEAD && git push ...

TheBlueMatt · 2017-09-29T18:13:05Z

Concept ACK. Care to rebase?

afk11 · 2017-09-30T14:31:38Z

Rebased, sorry for the delay. Updated to check that keys are compressed before allowing sorting, and added more tests for this.

Updated the docs/bips.md document to mention 0.15.1 instead of 0.15.0 (let me know whatever's best for this)

TheBlueMatt · 2017-10-02T22:37:51Z

Hmm, hate to reopen it, but now that we do actually have named arguments, could you rever to just adding a new boolean argument? options objects are just redundant now, and having options alias account in addmultisigaddress is just gross. Everything else seems fine at first glance.

@jnewbery I'd generally agree with you, but, at least in principal, I think BIP67 is worth it.

…sig methods Also add accounts parameter to vRPCConvertParams (required by RPC mappings test) Github-Pull: bitcoin#8751 Rebased-From: 4833935

Github-Pull: bitcoin#8751 Rebased-From: 2638389

sort_multisig test: check uncompressed keys are disallowed sort_multisig: add test demonstrating sorting wallet-accounts: test addmultisigaddress fails if sort=true and (wallet) address is uncompressed Github-Pull: bitcoin#8751 Rebased-From: 50e2ff5

…g_redeemScript to allow sorting of public keys (BIP67) addmultisig/createmultisig RPC documentation: Remove stray quotes from fSort parameter

sort_multisig test: check uncompressed keys are disallowed sort_multisig: add test demonstrating sorting wallet-accounts: test addmultisigaddress fails if sort=true and (wallet) address is uncompressed

afk11 · 2017-12-02T16:18:00Z

@TheBlueMatt that's fine, revised the PR now.

I missed the boat again for v0.15.1, suggestions for a release to mention in bips.md?

luke-jr · 2018-03-01T22:59:50Z

Hmm, hate to reopen it, but now that we do actually have named arguments, could you rever to just adding a new boolean argument? options objects are just redundant now, and having options alias account in addmultisigaddress is just gross. Everything else seems fine at first glance.

Strongly disagree. Named arguments is not a reason to have a terrible positional arguments API. Uncommon options should go through an options argument when positional arguments are used.

The account alias is merely for backward compatibility.

luke-jr · 2018-03-01T23:01:14Z

src/wallet/rpcwallet.cpp

    {
-        std::string msg = "addmultisigaddress nrequired [\"key\",...] ( \"account\" )\n"
+        std::string msg = "addmultisigaddress nrequired [\"key\",...] ( \"account\" ) ( sort )\n"


Please switch back to an options object for this.

luke-jr · 2018-03-01T23:01:24Z

src/wallet/rpcwallet.cpp

            "\nAdd a nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup.\n"
+


This blank line won't be in the actual help, so has no purpose here.

laanwj · 2018-08-31T11:13:55Z

Closing and putting "up for grabs" label

afk11 force-pushed the sort-multisigs branch from 69b421d to 3a20d17 Compare September 17, 2016 18:00

fanquake added the RPC/REST/ZMQ label Sep 18, 2016

laanwj mentioned this pull request Sep 26, 2016

rpc: Add support for JSON-RPC named arguments #8811

Merged

afk11 force-pushed the sort-multisigs branch from 3a20d17 to 2963bec Compare October 4, 2016 15:48

afk11 force-pushed the sort-multisigs branch 2 times, most recently from 0c9f570 to 7d7a647 Compare November 8, 2016 14:54

maflcko reviewed Nov 8, 2016

View reviewed changes

luke-jr reviewed Nov 24, 2016

View reviewed changes

afk11 force-pushed the sort-multisigs branch from 7d7a647 to 7439562 Compare November 24, 2016 10:23

luke-jr suggested changes Nov 25, 2016

View reviewed changes

afk11 force-pushed the sort-multisigs branch 2 times, most recently from 8d5106b to 71c4420 Compare March 8, 2017 18:41

afk11 force-pushed the sort-multisigs branch 3 times, most recently from ebca39a to e00d003 Compare March 14, 2017 08:29

afk11 force-pushed the sort-multisigs branch from e00d003 to 30f2ac9 Compare March 30, 2017 19:21

luke-jr reviewed Aug 18, 2017

View reviewed changes

afk11 force-pushed the sort-multisigs branch from 69a90ec to 464827a Compare August 24, 2017 23:05

afk11 force-pushed the sort-multisigs branch from 464827a to 222cfb9 Compare September 7, 2017 19:28

afk11 force-pushed the sort-multisigs branch from 222cfb9 to 50e2ff5 Compare September 30, 2017 14:30

luke-jr pushed a commit to bitcoinknots/bitcoin that referenced this pull request Nov 6, 2017

Ensure whilst sorting only compressed public keys are used

48517f9

Github-Pull: bitcoin#8751 Rebased-From: 2638389

afk11 and others added 5 commits December 2, 2017 13:38

RPC: addmultisigaddress / createmultisig: parameterize _createmultisi…

5a2da09

…g_redeemScript to allow sorting of public keys (BIP67) addmultisig/createmultisig RPC documentation: Remove stray quotes from fSort parameter

script: GetScriptForRawPubKey: More efficient key-encoding loop

ee9110a

doc/bips: Add BIP 67

fcbf6cc

Ensure whilst sorting only compressed public keys are used

6fbcf50

Add more tests to sort_multisigs.py / wallet-accounts.py

e11cb50

sort_multisig test: check uncompressed keys are disallowed sort_multisig: add test demonstrating sorting wallet-accounts: test addmultisigaddress fails if sort=true and (wallet) address is uncompressed

afk11 force-pushed the sort-multisigs branch from 50e2ff5 to e11cb50 Compare December 2, 2017 15:40

luke-jr reviewed Mar 2, 2018

View reviewed changes

maflcko added the Needs rebase label Jun 6, 2018

laanwj closed this Aug 31, 2018

laanwj added the Up for grabs label Aug 31, 2018

laanwj removed the Needs rebase label Oct 24, 2019

bitcoin locked as resolved and limited conversation to collaborators Dec 16, 2021

		"\nAdd a nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup.\n"

RPC: Add parameter to addmultisigaddress / createmultisig to sort public keys #8751

RPC: Add parameter to addmultisigaddress / createmultisig to sort public keys #8751

Conversation

afk11 commented Sep 17, 2016

dcousens commented Sep 18, 2016

laanwj commented Sep 22, 2016 • edited Loading

maflcko commented Nov 8, 2016

afk11 commented Nov 8, 2016

ryanofsky commented Nov 8, 2016

Choose a reason for hiding this comment

maflcko commented Nov 8, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afk11 commented Nov 24, 2016

luke-jr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luke-jr Nov 25, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luke-jr commented Dec 21, 2016

luke-jr commented Feb 4, 2017

afk11 commented Feb 6, 2017

afk11 commented Mar 8, 2017

afk11 commented Mar 8, 2017

afk11 commented Mar 14, 2017

jnewbery commented Jun 15, 2017

afk11 commented Jun 16, 2017

jnewbery commented Jun 16, 2017

afk11 commented Jun 19, 2017

Choose a reason for hiding this comment

luke-jr commented Aug 21, 2017

TheBlueMatt commented Sep 29, 2017

afk11 commented Sep 30, 2017

TheBlueMatt commented Oct 2, 2017

afk11 commented Dec 2, 2017

luke-jr commented Mar 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

laanwj commented Aug 31, 2018

laanwj commented Sep 22, 2016 •

edited

Loading

luke-jr Nov 25, 2016 •

edited

Loading