Fields

• putPoolProduction :: BlockHeader -> PoolId -> ExceptT ErrPointAlreadyExists stm ()

  Write for a given slot id the id of stake pool that produced a a corresponding block

• readPoolProduction :: EpochNo -> stm ( Map PoolId [ BlockHeader ])

  Read the all stake pools together with corresponding slot ids for a given epoch.

• readTotalProduction :: stm ( Map PoolId ( Quantity "block" Word64 ))

  Read the total pool production since the pool was first registered.

• putStakeDistribution :: EpochNo -> [( PoolId , Quantity "lovelace" Word64 )] -> stm ()

  Replace an existing distribution for the given epoch by the one given as argument.

  If there's no existing distribution, simply inserts it.

• readStakeDistribution :: EpochNo -> stm [( PoolId , Quantity "lovelace" Word64 )]
• readPoolProductionCursor :: Int -> stm [ BlockHeader ]

  Read the latest k blockheaders in ascending order. The tip will be the last element in the list.

  This is useful for the NetworkLayer to know how far we have synced. Returns all headers if limit is <= 0.

• readPoolLifeCycleStatus :: PoolId -> stm PoolLifeCycleStatus

  Read the current life cycle status of the given pool.

• putPoolRegistration :: CertificatePublicationTime -> PoolRegistrationCertificate -> stm ()

  Add a mapping between stake pools and their corresponding certificate. If the mapping already exists, data are replaced with the latest version.

• readPoolRegistration :: PoolId -> stm ( Maybe ( CertificatePublicationTime , PoolRegistrationCertificate ))

  Find the latest registration certificate for the given pool, together with the point in time that the certificate was added.

  Note that a pool may also have other certificates associated with it that affect its current lifecycle status.

  See readPoolLifeCycleStatus for a complete picture.

• putPoolRetirement :: CertificatePublicationTime -> PoolRetirementCertificate -> stm ()

  Add a retirement certificate for a particular pool.

• readPoolRetirement :: PoolId -> stm ( Maybe ( CertificatePublicationTime , PoolRetirementCertificate ))

  Find the latest retirement certificate for the given pool, together with the point in time that the certificate was added.

  Note that a pool may also have other certificates associated with it that affect its current lifecycle status.

  See readPoolLifeCycleStatus for a complete picture.

• unfetchedPoolMetadataRefs :: Int -> stm [( PoolId , StakePoolMetadataUrl , StakePoolMetadataHash )]

  Read the list of metadata remaining to fetch from remote server, possibly empty if every pool already has an associated metadata cached.

  It returns at most n results, where n is the first argument.

• putFetchAttempt :: ( StakePoolMetadataUrl , StakePoolMetadataHash ) -> stm ()

  Store a fetch attempt for a given hash, so that it isn't retried too often.

• listRegisteredPools :: stm [ PoolId ]

  List the list of known pools, based on their registration certificate. This list doesn't necessarily match the keys of the map we would get from readPoolProduction because not all registered pools have necessarily produced any block yet!

• listRetiredPools :: EpochNo -> stm [ PoolRetirementCertificate ]

  List all pools with an active retirement epoch that is earlier than or equal to the specified epoch.

• listPoolLifeCycleData :: EpochNo -> stm [ PoolLifeCycleStatus ]

  List the lifecycle data of all non-retired pools: pools that either don't have an active retirement epoch or pools that have an active retirement epoch that is later than the given epoch.

• putPoolMetadata :: StakePoolMetadataHash -> StakePoolMetadata -> stm ()

  Store metadata fetched from a remote server.

• removePoolMetadata :: stm ()

  Delete all pool metadata.

• readPoolMetadata :: stm ( Map StakePoolMetadataHash StakePoolMetadata )
• readSystemSeed :: stm StdGen

  Read the seed assigned to this particular database. The seed is created with the database and is "unique" for each database. This however allow to have a seed that can be used to produce consistent results across requests.

• rollbackTo :: SlotNo -> stm ()

  Remove all entries of slot ids newer than the argument

• putDelistedPools :: [ PoolId ] -> stm ()

  Overwrite the set of delisted pools with a completely new set. Pools may be delisted for reasons such as non-compliance.

• readDelistedPools :: stm [ PoolId ]

  Fetch the set of delisted pools.

• removePools :: [ PoolId ] -> stm ()

  Remove all data relating to the specified pools.

• removeRetiredPools :: EpochNo -> stm [ PoolRetirementCertificate ]

  Remove all pools with an active retirement epoch that is earlier than or equal to the specified epoch.

  Returns the retirement certificates of the pools that were removed.

  See also:

  • listRetiredPools .
  • removePools .
• putHeader :: BlockHeader -> stm ()

  Add a block header

• listHeaders :: Int -> stm [ BlockHeader ]

  List headers, usually stored during syncing. Returns all headers if limit is <= 0.

• readSettings :: stm Settings

  Get the settings.

• putSettings :: Settings -> stm ()

  Modify the settings.

• readLastMetadataGC :: stm ( Maybe POSIXTime )

  Get the last metadata GC time.

• putLastMetadataGC :: POSIXTime -> stm ()

  Set the last metadata GC time.

• cleanDB :: stm ()

  Clean a database

• atomically :: forall a. stm a -> m a

  Run an operation.

  For a Sqlite DB, this would be "run a query inside a transaction".