Backporting 'IsOurs' abstraction from cardano-wallet

Author: KtorZ

wallet-new/src/Cardano/Wallet/Kernel/DB/HdWallet.hs

@@ -23,6 +23,9 @@ module Cardano.Wallet.Kernel.DB.HdWallet (
   , HdRoot(..)
   , HdAccount(..)
   , HdAddress(..)
+  -- * IsOurs
+  , IsOurs(..)
+  , decryptHdLvl2DerivationPath
     -- * HD Wallet state
   , HdAccountState(..)
   , HdAccountUpToDate(..)
@@ -113,14 +116,15 @@ import           Serokell.Util (listJson)
 import qualified Pos.Core as Core
 import           Pos.Core.Chrono (NewestFirst (..))
 import           Pos.Core.NetworkMagic (NetworkMagic (..))
+import           Pos.Crypto (HDPassphrase)
 import qualified Pos.Crypto as Core
 
 import           Cardano.Wallet.API.V1.Types (V1 (..))
 import           Cardano.Wallet.Kernel.DB.BlockContext
 import           Cardano.Wallet.Kernel.DB.InDb
 import           Cardano.Wallet.Kernel.DB.Spec
 import           Cardano.Wallet.Kernel.DB.Util.AcidState
-import           Cardano.Wallet.Kernel.DB.Util.IxSet
+import           Cardano.Wallet.Kernel.DB.Util.IxSet hiding (foldl')
 import qualified Cardano.Wallet.Kernel.DB.Util.IxSet as IxSet hiding (Indexable)
 import qualified Cardano.Wallet.Kernel.DB.Util.Zoomable as Z
 import           Cardano.Wallet.Kernel.NodeStateAdaptor (SecurityParameter (..))
@@ -210,6 +214,9 @@ deriveSafeCopy 1 'base ''HasSpendingPassword
 eskToHdRootId :: NetworkMagic -> Core.EncryptedSecretKey -> HdRootId
 eskToHdRootId nm = HdRootId . InDb . (Core.makePubKeyAddressBoot nm) . Core.encToPublic
 
+eskToHdPassphrase :: Core.EncryptedSecretKey -> HDPassphrase
+eskToHdPassphrase = Core.deriveHDPassphrase . Core.encToPublic
+
 
 {-------------------------------------------------------------------------------
   HD wallets
@@ -504,6 +511,37 @@ hdAccountRestorationState a = case a ^. hdAccountState of
       ( _hdIncompleteHistorical ^. currentCheckpoint . cpContext . lazy,
         _hdIncompleteCurrent    ^. oldestCheckpoint  . pcheckpointContext)
 
+{-------------------------------------------------------------------------------
+  Address relationship: isOurs?
+-------------------------------------------------------------------------------}
+
+class IsOurs s where
+    isOurs :: Core.Address -> s -> (Maybe HdAddress, s)
+
+{-------------------------------------------------------------------------------
+  isOurs for Hd Random wallets
+-------------------------------------------------------------------------------}
+
+-- | NOTE: We could modify the given state here to actually store decrypted
+-- addresses in a `Map` to trade a decryption against a map lookup for already
+-- decrypted addresses.
+instance IsOurs [(HdRootId, Core.EncryptedSecretKey)] where
+    isOurs addr s = (,s) $ foldl' (<|>) Nothing $ flip map s $ \(rootId, esk) -> do
+        (accountIx, addressIx) <- decryptHdLvl2DerivationPath (eskToHdPassphrase esk) addr
+        let accId = HdAccountId rootId accountIx
+        let addrId = HdAddressId accId addressIx
+        return $ HdAddress addrId (InDb addr)
+
+decryptHdLvl2DerivationPath
+    :: Core.HDPassphrase
+    -> Core.Address
+    -> Maybe (HdAccountIx, HdAddressIx)
+decryptHdLvl2DerivationPath hdPass addr = do
+    hdPayload <- Core.aaPkDerivationPath $ Core.addrAttributesUnwrapped addr
+    derPath <- Core.unpackHDAddressAttr hdPass hdPayload
+    case derPath of
+        [a,b] -> Just (HdAccountIx a, HdAddressIx b)
+        _     -> Nothing
 
 {-------------------------------------------------------------------------------
   Unknown identifiers

wallet-new/src/Cardano/Wallet/Kernel/Decrypt.hs

@@ -1,6 +1,5 @@
 module Cardano.Wallet.Kernel.Decrypt
     ( decryptAddress
-    , decryptHdLvl2DerivationPath
     , keyToWalletDecrCredentials
     , WalletDecrCredentials
     , WalletDecrCredentialsKey(..)
@@ -12,17 +11,5 @@ import           Data.List ((!!))
 
 import           Pos.Wallet.Web.Tracking.Decrypt
 
-import           Cardano.Wallet.Kernel.DB.HdWallet (HdAccountIx (..),
-                     HdAddressIx (..))
 import           Pos.Core (Address, aaPkDerivationPath, addrAttributesUnwrapped)
 import           Pos.Crypto (HDPassphrase, unpackHDAddressAttr)
-
-
-decryptHdLvl2DerivationPath :: HDPassphrase
-                            -> Address
-                            -> Maybe (HdAccountIx, HdAddressIx)
-decryptHdLvl2DerivationPath hdPass addr = do
-    hdPayload <- aaPkDerivationPath $ addrAttributesUnwrapped addr
-    derPath <- unpackHDAddressAttr hdPass hdPayload
-    guard $ length derPath == 2
-    pure (HdAccountIx (derPath !! 0), HdAddressIx (derPath !! 1))

wallet-new/src/Cardano/Wallet/Kernel/Wallets.hs

@@ -41,8 +41,7 @@ import           Cardano.Wallet.Kernel.DB.HdWallet (AssuranceLevel,
 import qualified Cardano.Wallet.Kernel.DB.HdWallet as HD
 import qualified Cardano.Wallet.Kernel.DB.HdWallet.Create as HD
 import           Cardano.Wallet.Kernel.DB.InDb (InDb (..), fromDb)
-import           Cardano.Wallet.Kernel.Decrypt (WalletDecrCredentialsKey (..),
-                     decryptHdLvl2DerivationPath, keyToWalletDecrCredentials)
+import           Cardano.Wallet.Kernel.Decrypt (keyToWalletDecrCredentials)
 import           Cardano.Wallet.Kernel.Internal (PassiveWallet, walletKeystore,
                      walletProtocolMagic, wallets)
 import qualified Cardano.Wallet.Kernel.Keystore as Keystore
@@ -282,7 +281,7 @@ defaultHdAddressWith :: HDPassphrase
                      -> Address
                      -> Maybe HdAddress
 defaultHdAddressWith hdPass rootId cardanoAddress = do
-    (hdAccountIx, hdAddressIx) <- decryptHdLvl2DerivationPath hdPass cardanoAddress
+    (hdAccountIx, hdAddressIx) <- HD.decryptHdLvl2DerivationPath hdPass cardanoAddress
     let hdAccountId = HdAccountId rootId hdAccountIx
         hdAddressId = HdAddressId hdAccountId hdAddressIx
     pure $ HD.HdAddress hdAddressId (InDb cardanoAddress)