Add Sapling support to z_getnewaddress and z_listaddresses #3429

str4d · 2018-07-30T15:30:59Z

Closes #3217.

Regtest addresses are 91 characters, and ZIP 32's Bech32 encoding will be significantly longer.

Eirik0 · 2018-07-30T16:46:30Z

I am getting a "Permission denied" error when I run ./qa/pull-tester/rpc-tests.sh wallet_addresses.py. Are the permissions for these files something we are supposed to be updating manually? I have run in to this before.

str4d · 2018-07-30T16:50:40Z

@Eirik0 try removing the cache folder inside your zcash directory and then run the test again. I am guessing that the permissions on the cache folder (which this test uses) might have been corrupted at some point.

Eirik0 · 2018-07-30T16:54:48Z

It was actually the wallet_addresses.py file. I updated that manually and that fixed the problem. I have seen this before when I have created new rpc tests and done the chmod before pushing. I wasn't sure if this was something that was supposed to be happening automatically.

Eirik0

Looks good! I suggested a couple of minor changes.

Eirik0 · 2018-07-30T17:32:15Z

qa/rpc-tests/wallet_addresses.py

+            assert(res['isvalid'])
+            assert(res['ismine'])
+            assert_equal(res['type'], 'sapling')
+            assert(addr in self.nodes[0].z_listaddresses())


Something like

types_and_addresses = [ (default_type, self.nodes[0].z_getnewaddress()), ('sprout', self.nodes[0].z_getnewaddress('sprout')), ('sapling', self.nodes[0].z_getnewaddress('sapling')) ] all_addresses = self.nodes[0].z_listaddresses() for addr_type, addr in types_and_addresses: res = self.nodes[0].z_validateaddress(addr) assert(res['isvalid']) assert(res['ismine']) assert_equal(addr_type, res['type']) assert(addr in all_addresses)

would make it clear we are doing the same for the three scenarios.

Eirik0 · 2018-07-30T17:33:40Z

src/bech32.cpp

@@ -169,7 +169,7 @@ std::pair<std::string, data> Decode(const std::string& str) {
    }
    if (lower && upper) return {};
    size_t pos = str.rfind('1');
-    if (str.size() > 90 || pos == str.npos || pos == 0 || pos + 7 > str.size()) {
+    if (str.size() > 1023 || pos == str.npos || pos == 0 || pos + 7 > str.size()) {


Where does the number 1023 come from?

From BIP 173:

Even though the chosen code performs reasonably well up to 1023 characters, other designs are preferable for lengths above 89 characters (excluding the separator).

We've decided that our addresses are generally small enough that sticking with the established Bech32 encoding for longer encodings is sufficient.

Eirik0 · 2018-07-30T17:41:44Z

src/keystore.h

@@ -251,6 +252,19 @@ class CBasicKeyStore : public CKeyStore
    virtual bool GetSaplingIncomingViewingKey(
        const libzcash::SaplingPaymentAddress &addr, 
        libzcash::SaplingIncomingViewingKey& ivkOut) const;
+    void GetSaplingPaymentAddresses(std::set<libzcash::SaplingPaymentAddress> &setAddress) const


It would be nice if void GetPaymentAddresses(std::set<libzcash::SproutPaymentAddress> &setAddress) const were renamed to reflect that it is now Sprout specific.

That can happen in a later PR, probably after 2.0.0 due to time pressure.

Eirik0 · 2018-07-30T22:10:53Z

src/wallet/gtest/test_wallet_zkeys.cpp

+    // verify there are two keys
+    wallet.GetSaplingPaymentAddresses(addrs);
+    ASSERT_EQ(2, addrs.size());
+    ASSERT_EQ(1, addrs.count(address));


What about adding ASSERT_EQ(1, addrs.count(sk.default_address()));?

Eirik0 · 2018-07-30T22:12:52Z

src/wallet/rpcwallet.cpp

            "\nExamples:\n"
            + HelpExampleCli("z_getnewaddress", "")
+            + HelpExampleCli("z_getnewaddress", ADDR_TYPE_SAPLING)
            + HelpExampleRpc("z_getnewaddress", "")


Why do we update HelpExampleCli, but not HelpExampleRpc?

I just didn't add an example, because you can conceptually reuse the CLI examples inside the RPC ones (and pretty much everywhere else only one RPC example is given).

Eirik0 · 2018-07-30T22:16:58Z

src/wallet/rpcwallet.cpp

@@ -3100,24 +3103,40 @@ UniValue z_getnewaddress(const UniValue& params, bool fHelp)
    if (!EnsureWalletIsAvailable(fHelp))
        return NullUniValue;

-    if (fHelp || params.size() > 0)
+    std::string defaultType = ADDR_TYPE_SPROUT;


I would not be apposed to either inlining this or making it a constant.

This was originally where we conditionally set the default based on whether Sapling had activated. We may still want to do that if we decide to make Sapling the default in 2.0.1 (after third parties have had time to test their setups). So I'll leave this as-is.

Eirik0 · 2018-07-30T22:21:17Z

src/wallet/rpcwallet.cpp

@@ -3129,7 +3148,7 @@ UniValue z_listaddresses(const UniValue& params, bool fHelp)
    if (fHelp || params.size() > 1)
        throw runtime_error(
            "z_listaddresses ( includeWatchonly )\n"
-            "\nReturns the list of zaddr belonging to the wallet.\n"
+            "\nReturns the list of Sprout and Sapling shielded addresses belonging to the wallet.\n"


I like the change from "zaddr" to "shielded addresses". Neither here nor there, but we don't really need to say "Sprout and Sapling". Shouldn't that be the default unless we otherwise specify?

I just wanted to be clearer for downstream users, given that technically previously they only ever received Sprout addresses from here, whereas now they need to check what type of address they are getting (if they are then doing something Sprout-specific, rather than using our regular APIs for which they will be interchangeable).

Eirik0 · 2018-07-30T22:22:10Z

src/wallet/rpcwallet.cpp

+    {
+        std::set<libzcash::SproutPaymentAddress> addresses;
+        pwalletMain->GetPaymentAddresses(addresses);
+        for (auto addr : addresses ) {


Formatting: There is an extra space after "addresses".

Eirik0 · 2018-07-30T22:22:41Z

src/wallet/rpcwallet.cpp

+        pwalletMain->GetSaplingPaymentAddresses(addresses);
+        libzcash::SaplingIncomingViewingKey ivk;
+        libzcash::SaplingFullViewingKey fvk;
+        for (auto addr : addresses ) {


Formatting.

str4d · 2018-08-01T08:48:23Z

Addressed @Eirik0's comments.

Eirik0 · 2018-08-01T15:43:00Z

ACK.

str4d · 2018-08-01T15:54:38Z

@zkbot r+

zkbot · 2018-08-01T15:54:38Z

📌 Commit 4fab49e has been approved by str4d

zkbot · 2018-08-01T15:54:44Z

⌛ Testing commit 4fab49e with merge d16052757cc7dade3dafe343f9284b8491805c35...

zkbot · 2018-08-01T18:11:27Z

💔 Test failed - pr-merge

str4d · 2018-08-01T19:01:35Z

Pushed fixes for the two test failures - both were bugs in the tests themselves, not the code.

@zkbot r+

zkbot · 2018-08-01T19:01:36Z

📌 Commit 40dc060 has been approved by str4d

zkbot · 2018-08-01T19:01:42Z

⌛ Testing commit 40dc060 with merge 066cc9c...

Add Sapling support to z_getnewaddress and z_listaddresses Closes #3217.

zkbot · 2018-08-01T20:55:29Z

☀️ Test successful - pr-merge
Approved by: str4d
Pushing 066cc9c to master...

str4d added 3 commits July 30, 2018 16:01

Implement CKeyStore::GetSaplingPaymentAddresses()

4715b31

Raise the 90-character limit on Bech32 encodings

281b51e

Regtest addresses are 91 characters, and ZIP 32's Bech32 encoding will be significantly longer.

Add Sapling support to z_getnewaddress and z_listaddresses

eec85c4

str4d added A-wallet Area: Wallet A-rpc-interface Area: RPC interface NU1-sapling Network upgrade: Sapling-specific tasks labels Jul 30, 2018

str4d added this to the v2.0.0 milestone Jul 30, 2018

str4d requested review from bitcartel and daira July 30, 2018 15:31

str4d added this to In Review in Arborist Team Jul 30, 2018

str4d mentioned this pull request Jul 30, 2018

Add Sapling support to wallet RPCs #3063

Closed

14 tasks

Eirik0 self-requested a review July 30, 2018 16:30

ebfull approved these changes Jul 30, 2018

View reviewed changes

Eirik0 suggested changes Jul 30, 2018

View reviewed changes

str4d added 3 commits July 31, 2018 23:28

Formatting

fbd029d

test: Deduplicate logic in wallet_addresses RPC test

d75e69d

test: Another assert in wallet_zkeys_tests.store_and_load_sapling_zkeys

4fab49e

Eirik0 approved these changes Aug 1, 2018

View reviewed changes

str4d added 2 commits August 1, 2018 19:56

test: Fix permissions of wallet_addresses

4aabeeb

test: Update rpc_wallet_z_importexport to account for Sapling changes

40dc060

zkbot added a commit that referenced this pull request Aug 1, 2018

Auto merge of #3429 - str4d:3217-sapling-address-creation, r=str4d

066cc9c

Add Sapling support to z_getnewaddress and z_listaddresses Closes #3217.

zkbot merged commit 40dc060 into zcash:master Aug 1, 2018

Arborist Team automation moved this from In Review to Released (Merged in Master) Aug 1, 2018

str4d deleted the 3217-sapling-address-creation branch March 10, 2020 05:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Sapling support to z_getnewaddress and z_listaddresses #3429

Add Sapling support to z_getnewaddress and z_listaddresses #3429

str4d commented Jul 30, 2018

Eirik0 commented Jul 30, 2018

str4d commented Jul 30, 2018

Eirik0 commented Jul 30, 2018

Eirik0 left a comment

Eirik0 Jul 30, 2018

Eirik0 Jul 30, 2018

str4d Jul 31, 2018 •

edited

Eirik0 Jul 30, 2018

str4d Jul 31, 2018

Eirik0 Jul 30, 2018

Eirik0 Jul 30, 2018

str4d Jul 31, 2018

Eirik0 Jul 30, 2018

str4d Jul 31, 2018

Eirik0 Jul 30, 2018

str4d Jul 31, 2018

Eirik0 Jul 30, 2018

Eirik0 Jul 30, 2018

str4d commented Aug 1, 2018

Eirik0 commented Aug 1, 2018

str4d commented Aug 1, 2018

zkbot commented Aug 1, 2018

zkbot commented Aug 1, 2018

zkbot commented Aug 1, 2018

str4d commented Aug 1, 2018

zkbot commented Aug 1, 2018

zkbot commented Aug 1, 2018

zkbot commented Aug 1, 2018

Add Sapling support to z_getnewaddress and z_listaddresses #3429

Add Sapling support to z_getnewaddress and z_listaddresses #3429

Conversation

str4d commented Jul 30, 2018

Eirik0 commented Jul 30, 2018

str4d commented Jul 30, 2018

Eirik0 commented Jul 30, 2018

Eirik0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

str4d Jul 31, 2018 • edited

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

str4d commented Aug 1, 2018

Eirik0 commented Aug 1, 2018

str4d commented Aug 1, 2018

zkbot commented Aug 1, 2018

zkbot commented Aug 1, 2018

zkbot commented Aug 1, 2018

str4d commented Aug 1, 2018

zkbot commented Aug 1, 2018

zkbot commented Aug 1, 2018

zkbot commented Aug 1, 2018

str4d Jul 31, 2018 •

edited