Merge pull request #3562 from input-output-hk/adinapoli/cbr-377/replace-new-wallet-flag

[CBR-377] Replace `--new-wallet` flag

Author: adinapoli-iohk

wallet-new/server/Main.hs

@@ -183,8 +183,8 @@ actionWithWallet coreConfig txpConfig sscParams nodeParams ntpConfig params =
         -- Periodically compact & snapshot the acid-state database.
         , Plugins.acidStateSnapshots (view Kernel.Internal.wallets (snd w)) params dbMode
 
-        -- | A @Plugin@ to notify frontend via websockets.
-        , Plugins.updateNotifier
+        -- | A @Plugin@ to watch and store incoming update proposals
+        , Plugins.updateWatcher
         ]
 
     -- Extract the logger name from node parameters

wallet-new/src/Cardano/Wallet/Server/CLI.hs

@@ -123,12 +123,12 @@ chooseWalletBackendParser :: Parser ChooseWalletBackend
 chooseWalletBackendParser = choose
     <$> walletBackendParamsParser
     <*> (switch $ mconcat [
-            long "new-wallet"
-          , help "Use the new wallet implementation (NOT FOR PRODUCTION USE)"
+            long "legacy-wallet"
+          , help "Use the legacy wallet implementation (NOT RECOMMENDED)"
           ])
   where
-    choose opts False = WalletLegacy $ opts
-    choose opts True  = WalletNew    $ NewWalletBackendParams opts
+    choose opts True  = WalletLegacy $ opts
+    choose opts False = WalletNew    $ NewWalletBackendParams opts
 
 -- | The @Parser@ for the @WalletBackendParams@.
 walletBackendParamsParser :: Parser WalletBackendParams

wallet-new/src/Cardano/Wallet/Server/LegacyPlugins.hs

@@ -48,7 +48,8 @@ import qualified Servant
 import           Pos.Context (HasNodeContext)
 import           Pos.Core as Core (Config)
 import           Pos.Util (lensOf)
-import           Pos.Util.Wlog (logInfo, modifyLoggerName, usingLoggerName)
+import           Pos.Util.Wlog (logInfo, logWarning, modifyLoggerName,
+                     usingLoggerName)
 
 import           Cardano.NodeIPC (startNodeJsIPC)
 import           Pos.Configuration (walletProductionApi,
@@ -115,6 +116,7 @@ legacyWalletBackend :: (HasConfigurations, HasCompileInfo)
                     -> Plugin WalletWebMode
 legacyWalletBackend coreConfig txpConfig WalletBackendParams {..} ntpStatus = pure $ \diffusion -> do
     modifyLoggerName (const "legacyServantBackend") $ do
+      logWarning $ sformat "RUNNING THE OLD LEGACY DATA LAYER IS NOT RECOMMENDED!"
       logInfo $ sformat ("Production mode for API: "%build)
         walletProductionApi
       logInfo $ sformat ("Transaction submission disabled: "%build)

wallet-new/src/Cardano/Wallet/Server/Plugins.hs

@@ -9,7 +9,7 @@ module Cardano.Wallet.Server.Plugins
     , docServer
     , monitoringServer
     , acidStateSnapshots
-    , updateNotifier
+    , updateWatcher
     ) where
 
 import           Universum
@@ -30,14 +30,14 @@ import           Cardano.Wallet.Server.CLI (NewWalletBackendParams (..),
                      isDebugMode, walletAcidInterval)
 import           Cardano.Wallet.WalletLayer (ActiveWalletLayer,
                      PassiveWalletLayer)
+import           Pos.Chain.Update (cpsSoftwareVersion)
 import           Pos.Crypto (ProtocolMagic)
 import           Pos.Infra.Diffusion.Types (Diffusion (..))
 import           Pos.Infra.Shutdown (HasShutdownContext (shutdownContext),
                      ShutdownContext)
 import           Pos.Launcher.Configuration (HasConfigurations)
 import           Pos.Util.CompileInfo (HasCompileInfo)
-import           Pos.Util.Wlog (logError, logInfo, modifyLoggerName,
-                     usingLoggerName)
+import           Pos.Util.Wlog (logInfo, modifyLoggerName, usingLoggerName)
 import           Pos.Web (serveDocImpl, serveImpl)
 import qualified Pos.Web.Server
 
@@ -46,6 +46,7 @@ import qualified Cardano.Wallet.Kernel.Mode as Kernel
 import qualified Cardano.Wallet.Server as Server
 import           Cardano.Wallet.Server.Plugins.AcidState
                      (createAndArchiveCheckpoints)
+import qualified Cardano.Wallet.WalletLayer as WalletLayer
 import qualified Cardano.Wallet.WalletLayer.Kernel as WalletLayer.Kernel
 import qualified Data.ByteString.Char8 as BS8
 import qualified Servant
@@ -158,8 +159,12 @@ acidStateSnapshots dbRef params dbMode = pure $ \_diffusion -> do
             (walletAcidInterval opts)
             dbMode
 
--- | A @Plugin@ to notify frontend via websockets.
-updateNotifier :: Plugin Kernel.WalletMode
-updateNotifier = [
-    \_diffusion -> logError "Not Implemented: updateNotifier [CBR-374]"
-    ]
+-- | A @Plugin@ to store updates proposal received from the blockchain
+updateWatcher :: Plugin Kernel.WalletMode
+updateWatcher = pure $ \_diffusion -> do
+    modifyLoggerName (const "update-watcher-plugin") $ do
+        w <- Kernel.getWallet
+        forever $ liftIO $ do
+            newUpdate <- WalletLayer.waitForUpdate w
+            logInfo "A new update was found!"
+            WalletLayer.addUpdate w . cpsSoftwareVersion $ newUpdate

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

@@ -34,6 +34,7 @@ import           Test.QuickCheck (Arbitrary (..), oneof)
 
 import           Pos.Chain.Block (Blund)
 import           Pos.Chain.Txp (Tx, TxId, Utxo)
+import           Pos.Chain.Update (ConfirmedProposalState)
 import           Pos.Core (Coin, Timestamp)
 import           Pos.Core.Chrono (NE, NewestFirst (..), OldestFirst (..))
 import           Pos.Core.Update (SoftwareVersion)
@@ -463,6 +464,10 @@ data PassiveWalletLayer m = PassiveWalletLayer
     , postponeUpdate       :: m ()
     , resetWalletState     :: m ()
     , importWallet         :: WalletImport -> m (Either ImportWalletError Wallet)
+
+    -- updates
+    , waitForUpdate        :: m ConfirmedProposalState
+    , addUpdate            :: SoftwareVersion -> m ()
     }
 
 ------------------------------------------------------------

wallet-new/src/Cardano/Wallet/WalletLayer/Kernel.hs

@@ -71,9 +71,11 @@ bracketPassiveWallet mode logFunction keystore node f = do
         , updateAccount        = Accounts.updateAccount       w
         , deleteAccount        = Accounts.deleteAccount       w
         , createAddress        = Addresses.createAddress      w
+        , addUpdate            = Internal.addUpdate           w
         , nextUpdate           = Internal.nextUpdate          w
         , applyUpdate          = Internal.applyUpdate         w
         , postponeUpdate       = Internal.postponeUpdate      w
+        , waitForUpdate        = Internal.waitForUpdate       w
         , resetWalletState     = Internal.resetWalletState    w
         , importWallet         = Internal.importWallet        w
         , applyBlocks          = invokeIO . Actions.ApplyBlocks

wallet-new/src/Cardano/Wallet/WalletLayer/Kernel/Internal.hs

@@ -4,6 +4,9 @@ module Cardano.Wallet.WalletLayer.Kernel.Internal (
   , postponeUpdate
   , resetWalletState
   , importWallet
+
+  , waitForUpdate
+  , addUpdate
   ) where
 
 import           Universum
@@ -12,12 +15,13 @@ import           Control.Concurrent.MVar (modifyMVar_)
 import           Data.Acid.Advanced (update')
 import           System.IO.Error (isDoesNotExistError)
 
+import           Pos.Chain.Update (ConfirmedProposalState)
 import           Pos.Core.Update (SoftwareVersion)
 
 import           Cardano.Wallet.API.V1.Types (V1 (..), Wallet,
                      WalletImport (..))
-import           Cardano.Wallet.Kernel.DB.AcidState (ClearDB (..),
-                     GetNextUpdate (..), RemoveNextUpdate (..))
+import           Cardano.Wallet.Kernel.DB.AcidState (AddUpdate (..),
+                     ClearDB (..), GetNextUpdate (..), RemoveNextUpdate (..))
 import           Cardano.Wallet.Kernel.DB.InDb
 import           Cardano.Wallet.Kernel.DB.TxMeta
 import qualified Cardano.Wallet.Kernel.Internal as Kernel
@@ -67,6 +71,18 @@ applyUpdate w = liftIO $ do
 postponeUpdate :: MonadIO m => Kernel.PassiveWallet -> m ()
 postponeUpdate w = update' (w ^. Kernel.wallets) $ RemoveNextUpdate
 
+-- | Wait for an update notification
+waitForUpdate :: MonadIO m => Kernel.PassiveWallet -> m ConfirmedProposalState
+waitForUpdate w = liftIO $
+    Node.withNodeState (w ^. Kernel.walletNode) $ \_lock ->
+        Node.waitForUpdate
+
+-- | Add an update in the DB, this is triggered by the notifier once getting
+-- a new proposal from the blockchain
+addUpdate :: MonadIO m => Kernel.PassiveWallet -> SoftwareVersion -> m ()
+addUpdate w v = liftIO $
+    update' (w ^. Kernel.wallets) $ AddUpdate (InDb v)
+
 -- | Reset wallet state
 resetWalletState :: MonadIO m => Kernel.PassiveWallet -> m ()
 resetWalletState w = liftIO $ do

wallet-new/test/Cardano/Wallet/WalletLayer/QuickCheck.hs

@@ -21,6 +21,7 @@ import           Cardano.Wallet.WalletLayer (ActiveWalletLayer (..),
 
 import           Cardano.Wallet.API.V1.Types (V1 (..))
 
+import           Pos.Chain.Update (ConfirmedProposalState)
 import           Pos.Core ()
 import           Test.Pos.Chain.Txp.Arbitrary ()
 import           Test.QuickCheck (Arbitrary (..), arbitrary, generate, oneof)
@@ -71,6 +72,9 @@ bracketPassiveWallet =
         , postponeUpdate       = liftedGen
         , resetWalletState     = liftedGen
         , importWallet         = \_ -> liftedGen
+
+        , waitForUpdate        = liftedGen
+        , addUpdate            = \_ -> liftedGen
         }
 
 -- | A utility function.
@@ -163,3 +167,10 @@ instance Arbitrary ImportWalletError where
                       , ImportWalletNoWalletFoundInBackup <$> arbitrary
                       , ImportWalletCreationFailed <$> arbitrary
                       ]
+
+-- This is obviously not a valid 'Arbitrary' instance, but one will be provided
+-- when we will be start using this 'WalletLayer' implementation. Note how the
+-- core layer already provides one, it's just a matter of exposing it to other
+-- components and use it.
+instance Arbitrary ConfirmedProposalState where
+    arbitrary = oneof []