[ADP-106] Support restoration-from option in create-wallet API (#4382)

This PR adds support for restoration from a given chainpoint for shelley wallets. - [x] Add RestorationMode optional field to the API specs - [x] Add RestorationMode and API counterpart haskell type - [x] Add some datatype to transport the mode to the DBLayer (StartRestorationPoint) - [x] Add a datatype to hold the initial state of a wallet (InitialState) - [x] Update JSON golden for WalletPostData - [x] Implement the database support for the mode ADP-106
cardano-foundation · Mar 11, 2024 · 8ff7008 · 8ff7008
2 parents a626766 + 80c0763
commit 8ff7008
Show file tree

Hide file tree

Showing 43 changed files with 1,580 additions and 401 deletions.
diff --git a/justfile b/justfile
@@ -42,13 +42,16 @@ unit-tests-cabal-match match:
 # run unit tests
 unit-tests-cabal:
     just unit-tests-cabal-match ""
+
 # run wallet-e2e suite against the preprod network
 e2e-preprod:
   nix run '.#cardano-wallet-e2e' -- preprod \
     -s lib/wallet-e2e/test-state/preprod \
     -c lib/wallet-e2e/config/cardano-node/preprod \
     -t lib/wallet-e2e/test-output/preprod
 
+add_missing_json_goldens:
+    CREATE_MISSING_GOLDEN=1 just unit-tests-cabal-match "JSON"
 
 # run wallet-e2e suite against the local test cluster
 e2e-local:
@@ -69,6 +72,7 @@ integration-tests-cabal-match match:
 
 # run any integration test matching the given pattern via cabal
 integration-tests-cabal-options options:
+  TESTS_TRACING_MIN_SEVERITY=Warning \
   LOCAL_CLUSTER_NODE_OUTPUT_FILE=/dev/null \
   LOCAL_CLUSTER_CONFIGS=../../lib/local-cluster/test/data/cluster-configs \
   CARDANO_WALLET_TEST_DATA=../../lib/integration/test/data \

diff --git a/lib/benchmarks/exe/db-bench.hs b/lib/benchmarks/exe/db-bench.hs
@@ -146,6 +146,9 @@ import Cardano.Wallet.Flavor
     ( KeyFlavorS (..)
     , WalletFlavor (..)
     )
+import Cardano.Wallet.Network.RestorationMode
+    ( RestorationPoint (RestorationPointAtGenesis)
+    )
 import Cardano.Wallet.Primitive.Model
     ( Wallet
     , initWallet
@@ -752,6 +755,7 @@ walletFixture :: WalletFixture StateBench
 walletFixture =
     ( DBLayerParams
         testCp
+        RestorationPointAtGenesis
         testMetadata
         mempty
         dummyGenesisParameters
@@ -762,6 +766,7 @@ walletFixtureByron :: WalletFixture StateBenchByron
 walletFixtureByron =
     ( DBLayerParams
         testCpByron
+        RestorationPointAtGenesis
         testMetadata
         mempty
         dummyGenesisParameters

diff --git a/lib/benchmarks/exe/latency-bench.hs b/lib/benchmarks/exe/latency-bench.hs
@@ -386,6 +386,7 @@ massiveFixtureWallet massiveMnemonic = do
                 , name = ApiT $ unsafeFromText "Massive wallet"
                 , passphrase = ApiT $ unsafeFromText fixturePassphrase
                 , oneChangeAddressMode = Nothing
+                , restorationMode = Nothing
                 }
     finallyDeleteWallet wal1
     wal1

diff --git a/lib/benchmarks/exe/restore-bench.hs b/lib/benchmarks/exe/restore-bench.hs
@@ -67,7 +67,8 @@ import Cardano.Mnemonic
     , entropyToMnemonic
     )
 import Cardano.Wallet
-    ( WalletLayer (..)
+    ( InitialState (..)
+    , WalletLayer (..)
     , WalletWorkerLog (..)
     , dummyChangeAddressGen
     )
@@ -157,6 +158,9 @@ import Cardano.Wallet.Network.Implementation.Ouroboros
     ( PipeliningStrategy
     , tunedForMainnetPipeliningStrategy
     )
+import Cardano.Wallet.Network.RestorationMode
+    ( RestorationPoint (..)
+    )
 import Cardano.Wallet.Primitive.Ledger.Read.Block
     ( fromCardanoBlock
     )
@@ -846,7 +850,9 @@ bench_restoration
             let ti = neverFails "bench db shouldn't forecast into future"
                     $ timeInterpreter nw
             let gps = (emptyGenesis gp, np)
-            withBenchDBLayer @s wlTr ti wid wname gps s
+                initialState
+                    = InitialState s (emptyGenesis gp) RestorationPointAtGenesis
+            withBenchDBLayer @s wlTr ti wid wname np initialState
                 $ \db -> withWalletLayerTracer
                     benchname pipeliningStrat traceToDisk
                 $ \progressTrace -> do
@@ -955,13 +961,13 @@ withBenchDBLayer
     -> TimeInterpreter IO
     -> WalletId
     -> WalletName
-    -> (Block, NetworkParameters)
-    -> s
+    -> NetworkParameters
+    -> InitialState s
     -> (DBLayer IO s -> IO a)
     -> IO a
-withBenchDBLayer tr ti wid wname gps s action =
+withBenchDBLayer tr ti wid wname np initialState action =
     withTempSqliteFile $ \dbFile -> do
-        params <- W.createWallet gps wid wname s
+        params <- W.createWallet np wid wname initialState
         withBootDBLayerFromFile
             (walletFlavor @s)
             tr'

diff --git a/lib/benchmarks/src/Cardano/Wallet/Benchmarks/Latency/BenchM.hs b/lib/benchmarks/src/Cardano/Wallet/Benchmarks/Latency/BenchM.hs
@@ -6,7 +6,6 @@ module Cardano.Wallet.Benchmarks.Latency.BenchM
     ( BenchM
     , BenchCtx (..)
     , partialFromRight
-    , clientEnv
     , fixtureMultiAssetWallet
     , fixtureWallet
     , fixtureWalletWith
@@ -53,15 +52,13 @@ import Numeric.Natural
     ( Natural
     )
 import Servant.Client
-    ( ClientEnv
-    , ClientError
+    ( ClientError
     , ClientM
-    , mkClientEnv
-    , parseBaseUrl
     , runClientM
     )
 import Test.Integration.Framework.DSL
     ( Context
+    , clientEnv
     )
 
 import qualified Cardano.Wallet.Api.Clients.Testnet.Shelley as C
@@ -72,12 +69,6 @@ data BenchCtx = BenchCtx
     , logFun :: LogCaptureFunc ApiLog ()
     }
 
--- one day we will export the manager from the context
-clientEnv :: Context -> ClientEnv
-clientEnv ctx = case parseBaseUrl $ show (fst $ ctx ^. #_manager) of
-    Left _ -> error "Invalid base URL"
-    Right bu -> mkClientEnv (snd $ ctx ^. #_manager) bu
-
 partialFromRight :: Show l => Either l r -> r
 partialFromRight = either (error . show) Prelude.id
 

diff --git a/lib/integration/cardano-wallet-integration.cabal b/lib/integration/cardano-wallet-integration.cabal
@@ -87,6 +87,7 @@ library framework
     , memory
     , microstache
     , monad-loops
+    , mtl
     , network-uri
     , resourcet
     , retry
@@ -105,6 +106,9 @@ library framework
   exposed-modules:
     Test.Integration.Framework.Context
     Test.Integration.Framework.DSL
+    Test.Integration.Framework.DSL.Network
+    Test.Integration.Framework.DSL.TestM
+    Test.Integration.Framework.DSL.Wallet
     Test.Integration.Framework.Logging
     Test.Integration.Framework.PendingInEra
     Test.Integration.Framework.Request
@@ -128,6 +132,7 @@ library scenarios
     , cardano-crypto-class
     , cardano-ledger-alonzo
     , cardano-ledger-core
+    , cardano-wallet-network-layer
     , cardano-wallet-primitive
     , cardano-wallet-secrets
     , cardano-wallet-test-utils
@@ -149,6 +154,7 @@ library scenarios
     , memory
     , pretty-simple
     , resourcet
+    , servant-client
     , text
     , text-class
     , time
@@ -175,6 +181,7 @@ library scenarios
     Test.Integration.Scenario.API.Shelley.HWWallets
     Test.Integration.Scenario.API.Shelley.Migrations
     Test.Integration.Scenario.API.Shelley.Network
+    Test.Integration.Scenario.API.Shelley.Restoration
     Test.Integration.Scenario.API.Shelley.Settings
     Test.Integration.Scenario.API.Shelley.StakePools
     Test.Integration.Scenario.API.Shelley.Transactions

diff --git a/lib/integration/framework/Test/Integration/Framework/Context.hs b/lib/integration/framework/Test/Integration/Framework/Context.hs
@@ -5,6 +5,9 @@ module Test.Integration.Framework.Context
     ( Context (..)
     , PoolGarbageCollectionEvent (..)
     , TxDescription (..)
+    , clientEnv
+    , runClientRequest
+    , runPartialClientRequest
     ) where
 
 import Prelude
@@ -35,6 +38,9 @@ import Cardano.Wallet.Primitive.Types.Coin
 import Cardano.Wallet.Transaction
     ( DelegationAction
     )
+import Control.Monad.IO.Class
+    ( MonadIO (..)
+    )
 import Data.IORef
     ( IORef
     )
@@ -50,6 +56,14 @@ import Network.HTTP.Client
 import Network.URI
     ( URI
     )
+import Servant.Client
+    ( ClientEnv
+    , ClientError
+    , ClientM
+    , mkClientEnv
+    , parseBaseUrl
+    , runClientM
+    )
 
 -- | Context for integration tests.
 --
@@ -114,3 +128,19 @@ data TxDescription
             :: Int
         }
     deriving Show
+
+-- one day we will export the manager from the context
+clientEnv :: Context -> ClientEnv
+clientEnv ctx = case parseBaseUrl $ show (fst $ _manager ctx) of
+    Left _ -> error "Invalid base URL"
+    Right bu -> mkClientEnv (snd $ _manager ctx) bu
+
+runClientRequest :: MonadIO m => Context -> ClientM a -> m (Either ClientError a)
+runClientRequest ctx action = liftIO $ runClientM action (clientEnv ctx)
+
+runPartialClientRequest :: MonadIO m => Context -> ClientM a -> m a
+runPartialClientRequest ctx action = liftIO $ do
+    res <- runClientRequest ctx action
+    case res of
+        Left e -> fail $ show e
+        Right a -> return a
diff --git a/lib/integration/framework/Test/Integration/Framework/DSL.hs b/lib/integration/framework/Test/Integration/Framework/DSL.hs
@@ -108,6 +108,7 @@ module Test.Integration.Framework.DSL
     -- * Helpers
     , (</>)
     , (!!)
+    , clientEnv
     , computeApiCoinSelectionFee
     , isValidDerivationPath
     , derivationPathValidationErrors
@@ -618,6 +619,7 @@ import Test.HUnit.Lang
 import Test.Integration.Framework.Context
     ( Context (..)
     , TxDescription (..)
+    , clientEnv
     )
 import Test.Integration.Framework.Request
     ( Headers (..)
@@ -3124,7 +3126,7 @@ createWalletViaCLI ctx args mnemonic secondFactor passphrase =
         let portArgs =
                 [ "--port", show (ctx ^. typed @(Port "wallet")) ]
         let fullArgs =
-                [ "wallet", "create", "from-recovery-phrase" ] ++ portArgs ++ args
+                [ "wallet", "create", "from-recovery-phrase", "from-genesis" ] ++ portArgs ++ args
         let process = proc' commandName fullArgs
         liftIO $ withCreateProcess process $
             \(Just stdin) (Just stdout) (Just stderr) h -> do

diff --git a/lib/integration/framework/Test/Integration/Framework/DSL/Network.hs b/lib/integration/framework/Test/Integration/Framework/DSL/Network.hs
@@ -0,0 +1,42 @@
+{-# LANGUAGE OverloadedLabels #-}
+{-# LANGUAGE PatternSynonyms #-}
+{-# LANGUAGE ScopedTypeVariables #-}
+
+module Test.Integration.Framework.DSL.Network where
+
+import Prelude
+
+import Cardano.Wallet.Api.Types
+    ( ApiNetworkInformation
+    )
+import Cardano.Wallet.Primitive.Types
+    ( EpochNo
+    )
+import Control.Lens
+    ( (^.)
+    )
+import Test.Hspec.Expectations.Lifted
+    ( shouldSatisfy
+    )
+import Test.Integration.Framework.DSL
+    ( eventually
+    )
+import Test.Integration.Framework.DSL.TestM
+    ( TestM
+    , pattern Partial
+    , request
+    )
+
+import qualified Cardano.Wallet.Api.Clients.Testnet.Network as C
+
+tipInfo :: TestM EpochNo
+tipInfo = do
+    Partial (netInfo :: ApiNetworkInformation) <- request C.networkInformation
+    pure $ netInfo ^. #nodeTip . #slotId . #epochNumber . #getApiT
+
+waitSomeEpochs :: Int -> TestM ()
+waitSomeEpochs n = do
+    now <- tipInfo
+    eventually "Waiting some epochs" $ do
+        current <- tipInfo
+        current `shouldSatisfy` (>= now + fromIntegral n)