[CO-347] Wallet's UTXO histogram view

pkgs/default.nix

@@ -17579,6 +17579,7 @@ license = stdenv.lib.licenses.mit;
 , monad-control
 , MonadRandom
 , mtl
+, pvss
 , QuickCheck
 , random
 , reflection
@@ -17715,10 +17716,12 @@ lens
 log-warper
 MonadRandom
 mtl
+pvss
 QuickCheck
 safe-exceptions
 safecopy
 serokell-util
+servant
 servant-server
 stm
 universum
@@ -17762,7 +17765,6 @@ license = stdenv.lib.licenses.mit;
 , cardano-sl-util
 , cardano-sl-util-test
 , cardano-sl-wallet
-, cardano-sl-wallet-test
 , cassava
 , conduit
 , connection
@@ -17774,8 +17776,10 @@ license = stdenv.lib.licenses.mit;
 , directory
 , exceptions
 , filepath
+, foldl
 , formatting
 , gauge
+, generic-arbitrary
 , generics-sop
 , hedgehog
 , hspec
@@ -17874,7 +17878,6 @@ cardano-sl-networking
 cardano-sl-node-ipc
 cardano-sl-util
 cardano-sl-wallet
-cardano-sl-wallet-test
 conduit
 connection
 containers
@@ -17883,6 +17886,7 @@ data-default
 data-default-class
 directory
 exceptions
+foldl
 formatting
 generics-sop
 http-api-data
@@ -17997,9 +18001,9 @@ data-default
 directory
 filepath
 formatting
+generic-arbitrary
 hedgehog
 hspec
-ixset-typed
 lens
 log-warper
 mtl
@@ -18030,7 +18034,6 @@ base
 bytestring
 cardano-sl-client
 cardano-sl-core
-cardano-sl-db
 cardano-sl-wallet
 cassava
 connection

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

@@ -118,6 +118,7 @@ library
                        Cardano.Wallet.Server.CLI
                        Cardano.Wallet.Server.Plugins
                        Cardano.Wallet.TypeLits
+                       Cardano.Wallet.Types.UtxoStatistics
                        Cardano.Wallet.Client
                        Cardano.Wallet.Client.Http
 
@@ -161,7 +162,6 @@ library
                      , cardano-sl-node-ipc
                      , cardano-sl-util
                      , cardano-sl-wallet
-                     , cardano-sl-wallet-test
                      , conduit
                      , connection
                      , containers
@@ -179,6 +179,7 @@ library
                      , http-types
                      , ixset-typed
                      , json-sop
+                     , foldl
                      , lens
                      , log-warper
                      , memory
@@ -485,7 +486,6 @@ test-suite wallet-unit-tests
                     , data-default
                     , formatting
                     , hspec
-                    , ixset-typed
                     , lens
                     , log-warper
                     , mtl
@@ -574,6 +574,7 @@ test-suite wallet-new-specs
                     , formatting
                     , hedgehog
                     , hspec
+                    , generic-arbitrary
                     , lens
                     , QuickCheck
                     , quickcheck-instances
@@ -620,7 +621,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

@@ -8,13 +8,17 @@ import           Universum
 import           Cardano.Wallet.API.V1.Errors hiding (describe)
 import           Cardano.Wallet.Client.Http
 import           Control.Lens
-import qualified Pos.Core as Core
 import           Test.Hspec
 
 import           Control.Concurrent (threadDelay)
 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
+
+
 {-# ANN module ("HLint: ignore Reduce duplication" :: Text) #-}
 
 log :: MonadIO m => Text -> m ()
@@ -24,7 +28,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 +191,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

@@ -15,7 +15,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
@@ -53,6 +53,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,18 +2,18 @@ module Cardano.Wallet.API.V1.Handlers.Wallets where
 
 import           Universum
 
+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.Types as WalletLayer
 
+import qualified Cardano.Wallet.API.V1.Wallets as Wallets
 import qualified Cardano.Wallet.Kernel.DB.Util.IxSet as KernelIxSet
+import qualified Cardano.Wallet.WalletLayer.Types as WalletLayer
 import qualified Data.IxSet.Typed as IxSet
 
-import           Servant
 
 -- | All the @Servant@ handlers for wallet-specific operations.
 handlers :: PassiveWalletLayer IO -> ServerT Wallets.API Handler
@@ -23,7 +23,7 @@ handlers pwl =  newWallet pwl
            :<|> deleteWallet pwl
            :<|> getWallet pwl
            :<|> updateWallet pwl
-
+           :<|> getUtxoStatistics pwl
 
 -- | Creates a new or restores an existing @wallet@ given a 'NewWallet' payload.
 -- Returns to the client the representation of the created or restored
@@ -97,3 +97,14 @@ updateWallet pwl wid walletUpdateRequest = do
     case res of
          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)

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

@@ -32,6 +32,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
@@ -41,7 +42,7 @@ handlers = newWallet
     :<|> deleteWallet
     :<|> getWallet
     :<|> updateWallet
-
+    :<|> getUtxoStatistics
 
 -- | Pure function which returns whether or not the underlying node is
 -- \"synced enough\" to allow wallet creation/restoration. The notion of
@@ -185,3 +186,12 @@ updateWallet wid WalletUpdate{..} = do
         -- reacquire the snapshot because we did an update
         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 _ =
+    return $ single (V1.computeUtxoStatistics V1.log10 [])

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

@@ -733,8 +733,8 @@ curl -X POST \
   --cacert ./scripts/tls-files/ca.crt \
   --cert ./scripts/tls-files/client.pem \
   -d '{
-	"walletId": "Ae2tdPwUPE...V3AVTnqGZ4",
-	"accountIndex": 2147483648
+        "walletId": "Ae2tdPwUPE...V3AVTnqGZ4",
+        "accountIndex": 2147483648
 }'
 ```
 
@@ -829,6 +829,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.
 |]
@@ -843,7 +861,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

@@ -87,6 +87,9 @@ module Cardano.Wallet.API.V1.Types (
   , CaptureAccountId
   -- * Core re-exports
   , Core.Address
+
+  , module Cardano.Wallet.Types.UtxoStatistics
+
   ) where
 
 import           Universum
@@ -129,6 +132,7 @@ import           Cardano.Wallet.API.Types.UnitOfMeasure (MeasuredIn (..),
 import           Cardano.Wallet.Kernel.DB.Util.IxSet (HasPrimKey (..),
                      IndicesOf, OrdByPrimKey, ixFun, ixList)
 import           Cardano.Wallet.Orphans.Aeson ()
+import           Cardano.Wallet.Types.UtxoStatistics
 
 -- V0 logic
 import           Pos.Util.Mnemonic (Mnemonic)
@@ -852,6 +856,7 @@ instance BuildableSafeGen Wallet where
 instance Buildable [Wallet] where
     build = bprint listJson
 
+
 --------------------------------------------------------------------------------
 -- Addresses
 --------------------------------------------------------------------------------

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

@@ -37,4 +37,7 @@ 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)
     )

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

@@ -88,6 +88,8 @@ data WalletClient m
         :: WalletId -> Resp m Wallet
     , updateWallet
          :: WalletId -> Update Wallet -> Resp m Wallet
+    , getUtxoStatistics
+        :: WalletId -> Resp m UtxoStatistics
     -- account endpoints
     , deleteAccount
          :: WalletId -> AccountIndex -> m (Either ClientError ())
@@ -211,6 +213,8 @@ hoistClient phi wc = WalletClient
         phi . getWallet wc
     , updateWallet =
         \x -> phi . updateWallet wc x
+    , getUtxoStatistics =
+         phi . getUtxoStatistics wc
     , deleteAccount =
         \x -> phi . deleteAccount wc x
     , getAccount =