Sapling keys in keystore, wallet #3273

arcalinea · 2018-05-17T13:09:46Z

Add/Have/Get SaplingSpendingKey
Add/Remove/Have/Get SaplingFullViewingKey
Have/Get SaplingIncomingViewingKey
SaplingSpendingKeyMap, SaplingFullViewingKeyMap, SaplingIncomingViewingKeyMap
GenerateNewSaplingZKey()

Not included: note decryptors, crypted keystore

zkbot · 2018-05-18T21:42:33Z

☔ The latest upstream changes (presumably #3275) made this pull request unmergeable. Please resolve the merge conflicts.

str4d

Remove the two binaries that were added.

str4d · 2018-06-19T14:39:04Z

src/wallet/gtest/test_wallet_zkeys.cpp

@@ -313,4 +346,3 @@ TEST(wallet_zkeys_tests, write_cryptedzkey_direct_to_db) {

    ECC_Stop();
 }
-


Leave this in.

str4d · 2018-06-19T14:39:10Z

src/wallet/wallet.cpp

@@ -3881,4 +3906,3 @@ void CWallet::GetUnspentFilteredNotes(
        }
    }
 }
-


Leave this in.

bitcartel

Looks good. New methods and tests are independent of existing Sprout keystore. Verified that WriteSaplingZKey is never invoked, so database is not touched.

str4d · 2018-07-03T08:26:43Z

@zkbot try

zkbot · 2018-07-03T08:26:48Z

⌛ Trying commit 891760c with merge 5c98b97a8ae64fac706126c34888b83fe7a99054...

str4d

Looking pretty good overall!

str4d · 2018-07-03T08:19:26Z

src/keystore.cpp

+    // Add addr -> SaplingIncomingViewing to SaplingIncomingViewingKeyMap
+    auto ivk = fvk.in_viewing_key();
+    auto addr = sk.default_address();
+    mapSaplingIncomingViewingKeys[addr] = ivk;


Reminder to self: when we implement ZIP 32, we need to set the address -> ivk mapping inside AddSaplingFullViewingKey(), not here (which we can't do in this PR because we can't get the default address from fvk).

str4d · 2018-07-03T08:20:59Z

src/keystore.cpp

 bool CBasicKeyStore::RemoveViewingKey(const libzcash::SproutViewingKey &vk)
 {
    LOCK(cs_SpendingKeyStore);
    mapViewingKeys.erase(vk.address());
    return true;
 }

+bool CBasicKeyStore::RemoveSaplingFullViewingKey(const libzcash::SaplingFullViewingKey &fvk)


Not sure we need this, but I'm not going to block the PR on removing it.

str4d · 2018-07-03T08:23:46Z

src/keystore.h

@@ -70,6 +91,13 @@ typedef std::map<libzcash::SproutPaymentAddress, libzcash::SproutSpendingKey> Sp
 typedef std::map<libzcash::SproutPaymentAddress, libzcash::SproutViewingKey> ViewingKeyMap;
 typedef std::map<libzcash::SproutPaymentAddress, ZCNoteDecryption> NoteDecryptorMap;

+// Full viewing key has equivalent functionality to a transparent address
+// When encrypting wallet, encrypt SaplingSpendingKeyMap, while leaving SaplingFullViewingKeyMap unencrypted
+typedef std::map<libzcash::SaplingFullViewingKey, libzcash::SaplingSpendingKey> SaplingSpendingKeyMap;


Reminder to self: when we implement ZIP 32, we'll add another map here from fvk -> ExtendedSpendingKey.

added comment

str4d · 2018-07-03T08:24:21Z

src/wallet/wallet.cpp

+// Generate a new Sapling spending key and return its public payment address
+SaplingPaymentAddress CWallet::GenerateNewSaplingZKey()
+{
+    AssertLockHeld(cs_wallet); // mapZKeyMetadata


Nit: mapSaplingZKeyMetadata in comment.

str4d · 2018-07-03T08:24:42Z

src/wallet/wallet.cpp

+
+    // Check for collision, even though it is unlikely to ever occur
+    if (CCryptoKeyStore::HaveSaplingSpendingKey(fvk))
+    throw std::runtime_error("CWallet::GenerateNewSaplingZKey(): Collision detected");


Add brackets and fix indentation.

str4d · 2018-07-03T08:26:11Z

src/wallet/walletdb.h

@@ -141,7 +141,7 @@ class CWalletDB : public CDB

    bool WriteViewingKey(const libzcash::SproutViewingKey &vk);
    bool EraseViewingKey(const libzcash::SproutViewingKey &vk);
-
+    


Remove whitespace.

str4d · 2018-07-03T08:26:19Z

src/zcash/Address.cpp

@@ -1,3 +1,4 @@
+


Remove whitespace.

str4d · 2018-07-03T08:32:41Z

src/wallet/wallet.cpp

+{
+    AssertLockHeld(cs_wallet); // mapSaplingZKeyMetadata
+
+    if (!CCryptoKeyStore::AddSaplingSpendingKey(sk)) {


I suspect this call will fail, because this PR doesn't update CCryptoKeyStore with the new methods. Please add a test that calls GenerateNewSaplingZKey() and/or AddSaplingZKey() to ensure the pathway is exercised.

If the ongoing try passes, I will downgrade this to non-blocking in the interest of unblocking downstream PRs.

I updated CCryptoKeyStore to add sapling spending keys, and added a test calling GenerateNewSaplingZKey() and AddSaplingZKey(), going to run a try again

zkbot · 2018-07-03T08:49:14Z

💔 Test failed - pr-try

arcalinea · 2018-07-03T21:55:04Z

@zkbot try

zkbot · 2018-07-03T21:55:11Z

⌛ Trying commit 2777fe0 with merge f42d1c5...

Sapling keys in keystore, wallet - Add/Have/Get SaplingSpendingKey - Add/Remove/Have/Get SaplingFullViewingKey - Have/Get SaplingIncomingViewingKey - SaplingSpendingKeyMap, SaplingFullViewingKeyMap, SaplingIncomingViewingKeyMap - GenerateNewSaplingZKey() Not included: note decryptors, crypted keystore

zkbot · 2018-07-03T22:39:27Z

💔 Test failed - pr-try

…tional

arcalinea · 2018-07-06T00:09:29Z

@zkbot try

zkbot · 2018-07-06T00:09:34Z

⌛ Trying commit 2173767 with merge 2b21793ac510d049ffb5e6540c2c2ce5040bd3a4...

zkbot · 2018-07-06T01:42:52Z

☀️ Test successful - pr-try
State: approved= try=True

daira

ut(ACK+cov)

daira · 2018-07-06T18:26:57Z

src/wallet/wallet.cpp

+    auto fvk = sk.full_viewing_key();
+    auto addr = sk.default_address();
+
+    // Check for collision, even though it is unlikely to ever occur


Technically it is also possible for a collision to occur on ivk, even though fvk does not collide.

str4d

ut(ACK+cov)

str4d · 2018-07-06T22:11:28Z

src/wallet/crypter.h

+    //! Sapling 
+    virtual bool AddCryptedSaplingSpendingKey(const libzcash::SaplingFullViewingKey &fvk,
+                                       const std::vector<unsigned char> &vchCryptedSecret);
+    bool AddSaplingSpendingKey(const libzcash::SaplingSpendingKey &sk);


Todo in subsequent PR: implement crypter overrides of HaveSaplingSpendingKey() etc.

str4d · 2018-07-06T22:17:10Z

src/wallet/crypter.cpp

+        CKeyingMaterial vchSecret(ss.begin(), ss.end());
+        auto address = sk.default_address();
+        auto fvk = sk.full_viewing_key();
+        if (!EncryptSecret(vMasterKey, vchSecret, address.GetHash(), vchCryptedSecret)) {


We should use fvk.GetHash() here (as that is what is stored in the mapping with the ciphertext). Non-blocking, as we can fix this in the subsequent PR that fleshes out the crypter for Sapling.

str4d · 2018-07-06T22:18:37Z

Nice work!

@zkbot r+

zkbot · 2018-07-06T22:18:37Z

📌 Commit 2173767 has been approved by str4d

zkbot · 2018-07-06T22:18:42Z

⌛ Testing commit 2173767 with merge 579ad3b...

Sapling keys in keystore, wallet - Add/Have/Get SaplingSpendingKey - Add/Remove/Have/Get SaplingFullViewingKey - Have/Get SaplingIncomingViewingKey - SaplingSpendingKeyMap, SaplingFullViewingKeyMap, SaplingIncomingViewingKeyMap - GenerateNewSaplingZKey() Not included: note decryptors, crypted keystore

zkbot · 2018-07-07T01:57:26Z

☀️ Test successful - pr-merge
Approved by: str4d
Pushing 579ad3b to master...

str4d added the A-wallet Area: Wallet label Jun 12, 2018

str4d added this to the v2.0.0 milestone Jun 12, 2018

str4d assigned arcalinea Jun 12, 2018

str4d added this to In Progress in Arborist Team Jun 12, 2018

arcalinea force-pushed the sapling_keys branch from 5ed0775 to f6915ae Compare June 14, 2018 18:08

arcalinea requested a review from str4d June 14, 2018 18:51

str4d reviewed Jun 19, 2018

View reviewed changes

arcalinea force-pushed the sapling_keys branch from 2b847e2 to 99333ec Compare June 21, 2018 20:50

arcalinea changed the title ~~WIP: Sapling keys in keystore, wallet~~ Sapling keys in keystore, wallet Jun 22, 2018

arcalinea requested a review from bitcartel June 22, 2018 17:31

bitcartel reviewed Jun 22, 2018

View reviewed changes

arcalinea requested review from bitcartel and str4d June 30, 2018 19:48

arcalinea force-pushed the sapling_keys branch 3 times, most recently from 7343289 to 891760c Compare June 30, 2018 20:26

str4d modified the milestones: v1.1.2, v2.0.0 Jul 2, 2018

str4d moved this from In Progress to In Review in Arborist Team Jul 2, 2018

str4d requested changes Jul 3, 2018

View reviewed changes

str4d moved this from In Review to In Progress in Arborist Team Jul 3, 2018

arcalinea force-pushed the sapling_keys branch 4 times, most recently from 5fa6689 to a33eff6 Compare July 5, 2018 21:27

Add Sapling Add/Have/Get to keystore

efb7662

arcalinea force-pushed the sapling_keys branch from a33eff6 to b8ec444 Compare July 5, 2018 21:38

Jay Graber added 3 commits July 5, 2018 14:52

Add SaplingIncomingViewingKeys map, SaplingFullViewingKey methods

f4207d0

Add StoreAndRetrieveSaplingSpendingKey test

f82a864

Change default_address to return SaplingPaymentAddr and not boost::op…

8e91ebf

…tional

arcalinea force-pushed the sapling_keys branch from b8ec444 to 829042f Compare July 5, 2018 21:54

Add crypted keystore sapling add key

2173767

arcalinea force-pushed the sapling_keys branch from 829042f to 2173767 Compare July 5, 2018 22:00

str4d moved this from In Progress to Review Backlog in Arborist Team Jul 6, 2018

daira approved these changes Jul 6, 2018

View reviewed changes

str4d moved this from Review Backlog to In Review in Arborist Team Jul 6, 2018

str4d reviewed Jul 6, 2018

View reviewed changes

str4d approved these changes Jul 6, 2018

View reviewed changes

zkbot merged commit 2173767 into zcash:master Jul 7, 2018

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

This was referenced Jul 9, 2018

Add Sapling support to z_validateaddress #3345

Merged

Add Sapling keys and addresses to the wallet #3059

Closed

		@@ -313,4 +346,3 @@ TEST(wallet_zkeys_tests, write_cryptedzkey_direct_to_db) {

		ECC_Stop();
		}

@@ @@ -3881,4 +3906,3 @@ void CWallet::GetUnspentFilteredNotes( @@
                       }
                   }
               }

		@@ -141,7 +141,7 @@ class CWalletDB : public CDB

		bool WriteViewingKey(const libzcash::SproutViewingKey &vk);
		bool EraseViewingKey(const libzcash::SproutViewingKey &vk);

Sapling keys in keystore, wallet #3273

Sapling keys in keystore, wallet #3273

Conversation

arcalinea commented May 17, 2018 • edited

zkbot commented May 18, 2018

str4d left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bitcartel left a comment

Choose a reason for hiding this comment

str4d commented Jul 3, 2018

zkbot commented Jul 3, 2018

str4d left a 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

Choose a reason for hiding this comment

zkbot commented Jul 3, 2018

arcalinea commented Jul 3, 2018

zkbot commented Jul 3, 2018

zkbot commented Jul 3, 2018

arcalinea commented Jul 6, 2018

zkbot commented Jul 6, 2018

zkbot commented Jul 6, 2018

daira left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

str4d 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 commented Jul 6, 2018

zkbot commented Jul 6, 2018

zkbot commented Jul 6, 2018

zkbot commented Jul 7, 2018

arcalinea commented May 17, 2018 •

edited