e5eab182b5
libzcash::PaymentAddress has been renamed to libzcash::SproutPaymentAddress, and a new typedef boost::variant is now libzcash::PaymentAddress. Similarly for ViewingKey and SpendingKey. A new class InvalidEncoding is introduced as the default boost::variant option for each address and key type; it is used during decoding instead of boost::optional. All address and key storage functions in the wallet have been modified to refer specifically to the Sprout types, as they are used very precisely. In most other cases, the more general type is leveraged as much as possible, and we convert to the Sprout type when necessary. This will be subsequently wrapped in, or replaced with, context-specific functions once Sapling types are implemented.
317 lines
9.5 KiB
C++
317 lines
9.5 KiB
C++
#include <gtest/gtest.h>
|
|
|
|
#include "zcash/Address.hpp"
|
|
#include "wallet/wallet.h"
|
|
#include "wallet/walletdb.h"
|
|
#include "util.h"
|
|
|
|
#include <boost/filesystem.hpp>
|
|
|
|
/**
|
|
* This test covers methods on CWallet
|
|
* GenerateNewZKey()
|
|
* AddZKey()
|
|
* LoadZKey()
|
|
* LoadZKeyMetadata()
|
|
*/
|
|
TEST(wallet_zkeys_tests, store_and_load_zkeys) {
|
|
SelectParams(CBaseChainParams::MAIN);
|
|
|
|
CWallet wallet;
|
|
|
|
// wallet should be empty
|
|
std::set<libzcash::SproutPaymentAddress> addrs;
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(0, addrs.size());
|
|
|
|
// wallet should have one key
|
|
auto address = wallet.GenerateNewZKey();
|
|
ASSERT_NE(boost::get<libzcash::SproutPaymentAddress>(&address), nullptr);
|
|
auto addr = boost::get<libzcash::SproutPaymentAddress>(address);
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(1, addrs.size());
|
|
|
|
// verify wallet has spending key for the address
|
|
ASSERT_TRUE(wallet.HaveSpendingKey(addr));
|
|
|
|
// manually add new spending key to wallet
|
|
auto sk = libzcash::SproutSpendingKey::random();
|
|
ASSERT_TRUE(wallet.AddZKey(sk));
|
|
|
|
// verify wallet did add it
|
|
addr = sk.address();
|
|
ASSERT_TRUE(wallet.HaveSpendingKey(addr));
|
|
|
|
// verify spending key stored correctly
|
|
libzcash::SproutSpendingKey keyOut;
|
|
wallet.GetSpendingKey(addr, keyOut);
|
|
ASSERT_EQ(sk, keyOut);
|
|
|
|
// verify there are two keys
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(2, addrs.size());
|
|
ASSERT_EQ(1, addrs.count(addr));
|
|
|
|
// Load a third key into the wallet
|
|
sk = libzcash::SproutSpendingKey::random();
|
|
ASSERT_TRUE(wallet.LoadZKey(sk));
|
|
|
|
// attach metadata to this third key
|
|
addr = sk.address();
|
|
int64_t now = GetTime();
|
|
CKeyMetadata meta(now);
|
|
ASSERT_TRUE(wallet.LoadZKeyMetadata(addr, meta));
|
|
|
|
// check metadata is the same
|
|
CKeyMetadata m= wallet.mapZKeyMetadata[addr];
|
|
ASSERT_EQ(m.nCreateTime, now);
|
|
}
|
|
|
|
/**
|
|
* This test covers methods on CWallet
|
|
* AddViewingKey()
|
|
* RemoveViewingKey()
|
|
* LoadViewingKey()
|
|
*/
|
|
TEST(wallet_zkeys_tests, StoreAndLoadViewingKeys) {
|
|
SelectParams(CBaseChainParams::MAIN);
|
|
|
|
CWallet wallet;
|
|
|
|
// wallet should be empty
|
|
std::set<libzcash::SproutPaymentAddress> addrs;
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(0, addrs.size());
|
|
|
|
// manually add new viewing key to wallet
|
|
auto sk = libzcash::SproutSpendingKey::random();
|
|
auto vk = sk.viewing_key();
|
|
ASSERT_TRUE(wallet.AddViewingKey(vk));
|
|
|
|
// verify wallet did add it
|
|
auto addr = sk.address();
|
|
ASSERT_TRUE(wallet.HaveViewingKey(addr));
|
|
// and that we don't have the corresponding spending key
|
|
ASSERT_FALSE(wallet.HaveSpendingKey(addr));
|
|
|
|
// verify viewing key stored correctly
|
|
libzcash::SproutViewingKey vkOut;
|
|
wallet.GetViewingKey(addr, vkOut);
|
|
ASSERT_EQ(vk, vkOut);
|
|
|
|
// Load a second viewing key into the wallet
|
|
auto sk2 = libzcash::SproutSpendingKey::random();
|
|
ASSERT_TRUE(wallet.LoadViewingKey(sk2.viewing_key()));
|
|
|
|
// verify wallet did add it
|
|
auto addr2 = sk2.address();
|
|
ASSERT_TRUE(wallet.HaveViewingKey(addr2));
|
|
ASSERT_FALSE(wallet.HaveSpendingKey(addr2));
|
|
|
|
// Remove the first viewing key
|
|
ASSERT_TRUE(wallet.RemoveViewingKey(vk));
|
|
ASSERT_FALSE(wallet.HaveViewingKey(addr));
|
|
ASSERT_TRUE(wallet.HaveViewingKey(addr2));
|
|
}
|
|
|
|
/**
|
|
* This test covers methods on CWalletDB
|
|
* WriteZKey()
|
|
*/
|
|
TEST(wallet_zkeys_tests, write_zkey_direct_to_db) {
|
|
SelectParams(CBaseChainParams::TESTNET);
|
|
|
|
// Get temporary and unique path for file.
|
|
// Note: / operator to append paths
|
|
boost::filesystem::path pathTemp = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path();
|
|
boost::filesystem::create_directories(pathTemp);
|
|
mapArgs["-datadir"] = pathTemp.string();
|
|
|
|
bool fFirstRun;
|
|
CWallet wallet("wallet.dat");
|
|
ASSERT_EQ(DB_LOAD_OK, wallet.LoadWallet(fFirstRun));
|
|
|
|
// No default CPubKey set
|
|
ASSERT_TRUE(fFirstRun);
|
|
|
|
// wallet should be empty
|
|
std::set<libzcash::SproutPaymentAddress> addrs;
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(0, addrs.size());
|
|
|
|
// Add random key to the wallet
|
|
auto paymentAddress = wallet.GenerateNewZKey();
|
|
|
|
// wallet should have one key
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(1, addrs.size());
|
|
|
|
// create random key and add it to database directly, bypassing wallet
|
|
auto sk = libzcash::SproutSpendingKey::random();
|
|
auto addr = sk.address();
|
|
int64_t now = GetTime();
|
|
CKeyMetadata meta(now);
|
|
CWalletDB db("wallet.dat");
|
|
db.WriteZKey(addr, sk, meta);
|
|
|
|
// wallet should not be aware of key
|
|
ASSERT_FALSE(wallet.HaveSpendingKey(addr));
|
|
|
|
// wallet sees one key
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(1, addrs.size());
|
|
|
|
// wallet should have default metadata for addr with null createtime
|
|
CKeyMetadata m = wallet.mapZKeyMetadata[addr];
|
|
ASSERT_EQ(m.nCreateTime, 0);
|
|
ASSERT_NE(m.nCreateTime, now);
|
|
|
|
// load the wallet again
|
|
ASSERT_EQ(DB_LOAD_OK, wallet.LoadWallet(fFirstRun));
|
|
|
|
// wallet can now see the spending key
|
|
ASSERT_TRUE(wallet.HaveSpendingKey(addr));
|
|
|
|
// check key is the same
|
|
libzcash::SproutSpendingKey keyOut;
|
|
wallet.GetSpendingKey(addr, keyOut);
|
|
ASSERT_EQ(sk, keyOut);
|
|
|
|
// wallet should have two keys
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(2, addrs.size());
|
|
|
|
// check metadata is now the same
|
|
m = wallet.mapZKeyMetadata[addr];
|
|
ASSERT_EQ(m.nCreateTime, now);
|
|
}
|
|
|
|
/**
|
|
* This test covers methods on CWalletDB
|
|
* WriteViewingKey()
|
|
*/
|
|
TEST(wallet_zkeys_tests, WriteViewingKeyDirectToDB) {
|
|
SelectParams(CBaseChainParams::TESTNET);
|
|
|
|
// Get temporary and unique path for file.
|
|
// Note: / operator to append paths
|
|
boost::filesystem::path pathTemp = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path();
|
|
boost::filesystem::create_directories(pathTemp);
|
|
mapArgs["-datadir"] = pathTemp.string();
|
|
|
|
bool fFirstRun;
|
|
CWallet wallet("wallet-vkey.dat");
|
|
ASSERT_EQ(DB_LOAD_OK, wallet.LoadWallet(fFirstRun));
|
|
|
|
// No default CPubKey set
|
|
ASSERT_TRUE(fFirstRun);
|
|
|
|
// create random viewing key and add it to database directly, bypassing wallet
|
|
auto sk = libzcash::SproutSpendingKey::random();
|
|
auto vk = sk.viewing_key();
|
|
auto addr = sk.address();
|
|
int64_t now = GetTime();
|
|
CKeyMetadata meta(now);
|
|
CWalletDB db("wallet-vkey.dat");
|
|
db.WriteViewingKey(vk);
|
|
|
|
// wallet should not be aware of viewing key
|
|
ASSERT_FALSE(wallet.HaveViewingKey(addr));
|
|
|
|
// load the wallet again
|
|
ASSERT_EQ(DB_LOAD_OK, wallet.LoadWallet(fFirstRun));
|
|
|
|
// wallet can now see the viewing key
|
|
ASSERT_TRUE(wallet.HaveViewingKey(addr));
|
|
|
|
// check key is the same
|
|
libzcash::SproutViewingKey vkOut;
|
|
wallet.GetViewingKey(addr, vkOut);
|
|
ASSERT_EQ(vk, vkOut);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* This test covers methods on CWalletDB to load/save crypted z keys.
|
|
*/
|
|
TEST(wallet_zkeys_tests, write_cryptedzkey_direct_to_db) {
|
|
ECC_Start();
|
|
|
|
SelectParams(CBaseChainParams::TESTNET);
|
|
|
|
// Get temporary and unique path for file.
|
|
// Note: / operator to append paths
|
|
boost::filesystem::path pathTemp = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path();
|
|
boost::filesystem::create_directories(pathTemp);
|
|
mapArgs["-datadir"] = pathTemp.string();
|
|
|
|
bool fFirstRun;
|
|
CWallet wallet("wallet_crypted.dat");
|
|
ASSERT_EQ(DB_LOAD_OK, wallet.LoadWallet(fFirstRun));
|
|
|
|
// No default CPubKey set
|
|
ASSERT_TRUE(fFirstRun);
|
|
|
|
// wallet should be empty
|
|
std::set<libzcash::SproutPaymentAddress> addrs;
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(0, addrs.size());
|
|
|
|
// Add random key to the wallet
|
|
auto address = wallet.GenerateNewZKey();
|
|
ASSERT_NE(boost::get<libzcash::SproutPaymentAddress>(&address), nullptr);
|
|
auto paymentAddress = boost::get<libzcash::SproutPaymentAddress>(address);
|
|
|
|
// wallet should have one key
|
|
wallet.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(1, addrs.size());
|
|
|
|
// encrypt wallet
|
|
SecureString strWalletPass;
|
|
strWalletPass.reserve(100);
|
|
strWalletPass = "hello";
|
|
ASSERT_TRUE(wallet.EncryptWallet(strWalletPass));
|
|
|
|
// adding a new key will fail as the wallet is locked
|
|
EXPECT_ANY_THROW(wallet.GenerateNewZKey());
|
|
|
|
// unlock wallet and then add
|
|
wallet.Unlock(strWalletPass);
|
|
auto address2 = wallet.GenerateNewZKey();
|
|
ASSERT_NE(boost::get<libzcash::SproutPaymentAddress>(&address2), nullptr);
|
|
auto paymentAddress2 = boost::get<libzcash::SproutPaymentAddress>(address2);
|
|
|
|
// Create a new wallet from the existing wallet path
|
|
CWallet wallet2("wallet_crypted.dat");
|
|
ASSERT_EQ(DB_LOAD_OK, wallet2.LoadWallet(fFirstRun));
|
|
|
|
// Confirm it's not the same as the other wallet
|
|
ASSERT_TRUE(&wallet != &wallet2);
|
|
|
|
// wallet should have two keys
|
|
wallet2.GetPaymentAddresses(addrs);
|
|
ASSERT_EQ(2, addrs.size());
|
|
|
|
// check we have entries for our payment addresses
|
|
ASSERT_TRUE(addrs.count(paymentAddress));
|
|
ASSERT_TRUE(addrs.count(paymentAddress2));
|
|
|
|
// spending key is crypted, so we can't extract valid payment address
|
|
libzcash::SproutSpendingKey keyOut;
|
|
wallet2.GetSpendingKey(paymentAddress, keyOut);
|
|
ASSERT_FALSE(paymentAddress == keyOut.address());
|
|
|
|
// unlock wallet to get spending keys and verify payment addresses
|
|
wallet2.Unlock(strWalletPass);
|
|
|
|
wallet2.GetSpendingKey(paymentAddress, keyOut);
|
|
ASSERT_EQ(paymentAddress, keyOut.address());
|
|
|
|
wallet2.GetSpendingKey(paymentAddress2, keyOut);
|
|
ASSERT_EQ(paymentAddress2, keyOut.address());
|
|
|
|
ECC_Stop();
|
|
}
|
|
|