Merge pull request #278 from input-output-hk/denisshevchenko/36/eos-wallets-RDL

RDL-operations for EOS-wallets.

Author: KtorZ

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

@@ -136,8 +136,11 @@ readEosWallets
     :: PassiveWalletLayer IO
     -> WalletId
     -> Handler (APIResponse EosWallet)
-readEosWallets _ _ = do
-    throwM $ err501 { errBody = "Not Implemented" }
+readEosWallets pwl wid = do
+    res <- liftIO $ WalletLayer.getEosWallet pwl wid
+    case res of
+         Left e  -> throwM e
+         Right w -> return $ single w
 
 updateEosWallets
     :: PassiveWalletLayer IO
@@ -151,14 +154,24 @@ deleteEosWallets
     :: PassiveWalletLayer IO
     -> WalletId
     -> Handler NoContent
-deleteEosWallets _ _ = do
-    throwM $ err501 { errBody = "Not Implemented" }
+deleteEosWallets pwl wid = do
+    res <- liftIO $ WalletLayer.deleteEosWallet pwl wid
+    case res of
+         Left e   -> throwM e
+         Right () -> return NoContent
 
 listEosWallets
     :: PassiveWalletLayer IO
     -> RequestParams
     -> FilterOperations '[WalletId, Coin] EosWallet
     -> SortOperations EosWallet
     -> Handler (APIResponse [EosWallet])
-listEosWallets _ _ _ _ = do
-    throwM $ err501 { errBody = "Not Implemented" }
+listEosWallets pwl params fops sops = do
+    res <- liftIO $ WalletLayer.getEosWallets pwl
+    case res of
+        Left e -> throwM e
+        Right wallets ->
+            respondWith params
+                fops
+                sops
+                (pure wallets)

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

@@ -43,6 +43,7 @@ translateWalletLayerErrors ex = do
 
         <|> try' @CreateWalletError createWalletError
         <|> try' @GetWalletError getWalletError
+        <|> try' @GetEosWalletError getEosWalletError
         <|> try' @UpdateWalletError updateWalletError
         <|> try' @UpdateWalletPasswordError updateWalletPasswordError
         <|> try' @DeleteWalletError deleteWalletError
@@ -156,6 +157,24 @@ getWalletError e = case e of
     (GetWalletWalletIdDecodingFailed _txt) ->
             V1.WalletNotFound
 
+getAddressPoolGapError :: GetAddressPoolGapError -> V1.WalletError
+getAddressPoolGapError e = case e of
+    ex@(GetEosWalletErrorNoAccounts _txt) ->
+        V1.EosWalletDoesNotHaveAccounts (sformat build ex)
+    ex@(GetEosWalletErrorWrongAccounts _txt) ->
+        V1.EosWalletHasWrongAccounts (sformat build ex)
+    ex@(GetEosWalletErrorGapsDiffer _txt) ->
+        V1.EosWalletGapsDiffer (sformat build ex)
+
+getEosWalletError :: GetEosWalletError -> V1.WalletError
+getEosWalletError e = case e of
+    (GetEosWalletError (HD.UnknownHdRoot _rootId)) ->
+        V1.WalletNotFound
+    (GetEosWalletWalletIdDecodingFailed _txt) ->
+        V1.WalletNotFound
+    (GetEosWalletErrorAddressPoolGap e') ->
+        getAddressPoolGapError e'
+
 updateWalletError :: UpdateWalletError -> V1.WalletError
 updateWalletError e = case e of
     (UpdateWalletError (HD.UnknownHdRoot _rootId)) ->

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

@@ -2496,6 +2496,12 @@ data WalletError =
     | UtxoNotEnoughFragmented !ErrUtxoNotEnoughFragmented
     -- ^ available Utxo is not enough fragmented, ie., there is more outputs of transaction than
     -- utxos
+    | EosWalletDoesNotHaveAccounts Text
+    -- ^ EOS-wallet doesn't have any accounts.
+    | EosWalletHasWrongAccounts Text
+    -- ^ Some of accounts associated with EOS-wallets have FO-branch.
+    | EosWalletGapsDiffer Text
+    -- ^ Accounts associated with EOS-wallet contain different values of address pool gap.
     deriving (Generic, Show, Eq)
 
 deriveGeneric ''WalletError
@@ -2599,6 +2605,12 @@ instance Buildable WalletError where
             bprint "You've made too many requests too soon, and this one was throttled."
         UtxoNotEnoughFragmented x ->
             bprint build x
+        EosWalletDoesNotHaveAccounts _ ->
+            bprint "EOS-wallet doesn't have any accounts."
+        EosWalletHasWrongAccounts _ ->
+            bprint "Some of accounts associated with EOS-wallets have FO-branch."
+        EosWalletGapsDiffer _ ->
+            bprint "Accounts associated with EOS-wallet contain different values of address pool gap."
 
 -- | Convert wallet errors to Servant errors
 instance ToServantError WalletError where
@@ -2643,7 +2655,12 @@ instance ToServantError WalletError where
             err400 { errHTTPCode = 429 }
         UtxoNotEnoughFragmented{} ->
             err403
-
+        EosWalletDoesNotHaveAccounts{} ->
+            err500
+        EosWalletHasWrongAccounts{} ->
+            err500
+        EosWalletGapsDiffer{} ->
+            err500
 
 -- | Declare the key used to wrap the diagnostic payload, if any
 instance HasDiagnostic WalletError where
@@ -2688,3 +2705,9 @@ instance HasDiagnostic WalletError where
             "microsecondsUntilRetry"
         UtxoNotEnoughFragmented{} ->
             "details"
+        EosWalletDoesNotHaveAccounts{} ->
+            noDiagnosticKey
+        EosWalletHasWrongAccounts{} ->
+            noDiagnosticKey
+        EosWalletGapsDiffer{} ->
+            noDiagnosticKey

src/Cardano/Wallet/WalletLayer.hs

@@ -6,10 +6,11 @@ module Cardano.Wallet.WalletLayer
     -- ** Errors
     , CreateWalletError(..)
     , GetWalletError(..)
+    , GetAddressPoolGapError(..)
+    , GetEosWalletError(..)
     , UpdateWalletError(..)
     , UpdateWalletPasswordError(..)
     , DeleteWalletError(..)
-    , DeleteEosWalletError(..)
     , GetUtxosError(..)
     , NewPaymentError(..)
     , EstimateFeesError(..)
@@ -114,6 +115,40 @@ instance Buildable GetWalletError where
     build (GetWalletWalletIdDecodingFailed txt) =
         bprint ("GetWalletWalletIdDecodingFailed " % build) txt
 
+data GetAddressPoolGapError =
+      GetEosWalletErrorNoAccounts Text
+    | GetEosWalletErrorWrongAccounts Text
+    | GetEosWalletErrorGapsDiffer Text
+    deriving Eq
+
+instance Buildable GetAddressPoolGapError where
+    build (GetEosWalletErrorNoAccounts txt) =
+        bprint ("GetEosWalletErrorNoAccounts " % build) txt
+    build (GetEosWalletErrorWrongAccounts txt) =
+        bprint ("FO-accounts found in EOS-wallet " % build) txt
+    build (GetEosWalletErrorGapsDiffer txt) =
+        bprint ("Address pool gaps differ, for EOS-wallet " % build) txt
+
+data GetEosWalletError =
+      GetEosWalletError Kernel.UnknownHdRoot
+    | GetEosWalletWalletIdDecodingFailed Text
+    | GetEosWalletErrorAddressPoolGap GetAddressPoolGapError
+    deriving Eq
+
+-- | Unsound show instance needed for the 'Exception' instance.
+instance Show GetEosWalletError where
+    show = formatToString build
+
+instance Exception GetEosWalletError
+
+instance Buildable GetEosWalletError where
+    build (GetEosWalletError kernelError) =
+        bprint ("GetEosWalletError " % build) kernelError
+    build (GetEosWalletWalletIdDecodingFailed txt) =
+        bprint ("GetEosWalletWalletIdDecodingFailed " % build) txt
+    build (GetEosWalletErrorAddressPoolGap gapError) =
+        bprint ("GetEosWalletErrorAddressPoolGap " % build) gapError
+
 data UpdateWalletError =
       UpdateWalletError Kernel.UnknownHdRoot
     | UpdateWalletErrorNotFound WalletId
@@ -168,19 +203,6 @@ instance Buildable DeleteWalletError where
     build (DeleteWalletError kernelError) =
         bprint ("DeleteWalletError " % build) kernelError
 
-data DeleteEosWalletError =
-    DeleteEosWalletError Kernel.UnknownHdRoot
-
--- | Unsound show instance needed for the 'Exception' instance.
-instance Show DeleteEosWalletError where
-    show = formatToString build
-
-instance Exception DeleteEosWalletError
-
-instance Buildable DeleteEosWalletError where
-    build (DeleteEosWalletError kernelError) =
-        bprint ("DeleteEosWalletError " % build) kernelError
-
 data GetUtxosError =
       GetUtxosWalletIdDecodingFailed Text
     | GetUtxosGetAccountsError Kernel.UnknownHdRoot
@@ -429,7 +451,9 @@ data PassiveWalletLayer m = PassiveWalletLayer
     -- fully-owned wallets
       createWallet         :: CreateWallet -> m (Either CreateWalletError Wallet)
     , getWallets           :: m (IxSet Wallet)
+    , getEosWallets        :: m (Either GetEosWalletError (IxSet EosWallet))
     , getWallet            :: WalletId -> m (Either GetWalletError Wallet)
+    , getEosWallet         :: WalletId -> m (Either GetEosWalletError EosWallet)
     , updateWallet         :: WalletId
                            -> WalletUpdate
                            -> m (Either UpdateWalletError Wallet)
@@ -439,7 +463,7 @@ data PassiveWalletLayer m = PassiveWalletLayer
     , deleteWallet         :: WalletId -> m (Either DeleteWalletError ())
     -- externally-owned wallets
     , createEosWallet      :: NewEosWallet -> m (Either CreateWalletError EosWallet)
-    , deleteEosWallet      :: WalletId -> m (Either DeleteEosWalletError ())
+    , deleteEosWallet      :: WalletId -> m (Either DeleteWalletError ())
     , getUtxos             :: WalletId
                            -> m (Either GetUtxosError [(Account, Utxo)])
     -- accounts

src/Cardano/Wallet/WalletLayer/Kernel.hs

@@ -128,7 +128,9 @@ bracketPassiveWallet pm mode logFunction keystore node fInjects f = do
 
           -- Read-only operations
         , getWallets           =                   join (ro $ Wallets.getWallets w)
+        , getEosWallets        =                   join (ro $ Wallets.getEosWallets w)
         , getWallet            = \wId           -> join (ro $ Wallets.getWallet w wId)
+        , getEosWallet         = \wId           -> join (ro $ Wallets.getEosWallet w wId)
         , getUtxos             = \wId           -> ro $ Wallets.getWalletUtxos wId
         , getAccounts          = \wId           -> ro $ Accounts.getAccounts         wId
         , getAccount           = \wId acc       -> ro $ Accounts.getAccount          wId acc

src/Cardano/Wallet/WalletLayer/Kernel/Conv.hs

@@ -12,6 +12,7 @@ module Cardano.Wallet.WalletLayer.Kernel.Conv (
   , toRootId
   , toAccount
   , toWallet
+  , toEosWallet
   , toAddress
   , toCardanoAddress
   , toAssuranceLevel
@@ -46,6 +47,7 @@ import           Pos.Crypto (AesKey, RedeemSecretKey, aesDecrypt,
 import           Cardano.Mnemonic (mnemonicToAesKey)
 import           Cardano.Wallet.API.Types.UnitOfMeasure
 import qualified Cardano.Wallet.API.V1.Types as V1
+import           Cardano.Wallet.Kernel.AddressPoolGap (AddressPoolGap)
 import           Cardano.Wallet.Kernel.CoinSelection.FromGeneric
                      (InputGrouping (..))
 import           Cardano.Wallet.Kernel.DB.BlockMeta (addressMetaIsUsed)
@@ -62,6 +64,11 @@ import qualified Cardano.Wallet.Kernel.Read as Kernel
 import           UTxO.Util (exceptT)
 -- import           Cardano.Wallet.WalletLayer (InvalidRedemptionCode (..))
 
+-- Functions 'toWallet' and 'toEosWallet' contain duplications in 'where'
+-- sections, but in order to fix it we should change two functions and
+-- introduce the new one.
+{-# ANN module ("HLint: ignore Reduce duplication" :: Text) #-}
+
 {-------------------------------------------------------------------------------
   From V1 to kernel types
 
@@ -180,6 +187,22 @@ toWallet db hdRoot = V1.Wallet {
     walletId         = sformat build rootId
     v1AssuranceLevel = toAssuranceLevel $ hdRoot ^. HD.hdRootAssurance
 
+-- | Converts an 'HdRoot' into a V1 'EosWallet'.
+toEosWallet :: Kernel.DB -> HD.HdRoot -> AddressPoolGap -> V1.EosWallet
+toEosWallet db hdRoot gap = V1.EosWallet {
+      eoswalId = V1.WalletId walletId
+    , eoswalName = hdRoot ^. HD.hdRootName . to HD.getWalletName
+    , eoswalAddressPoolGap = gap
+    , eoswalBalance = V1.WalletCoin (Kernel.rootTotalBalance db rootId)
+    , eoswalCreatedAt = V1.WalletTimestamp createdAt
+    , eoswalAssuranceLevel = v1AssuranceLevel
+    }
+  where
+    rootId = hdRoot ^. HD.hdRootId
+    createdAt = hdRoot ^. HD.hdRootCreatedAt . fromDb
+    walletId = sformat build rootId
+    v1AssuranceLevel = toAssuranceLevel $ hdRoot ^. HD.hdRootAssurance
+
 toAssuranceLevel :: HD.AssuranceLevel -> V1.AssuranceLevel
 toAssuranceLevel HD.AssuranceLevelNormal = V1.NormalAssurance
 toAssuranceLevel HD.AssuranceLevelStrict = V1.StrictAssurance