Account for "active slot coefficient" in apparent performance calculation

lib/core/src/Cardano/Pool/Metrics.hs

@@ -70,7 +70,8 @@ import Cardano.Wallet.Network
     , staticBlockchainParameters
     )
 import Cardano.Wallet.Primitive.Types
-    ( BlockHeader (..)
+    ( ActiveSlotCoefficient (..)
+    , BlockHeader (..)
     , EpochLength (..)
     , EpochNo (..)
     , PoolId (..)
@@ -304,7 +305,7 @@ newStakePoolLayer tr db@DBLayer{..} nl metadataDir = StakePoolLayer
 
         else do
             let sl = prodTip ^. #slotId
-            perfs <- liftIO $ readPoolsPerformances db epochLength sl
+            perfs <- liftIO $ readPoolsPerformances db activeSlotCoeff epochLength sl
             combineWith (pure . sortByPerformance) distr (count prod) perfs
 
     readPoolProductionTip = readPoolProductionCursor 1 <&> \case
@@ -331,6 +332,7 @@ newStakePoolLayer tr db@DBLayer{..} nl metadataDir = StakePoolLayer
 
     (block0, bp) = staticBlockchainParameters nl
     epochLength = bp ^. #getEpochLength
+    activeSlotCoeff = bp ^. #getActiveSlotCoefficient
 
     combineWith
         :: ([(StakePool, [PoolOwner])] -> IO [(StakePool, [PoolOwner])])
@@ -401,11 +403,13 @@ readNewcomers DBLayer{..} elders avg = do
 
 readPoolsPerformances
     :: DBLayer m
+    -> ActiveSlotCoefficient
     -> EpochLength
     -> SlotId
     -> m (Map PoolId Double)
-readPoolsPerformances DBLayer{..} (EpochLength el) tip = do
+readPoolsPerformances DBLayer{..} activeSlotCoeff (EpochLength el) tip = do
     atomically $ fmap avg $ forM historicalEpochs $ \ep -> calculatePerformance
+        activeSlotCoeff
         (slotsInEpoch ep)
         <$> (Map.fromList <$> readStakeDistribution ep)
         <*> (count <$> readPoolProduction ep)
@@ -442,10 +446,11 @@ readPoolsPerformances DBLayer{..} (EpochLength el) tip = do
 -- is a 'Double' between 0 and 1 as:
 --
 -- @
---     p = n / N * S / s
+--     p = n / (f * N) * S / s
 --   where
 --     n = number of blocks produced in an epoch e
 --     N = number of slots in e
+--     f = active slot coeff, i.e. % of slots for which a leader can be elected.
 --     s = stake owned by the pool in e
 --     S = total stake delegated to pools in e
 -- @
@@ -454,19 +459,20 @@ readPoolsPerformances DBLayer{..} (EpochLength el) tip = do
 -- practice, be greater than 1 if a stake pool produces more than it is
 -- expected.
 calculatePerformance
-    :: Int
+    :: ActiveSlotCoefficient
+    -> Int
     -> Map PoolId (Quantity "lovelace" Word64)
     -> Map PoolId (Quantity "block" Word64)
     -> Map PoolId Double
-calculatePerformance nTotal mStake mProd =
+calculatePerformance (ActiveSlotCoefficient f) nTotal mStake mProd =
     let
         stakeButNotProd = traverseMissing $ \_ _ -> 0
         prodButNoStake  = dropMissing
         stakeAndProd sTotal = zipWithMatched $ \_ s n ->
             if (nTotal == 0 || s == Quantity 0) then
                 0
             else
-                min 1 ((double n / fromIntegral nTotal) * (sTotal / double s))
+                min 1 ((double n / (f * fromIntegral nTotal)) * (sTotal / double s))
     in
         Map.merge
             stakeButNotProd

lib/core/src/Cardano/Wallet.hs

@@ -187,22 +187,21 @@ import Cardano.Wallet.Primitive.Fee
     , computeFee
     )
 import Cardano.Wallet.Primitive.Model
-    ( BlockchainParameters (..)
-    , Wallet
+    ( Wallet
     , applyBlocks
     , availableUTxO
     , blockchainParameters
     , currentTip
     , getState
     , initWallet
-    , slotParams
     , updateState
     )
 import Cardano.Wallet.Primitive.Types
     ( Address (..)
     , AddressState (..)
     , Block (..)
     , BlockHeader (..)
+    , BlockchainParameters (..)
     , ChimericAccount (..)
     , Coin (..)
     , DelegationCertificate (..)
@@ -233,6 +232,7 @@ import Cardano.Wallet.Primitive.Types
     , computeUtxoStatistics
     , dlgCertPoolId
     , log10
+    , slotParams
     , slotRangeFromTimeRange
     , slotStartTime
     , syncProgressRelativeToTime

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

@@ -76,11 +76,10 @@ import Cardano.Wallet.Network
     ( NetworkLayer )
 import Cardano.Wallet.Primitive.AddressDerivation
     ( Depth )
-import Cardano.Wallet.Primitive.Model
-    ( BlockchainParameters )
 import Cardano.Wallet.Primitive.Types
     ( AddressState
     , Block
+    , BlockchainParameters
     , PoolId
     , SortOrder (..)
     , SyncTolerance

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

@@ -160,17 +160,12 @@ import Cardano.Wallet.Primitive.CoinSelection
 import Cardano.Wallet.Primitive.Fee
     ( Fee (..) )
 import Cardano.Wallet.Primitive.Model
-    ( BlockchainParameters
-    , Wallet
-    , availableBalance
-    , currentTip
-    , getState
-    , totalBalance
-    )
+    ( Wallet, availableBalance, currentTip, getState, totalBalance )
 import Cardano.Wallet.Primitive.Types
     ( Address
     , AddressState
     , Block
+    , BlockchainParameters
     , ChimericAccount (..)
     , Coin (..)
     , Hash (..)

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

@@ -555,6 +555,8 @@ mkCheckpointEntity wid wal =
         , checkpointEpochLength = coerce (bp ^. #getEpochLength)
         , checkpointTxMaxSize = coerce (bp ^. #getTxMaxSize)
         , checkpointEpochStability = coerce (bp ^. #getEpochStability)
+        , checkpointActiveSlotCoeff =
+            W.unActiveSlotCoefficient (bp ^. #getActiveSlotCoefficient)
         }
     utxo =
         [ UTxO wid sl (TxId input) ix addr coin
@@ -589,6 +591,7 @@ checkpointFromEntity cp utxo s =
         epochLength
         txMaxSize
         epochStability
+        activeSlotCoeff
         ) = cp
     header = (W.BlockHeader slot (Quantity bh) headerHash parentHeaderHash)
     utxo' = W.UTxO . Map.fromList $
@@ -603,6 +606,7 @@ checkpointFromEntity cp utxo s =
         , getEpochLength = W.EpochLength epochLength
         , getTxMaxSize = Quantity txMaxSize
         , getEpochStability = Quantity epochStability
+        , getActiveSlotCoefficient = W.ActiveSlotCoefficient activeSlotCoeff
         }
 
 mkTxHistory

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

@@ -125,18 +125,19 @@ TxOut
 -- A checkpoint for a given wallet is referred to by (wallet_id, slot).
 -- Volatile checkpoint data such as AD state will refer to this table.
 Checkpoint
-    checkpointWalletId       W.WalletId   sql=wallet_id
-    checkpointSlot           W.SlotId     sql=slot
-    checkpointHeaderHash     BlockId      sql=header_hash
-    checkpointParentHash     BlockId      sql=parent_header_hash
-    checkpointBlockHeight    Word32       sql=block_height
-    checkpointGenesisHash    BlockId      sql=genesis_hash
-    checkpointGenesisStart   UTCTime      sql=genesis_start
-    checkpointFeePolicy      W.FeePolicy  sql=fee_policy
-    checkpointSlotLength     Word64       sql=slot_length
-    checkpointEpochLength    Word32       sql=epoch_length
-    checkpointTxMaxSize      Word16       sql=tx_max_size
-    checkpointEpochStability Word32       sql=epoch_stability
+    checkpointWalletId          W.WalletId   sql=wallet_id
+    checkpointSlot              W.SlotId     sql=slot
+    checkpointHeaderHash        BlockId      sql=header_hash
+    checkpointParentHash        BlockId      sql=parent_header_hash
+    checkpointBlockHeight       Word32       sql=block_height
+    checkpointGenesisHash       BlockId      sql=genesis_hash
+    checkpointGenesisStart      UTCTime      sql=genesis_start
+    checkpointFeePolicy         W.FeePolicy  sql=fee_policy
+    checkpointSlotLength        Word64       sql=slot_length
+    checkpointEpochLength       Word32       sql=epoch_length
+    checkpointTxMaxSize         Word16       sql=tx_max_size
+    checkpointEpochStability    Word32       sql=epoch_stability
+    checkpointActiveSlotCoeff   Double       sql=active_slot_coeff
 
     Primary checkpointWalletId checkpointSlot
     Foreign Wallet checkpoint checkpointWalletId ! ON DELETE CASCADE

lib/core/src/Cardano/Wallet/Network.hs

@@ -31,10 +31,9 @@ import Prelude
 
 import Cardano.BM.Trace
     ( Trace, logDebug, logError, logInfo, logWarning )
-import Cardano.Wallet.Primitive.Model
-    ( BlockchainParameters (..) )
 import Cardano.Wallet.Primitive.Types
     ( BlockHeader (..)
+    , BlockchainParameters (..)
     , ChimericAccount (..)
     , EpochNo
     , Hash (..)

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

@@ -34,12 +34,11 @@ module Cardano.Wallet.Primitive.Model
     (
     -- * Type
       Wallet
-    , BlockchainParameters (..)
 
     -- * Construction & Modification
+    , FilteredBlock (..)
     , initWallet
     , updateState
-    , FilteredBlock (..)
     , applyBlock
     , applyBlocks
     , unsafeInitWallet
@@ -53,9 +52,6 @@ module Cardano.Wallet.Primitive.Model
     , availableUTxO
     , utxo
     , blockchainParameters
-
-    -- * Auxiliary
-    , slotParams
     ) where
 
 import Prelude
@@ -66,16 +62,11 @@ import Cardano.Wallet.Primitive.Types
     ( Address (..)
     , Block (..)
     , BlockHeader (..)
+    , BlockchainParameters (..)
     , ChimericAccount (..)
     , DelegationCertificate (..)
     , Direction (..)
     , Dom (..)
-    , EpochLength (..)
-    , FeePolicy (..)
-    , Hash (..)
-    , SlotLength (..)
-    , SlotParameters (SlotParameters)
-    , StartTime (..)
     , Tx (..)
     , TxIn (..)
     , TxMeta (..)
@@ -97,8 +88,6 @@ import Control.Monad.Extra
     ( mapMaybeM )
 import Control.Monad.Trans.State.Strict
     ( State, evalState, runState, state )
-import Data.ByteArray.Encoding
-    ( Base (Base16), convertToBase )
 import Data.Functor
     ( (<&>) )
 import Data.Generics.Internal.VL.Lens
@@ -113,12 +102,8 @@ import Data.Quantity
     ( Quantity (..) )
 import Data.Set
     ( Set )
-import Data.Text.Class
-    ( toText )
-import Data.Word
-    ( Word16, Word32 )
 import Fmt
-    ( Buildable (..), blockListF', indentF )
+    ( Buildable (..), indentF )
 import GHC.Generics
     ( Generic )
 import Numeric.Natural
@@ -127,7 +112,6 @@ import Numeric.Natural
 import qualified Data.List.NonEmpty as NE
 import qualified Data.Map as Map
 import qualified Data.Set as Set
-import qualified Data.Text.Encoding as T
 
 {-------------------------------------------------------------------------------
                                      Type
@@ -193,51 +177,6 @@ instance Buildable s => Buildable (Wallet s) where
         <> indentF 4 ("UTxO: " <> build u)
         <> indentF 4 (build s)
 
-data BlockchainParameters = BlockchainParameters
-    { getGenesisBlockHash :: Hash "Genesis"
-        -- ^ Hash of the very first block
-    , getGenesisBlockDate :: StartTime
-        -- ^ Start time of the chain.
-    , getFeePolicy :: FeePolicy
-        -- ^ Policy regarding transaction fee.
-    , getSlotLength :: SlotLength
-        -- ^ Length, in seconds, of a slot.
-    , getEpochLength :: EpochLength
-        -- ^ Number of slots in a single epoch.
-    , getTxMaxSize :: Quantity "byte" Word16
-        -- ^ Maximum size of a transaction (soft or hard limit).
-    , getEpochStability :: Quantity "block" Word32
-        -- ^ Length of the suffix of the chain considered unstable
-    } deriving (Generic, Show, Eq)
-
-instance NFData BlockchainParameters
-
-instance Buildable BlockchainParameters where
-    build bp = blockListF' "" id
-        [ "Genesis block hash: " <> genesisF (getGenesisBlockHash bp)
-        , "Genesis block date: " <> startTimeF (getGenesisBlockDate bp)
-        , "Fee policy:         " <> feePolicyF (getFeePolicy bp)
-        , "Slot length:        " <> slotLengthF (getSlotLength bp)
-        , "Epoch length:       " <> epochLengthF (getEpochLength bp)
-        , "Tx max size:        " <> txMaxSizeF (getTxMaxSize bp)
-        , "Epoch stability:    " <> epochStabilityF (getEpochStability bp)
-        ]
-      where
-        genesisF = build . T.decodeUtf8 . convertToBase Base16 . getHash
-        startTimeF (StartTime s) = build s
-        feePolicyF = build . toText
-        slotLengthF (SlotLength s) = build s
-        epochLengthF (EpochLength s) = build s
-        txMaxSizeF (Quantity s) = build s
-        epochStabilityF (Quantity s) = build s
-
-slotParams :: BlockchainParameters -> SlotParameters
-slotParams bp =
-    SlotParameters
-        (bp ^. #getEpochLength)
-        (bp ^. #getSlotLength)
-        (bp ^. #getGenesisBlockDate)
-
 {-------------------------------------------------------------------------------
                           Construction & Modification
 -------------------------------------------------------------------------------}