Merge #1890

1890: Move slotting to separate module r=Anviking a=Anviking

# Issue Number

ADP-356 #1868, #1869 

# Overview


- [x] I have moved the existing slotting logic (`flatSlot`, `slotAt`, etc.) to a new module `Cardano.Wallet.Primitive.Slotting`
    - It is easier to keep track of remaining uses of static slotting this way
- [x] I started adding a ouroboros-consensus wrapper on top (currently unused)
    - [x] Added property `runQuery epochOf singleEraInterpreter == epochNumber . fromFlatSlot`


# Comments

- I left tests for slotting arithmetic in TypesSpec because the boundary between `Range` tests and slotting tests seemed unclear.
- Next step: Wrap all existing slotting logic using `Qry`/`Interpreter`.
- Could split into two PRs if you want

<!-- Additional comments or screenshots to attach if any -->

<!-- 
Don't forget to:

 ✓ Self-review your changes to make sure nothing unexpected slipped through
 ✓ Assign yourself to the PR
 ✓ Assign one or several reviewer(s)
 ✓ Once created, link this PR to its corresponding ticket
 ✓ Assign the PR to a corresponding milestone
 ✓ Acknowledge any changes required to the Wiki
-->


Co-authored-by: Johannes Lund <[email protected]>

lib/byron/bench/Restore.hs

@@ -96,6 +96,8 @@ import Cardano.Wallet.Primitive.AddressDiscovery.Random
     ( RndState, mkRndState )
 import Cardano.Wallet.Primitive.Model
     ( currentTip, totalUTxO )
+import Cardano.Wallet.Primitive.Slotting
+    ( slotAt, slotParams )
 import Cardano.Wallet.Primitive.SyncProgress
     ( SyncProgress (..), mkSyncTolerance, syncProgressRelativeToTime )
 import Cardano.Wallet.Primitive.Types
@@ -111,8 +113,6 @@ import Cardano.Wallet.Primitive.Types
     , WalletName (..)
     , computeUtxoStatistics
     , log10
-    , slotAt
-    , slotParams
     )
 import Cardano.Wallet.Unsafe
     ( unsafeMkMnemonic, unsafeRunExceptT )

lib/byron/src/Cardano/Wallet/Byron/Compatibility.hs

@@ -96,6 +96,8 @@ import Cardano.Wallet.Primitive.AddressDerivation
     ( NetworkDiscriminant (..) )
 import Cardano.Wallet.Primitive.AddressDerivation.Byron
     ( decodeLegacyAddress )
+import Cardano.Wallet.Primitive.Slotting
+    ( flatSlot, fromFlatSlot )
 import Cardano.Wallet.Unsafe
     ( unsafeDeserialiseCbor, unsafeFromHex )
 import Data.ByteString
@@ -306,7 +308,7 @@ toPoint genesisH epLength (W.BlockHeader sid _ h _)
 
 toSlotInEpoch :: W.EpochLength -> W.SlotId -> SlotNo
 toSlotInEpoch epLength =
-    SlotNo . W.flatSlot epLength
+    SlotNo . flatSlot epLength
 
 -- | SealedTx are the result of rightfully constructed byron transactions so, it
 -- is relatively safe to unserialize them from CBOR.
@@ -388,7 +390,7 @@ fromChainHash genesisHash = \case
 
 fromSlotNo :: W.EpochLength -> SlotNo -> W.SlotId
 fromSlotNo epLength (SlotNo sl) =
-    W.fromFlatSlot epLength sl
+    fromFlatSlot epLength sl
 
 -- FIXME unsafe conversion (Word64 -> Word32)
 fromBlockNo :: BlockNo -> Quantity "block" Word32

lib/byron/test/unit/Cardano/Wallet/Byron/CompatibilitySpec.hs

@@ -50,8 +50,10 @@ import Cardano.Wallet.Primitive.AddressDerivation
     )
 import Cardano.Wallet.Primitive.AddressDerivation.Icarus
     ( generateKeyFromHardwareLedger )
+import Cardano.Wallet.Primitive.Slotting
+    ( fromFlatSlot )
 import Cardano.Wallet.Primitive.Types
-    ( EpochLength (..), Hash (..), SealedTx (..), SlotId (..), fromFlatSlot )
+    ( EpochLength (..), Hash (..), SealedTx (..), SlotId (..) )
 import Cardano.Wallet.Unsafe
     ( unsafeFromHex, unsafeMkSomeMnemonicFromEntropy )
 import Control.Monad

lib/core-integration/src/Test/Integration/Framework/DSL.hs

@@ -151,7 +151,7 @@ import Cardano.Wallet.Api.Types
     , ApiAddress
     , ApiByronWallet
     , ApiCoinSelection
-    , ApiEpochInfo (..)
+    , ApiEpochInfo (ApiEpochInfo)
     , ApiFee
     , ApiNetworkInformation
     , ApiNetworkParameters (..)
@@ -190,6 +190,8 @@ import Cardano.Wallet.Primitive.AddressDerivation.Jormungandr
     ( generateKeyFromSeed )
 import Cardano.Wallet.Primitive.AddressDerivation.Shelley
     ( ShelleyKey )
+import Cardano.Wallet.Primitive.Slotting
+    ( SlotParameters (..), epochStartTime )
 import Cardano.Wallet.Primitive.SyncProgress
     ( SyncProgress (..) )
 import Cardano.Wallet.Primitive.Types
@@ -202,7 +204,6 @@ import Cardano.Wallet.Primitive.Types
     , HistogramBar (..)
     , PoolId (..)
     , SlotLength (..)
-    , SlotParameters (..)
     , SortOrder (..)
     , TxIn (..)
     , TxOut (..)
@@ -1715,10 +1716,10 @@ mkEpochInfo
     -> SlotParameters
     -- ^ Blockchain slot parameters
     -> ApiEpochInfo
-mkEpochInfo epochNo sp = ApiEpochInfo
-    { epochNumber = ApiT epochNo
-    , epochStartTime = W.epochStartTime sp epochNo
-    }
+mkEpochInfo epochNo sp =
+    ApiEpochInfo
+        (ApiT epochNo)
+        (epochStartTime sp epochNo)
 
 -- | Wallet not delegating and not about to join any stake pool.
 notDelegating

lib/core/cardano-wallet-core.cabal

@@ -140,6 +140,7 @@ library
       Cardano.Wallet.Primitive.AddressDerivation.Jormungandr
       Cardano.Wallet.Primitive.AddressDerivation.Shelley
       Cardano.Wallet.Primitive.AddressDiscovery
+      Cardano.Wallet.Primitive.Slotting
       Cardano.Wallet.Primitive.AddressDiscovery.Random
       Cardano.Wallet.Primitive.AddressDiscovery.Sequential
       Cardano.Wallet.Primitive.CoinSelection
@@ -191,6 +192,7 @@ test-suite unit
     , cardano-wallet-core
     , cardano-wallet-launcher
     , cardano-wallet-test-utils
+    , cardano-slotting
     , cborg
     , connection
     , containers
@@ -287,6 +289,7 @@ test-suite unit
       Cardano.Wallet.Primitive.CoinSelectionSpec
       Cardano.Wallet.Primitive.FeeSpec
       Cardano.Wallet.Primitive.ModelSpec
+      Cardano.Wallet.Primitive.SlottingSpec
       Cardano.Wallet.Primitive.SyncProgressSpec
       Cardano.Wallet.Primitive.TypesSpec
       Cardano.Wallet.RegistrySpec

lib/core/src/Cardano/Wallet.hs

@@ -253,6 +253,8 @@ import Cardano.Wallet.Primitive.Model
     , initWallet
     , updateState
     )
+import Cardano.Wallet.Primitive.Slotting
+    ( SlotParameters (..), slotParams, slotRangeFromTimeRange, slotStartTime )
 import Cardano.Wallet.Primitive.SyncProgress
     ( SyncProgress, SyncTolerance (..), syncProgressRelativeToTime )
 import Cardano.Wallet.Primitive.Types
@@ -275,7 +277,6 @@ import Cardano.Wallet.Primitive.Types
     , Range (..)
     , SealedTx
     , SlotId (..)
-    , SlotParameters (..)
     , SortOrder (..)
     , TransactionInfo (..)
     , Tx
@@ -295,9 +296,6 @@ import Cardano.Wallet.Primitive.Types
     , dlgCertPoolId
     , fromTransactionInfo
     , log10
-    , slotParams
-    , slotRangeFromTimeRange
-    , slotStartTime
     , wholeRange
     )
 import Cardano.Wallet.Transaction

lib/core/src/Cardano/Wallet/Api/Server.hs

@@ -265,8 +265,6 @@ import Cardano.Wallet.Primitive.Types
     , UnsignedTx (..)
     , WalletId (..)
     , WalletMetadata (..)
-    , slotAt
-    , slotMinBound
     )
 import Cardano.Wallet.Registry
     ( HasWorkerCtx (..)
@@ -385,6 +383,7 @@ import qualified Cardano.Wallet as W
 import qualified Cardano.Wallet.Network as NW
 import qualified Cardano.Wallet.Primitive.AddressDerivation.Byron as Byron
 import qualified Cardano.Wallet.Primitive.AddressDerivation.Icarus as Icarus
+import qualified Cardano.Wallet.Primitive.Slotting as W
 import qualified Cardano.Wallet.Primitive.Types as W
 import qualified Cardano.Wallet.Registry as Registry
 import qualified Data.Aeson as Aeson
@@ -1418,7 +1417,7 @@ getNetworkInformation
 getNetworkInformation (_block0, np, st) nl = do
     now <- liftIO getCurrentTime
     nodeTip <- liftHandler (NW.currentNodeTip nl)
-    let ntrkTip = fromMaybe slotMinBound (slotAt sp now)
+    let ntrkTip = fromMaybe W.slotMinBound (W.slotAt sp now)
     let nextEpochNo = unsafeEpochSucc (ntrkTip ^. #epochNumber)
     pure $ ApiNetworkInformation
         { syncProgress =

lib/core/src/Cardano/Wallet/DB/Model.hs

@@ -67,6 +67,8 @@ import Prelude
 
 import Cardano.Wallet.Primitive.Model
     ( Wallet, blockchainParameters, currentTip, utxo )
+import Cardano.Wallet.Primitive.Slotting
+    ( slotParams, slotStartTime )
 import Cardano.Wallet.Primitive.Types
     ( BlockHeader (blockHeight, slotId)
     , Coin (..)
@@ -91,8 +93,6 @@ import Cardano.Wallet.Primitive.Types
     , WalletMetadata (..)
     , dlgCertPoolId
     , isWithinRange
-    , slotParams
-    , slotStartTime
     )
 import Control.Monad
     ( when )

lib/core/src/Cardano/Wallet/DB/Sqlite.hs

@@ -101,6 +101,8 @@ import Cardano.Wallet.Primitive.AddressDerivation
     , SoftDerivation (..)
     , WalletKey (..)
     )
+import Cardano.Wallet.Primitive.Slotting
+    ( SlotParameters, slotParams, slotStartTime )
 import Control.Concurrent.MVar
     ( modifyMVar, modifyMVar_, newMVar, readMVar )
 import Control.Exception
@@ -1038,7 +1040,7 @@ mkTxMetaEntity wid txid meta = TxMeta
 -- note: TxIn records must already be sorted by order
 -- and TxOut records must already be sorted by index
 txHistoryFromEntity
-    :: W.SlotParameters
+    :: SlotParameters
     -> W.BlockHeader
     -> [TxMeta]
     -> [(TxIn, Maybe TxOut)]
@@ -1063,7 +1065,7 @@ txHistoryFromEntity sp tip metas ins outs ws =
         , W.txInfoDepth =
             Quantity $ fromIntegral $ if tipH > txH then tipH - txH else 0
         , W.txInfoTime =
-            W.slotStartTime sp (meta ^. #slotId)
+            slotStartTime sp (meta ^. #slotId)
         }
       where
         txH  = getQuantity (meta ^. #blockHeight)
@@ -1330,7 +1332,7 @@ selectTxHistory wid minWithdrawal order conditions = do
 
             let wal = checkpointFromEntity cp [] ()
             let tip = W.currentTip wal
-            let slp = W.slotParams $ W.blockchainParameters wal
+            let slp = slotParams $ W.blockchainParameters wal
 
             return $ txHistoryFromEntity slp tip metas ins outs ws
   where

lib/core/src/Cardano/Wallet/DB/Sqlite/Types.hs

@@ -24,6 +24,8 @@ import Cardano.Wallet.Primitive.AddressDerivation
     ( AccountingStyle (..), Passphrase (..), PassphraseScheme (..) )
 import Cardano.Wallet.Primitive.AddressDiscovery.Sequential
     ( AddressPoolGap (..), getAddressPoolGap, mkAddressPoolGap )
+import Cardano.Wallet.Primitive.Slotting
+    ( flatSlot, fromFlatSlot )
 import Cardano.Wallet.Primitive.Types
     ( Address (..)
     , ChimericAccount (..)
@@ -43,8 +45,6 @@ import Cardano.Wallet.Primitive.Types
     , StakePoolTicker
     , TxStatus (..)
     , WalletId (..)
-    , flatSlot
-    , fromFlatSlot
     , isValidCoin
     , unsafeEpochNo
     )