Pass SaplingPaymentAddress to store through the CKeyStore

src/gtest/test_keystore.cpp

@@ -185,8 +185,15 @@ TEST(keystore_tests, StoreAndRetrieveSaplingSpendingKey) {
     EXPECT_FALSE(keyStore.HaveSaplingIncomingViewingKey(addr));
     EXPECT_FALSE(keyStore.GetSaplingIncomingViewingKey(addr, ivkOut));
 
+    // If we don't specify the default address, that mapping isn't created
     keyStore.AddSaplingSpendingKey(sk);
     EXPECT_TRUE(keyStore.HaveSaplingSpendingKey(fvk));
+    EXPECT_TRUE(keyStore.HaveSaplingFullViewingKey(ivk));
+    EXPECT_FALSE(keyStore.HaveSaplingIncomingViewingKey(addr));
+
+    // When we specify the default address, we get the full mapping
+    keyStore.AddSaplingSpendingKey(sk, addr);
+    EXPECT_TRUE(keyStore.HaveSaplingSpendingKey(fvk));
     EXPECT_TRUE(keyStore.GetSaplingSpendingKey(fvk, skOut));
     EXPECT_TRUE(keyStore.HaveSaplingFullViewingKey(ivk));
     EXPECT_TRUE(keyStore.GetSaplingFullViewingKey(ivk, fvkOut));

src/keystore.cpp

@@ -94,23 +94,20 @@ bool CBasicKeyStore::AddSpendingKey(const libzcash::SproutSpendingKey &sk)
 }
 
 //! Sapling 
-bool CBasicKeyStore::AddSaplingSpendingKey(const libzcash::SaplingSpendingKey &sk)
+bool CBasicKeyStore::AddSaplingSpendingKey(
+    const libzcash::SaplingSpendingKey &sk,
+    const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr)
 {
     LOCK(cs_SpendingKeyStore);
     auto fvk = sk.full_viewing_key();
-    
+
     // if SaplingFullViewingKey is not in SaplingFullViewingKeyMap, add it
-    if (!AddSaplingFullViewingKey(fvk)){
+    if (!AddSaplingFullViewingKey(fvk, defaultAddr)){
         return false;
     }
-    
+
     mapSaplingSpendingKeys[fvk] = sk;
 
-    // Add addr -> SaplingIncomingViewing to SaplingIncomingViewingKeyMap
-    auto ivk = fvk.in_viewing_key();
-    auto addr = sk.default_address();
-    mapSaplingIncomingViewingKeys[addr] = ivk;
-    
     return true;
 }
 
@@ -123,13 +120,18 @@ bool CBasicKeyStore::AddViewingKey(const libzcash::SproutViewingKey &vk)
     return true;
 }
 
-bool CBasicKeyStore::AddSaplingFullViewingKey(const libzcash::SaplingFullViewingKey &fvk)
+bool CBasicKeyStore::AddSaplingFullViewingKey(
+    const libzcash::SaplingFullViewingKey &fvk,
+    const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr)
 {
     LOCK(cs_SpendingKeyStore);
     auto ivk = fvk.in_viewing_key();
     mapSaplingFullViewingKeys[ivk] = fvk;
-    
-    //! TODO: Note decryptors for Sapling
+
+    if (defaultAddr) {
+        // Add defaultAddr -> SaplingIncomingViewing to SaplingIncomingViewingKeyMap
+        mapSaplingIncomingViewingKeys[defaultAddr.get()] = ivk;
+    }
     
     return true;
 }

src/keystore.h

@@ -57,14 +57,18 @@ public:
     virtual void GetPaymentAddresses(std::set<libzcash::SproutPaymentAddress> &setAddress) const =0;
     
     //! Add a Sapling spending key to the store.
-    virtual bool AddSaplingSpendingKey(const libzcash::SaplingSpendingKey &sk) =0;
+    virtual bool AddSaplingSpendingKey(
+        const libzcash::SaplingSpendingKey &sk,
+        const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr = boost::none) =0;
     
     //! Check whether a Sapling spending key corresponding to a given Sapling viewing key is present in the store.
     virtual bool HaveSaplingSpendingKey(const libzcash::SaplingFullViewingKey &fvk) const =0;
     virtual bool GetSaplingSpendingKey(const libzcash::SaplingFullViewingKey &fvk, libzcash::SaplingSpendingKey& skOut) const =0;
-    
+
     //! Support for Sapling full viewing keys
-    virtual bool AddSaplingFullViewingKey(const libzcash::SaplingFullViewingKey &fvk) =0;
+    virtual bool AddSaplingFullViewingKey(
+        const libzcash::SaplingFullViewingKey &fvk,
+        const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr = boost::none) =0;
     virtual bool HaveSaplingFullViewingKey(const libzcash::SaplingIncomingViewingKey &ivk) const =0;
     virtual bool GetSaplingFullViewingKey(
         const libzcash::SaplingIncomingViewingKey &ivk, 
@@ -217,7 +221,9 @@ public:
     }
     
     //! Sapling 
-    bool AddSaplingSpendingKey(const libzcash::SaplingSpendingKey &sk);
+    bool AddSaplingSpendingKey(
+        const libzcash::SaplingSpendingKey &sk,
+        const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr = boost::none);
     bool HaveSaplingSpendingKey(const libzcash::SaplingFullViewingKey &fvk) const
     {
         bool result;
@@ -241,8 +247,10 @@ public:
         }
         return false;
     }
-    
-    virtual bool AddSaplingFullViewingKey(const libzcash::SaplingFullViewingKey &fvk);
+
+    virtual bool AddSaplingFullViewingKey(
+        const libzcash::SaplingFullViewingKey &fvk,
+        const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr = boost::none);
     virtual bool HaveSaplingFullViewingKey(const libzcash::SaplingIncomingViewingKey &ivk) const;
     virtual bool GetSaplingFullViewingKey(
         const libzcash::SaplingIncomingViewingKey &ivk, 

src/wallet/crypter.cpp

@@ -354,12 +354,14 @@ bool CCryptoKeyStore::AddSpendingKey(const libzcash::SproutSpendingKey &sk)
     return true;
 }
 
-bool CCryptoKeyStore::AddSaplingSpendingKey(const libzcash::SaplingSpendingKey &sk)
+bool CCryptoKeyStore::AddSaplingSpendingKey(
+    const libzcash::SaplingSpendingKey &sk,
+    const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr)
 {
     {
         LOCK(cs_SpendingKeyStore);
         if (!IsCrypted()) {
-            return CBasicKeyStore::AddSaplingSpendingKey(sk);
+            return CBasicKeyStore::AddSaplingSpendingKey(sk, defaultAddr);
         }
 
         if (IsLocked()) {
@@ -375,7 +377,7 @@ bool CCryptoKeyStore::AddSaplingSpendingKey(const libzcash::SaplingSpendingKey &
             return false;
         }
 
-        if (!AddCryptedSaplingSpendingKey(fvk, vchCryptedSecret)) {
+        if (!AddCryptedSaplingSpendingKey(fvk, vchCryptedSecret, defaultAddr)) {
             return false;
         }
     }
@@ -397,8 +399,10 @@ bool CCryptoKeyStore::AddCryptedSpendingKey(const libzcash::SproutPaymentAddress
     return true;
 }
 
-bool CCryptoKeyStore::AddCryptedSaplingSpendingKey(const libzcash::SaplingFullViewingKey &fvk,
-                                            const std::vector<unsigned char> &vchCryptedSecret)
+bool CCryptoKeyStore::AddCryptedSaplingSpendingKey(
+    const libzcash::SaplingFullViewingKey &fvk,
+    const std::vector<unsigned char> &vchCryptedSecret,
+    const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr)
 {
     {
         LOCK(cs_SpendingKeyStore);
@@ -406,6 +410,11 @@ bool CCryptoKeyStore::AddCryptedSaplingSpendingKey(const libzcash::SaplingFullVi
             return false;
         }
 
+        // if SaplingFullViewingKey is not in SaplingFullViewingKeyMap, add it
+        if (!AddSaplingFullViewingKey(fvk, defaultAddr)){
+            return false;
+        }
+
         mapCryptedSaplingSpendingKeys[fvk] = vchCryptedSecret;
     }
     return true;

src/wallet/crypter.h

@@ -232,9 +232,13 @@ public:
         }
     }
     //! Sapling 
-    virtual bool AddCryptedSaplingSpendingKey(const libzcash::SaplingFullViewingKey &fvk,
-                                       const std::vector<unsigned char> &vchCryptedSecret);
-    bool AddSaplingSpendingKey(const libzcash::SaplingSpendingKey &sk);
+    virtual bool AddCryptedSaplingSpendingKey(
+        const libzcash::SaplingFullViewingKey &fvk,
+        const std::vector<unsigned char> &vchCryptedSecret,
+        const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr = boost::none);
+    bool AddSaplingSpendingKey(
+        const libzcash::SaplingSpendingKey &sk,
+        const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr = boost::none);
     bool HaveSaplingSpendingKey(const libzcash::SaplingFullViewingKey &fvk) const
     {
         {

src/wallet/gtest/test_wallet_zkeys.cpp

@@ -31,7 +31,7 @@ TEST(wallet_zkeys_tests, store_and_load_sapling_zkeys) {
     
     // manually add new spending key to wallet
     auto sk = libzcash::SaplingSpendingKey::random();
-    ASSERT_TRUE(wallet.AddSaplingZKey(sk));
+    ASSERT_TRUE(wallet.AddSaplingZKey(sk, sk.default_address()));
 
     // verify wallet did add it
     auto fvk = sk.full_viewing_key();
@@ -44,9 +44,9 @@ TEST(wallet_zkeys_tests, store_and_load_sapling_zkeys) {
 
     // verify there are two keys
     wallet.GetSaplingPaymentAddresses(addrs);
-    ASSERT_EQ(2, addrs.size());
-    ASSERT_EQ(1, addrs.count(address));
-    ASSERT_EQ(1, addrs.count(sk.default_address()));
+    EXPECT_EQ(2, addrs.size());
+    EXPECT_EQ(1, addrs.count(address));
+    EXPECT_EQ(1, addrs.count(sk.default_address()));
 }
 
 /**

src/wallet/rpcdump.cpp

@@ -585,7 +585,7 @@ public:
             } else {
                 m_wallet->MarkDirty();
     
-                if (!m_wallet-> AddSaplingZKey(sk)) {
+                if (!m_wallet-> AddSaplingZKey(sk, addr)) {
                     throw JSONRPCError(RPC_WALLET_ERROR, "Error adding spending key to wallet");
                 }
     

src/wallet/wallet.cpp

@@ -118,7 +118,7 @@ SaplingPaymentAddress CWallet::GenerateNewSaplingZKey()
     int64_t nCreationTime = GetTime();
     mapSaplingZKeyMetadata[addr] = CKeyMetadata(nCreationTime);
     
-    if (!AddSaplingZKey(sk)) {
+    if (!AddSaplingZKey(sk, addr)) {
         throw std::runtime_error("CWallet::GenerateNewSaplingZKey(): AddSaplingZKey failed");
     }
     // return default sapling payment address.
@@ -126,11 +126,13 @@ SaplingPaymentAddress CWallet::GenerateNewSaplingZKey()
 }
 
 // Add spending key to keystore 
-bool CWallet::AddSaplingZKey(const libzcash::SaplingSpendingKey &sk)
+bool CWallet::AddSaplingZKey(
+    const libzcash::SaplingSpendingKey &sk,
+    const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr)
 {
     AssertLockHeld(cs_wallet); // mapSaplingZKeyMetadata
 
-    if (!CCryptoKeyStore::AddSaplingSpendingKey(sk)) {
+    if (!CCryptoKeyStore::AddSaplingSpendingKey(sk, defaultAddr)) {
         return false;
     }
     
@@ -265,9 +267,10 @@ bool CWallet::AddCryptedSpendingKey(const libzcash::SproutPaymentAddress &addres
 }
 
 bool CWallet::AddCryptedSaplingSpendingKey(const libzcash::SaplingFullViewingKey &fvk,
-                                           const std::vector<unsigned char> &vchCryptedSecret)
+                                           const std::vector<unsigned char> &vchCryptedSecret,
+                                           const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr)
 {
-    if (!CCryptoKeyStore::AddCryptedSaplingSpendingKey(fvk, vchCryptedSecret))
+    if (!CCryptoKeyStore::AddCryptedSaplingSpendingKey(fvk, vchCryptedSecret, defaultAddr))
         return false;
     if (!fFileBacked)
         return true;

src/wallet/wallet.h

@@ -1006,9 +1006,13 @@ public:
     //! Generates new Sapling key
     libzcash::SaplingPaymentAddress GenerateNewSaplingZKey();
     //! Adds Sapling spending key to the store, and saves it to disk
-    bool AddSaplingZKey(const libzcash::SaplingSpendingKey &key);
-    bool AddCryptedSaplingSpendingKey(const libzcash::SaplingFullViewingKey &fvk,
-                                      const std::vector<unsigned char> &vchCryptedSecret);
+    bool AddSaplingZKey(
+        const libzcash::SaplingSpendingKey &key,
+        const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr = boost::none);
+    bool AddCryptedSaplingSpendingKey(
+        const libzcash::SaplingFullViewingKey &fvk,
+        const std::vector<unsigned char> &vchCryptedSecret,
+        const boost::optional<libzcash::SaplingPaymentAddress> &defaultAddr = boost::none);
 
     /** 
      * Increment the next transaction order id