aboutsummaryrefslogtreecommitdiff
path: root/src/keystore.h
diff options
context:
space:
mode:
authorPieter Wuille <pieter.wuille@gmail.com>2011-11-07 00:05:42 +0100
committerPieter Wuille <pieter.wuille@gmail.com>2011-11-07 00:11:34 +0100
commitd825e6a31bf980dde8afd94fba61614523e60f09 (patch)
treee39034b1e8bfbc103299fa84b15273a3a275719e /src/keystore.h
parent81a28d7a6f8ab4b3642907b79106d2350a5e7d63 (diff)
Some extra comments
Diffstat (limited to 'src/keystore.h')
-rw-r--r--src/keystore.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/keystore.h b/src/keystore.h
index 1f2c6aea3e..4d889146fc 100644
--- a/src/keystore.h
+++ b/src/keystore.h
@@ -7,21 +7,34 @@
#include "crypter.h"
+// A virtual base class for key stores
class CKeyStore
{
protected:
mutable CCriticalSection cs_KeyStore;
public:
+ // Add a key to the store.
virtual bool AddKey(const CKey& key) =0;
+
+ // Check whether a key corresponding to a given address is present in the store.
virtual bool HaveKey(const CBitcoinAddress &address) const =0;
+
+ // Retrieve a key corresponding to a given address from the store.
+ // Return true if succesful.
virtual bool GetKey(const CBitcoinAddress &address, CKey& keyOut) const =0;
+
+ // Retrieve only the public key corresponding to a given address.
+ // This may succeed even if GetKey fails (e.g., encrypted wallets)
virtual bool GetPubKey(const CBitcoinAddress &address, std::vector<unsigned char>& vchPubKeyOut) const;
+
+ // Generate a new key, and add it to the store
virtual std::vector<unsigned char> GenerateNewKey();
};
typedef std::map<CBitcoinAddress, CSecret> KeyMap;
+// Basic key store, that keeps keys in an address->secret map
class CBasicKeyStore : public CKeyStore
{
protected:
@@ -53,6 +66,8 @@ public:
typedef std::map<CBitcoinAddress, std::pair<std::vector<unsigned char>, std::vector<unsigned char> > > CryptedKeyMap;
+// Keystore which keeps the private keys encrypted
+// It derives from the basic key store, which is used if no encryption is active.
class CCryptoKeyStore : public CBasicKeyStore
{
private: