Merge pull request #3468 from input-output-hk/CHW-5-api-wallets-impl

[CHW] Implement basic handlers for work with external wallets.

Author: Denis Shevchenko

server/Main.hs

@@ -29,12 +29,12 @@ import           Pos.Launcher.Configuration (AssetLockPath (..),
 import           Pos.Util (logException)
 import           Pos.Util.CompileInfo (HasCompileInfo, withCompileInfo)
 import           Pos.Util.UserSecret (usVss)
-import           Pos.Wallet.Web (bracketWalletWS, bracketWalletWebDB, getSKById,
-                     getWalletAddresses, runWRealMode)
+import           Pos.Wallet.Web (bracketWalletWS, bracketWalletWebDB,
+                     getKeyById, getWalletAddresses, runWRealMode)
 import           Pos.Wallet.Web.Mode (WalletWebMode)
 import           Pos.Wallet.Web.State (askWalletDB, askWalletSnapshot,
                      flushWalletStorage)
-import           Pos.Wallet.Web.Tracking.Decrypt (eskToWalletDecrCredentials)
+import           Pos.Wallet.Web.Tracking.Decrypt (keyToWalletDecrCredentials)
 import           Pos.Wallet.Web.Tracking.Sync (syncWallet)
 import           System.Wlog (LoggerName, Severity (..), logInfo, logMessage,
                      usingLoggerName)
@@ -100,8 +100,8 @@ actionWithWallet pm txpConfig sscParams nodeParams ntpConfig wArgs@WalletBackend
     syncWallets :: WalletWebMode ()
     syncWallets = do
         addrs <- getWalletAddresses <$> askWalletSnapshot
-        sks <- mapM getSKById addrs
-        forM_ sks (syncWallet . eskToWalletDecrCredentials)
+        keys' <- mapM getKeyById addrs
+        forM_ keys' (syncWallet . keyToWalletDecrCredentials)
 
     plugins :: TVar NtpStatus -> Plugins.Plugin WalletWebMode
     plugins ntpStatus =

src/Cardano/Wallet/API/V1/LegacyHandlers/Addresses.hs

@@ -27,7 +27,7 @@ import qualified Pos.Wallet.Web.State.State as V0State
 import           Pos.Wallet.Web.State.Storage (getWalletAddresses)
 import qualified Pos.Wallet.Web.State.Storage as V0
 import qualified Pos.Wallet.Web.Tracking as V0 (txMempoolToModifier)
-import           Pos.Wallet.Web.Tracking.Decrypt (eskToWalletDecrCredentials)
+import           Pos.Wallet.Web.Tracking.Decrypt (keyToWalletDecrCredentials)
 
 import           Cardano.Wallet.API.Indices (IxSet)
 import           Cardano.Wallet.API.Request
@@ -126,6 +126,6 @@ getAddress addrText = do
         Just (_walletMeta, V0.AddressInfo{..}) -> do
             let accId = adiWAddressMeta ^. V0.wamAccount
             mps <- V0.withTxpLocalData V0.getMempoolSnapshot
-            accMod <- V0.txMempoolToModifier ws mps . eskToWalletDecrCredentials =<< V0.findKey accId
+            accMod <- V0.txMempoolToModifier ws mps . keyToWalletDecrCredentials =<< V0.findKey accId
             let caddr = V0.getWAddress ws accMod adiWAddressMeta
             single <$> migrate caddr

src/Cardano/Wallet/API/V1/LegacyHandlers/Wallets.hs

@@ -6,6 +6,7 @@ module Cardano.Wallet.API.V1.LegacyHandlers.Wallets (
     , newWallet
     ) where
 
+import           Formatting (build, sformat)
 import           Universum
 import           UnliftIO (MonadUnliftIO)
 
@@ -21,9 +22,11 @@ import           Cardano.Wallet.API.V1.Types as V1
 import qualified Cardano.Wallet.API.V1.Wallets as Wallets
 import qualified Cardano.Wallet.Kernel.DB.Util.IxSet as IxSet
 import           Pos.Chain.Update ()
+import           Pos.Client.KeyStorage (addPublicKey)
 import qualified Pos.Core as Core
 
-import           Pos.Util (HasLens (..))
+import           Pos.Util (HasLens (..), maybeThrow)
+import           Pos.Util.Servant (encodeCType)
 import qualified Pos.Wallet.WalletMode as V0
 import           Pos.Wallet.Web.Methods.Logic (MonadWalletLogic,
                      MonadWalletLogicRead)
@@ -199,25 +202,110 @@ checkExternalWallet _encodedRootPK =
 -- | Creates a new or restores an existing external @wallet@ given a 'NewExternalWallet' payload.
 -- Returns to the client the representation of the created or restored wallet in the 'Wallet' type.
 newExternalWallet
+    :: ( MonadThrow m
+       , MonadUnliftIO m
+       -- , HasLens SyncQueue ctx SyncQueue
+       , V0.MonadBlockchainInfo m
+       , V0.MonadWalletLogic ctx m
+       )
+    => NewExternalWallet
+    -> m (WalletResponse Wallet)
+newExternalWallet (NewExternalWallet rootPK assuranceLevel name operation) = do
+    let newExternalWalletHandler CreateWallet  = createNewExternalWallet
+        newExternalWalletHandler RestoreWallet = restoreExternalWallet
+    walletMeta <- V0.CWalletMeta <$> pure name
+                                 <*> migrate assuranceLevel
+                                 <*> pure 0
+    single <$> do
+        v0wallet <- newExternalWalletHandler operation walletMeta rootPK
+        ws <- V0.askWalletSnapshot
+        migrateWallet ws v0wallet True
+
+-- | Creates new external wallet.
+createNewExternalWallet
+    :: ( MonadThrow m
+       , V0.MonadWalletLogic ctx m
+       )
+    => V0.CWalletMeta
+    -> PublicKeyAsBase58
+    -> m V0.CWallet
+createNewExternalWallet walletMeta encodedRootPK = do
+    rootPK <- case mkPublicKeyFromBase58 encodedRootPK of
+        Left problem -> throwM (InvalidPublicKey $ sformat build problem)
+        Right rootPK -> return rootPK
+
+    -- This extended public key will be used during synchronization
+    -- with the blockchain.
+    addPublicKey rootPK
+
+    let walletId = encodeCType . Core.makePubKeyAddressBoot $ rootPK
+        isReady  = True -- We don't need to sync new wallet with the blockchain.
+
+    -- Create new external wallet.
+    -- This is safe: if the client will try to create an external wallet from the same
+    -- root public key - error will be thrown.
+    void $ V0.createWalletSafe walletId walletMeta isReady
+
+    addInitAccountInExternalWallet walletId
+
+    V0.getWallet walletId
+
+-- | Restore external wallet using it's root public key and metadata.
+restoreExternalWallet
     :: -- ( MonadThrow m
        -- , MonadUnliftIO m
        -- , HasLens SyncQueue ctx SyncQueue
-       -- , V0.MonadBlockchainInfo m
        -- , V0.MonadWalletLogic ctx m
        -- )
        -- =>
-    NewExternalWallet
-    -> m (WalletResponse Wallet)
-newExternalWallet NewExternalWallet{..} =
-    error "[CHW-80], Cardano Hardware Wallet, new external wallet, legacy handler, unimplemented yet."
+    V0.CWalletMeta
+    -> PublicKeyAsBase58
+    -> m V0.CWallet
+restoreExternalWallet _walletMeta _encodedRootPK =
+    error "[CHW-54], restore external wallet, unimplemented yet."
+
+addInitAccountInExternalWallet
+    :: ( MonadThrow m
+       , V0.MonadWalletLogic ctx m
+       )
+    => V0.CId V0.Wal
+    -> m ()
+addInitAccountInExternalWallet walletId = do
+    let accountName = "Initial account"
+        accountMeta = V0.CAccountMeta accountName
+        accountInit = V0.CAccountInit accountMeta walletId
+        includeUnready = True
+    void $ V0.newExternalAccountIncludeUnready includeUnready accountInit
 
 -- | On the disk, once imported or created, there's so far not much difference
 -- between a wallet and an external wallet, except one: node stores a public key
 -- for external wallet, there's no secret key.
 deleteExternalWallet
-    :: -- (V0.MonadWalletLogic ctx m)
-       -- =>
-    PublicKeyAsBase58
+    :: (V0.MonadWalletLogic ctx m)
+    => PublicKeyAsBase58
     -> m NoContent
-deleteExternalWallet _encodedRootPK =
-    error "[CHW-106], Cardano Hardware Wallet, delete external wallet, legacy handler, unimplemented yet."
+deleteExternalWallet encodedRootPK =
+    case V1.mkPublicKeyFromBase58 encodedRootPK of
+        Left problem -> throwM (InvalidPublicKey $ sformat build problem)
+        Right rootPK -> V0.deleteExternalWallet rootPK
+
+migrateWallet
+    :: ( V0.MonadWalletLogicRead ctx m
+       , V0.MonadBlockchainInfo m
+       )
+    => V0.WalletSnapshot
+    -> V0.CWallet
+    -> Bool
+    -> m Wallet
+migrateWallet snapshot wallet walletIsReady = do
+    let walletId = V0.cwId wallet
+    walletInfo <- if walletIsReady
+        then maybeThrow WalletNotFound $ V0.getWalletInfo walletId snapshot
+        else
+            -- Wallet is not ready yet (because of restoring),
+            -- the only information we can provide is the default one.
+            pure $ V0.getUnreadyWalletInfo snapshot
+    walletIsExternal <- V0.isWalletExternal walletId
+    let walletType = if walletIsExternal then WalletExternal else WalletRegular
+    currentDepth <- V0.networkChainDifficulty
+    migrate (wallet, walletInfo, walletType, currentDepth)

src/Cardano/Wallet/API/V1/Types.hs

@@ -41,6 +41,7 @@ module Cardano.Wallet.API.V1.Types (
   , ExternalWallet (..)
   , PublicKeyAsBase58
   , mkPublicKeyAsBase58
+  , mkPublicKeyFromBase58
   , NewExternalWallet (..)
   , WalletAndTxHistory (..)
   -- * Addresses
@@ -151,7 +152,7 @@ import           Data.Swagger.Internal.TypeShape (GenericHasSimpleShape,
 import           Data.Text (Text, dropEnd, toLower)
 import qualified Data.Text as T
 import           Data.Version (Version)
-import           Formatting (bprint, build, fconst, int, sformat, (%))
+import           Formatting (bprint, build, fconst, int, sformat, stext, (%))
 import qualified Formatting.Buildable
 import           Generics.SOP.TH (deriveGeneric)
 import           GHC.Generics (Generic, Rep)
@@ -618,6 +619,27 @@ mkPublicKeyAsBase58 (PublicKey xPub) = PublicKeyAsBase58Unsafe encodedXPub
   where
     encodedXPub = decodeUtf8 $ encodeBase58 bitcoinAlphabet (CC.unXPub xPub)
 
+-- | Possible problems with Base58-encoded extended public key.
+data Base58PublicKeyError
+    = PublicKeyNotInBase58Form
+    | NotAPublicKey !Text
+    deriving Show
+
+instance Buildable Base58PublicKeyError where
+    build PublicKeyNotInBase58Form =
+        "Extended public key is not in Base58-format."
+    build (NotAPublicKey msg) =
+        bprint ("It is not an extended public key: "%stext) msg
+
+-- | Decoder for 'PublicKey' in Base58-format.
+mkPublicKeyFromBase58 :: PublicKeyAsBase58 -> Either Base58PublicKeyError PublicKey
+mkPublicKeyFromBase58 (PublicKeyAsBase58Unsafe encodedXPub) = do
+    case (decodeBase58 bitcoinAlphabet . encodeUtf8 $ encodedXPub) of
+        Nothing -> Left PublicKeyNotInBase58Form
+        Just rawKey -> case CC.xpub rawKey of
+            Left problem -> Left $ NotAPublicKey (toText problem)
+            Right xPub   -> Right $ PublicKey xPub
+
 -- | Type for representation address in Base58-format.
 -- We use it for external wallets.
 newtype AddressAsBase58 = AddressAsBase58Unsafe

src/Cardano/Wallet/Kernel/Pending.hs

@@ -31,7 +31,8 @@ import           Cardano.Wallet.Kernel.Read (getWalletCredentials)
 import           Cardano.Wallet.Kernel.Submission (Cancelled, addPending)
 import           Cardano.Wallet.Kernel.Types (WalletId (..))
 
-import           Pos.Wallet.Web.Tracking.Decrypt (eskToWalletDecrCredentials)
+import           Pos.Wallet.Web.Tracking.Decrypt (WalletDecrCredentialsKey (..),
+                     keyToWalletDecrCredentials)
 
 {-------------------------------------------------------------------------------
   Submit pending transactions
@@ -105,7 +106,7 @@ newTx ActiveWallet{..} accountId tx mbMeta upd = do
             map f $ filterOurs wKey identity addrs
             where
                 f (address,addressId) = initHdAddress addressId (InDb address)
-                wKey = (wid, eskToWalletDecrCredentials esk)
+                wKey = (wid, keyToWalletDecrCredentials $ KeyForRegular esk)
 
         putTxMeta' :: Maybe TxMeta -> IO ()
         putTxMeta' (Just meta) = putTxMeta (walletPassive ^. walletMeta) meta

src/Cardano/Wallet/Kernel/PrefilterTx.hs

@@ -30,7 +30,8 @@ import           Pos.Core.Txp (TxId, TxIn (..), TxOut (..), TxOutAux (..))
 import           Pos.Crypto (EncryptedSecretKey)
 import           Pos.Wallet.Web.State.Storage (WAddressMeta (..))
 import           Pos.Wallet.Web.Tracking.Decrypt (WalletDecrCredentials,
-                     eskToWalletDecrCredentials, selectOwnAddresses)
+                     WalletDecrCredentialsKey (..), keyToWalletDecrCredentials,
+                     selectOwnAddresses)
 
 import           Cardano.Wallet.Kernel.DB.BlockMeta
 import           Cardano.Wallet.Kernel.DB.HdWallet
@@ -168,7 +169,7 @@ prefilterUtxo :: HdRootId -> EncryptedSecretKey -> Utxo -> Map HdAccountId (Utxo
 prefilterUtxo rootId esk utxo = map toPrefilteredUtxo prefUtxo
     where
         (_,prefUtxo) = prefilterUtxo' wKey utxo
-        wKey         = (WalletIdHdRnd rootId, eskToWalletDecrCredentials esk)
+        wKey         = (WalletIdHdRnd rootId, keyToWalletDecrCredentials $ KeyForRegular esk)
 
 -- | Produce Utxo along with all (extended) addresses occurring in the Utxo
 toPrefilteredUtxo :: UtxoWithAddrId -> (Utxo,[AddrWithId])
@@ -262,7 +263,7 @@ prefilterBlock block wid esk =
     , metas)
   where
     wdc :: WalletDecrCredentials
-    wdc  = eskToWalletDecrCredentials esk
+    wdc  = keyToWalletDecrCredentials $ KeyForRegular esk
     wKey = (wid, wdc)
 
     inps :: [Map HdAccountId (Set TxIn)]

src/Cardano/Wallet/Server/Plugins.hs

@@ -182,9 +182,11 @@ legacyWalletBackend pm txpConfig WalletBackendParams {..} ntpStatus = pure $ \di
     handleV0Errors se =
         let maskSensitive err =
                 case err of
-                    V0.RequestError _  -> err
-                    V0.InternalError _ -> V0.RequestError "InternalError"
-                    V0.DecodeError _   -> V0.RequestError "DecodeError"
+                    V0.RequestError _         -> err
+                    V0.DuplicateWalletError _ -> V0.RequestError "DuplicateWalletError"
+                    V0.NoSuchWalletError _    -> V0.RequestError "NoSuchWalletError"
+                    V0.InternalError _        -> V0.RequestError "InternalError"
+                    V0.DecodeError _          -> V0.RequestError "DecodeError"
             reify :: V0.WalletError -> V1.WalletError
             reify = V1.UnknownError . sformat build . maskSensitive
         in fmap (responseLBS badRequest400 [applicationJson] .  encode . reify) (fromException se)