introduce GetAccount type class

lib/core/src/Cardano/Wallet.hs

@@ -158,8 +158,7 @@ module Cardano.Wallet
 
     -- ** Root Key
     , withRootKey
-    , derivePublicKeyShelley
-    , derivePublicKeyShared
+    , derivePublicKey
     , readPublicAccountKey
     , signMetadataWith
     , ErrWithRootKey (..)
@@ -250,6 +249,7 @@ import Cardano.Wallet.Primitive.AddressDerivation.Shelley
 import Cardano.Wallet.Primitive.AddressDiscovery
     ( CompareDiscovery (..)
     , GenChange (..)
+    , GetAccount (..)
     , IsOurs (..)
     , IsOwned (..)
     , KnownAddresses (..)
@@ -266,7 +266,7 @@ import Cardano.Wallet.Primitive.AddressDiscovery.Sequential
     , purposeBIP44
     )
 import Cardano.Wallet.Primitive.AddressDiscovery.SharedState
-    ( ErrAddCosigner (..), SharedState, accountPublicKey, addCosignerAccXPub )
+    ( ErrAddCosigner (..), SharedState, addCosignerAccXPub )
 import Cardano.Wallet.Primitive.CoinSelection.MA.RoundRobin
     ( SelectionError (..)
     , SelectionResult (..)
@@ -2104,69 +2104,26 @@ signMetadataWith ctx wid pwd (role_, ix) metadata = db & \DBLayer{..} -> do
   where
     db = ctx ^. dbLayer @IO @s @k
 
--- | Derive public key from a wallet's account key.
-derivePublicKeyShelley
-    :: forall ctx s k n.
-        ( HasDBLayer IO s k ctx
-        , SoftDerivation k
-        , s ~ SeqState n k
-        )
-    => ctx
-    -> WalletId
-    -> Role
-    -> DerivationIndex
-    -> ExceptT ErrDerivePublicKey IO (k 'AddressK XPub)
-derivePublicKeyShelley ctx =
-    derivePublicKey @ctx @s @k  ctx toAccXPubShelley
-
-derivePublicKeyShared
-    :: forall ctx s k n.
-        ( HasDBLayer IO s k ctx
-        , SoftDerivation k
-        , s ~ SharedState n k
-        )
-    => ctx
-    -> WalletId
-    -> Role
-    -> DerivationIndex
-    -> ExceptT ErrDerivePublicKey IO (k 'AddressK XPub)
-derivePublicKeyShared ctx =
-    derivePublicKey @ctx @s @k ctx toAccXPubShared
-
-toAccXPubShared
-    :: SharedState n k
-    -> k 'AccountK XPub
-toAccXPubShared = accountPublicKey
-
-toAccXPubShelley
-    :: SeqState n k
-    -> k 'AccountK XPub
-toAccXPubShelley s =
-    -- NOTE: Alternatively, we could use 'internalPool', they share the same
-    --       account public key.
-    let (Seq.ParentContextUtxo acctK) = Seq.context $ Seq.externalPool s
-    in acctK
-
 derivePublicKey
     :: forall ctx s k.
         ( HasDBLayer IO s k ctx
         , SoftDerivation k
+        , GetAccount s k
         )
     => ctx
-    -> (s -> k 'AccountK XPub)
     -> WalletId
     -> Role
     -> DerivationIndex
     -> ExceptT ErrDerivePublicKey IO (k 'AddressK XPub)
-derivePublicKey ctx toAccXPub wid role_ ix = db & \DBLayer{..} -> do
+derivePublicKey ctx wid role_ ix = db & \DBLayer{..} -> do
     addrIx <- withExceptT ErrDerivePublicKeyInvalidIndex $ guardSoftIndex ix
 
     cp <- mapExceptT atomically
         $ withExceptT ErrDerivePublicKeyNoSuchWallet
         $ withNoSuchWallet wid
         $ readCheckpoint wid
 
-    let acctK = toAccXPub $ getState cp
+    let acctK = getAccount $ getState cp
     let addrK = deriveAddressPublicKey acctK role_ addrIx
 
     return addrK

lib/core/src/Cardano/Wallet/Api/Server.hs

@@ -2178,7 +2178,7 @@ derivePublicKeyShelley
     -> Handler ApiVerificationKeyShelley
 derivePublicKeyShelley ctx (ApiT wid) (ApiT role_) (ApiT ix) = do
     withWorkerCtx @_ @s @k ctx wid liftE liftE $ \wrk -> do
-        k <- liftHandler $ W.derivePublicKeyShelley @_ @s @k @n wrk wid role_ ix
+        k <- liftHandler $ W.derivePublicKey @_ @s @k wrk wid role_ ix
         pure $ ApiVerificationKeyShelley (xpubPublicKey $ getRawKey k, role_)
 
 derivePublicKeyShared
@@ -2196,7 +2196,7 @@ derivePublicKeyShared
     -> Handler ApiVerificationKeyShared
 derivePublicKeyShared ctx (ApiT wid) (ApiT role_) (ApiT ix) hashed = do
     withWorkerCtx @_ @s @k ctx wid liftE liftE $ \wrk -> do
-        k <- liftHandler $ W.derivePublicKeyShared @_ @s @k @n wrk wid role_ ix
+        k <- liftHandler $ W.derivePublicKey @_ @s @k wrk wid role_ ix
         pure $ ApiVerificationKeyShared (computePayload k, role_) hashing
   where
     hashing = case hashed of

lib/core/src/Cardano/Wallet/Primitive/AddressDiscovery.hs

@@ -3,6 +3,7 @@
 {-# LANGUAGE DerivingStrategies #-}
 {-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE FunctionalDependencies #-}
 {-# LANGUAGE MultiParamTypeClasses #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeFamilies #-}
@@ -26,13 +27,14 @@ module Cardano.Wallet.Primitive.AddressDiscovery
     , CompareDiscovery(..)
     , KnownAddresses(..)
     , GetPurpose (..)
+    , GetAccount (..)
     , coinTypeAda
     ) where
 
 import Prelude
 
 import Cardano.Crypto.Wallet
-    ( XPrv )
+    ( XPrv, XPub )
 import Cardano.Wallet.Primitive.AddressDerivation
     ( Depth (..)
     , DerivationIndex (..)
@@ -156,3 +158,7 @@ coinTypeAda = toEnum 0x80000717
 -- It is used for geting purpose for a given key.
 class GetPurpose (key :: Depth -> Type -> Type)  where
     getPurpose :: Index 'Hardened 'PurposeK
+
+-- It is used for geting account public key for a given state.
+class GetAccount s (key :: Depth -> Type -> Type) | s -> key  where
+    getAccount :: s -> key 'AccountK XPub

lib/core/src/Cardano/Wallet/Primitive/AddressDiscovery/Sequential.hs

@@ -105,6 +105,7 @@ import Cardano.Wallet.Primitive.AddressDerivation.SharedKey
 import Cardano.Wallet.Primitive.AddressDiscovery
     ( CompareDiscovery (..)
     , GenChange (..)
+    , GetAccount (..)
     , GetPurpose (..)
     , IsOurs (..)
     , IsOwned (..)
@@ -1002,3 +1003,10 @@ instance
     ) => KnownAddresses (SeqAnyState n k p)
   where
     knownAddresses (SeqAnyState s) = knownAddresses s
+
+instance GetAccount (SeqState n k) k where
+    getAccount s =
+        -- NOTE: Alternatively, we could use 'internalPool', they share the same
+        --       account public key.
+        let (ParentContextUtxo acctK) = context $ externalPool s
+        in acctK

lib/core/src/Cardano/Wallet/Primitive/AddressDiscovery/SharedState.hs

@@ -33,7 +33,6 @@ module Cardano.Wallet.Primitive.AddressDiscovery.SharedState
     , isShared
     , retrieveAllCosigners
     , walletCreationInvariant
-    , accountPublicKey
     ) where
 
 import Prelude
@@ -64,7 +63,7 @@ import Cardano.Wallet.Primitive.AddressDerivation
 import Cardano.Wallet.Primitive.AddressDerivation.SharedKey
     ( SharedKey (..), purposeCIP1854 )
 import Cardano.Wallet.Primitive.AddressDiscovery
-    ( IsOurs (..), coinTypeAda )
+    ( GetAccount (..), IsOurs (..), coinTypeAda )
 import Cardano.Wallet.Primitive.AddressDiscovery.Script
     ( CredentialType (..) )
 import Cardano.Wallet.Primitive.AddressDiscovery.Sequential
@@ -200,13 +199,6 @@ instance
     ( NFData (k 'AccountK XPub)
     ) => NFData (SharedStatePending k)
 
-accountPublicKey :: SharedState n k -> k 'AccountK XPub
-accountPublicKey (SharedState _ (PendingFields pending)) =
-    pendingSharedStateAccountKey pending
-accountPublicKey (SharedState _ (ReadyFields pool)) =
-    let (ParentContextShared accXPub _ _) = context pool
-    in accXPub
-
 -- | Create a new SharedState from public account key.
 mkSharedStateFromAccountXPub
     :: (SupportsSharedState n k, WalletKey k, k ~ SharedKey)
@@ -425,3 +417,10 @@ instance IsOurs (SharedState n k) Address where
 
 instance IsOurs (SharedState n k) RewardAccount where
     isOurs _account state = (Nothing, state)
+
+instance GetAccount (SharedState n k) k where
+    getAccount (SharedState _ (PendingFields pending)) =
+        pendingSharedStateAccountKey pending
+    getAccount (SharedState _ (ReadyFields pool)) =
+        let (ParentContextShared accXPub _ _) = context pool
+        in accXPub