Copyright	© 2018-2020 IOHK
License	Apache-2.0
Safe Haskell	None
Language	Haskell2010

Cardano.Pool.DB.Model

Contents

Model Types
Model Operation Types
Model pool database functions

Description

An implementation of the production pool database using only pure functions.

These functions and types model the behaviour of the SQLite database backend, and are used for QuickCheck state machine testing, and the MVar database backend.

Synopsis

data PoolDatabase = PoolDatabase {
- pools :: !( Map PoolId [ BlockHeader ])
- distributions :: !( Map EpochNo [( PoolId , Quantity "lovelace" Word64 )])
- owners :: !( Map PoolId [ PoolOwner ])
- registrations :: !( Map ( CertificatePublicationTime , PoolId ) PoolRegistrationCertificate )
- retirements :: !( Map ( CertificatePublicationTime , PoolId ) PoolRetirementCertificate )
- delisted :: !( Set PoolId )
- metadata :: !( Map StakePoolMetadataHash StakePoolMetadata )
- fetchAttempts :: !( Map ( StakePoolMetadataUrl , StakePoolMetadataHash ) Int )
- seed :: !SystemSeed
- blockHeaders :: [ BlockHeader ]
- settings :: Settings
- internalState :: InternalState
}
emptyPoolDatabase :: PoolDatabase
type ModelOp a = StateT PoolDatabase ( Either PoolErr ) a
newtype PoolErr = PointAlreadyExists BlockHeader
mCleanDatabase :: ModelOp ()
mCleanPoolMetadata :: ModelOp ()
mPutPoolProduction :: BlockHeader -> PoolId -> ModelOp ()
mPutHeader :: BlockHeader -> ModelOp ()
mListHeaders :: Int -> ModelOp [ BlockHeader ]
mReadPoolProduction :: TimeInterpreter Identity -> EpochNo -> ModelOp ( Map PoolId [ BlockHeader ])
mReadTotalProduction :: ModelOp ( Map PoolId ( Quantity "block" Word64 ))
mPutStakeDistribution :: EpochNo -> [( PoolId , Quantity "lovelace" Word64 )] -> ModelOp ()
mReadStakeDistribution :: EpochNo -> ModelOp [( PoolId , Quantity "lovelace" Word64 )]
mReadPoolMetadata :: ModelOp ( Map StakePoolMetadataHash StakePoolMetadata )
mPutPoolRegistration :: CertificatePublicationTime -> PoolRegistrationCertificate -> ModelOp ()
mReadPoolRegistration :: PoolId -> ModelOp ( Maybe ( CertificatePublicationTime , PoolRegistrationCertificate ))
mPutPoolRetirement :: CertificatePublicationTime -> PoolRetirementCertificate -> ModelOp ()
mReadPoolRetirement :: PoolId -> ModelOp ( Maybe ( CertificatePublicationTime , PoolRetirementCertificate ))
mUnfetchedPoolMetadataRefs :: Int -> ModelOp [( PoolId , StakePoolMetadataUrl , StakePoolMetadataHash )]
mPutDelistedPools :: [ PoolId ] -> ModelOp ()
mPutFetchAttempt :: ( StakePoolMetadataUrl , StakePoolMetadataHash ) -> ModelOp ()
mPutPoolMetadata :: StakePoolMetadataHash -> StakePoolMetadata -> ModelOp ()
mListPoolLifeCycleData :: EpochNo -> ModelOp [ PoolLifeCycleStatus ]
mListRegisteredPools :: ModelOp [ PoolId ]
mListRetiredPools :: EpochNo -> ModelOp [ PoolRetirementCertificate ]
mReadPoolLifeCycleStatus :: PoolId -> ModelOp PoolLifeCycleStatus
mReadSystemSeed :: PoolDatabase -> IO ( StdGen , PoolDatabase )
mRollbackTo :: TimeInterpreter Identity -> SlotNo -> ModelOp ()
mReadCursor :: Int -> ModelOp [ BlockHeader ]
mRemovePools :: [ PoolId ] -> ModelOp ()
mReadDelistedPools :: ModelOp [ PoolId ]
mRemoveRetiredPools :: EpochNo -> ModelOp [ PoolRetirementCertificate ]
mReadSettings :: ModelOp Settings
mPutSettings :: Settings -> ModelOp ()
mPutLastMetadataGC :: POSIXTime -> ModelOp ()
mReadLastMetadataGC :: ModelOp ( Maybe POSIXTime )

Model Types

data PoolDatabase Source #

Constructors

PoolDatabase

Fields

pools :: !( Map PoolId [ BlockHeader ])

Information of what blocks were produced by which stake pools
distributions :: !( Map EpochNo [( PoolId , Quantity "lovelace" Word64 )])

Store known stake distributions for epochs
owners :: !( Map PoolId [ PoolOwner ])

Mapping between pool ids and owners
registrations :: !( Map ( CertificatePublicationTime , PoolId ) PoolRegistrationCertificate )

On-chain registrations associated with pools
retirements :: !( Map ( CertificatePublicationTime , PoolId ) PoolRetirementCertificate )

On-chain retirements associated with pools
delisted :: !( Set PoolId )
metadata :: !( Map StakePoolMetadataHash StakePoolMetadata )

Off-chain metadata cached in database
fetchAttempts :: !( Map ( StakePoolMetadataUrl , StakePoolMetadataHash ) Int )

Metadata (failed) fetch attempts
seed :: !SystemSeed

Store an arbitrary random generator seed
blockHeaders :: [ BlockHeader ]

Store headers during syncing
settings :: Settings
internalState :: InternalState

Various internal states that need to persist across wallet restarts.

Instances

Instances details

Eq PoolDatabase Source #
Instance details Defined in Cardano.Pool.DB.Model Methods (==) :: PoolDatabase -> PoolDatabase -> Bool Source # (/=) :: PoolDatabase -> PoolDatabase -> Bool Source #
Show PoolDatabase Source #
Instance details Defined in Cardano.Pool.DB.Model Methods showsPrec :: Int -> PoolDatabase -> ShowS Source # show :: PoolDatabase -> String Source # showList :: [ PoolDatabase ] -> ShowS Source #
Generic PoolDatabase Source #
Instance details Defined in Cardano.Pool.DB.Model Associated Types type Rep PoolDatabase :: Type -> Type Source # Methods from :: PoolDatabase -> Rep PoolDatabase x Source # to :: Rep PoolDatabase x -> PoolDatabase Source #
type Rep PoolDatabase Source #
Instance details Defined in Cardano.Pool.DB.Model type Rep PoolDatabase

emptyPoolDatabase :: PoolDatabase Source #

Produces an empty model pool production database.

Model Operation Types

type ModelOp a = StateT PoolDatabase ( Either PoolErr ) a Source #

newtype PoolErr Source #

Constructors

PointAlreadyExists BlockHeader

Instances

Instances details

Eq PoolErr Source #
Instance details Defined in Cardano.Pool.DB.Model Methods (==) :: PoolErr -> PoolErr -> Bool Source # (/=) :: PoolErr -> PoolErr -> Bool Source #
Show PoolErr Source #
Instance details Defined in Cardano.Pool.DB.Model Methods showsPrec :: Int -> PoolErr -> ShowS Source # show :: PoolErr -> String Source # showList :: [ PoolErr ] -> ShowS Source #