{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TupleSections #-}
-
-- | Module for indexing the stakepool delegation per epoch in the Cardano blockchain.
+
-- | Module for indexing the stakepool delegation per epoch and nonce per epoch in the Cardano
+
-- blockchain. Basically, any data that we want to index directly from the 'LedgerState' is in this
+
-- module. The rationale is that we don't want multiple indexers saving the same LedgerState. If we
+
-- continue using LedgerState in the future, then it might make some sense to create an indexer just
+
-- for the LedgerState, and has two other indexers using that. However, the current design of
+
-- Marconi is not entirely designed to do that. In the future, we plan to rework the marconi-core
+
-- design and will hopefully tackle this.
-- This module will create the SQL tables:
-- |---------+--------+----------+--------+-----------------+---------|
+
-- |---------+--------+--------+-----------------+---------|
+
-- | epochNo | nonce | slotNo | blockHeaderHash | blockNo |
+
-- |---------+--------+--------+-----------------+---------|
-- To create this table, we need to compute the `LedgerState` from `ouroboros-network` (called
-- `NewEpochState` in `cardano-ledger`) at each 'Rollforward' chain sync event. Using the
-
-- 'LegderState', we can easily compute the epochNo as well as the stake pool delegation for that
+
-- 'LegderState', we can easily compute the epochNo as well as the nonce and stake pool delegation
-- The main issue with this indexer is that building the LedgerState and saving it on disk for being
-- able to resume is VERY resource intensive. Syncing time for this indexer is over 20h and uses
import Cardano.Ledger.Compactible qualified as Ledger
import Cardano.Ledger.Era qualified as Ledger
import Cardano.Ledger.Shelley.API qualified as Ledger
+
import Cardano.Protocol.TPraos.API qualified as Shelley
+
import Cardano.Protocol.TPraos.Rules.Tickn qualified as Shelley
import Cardano.Slotting.Slot (EpochNo)
import Codec.CBOR.Read qualified as CBOR
import Codec.CBOR.Write qualified as CBOR
import Data.List.NonEmpty qualified as NE
import Data.Map.Strict (Map)
import Data.Map.Strict qualified as Map
-
import Data.Maybe (catMaybes, mapMaybe)
+
import Data.Maybe (catMaybes, listToMaybe, mapMaybe)
import Data.Ord (Down (Down))
import Data.Set qualified as Set
import Data.Word (Word64)
import Database.SQLite.Simple qualified as SQL
import GHC.Generics (Generic)
-
import Marconi.ChainIndex.Orphans (decodeLedgerState, encodeLedgerState)
+
import Marconi.ChainIndex.Orphans ()
import Marconi.ChainIndex.Utils (isBlockRollbackable)
import Marconi.Core.Storable (Buffered (persistToStorage), HasPoint (getPoint), QueryInterval, Queryable (queryStorage),
Resumable, Rewindable (rewindStorage), State, StorableEvent, StorableMonad, StorablePoint,
StorableQuery, StorableResult, emptyState)
import Marconi.Core.Storable qualified as Storable
import Ouroboros.Consensus.Cardano.Block qualified as O
+
import Ouroboros.Consensus.Config qualified as O
+
import Ouroboros.Consensus.HeaderValidation qualified as O
+
import Ouroboros.Consensus.Ledger.Extended qualified as O
+
import Ouroboros.Consensus.Protocol.Praos qualified as O
+
import Ouroboros.Consensus.Protocol.TPraos qualified as O
import Ouroboros.Consensus.Shelley.Ledger qualified as O
+
import Ouroboros.Consensus.Storage.Serialisation qualified as O
import System.Directory (listDirectory, removeFile)
import System.FilePath (dropExtension, (</>))
import Text.RawString.QQ (r)
import Text.Read (readMaybe)
data EpochSPDHandle = EpochSPDHandle
-
{ _epochSDPHandleConnection :: !SQL.Connection
+
{ _epochSDPHandleTopLevelCfg :: !(O.TopLevelConfig (O.CardanoBlock O.StandardCrypto))
+
, _epochSDPHandleConnection :: !SQL.Connection
, _epochSDPHandleLedgerStateDirPath :: !FilePath
, _epochSDPHandleSecurityParam :: !Word64
data instance StorableEvent EpochSPDHandle =
-
{ epochSPDEventLedgerState :: Maybe (O.LedgerState (O.CardanoBlock O.StandardCrypto))
+
{ epochSPDEventLedgerState :: Maybe (O.ExtLedgerState (O.CardanoBlock O.StandardCrypto))
, epochSPDEventEpochNo :: Maybe C.EpochNo
+
, epochSPDEventNonce :: Ledger.Nonce
, epochSPDEventSPD :: Map C.PoolId C.Lovelace
, epochSPDEventSlotNo :: C.SlotNo
, epochSPDEventBlockHeaderHash :: C.Hash C.BlockHeader
type instance StorablePoint EpochSPDHandle = C.ChainPoint
instance HasPoint (StorableEvent EpochSPDHandle) C.ChainPoint where
-
getPoint (EpochSPDEvent _ _ _ s bhh _ _ _) = C.ChainPoint s bhh
+
getPoint (EpochSPDEvent _ _ _ _ s bhh _ _ _) = C.ChainPoint s bhh
data instance StorableQuery EpochSPDHandle =
SPDByEpochNoQuery C.EpochNo
+
| NonceByEpochNoQuery C.EpochNo
| LedgerStateAtPointQuery C.ChainPoint
data instance StorableResult EpochSPDHandle =
SPDByEpochNoResult [EpochSPDRow]
-
| LedgerStateAtPointResult (Maybe (O.LedgerState (O.CardanoBlock O.StandardCrypto)))
+
| NonceByEpochNoResult (Maybe EpochNonceRow)
+
| LedgerStateAtPointResult (Maybe (O.ExtLedgerState (O.CardanoBlock O.StandardCrypto)))
newtype EpochSPDDepth = EpochSPDDepth Int
type EpochSPDIndex = State EpochSPDHandle
-
:: O.LedgerState (O.HardForkBlock (O.CardanoEras O.StandardCrypto))
+
:: O.ExtLedgerState (O.HardForkBlock (O.CardanoEras O.StandardCrypto))
-> Word64 -- ^ Security param
-> Bool -- ^ Is the last event of the current epoch
-> StorableEvent EpochSPDHandle
-
toStorableEvent ledgerState slotNo bhh bn chainTip securityParam isLastEventOfEpoch = do
+
toStorableEvent extLedgerState slotNo bhh bn chainTip securityParam isLastEventOfEpoch = do
let doesStoreLedgerState = isBlockRollbackable securityParam bn chainTip || isLastEventOfEpoch
-
(if doesStoreLedgerState then Just ledgerState else Nothing)
-
(getEpochNo ledgerState)
-
(getStakeMap ledgerState)
+
(if doesStoreLedgerState then Just extLedgerState else Nothing)
+
(getEpochNo extLedgerState)
+
(getEpochNonce extLedgerState)
+
(getStakeMap extLedgerState )
-- lovelace. We do this by getting the '_pstakeSet' stake snapshot and then use '_delegations' and
-- '_stake' to resolve it into the desired mapping.
-
:: O.LedgerState (O.CardanoBlock O.StandardCrypto)
+
:: O.ExtLedgerState (O.CardanoBlock O.StandardCrypto)
-> Map C.PoolId C.Lovelace
-
getStakeMap ledgerState' = case ledgerState' of
+
getStakeMap extLedgerState = case O.ledgerState extLedgerState of
O.LedgerStateByron _ -> mempty
O.LedgerStateShelley st -> getStakeMapFromShelleyBlock st
O.LedgerStateAllegra st -> getStakeMapFromShelleyBlock st
<$> VMap.lookup cred stakes)
-
getEpochNo :: O.LedgerState (O.CardanoBlock O.StandardCrypto) -> Maybe EpochNo
-
getEpochNo ledgerState' = case ledgerState' of
+
getEpochNo :: O.ExtLedgerState (O.CardanoBlock O.StandardCrypto) -> Maybe EpochNo
+
getEpochNo extLedgerState = case O.ledgerState extLedgerState of
O.LedgerStateByron _st -> Nothing
O.LedgerStateShelley st -> getEpochNoFromShelleyBlock st
O.LedgerStateAllegra st -> getEpochNoFromShelleyBlock st
getEpochNoFromShelleyBlock = Just . Ledger.nesEL . O.shelleyLedgerState
+
-- | Get Nonce per epoch given an extended ledger state. The Nonce is only available starting at
+
-- Shelley era. Byron era has the neutral nonce.
+
getEpochNonce :: O.ExtLedgerState (O.CardanoBlock O.StandardCrypto) -> Ledger.Nonce
+
getEpochNonce extLedgerState =
+
case O.headerStateChainDep (O.headerState extLedgerState) of
+
O.ChainDepStateByron _ -> Ledger.NeutralNonce
+
O.ChainDepStateShelley st -> extractNonce st
+
O.ChainDepStateAllegra st -> extractNonce st
+
O.ChainDepStateMary st -> extractNonce st
+
O.ChainDepStateAlonzo st -> extractNonce st
+
O.ChainDepStateBabbage st -> extractNoncePraos st
+
extractNonce :: O.TPraosState c -> Ledger.Nonce
+
Shelley.ticknStateEpochNonce . Shelley.csTickn . O.tpraosStateChainDepState
+
extractNoncePraos :: O.PraosState c -> Ledger.Nonce
+
extractNoncePraos = O.praosStateEpochNonce
data EpochSPDRow = EpochSPDRow
{ epochSPDRowEpochNo :: !C.EpochNo
, epochSPDRowPoolId :: !C.PoolId
+
data EpochNonceRow = EpochNonceRow
+
{ epochNonceRowEpochNo :: !C.EpochNo
+
, epochNonceRowNonce :: !Ledger.Nonce
+
, epochNonceRowSlotNo :: !C.SlotNo
![iohk-bors[bot]](https://avatars.githubusercontent.com/in/17473?v=4&s=80)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&s=80)
