Merge branch 'CO-347' into Squad1/CO-325/api-v1-improvements

Author: KtorZ

wallet-new/cardano-sl-wallet-new.cabal

@@ -129,6 +129,7 @@ library
                        Cardano.Wallet.Server.CLI
                        Cardano.Wallet.Server.Plugins
                        Cardano.Wallet.TypeLits
+                       Cardano.Wallet.Types.UtxoStatistics
                        Cardano.Wallet.Client
                        Cardano.Wallet.Client.Http
 
@@ -176,7 +177,6 @@ library
                      , cardano-sl-node-ipc
                      , cardano-sl-util
                      , cardano-sl-wallet
-                     , cardano-sl-wallet-test
                      , cereal
                      , conduit
                      , connection
@@ -195,6 +195,7 @@ library
                      , http-client-tls
                      , http-types
                      , ixset-typed
+                     , foldl
                      , lens
                      , log-warper
                      , memory
@@ -505,7 +506,6 @@ test-suite wallet-unit-tests
                     , data-default
                     , formatting
                     , hspec
-                    , ixset-typed
                     , lens
                     , log-warper
                     , mtl
@@ -643,7 +643,6 @@ benchmark cardano-sl-wallet-new-bench
                      , bytestring
                      , cardano-sl-client
                      , cardano-sl-core
-                     , cardano-sl-db
                      , cardano-sl-wallet
                      , cassava
                      , connection

wallet-new/integration/TransactionSpecs.hs

@@ -11,9 +11,12 @@ import           Control.Lens
 import           Test.Hspec
 import           Text.Show.Pretty (ppShow)
 
+import           Util
+
+import qualified Data.Map.Strict as Map
 import qualified Pos.Core as Core
+import qualified Pos.Core.Txp as Txp
 
-import           Util
 
 {-# ANN module ("HLint: ignore Reduce duplication" :: Text) #-}
 
@@ -24,7 +27,7 @@ ppShowT :: Show a => a -> Text
 ppShowT = fromString . ppShow
 
 transactionSpecs :: WalletRef -> WalletClient IO -> Spec
-transactionSpecs wRef wc = do
+transactionSpecs wRef wc =
     describe "Transactions" $ do
         it "posted transactions appear in the index" $ do
             genesis <- genesisWallet wc
@@ -187,3 +190,43 @@ transactionSpecs wRef wc = do
             etxn <- postTransaction wc payment
 
             void $ etxn `shouldPrism` _Left
+
+        xit "posted transactions gives rise to nonempty Utxo histogram" $ do
+            genesis <- genesisWallet wc
+            (fromAcct, _) <- firstAccountAndId wc genesis
+
+            wallet <- sampleWallet wRef wc
+            (_, toAddr) <- firstAccountAndId wc wallet
+
+            let payment val = Payment
+                    { pmtSource =  PaymentSource
+                        { psWalletId = walId genesis
+                        , psAccountIndex = accIndex fromAcct
+                        }
+                    , pmtDestinations = pure PaymentDistribution
+                        { pdAddress = addrId toAddr
+                        , pdAmount = V1 (Core.mkCoin val)
+                        }
+                    , pmtGroupingPolicy = Nothing
+                    , pmtSpendingPassword = Nothing
+                    }
+
+            eresp0 <- getUtxoStatistics wc (walId wallet)
+            utxoStatistics0 <- fmap wrData eresp0 `shouldPrism` _Right
+            let utxoStatistics0Expected = computeUtxoStatistics log10 []
+            utxoStatistics0 `shouldBe` utxoStatistics0Expected
+
+            void $ postTransaction wc (payment 1)
+            threadDelay 120000000
+
+            let txIn  = Txp.TxInUnknown 0 "test"
+            let txOut = Txp.TxOutAux Txp.TxOut
+                    { Txp.txOutAddress = unV1 (addrId toAddr)
+                    , Txp.txOutValue = Core.mkCoin 1
+                    }
+            let utxos = [Map.fromList [(txIn, txOut)]]
+
+            eresp <- getUtxoStatistics wc (walId wallet)
+            utxoStatistics <- fmap wrData eresp `shouldPrism` _Right
+            let utxoStatisticsExpected = computeUtxoStatistics log10 utxos
+            utxoStatistics `shouldBe` utxoStatisticsExpected

wallet-new/integration/WalletSpecs.hs

@@ -13,7 +13,7 @@ import           Util
 
 
 walletSpecs :: WalletRef -> WalletClient IO -> Spec
-walletSpecs _ wc = do
+walletSpecs _ wc =
     describe "Wallets" $ do
         it "Creating a wallet makes it available." $ do
             newWallet <- randomWallet CreateWallet
@@ -51,6 +51,15 @@ walletSpecs _ wc = do
                 }
 
             eresp `shouldPrism_` _Right
+
+        it "creating wallet gives rise to an empty Utxo histogram" $ do
+            newWallet <- randomWallet CreateWallet
+            wallet <- createWalletCheck wc newWallet
+
+            eresp <- getUtxoStatistics wc (walId wallet)
+            utxoStatistics <- fmap wrData eresp `shouldPrism` _Right
+            let utxoStatisticsExpected = computeUtxoStatistics log10 []
+            utxoStatistics `shouldBe` utxoStatisticsExpected
   where
     testWalletAlreadyExists action = do
             newWallet1 <- randomWallet action

wallet-new/src/Cardano/Wallet/API/V1/Handlers/Wallets.hs

@@ -2,17 +2,17 @@ module Cardano.Wallet.API.V1.Handlers.Wallets where
 
 import           Universum
 
-import           Pos.Core (Coin)
+import           Servant
 
 import           Cardano.Wallet.API.Request
 import           Cardano.Wallet.API.Response
 import           Cardano.Wallet.API.V1.Types as V1
 import qualified Cardano.Wallet.API.V1.Wallets as Wallets
-
 import           Cardano.Wallet.WalletLayer (PassiveWalletLayer)
 import qualified Cardano.Wallet.WalletLayer as WalletLayer
 
-import           Servant
+import           Pos.Core.Common (Coin (..))
+
 
 -- | All the @Servant@ handlers for wallet-specific operations.
 handlers :: PassiveWalletLayer IO -> ServerT Wallets.API Handler
@@ -22,6 +22,7 @@ handlers pwl =  newWallet pwl
            :<|> deleteWallet pwl
            :<|> getWallet pwl
            :<|> updateWallet pwl
+           :<|> getUtxoStatistics pwl
            :<|> checkExternalWallet pwl
            :<|> newExternalWallet pwl
            :<|> deleteExternalWallet pwl
@@ -96,6 +97,17 @@ updateWallet pwl wid walletUpdateRequest = do
          Left e  -> throwM e
          Right w -> return $ single w
 
+getUtxoStatistics
+    :: PassiveWalletLayer IO
+    -> WalletId
+    -> Handler (WalletResponse UtxoStatistics)
+getUtxoStatistics pwl wid = do
+    res <- liftIO $ WalletLayer.getUtxos pwl wid
+    case res of
+         Left e  -> throwM e
+         Right w ->
+            return $ single $ V1.computeUtxoStatistics V1.log10 (map snd w)
+
 checkExternalWallet :: PassiveWalletLayer IO
                     -> PublicKeyAsBase58
                     -> Handler (WalletResponse WalletAndTxHistory)

wallet-new/src/Cardano/Wallet/API/V1/LegacyHandlers/Wallets.hs

@@ -30,6 +30,7 @@ import           Pos.Wallet.Web.Methods.Logic (MonadWalletLogic,
 import           Pos.Wallet.Web.Tracking.Types (SyncQueue)
 import           Servant
 
+
 -- | All the @Servant@ handlers for wallet-specific operations.
 handlers :: HasConfigurations
          => ServerT Wallets.API MonadV1
@@ -39,11 +40,11 @@ handlers = newWallet
     :<|> deleteWallet
     :<|> getWallet
     :<|> updateWallet
+    :<|> getUtxoStatistics
     :<|> checkExternalWallet
     :<|> newExternalWallet
     :<|> deleteExternalWallet
 
-
 -- | Pure function which returns whether or not the underlying node is
 -- \"synced enough\" to allow wallet creation/restoration. The notion of
 -- \"synced enough\" is quite vague and if made too stringent could prevent
@@ -183,6 +184,15 @@ updateWallet wid WalletUpdate{..} = do
         ws' <- V0.askWalletSnapshot
         addWalletInfo ws' updated
 
+-- | Gets Utxo statistics for a wallet.
+-- | Stub, not calling data layer.
+getUtxoStatistics
+    :: (MonadWalletLogic ctx m)
+    => WalletId
+    -> m (WalletResponse UtxoStatistics)
+getUtxoStatistics _ = do
+    return $ single (V1.computeUtxoStatistics V1.log10 [])
+
 -- | Check if external wallet is presented in node's wallet db.
 checkExternalWallet
     :: -- ( V0.MonadWalletLogic ctx m

wallet-new/src/Cardano/Wallet/API/V1/Swagger.hs

@@ -857,6 +857,24 @@ curl -X GET 'https://127.0.0.1:8090/api/v1/transactions?wallet_id=Ae2tdPwU...3AV
   --cert ./scripts/tls-files/client.pem
 ```
 
+
+Getting Utxo statistics
+---------------------------------
+
+You can get Utxo statistics of a given wallet using
+ [`GET /api/v1/wallets/{{walletId}}/statistics/utxos`](#tag/Accounts%2Fpaths%2F~1api~1v1~1wallets~1{walletId}~1statistics~1utxos%2Fget)
+```
+curl -X GET \
+  https://127.0.0.1:8090/api/v1/wallets/Ae2tdPwUPE...8V3AVTnqGZ/statistics/utxos \
+  -H 'Accept: application/json;charset=utf-8' \
+  --cacert ./scripts/tls-files/ca.crt \
+  --cert ./scripts/tls-files/client.pem
+```
+
+```json
+$readUtxoStatistics
+```
+
 Make sure to carefully read the section about [Pagination](#section/Pagination) to fully
 leverage the API capabilities.
 |]
@@ -871,7 +889,7 @@ leverage the API capabilities.
     readFees             = decodeUtf8 $ encodePretty $ genExample @(WalletResponse EstimatedFees)
     readNodeInfo         = decodeUtf8 $ encodePretty $ genExample @(WalletResponse NodeInfo)
     readTransactions     = decodeUtf8 $ encodePretty $ genExample @(WalletResponse [Transaction])
-
+    readUtxoStatistics   = decodeUtf8 $ encodePretty $ genExample @(WalletResponse UtxoStatistics)
 
 -- | Provide an alternative UI (ReDoc) for rendering Swagger documentation.
 swaggerSchemaUIServer

wallet-new/src/Cardano/Wallet/API/V1/Types.hs

@@ -122,6 +122,8 @@ module Cardano.Wallet.API.V1.Types (
   , WalletError(..)
   , toServantError
   , toHttpErrorStatus
+
+  , module Cardano.Wallet.Types.UtxoStatistics
   ) where
 
 import qualified Prelude
@@ -177,7 +179,9 @@ import           Cardano.Wallet.API.V1.Generic (jsendErrorGenericParseJSON,
 import           Cardano.Wallet.API.V1.Swagger.Example (Example, example,
                      genExample)
 import           Cardano.Wallet.Orphans.Aeson ()
+import           Cardano.Wallet.Types.UtxoStatistics
 import           Cardano.Wallet.Util (showApiUtcTime)
+
 import qualified Pos.Binary.Class as Bi
 import qualified Pos.Client.Txp.Util as Core
 import           Pos.Core (addressF)

wallet-new/src/Cardano/Wallet/API/V1/Wallets.hs

@@ -37,6 +37,9 @@ type API = Tags '["Wallets"] :>
                    :> Summary "Update the Wallet identified by the given walletId."
                    :> ReqBody '[ValidJSON] (Update Wallet)
                    :> Put '[ValidJSON] (WalletResponse Wallet)
+    :<|> "wallets" :> CaptureWalletId :> "statistics" :> "utxos"
+                   :> Summary "Returns Utxo statistics for the Wallet identified by the given walletId."
+                   :> Get '[ValidJSON] (WalletResponse UtxoStatistics)
     :<|> "external-wallets"
                    :> Capture "rootPK" PublicKeyAsBase58
                    :> Summary "Check if this external wallet is presented in the node."

wallet-new/src/Cardano/Wallet/Client.hs

@@ -89,6 +89,8 @@ data WalletClient m
         :: WalletId -> Resp m Wallet
     , updateWallet
          :: WalletId -> Update Wallet -> Resp m Wallet
+    , getUtxoStatistics
+        :: WalletId -> Resp m UtxoStatistics
     , postCheckExternalWallet
          :: PublicKeyAsBase58 -> Resp m WalletAndTxHistory
     , postExternalWallet
@@ -218,6 +220,8 @@ hoistClient phi wc = WalletClient
         phi . getWallet wc
     , updateWallet =
         \x -> phi . updateWallet wc x
+    , getUtxoStatistics =
+         phi . getUtxoStatistics wc
     , postCheckExternalWallet =
         phi . postCheckExternalWallet wc
     , postExternalWallet =

wallet-new/src/Cardano/Wallet/Client/Http.hs

@@ -105,6 +105,8 @@ mkHttpClient baseUrl manager = WalletClient
         = run . getWalletR
     , updateWallet
         = \x -> run . updateWalletR x
+    , getUtxoStatistics
+        = run . getUtxoStatisticsR
     , postCheckExternalWallet
         = run . postCheckExternalWalletR
     , postExternalWallet
@@ -171,6 +173,7 @@ mkHttpClient baseUrl manager = WalletClient
         :<|> deleteWalletR
         :<|> getWalletR
         :<|> updateWalletR
+        :<|> getUtxoStatisticsR
         :<|> postCheckExternalWalletR
         :<|> postExternalWalletR
         :<|> deleteExternalWalletR