Safe Haskell	None
Language	Haskell2010

Cardano.Api.Query

Contents

Queries
Internal conversion functions
Wrapper types used in queries
Internal conversion functions

Description

Queries from local clients to the node.

Synopsis

data QueryInMode result where
- QueryCurrentEra :: QueryInMode AnyCardanoEra
- QueryInEra :: forall era result1. QueryInEra era result1 -> QueryInMode (Either EraMismatch result1)
- QueryEraHistory :: QueryInMode EraHistory
- QuerySystemStart :: QueryInMode SystemStart
- QueryChainBlockNo :: QueryInMode (WithOrigin BlockNo)
- QueryChainPoint :: QueryInMode ChainPoint
data QueryInEra era result where
- QueryByronUpdateState :: QueryInEra ByronEra ByronUpdateState
- QueryInShelleyBasedEra :: forall era result. ShelleyBasedEra era -> QueryInShelleyBasedEra era result -> QueryInEra era result
data QueryInShelleyBasedEra era result where
- QueryEpoch :: forall era. QueryInShelleyBasedEra era EpochNo
- QueryGenesisParameters :: forall era. QueryInShelleyBasedEra era (GenesisParameters ShelleyEra)
- QueryProtocolParameters :: forall era. QueryInShelleyBasedEra era (PParams (ShelleyLedgerEra era))
- QueryProtocolParametersUpdate :: forall era. QueryInShelleyBasedEra era (Map (Hash GenesisKey) ProtocolParametersUpdate)
- QueryStakeDistribution :: forall era. QueryInShelleyBasedEra era (Map (Hash StakePoolKey) Rational)
- QueryUTxO :: forall era. QueryUTxOFilter -> QueryInShelleyBasedEra era (UTxO era)
- QueryStakeAddresses :: forall era. Set StakeCredential -> NetworkId -> QueryInShelleyBasedEra era (Map StakeAddress Coin, Map StakeAddress PoolId)
- QueryStakePools :: forall era. QueryInShelleyBasedEra era (Set PoolId)
- QueryStakePoolParameters :: forall era. Set PoolId -> QueryInShelleyBasedEra era (Map PoolId StakePoolParameters)
- QueryDebugLedgerState :: forall era. QueryInShelleyBasedEra era (SerialisedDebugLedgerState era)
- QueryProtocolState :: forall era. QueryInShelleyBasedEra era (ProtocolState era)
- QueryCurrentEpochState :: forall era. QueryInShelleyBasedEra era (SerialisedCurrentEpochState era)
- QueryPoolState :: forall era. Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedPoolState era)
- QueryPoolDistribution :: forall era. Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedPoolDistribution era)
- QueryStakeSnapshot :: forall era. Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedStakeSnapshots era)
- QueryStakeDelegDeposits :: forall era. Set StakeCredential -> QueryInShelleyBasedEra era (Map StakeCredential Coin)
- QueryAccountState :: forall era. QueryInShelleyBasedEra era AccountState
- QueryConstitution :: forall era. QueryInShelleyBasedEra era (Constitution (ShelleyLedgerEra era))
- QueryGovState :: forall era. QueryInShelleyBasedEra era (GovState (ShelleyLedgerEra era))
- QueryDRepState :: forall era. Set (Credential 'DRepRole StandardCrypto) -> QueryInShelleyBasedEra era (Map (Credential 'DRepRole StandardCrypto) (DRepState StandardCrypto))
- QueryDRepStakeDistr :: forall era. Set (DRep StandardCrypto) -> QueryInShelleyBasedEra era (Map (DRep StandardCrypto) Coin)
- QuerySPOStakeDistr :: forall era. Set (KeyHash 'StakePool StandardCrypto) -> QueryInShelleyBasedEra era (Map (KeyHash 'StakePool StandardCrypto) Coin)
- QueryCommitteeMembersState :: forall era. Set (Credential 'ColdCommitteeRole StandardCrypto) -> Set (Credential 'HotCommitteeRole StandardCrypto) -> Set MemberStatus -> QueryInShelleyBasedEra era (CommitteeMembersState StandardCrypto)
- QueryStakeVoteDelegatees :: forall era. Set StakeCredential -> QueryInShelleyBasedEra era (Map StakeCredential (DRep StandardCrypto))
data QueryUTxOFilter
- = QueryUTxOWhole
- | QueryUTxOByAddress (Set AddressAny)
- | QueryUTxOByTxIn (Set TxIn)
newtype UTxO era = UTxO {
- unUTxO :: Map TxIn (TxOut CtxUTxO era)
}
data UTxOInAnyEra where
- UTxOInAnyEra :: forall era. CardanoEra era -> UTxO era -> UTxOInAnyEra
toConsensusQuery :: CardanoBlock StandardCrypto ~ block => QueryInMode result -> Some (Query block)
fromConsensusQueryResult :: (HasCallStack, CardanoBlock StandardCrypto ~ block) => QueryInMode result -> Query block result' -> result' -> result
newtype SerialisedDebugLedgerState era = SerialisedDebugLedgerState (Serialised (NewEpochState (ShelleyLedgerEra era)))
newtype ProtocolState era = ProtocolState (Serialised (ChainDepState (ConsensusProtocol era)))
decodeProtocolState :: FromCBOR (ChainDepState (ConsensusProtocol era)) => ProtocolState era -> Either (ByteString, DecoderError) (ChainDepState (ConsensusProtocol era))
newtype DebugLedgerState era = DebugLedgerState {
- unDebugLedgerState :: NewEpochState (ShelleyLedgerEra era)
}
decodeDebugLedgerState :: FromCBOR (DebugLedgerState era) => SerialisedDebugLedgerState era -> Either (ByteString, DecoderError) (DebugLedgerState era)
newtype SerialisedCurrentEpochState era = SerialisedCurrentEpochState (Serialised (EpochState (ShelleyLedgerEra era)))
newtype CurrentEpochState era = CurrentEpochState (EpochState (ShelleyLedgerEra era))
decodeCurrentEpochState :: ShelleyBasedEra era -> SerialisedCurrentEpochState era -> Either DecoderError (CurrentEpochState era)
newtype SerialisedPoolState era = SerialisedPoolState (Serialised (PState (ShelleyLedgerEra era)))
newtype PoolState era = PoolState (PState (ShelleyLedgerEra era))
decodePoolState :: (Era (ShelleyLedgerEra era), DecCBOR (PState (ShelleyLedgerEra era))) => SerialisedPoolState era -> Either DecoderError (PoolState era)
newtype SerialisedPoolDistribution era = SerialisedPoolDistribution (Serialised (PoolDistr (EraCrypto (ShelleyLedgerEra era))))
newtype PoolDistribution era = PoolDistribution {
- unPoolDistr :: PoolDistr (EraCrypto (ShelleyLedgerEra era))
}
decodePoolDistribution :: Crypto (EraCrypto (ShelleyLedgerEra era)) => ShelleyBasedEra era -> SerialisedPoolDistribution era -> Either DecoderError (PoolDistribution era)
newtype SerialisedStakeSnapshots era = SerialisedStakeSnapshots (Serialised (StakeSnapshots (EraCrypto (ShelleyLedgerEra era))))
newtype StakeSnapshot era = StakeSnapshot (StakeSnapshots (EraCrypto (ShelleyLedgerEra era)))
decodeStakeSnapshot :: FromCBOR (StakeSnapshots (EraCrypto (ShelleyLedgerEra era))) => SerialisedStakeSnapshots era -> Either DecoderError (StakeSnapshot era)
data EraHistory where
- EraHistory :: forall (xs :: [Type]). CardanoBlock StandardCrypto ~ HardForkBlock xs => Interpreter xs -> EraHistory
newtype SystemStart = SystemStart {
- getSystemStart :: UTCTime
}
newtype LedgerEpochInfo = LedgerEpochInfo {
- unLedgerEpochInfo :: EpochInfo (Either Text)
}
toLedgerEpochInfo :: EraHistory -> LedgerEpochInfo
newtype SlotsInEpoch = SlotsInEpoch Word64
newtype SlotsToEpochEnd = SlotsToEpochEnd Word64
slotToEpoch :: SlotNo -> EraHistory -> Either PastHorizonException (EpochNo, SlotsInEpoch, SlotsToEpochEnd)
data family LedgerState blk
getProgress :: SlotNo -> EraHistory -> Either PastHorizonException (RelativeTime, SlotLength)
getSlotForRelativeTime :: RelativeTime -> EraHistory -> Either PastHorizonException SlotNo
toLedgerUTxO :: ShelleyBasedEra era -> UTxO era -> UTxO (ShelleyLedgerEra era)
fromLedgerUTxO :: ShelleyBasedEra era -> UTxO (ShelleyLedgerEra era) -> UTxO era

Queries

data QueryInMode result where Source #

Constructors

QueryCurrentEra :: QueryInMode AnyCardanoEra
QueryInEra :: forall era result1. QueryInEra era result1 -> QueryInMode (Either EraMismatch result1)
QueryEraHistory :: QueryInMode EraHistory
QuerySystemStart :: QueryInMode SystemStart
QueryChainBlockNo :: QueryInMode (WithOrigin BlockNo)
QueryChainPoint :: QueryInMode ChainPoint

Instances

Instances details

Show (QueryInMode result) Source #
Instance details Defined in Cardano.Api.Query Methods showsPrec :: Int -> QueryInMode result -> ShowS Source # show :: QueryInMode result -> String Source # showList :: [QueryInMode result] -> ShowS Source #
NodeToClientVersionOf (QueryInMode result) Source #
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryInMode result -> NodeToClientVersion Source #

data QueryInEra era result where Source #

Constructors

QueryByronUpdateState :: QueryInEra ByronEra ByronUpdateState
QueryInShelleyBasedEra :: forall era result. ShelleyBasedEra era -> QueryInShelleyBasedEra era result -> QueryInEra era result

Instances

Instances details

Show (QueryInEra era result) Source #
Instance details Defined in Cardano.Api.Query Methods showsPrec :: Int -> QueryInEra era result -> ShowS Source # show :: QueryInEra era result -> String Source # showList :: [QueryInEra era result] -> ShowS Source #
NodeToClientVersionOf (QueryInEra era result) Source #
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryInEra era result -> NodeToClientVersion Source #

data QueryInShelleyBasedEra era result where Source #

Constructors

QueryEpoch :: forall era. QueryInShelleyBasedEra era EpochNo
QueryGenesisParameters :: forall era. QueryInShelleyBasedEra era (GenesisParameters ShelleyEra)
QueryProtocolParameters :: forall era. QueryInShelleyBasedEra era (PParams (ShelleyLedgerEra era))
QueryProtocolParametersUpdate :: forall era. QueryInShelleyBasedEra era (Map (Hash GenesisKey) ProtocolParametersUpdate)
QueryStakeDistribution :: forall era. QueryInShelleyBasedEra era (Map (Hash StakePoolKey) Rational)
QueryUTxO :: forall era. QueryUTxOFilter -> QueryInShelleyBasedEra era (UTxO era)
QueryStakeAddresses :: forall era. Set StakeCredential -> NetworkId -> QueryInShelleyBasedEra era (Map StakeAddress Coin, Map StakeAddress PoolId)
QueryStakePools :: forall era. QueryInShelleyBasedEra era (Set PoolId)
QueryStakePoolParameters :: forall era. Set PoolId -> QueryInShelleyBasedEra era (Map PoolId StakePoolParameters)
QueryDebugLedgerState :: forall era. QueryInShelleyBasedEra era (SerialisedDebugLedgerState era)
QueryProtocolState :: forall era. QueryInShelleyBasedEra era (ProtocolState era)
QueryCurrentEpochState :: forall era. QueryInShelleyBasedEra era (SerialisedCurrentEpochState era)
QueryPoolState :: forall era. Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedPoolState era)
QueryPoolDistribution :: forall era. Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedPoolDistribution era)
QueryStakeSnapshot :: forall era. Maybe (Set PoolId) -> QueryInShelleyBasedEra era (SerialisedStakeSnapshots era)
QueryStakeDelegDeposits :: forall era. Set StakeCredential -> QueryInShelleyBasedEra era (Map StakeCredential Coin)
QueryAccountState :: forall era. QueryInShelleyBasedEra era AccountState
QueryConstitution :: forall era. QueryInShelleyBasedEra era (Constitution (ShelleyLedgerEra era))
QueryGovState :: forall era. QueryInShelleyBasedEra era (GovState (ShelleyLedgerEra era))
QueryDRepState :: forall era. Set (Credential 'DRepRole StandardCrypto) -> QueryInShelleyBasedEra era (Map (Credential 'DRepRole StandardCrypto) (DRepState StandardCrypto))
QueryDRepStakeDistr :: forall era. Set (DRep StandardCrypto) -> QueryInShelleyBasedEra era (Map (DRep StandardCrypto) Coin)
QuerySPOStakeDistr :: forall era. Set (KeyHash 'StakePool StandardCrypto) -> QueryInShelleyBasedEra era (Map (KeyHash 'StakePool StandardCrypto) Coin)
QueryCommitteeMembersState :: forall era. Set (Credential 'ColdCommitteeRole StandardCrypto) -> Set (Credential 'HotCommitteeRole StandardCrypto) -> Set MemberStatus -> QueryInShelleyBasedEra era (CommitteeMembersState StandardCrypto)
QueryStakeVoteDelegatees :: forall era. Set StakeCredential -> QueryInShelleyBasedEra era (Map StakeCredential (DRep StandardCrypto))

Instances

Instances details

Show (QueryInShelleyBasedEra era result) Source #
Instance details Defined in Cardano.Api.Query Methods showsPrec :: Int -> QueryInShelleyBasedEra era result -> ShowS Source # show :: QueryInShelleyBasedEra era result -> String Source # showList :: [QueryInShelleyBasedEra era result] -> ShowS Source #
NodeToClientVersionOf (QueryInShelleyBasedEra era result) Source #	Mapping for queries in Shelley-based eras returning minimal node-to-client protocol versions. More information about queries versioning can be found: * https://ouroboros-network.cardano.intersectmbo.org/ouroboros-network/Ouroboros-Network-NodeToClient.html#t:NodeToClientVersion * https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/QueryVersioning/#implementation
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryInShelleyBasedEra era result -> NodeToClientVersion Source #

data QueryUTxOFilter Source #

Getting the whole UTxO is obviously not efficient since the result can be huge. Filtering by address is also not efficient because it requires a linear search.

The QueryUTxOFilterByTxIn is efficient since it fits with the structure of the UTxO (which is indexed by TxIn).

Constructors

QueryUTxOWhole	O(n) time and space for utxo size n
QueryUTxOByAddress (Set AddressAny)	O(n) time, O(m) space for utxo size n, and address set size m
QueryUTxOByTxIn (Set TxIn)	O(m log n) time, O(m) space for utxo size n, and address set size m

Instances

Instances details

Show QueryUTxOFilter Source #
Instance details Defined in Cardano.Api.Query Methods showsPrec :: Int -> QueryUTxOFilter -> ShowS Source # show :: QueryUTxOFilter -> String Source # showList :: [QueryUTxOFilter] -> ShowS Source #
NodeToClientVersionOf QueryUTxOFilter Source #
Instance details Defined in Cardano.Api.Query Methods nodeToClientVersionOf :: QueryUTxOFilter -> NodeToClientVersion Source #
Eq QueryUTxOFilter Source #
Instance details Defined in Cardano.Api.Query Methods (==) :: QueryUTxOFilter -> QueryUTxOFilter -> Bool Source # (/=) :: QueryUTxOFilter -> QueryUTxOFilter -> Bool Source #

newtype UTxO era Source #

Constructors

UTxO
Fields unUTxO :: Map TxIn (TxOut CtxUTxO era)

Instances

Instances details

(IsShelleyBasedEra era, FromJSON (TxOut CtxUTxO era)) => FromJSON (UTxO era) Source #
Instance details Defined in Cardano.Api.Query Methods parseJSON :: Value -> Parser (UTxO era) # parseJSONList :: Value -> Parser [UTxO era] # omittedField :: Maybe (UTxO era) #
IsCardanoEra era => ToJSON (UTxO era) Source #
Instance details Defined in Cardano.Api.Query Methods toJSON :: UTxO era -> Value # toEncoding :: UTxO era -> Encoding # toJSONList :: [UTxO era] -> Value # toEncodingList :: [UTxO era] -> Encoding # omitField :: UTxO era -> Bool #
Show (UTxO era) Source #
Instance details Defined in Cardano.Api.Query Methods showsPrec :: Int -> UTxO era -> ShowS Source # show :: UTxO era -> String Source # showList :: [UTxO era] -> ShowS Source #
Eq (UTxO era) Source #
Instance details Defined in Cardano.Api.Query Methods (==) :: UTxO era -> UTxO era -> Bool Source # (/=) :: UTxO era -> UTxO era -> Bool Source #

data UTxOInAnyEra where Source #

Constructors

UTxOInAnyEra :: forall era. CardanoEra era -> UTxO era -> UTxOInAnyEra

Instances

Instances details

Show UTxOInAnyEra Source #
Instance details Defined in Cardano.Api.Query Methods showsPrec :: Int -> UTxOInAnyEra -> ShowS Source # show :: UTxOInAnyEra -> String Source # showList :: [UTxOInAnyEra] -> ShowS Source #

Internal conversion functions

toConsensusQuery :: CardanoBlock StandardCrypto ~ block => QueryInMode result -> Some (Query block) Source #

fromConsensusQueryResult :: (HasCallStack, CardanoBlock StandardCrypto ~ block) => QueryInMode result -> Query block result' -> result' -> result Source #

Wrapper types used in queries

newtype SerialisedDebugLedgerState era Source #

Constructors

SerialisedDebugLedgerState (Serialised (NewEpochState (ShelleyLedgerEra era)))

newtype ProtocolState era Source #

Constructors

ProtocolState (Serialised (ChainDepState (ConsensusProtocol era)))

decodeProtocolState :: FromCBOR (ChainDepState (ConsensusProtocol era)) => ProtocolState era -> Either (ByteString, DecoderError) (ChainDepState (ConsensusProtocol era)) Source #

newtype DebugLedgerState era Source #

Constructors

DebugLedgerState
Fields unDebugLedgerState :: NewEpochState (ShelleyLedgerEra era)

Instances

Instances details

IsShelleyBasedEra era => ToJSON (DebugLedgerState era) Source #
Instance details Defined in Cardano.Api.Query.Types Methods toJSON :: DebugLedgerState era -> Value # toEncoding :: DebugLedgerState era -> Encoding # toJSONList :: [DebugLedgerState era] -> Value # toEncodingList :: [DebugLedgerState era] -> Encoding # omitField :: DebugLedgerState era -> Bool #
IsShelleyBasedEra era => FromCBOR (DebugLedgerState era) Source #
Instance details Defined in Cardano.Api.Query.Types Methods fromCBOR :: Decoder s (DebugLedgerState era) Source # label :: Proxy (DebugLedgerState era) -> Text Source #

decodeDebugLedgerState :: FromCBOR (DebugLedgerState era) => SerialisedDebugLedgerState era -> Either (ByteString, DecoderError) (DebugLedgerState era) Source #

newtype SerialisedCurrentEpochState era Source #

Constructors

SerialisedCurrentEpochState (Serialised (EpochState (ShelleyLedgerEra era)))

newtype CurrentEpochState era Source #

Constructors

CurrentEpochState (EpochState (ShelleyLedgerEra era))

decodeCurrentEpochState :: ShelleyBasedEra era -> SerialisedCurrentEpochState era -> Either DecoderError (CurrentEpochState era) Source #

newtype SerialisedPoolState era Source #

Constructors

SerialisedPoolState (Serialised (PState (ShelleyLedgerEra era)))

newtype PoolState era Source #

Constructors

PoolState (PState (ShelleyLedgerEra era))

decodePoolState :: (Era (ShelleyLedgerEra era), DecCBOR (PState (ShelleyLedgerEra era))) => SerialisedPoolState era -> Either DecoderError (PoolState era) Source #

newtype SerialisedPoolDistribution era Source #

Constructors

SerialisedPoolDistribution (Serialised (PoolDistr (EraCrypto (ShelleyLedgerEra era))))

newtype PoolDistribution era Source #

Constructors

PoolDistribution
Fields unPoolDistr :: PoolDistr (EraCrypto (ShelleyLedgerEra era))

decodePoolDistribution :: Crypto (EraCrypto (ShelleyLedgerEra era)) => ShelleyBasedEra era -> SerialisedPoolDistribution era -> Either DecoderError (PoolDistribution era) Source #

newtype SerialisedStakeSnapshots era Source #

Constructors

SerialisedStakeSnapshots (Serialised (StakeSnapshots (EraCrypto (ShelleyLedgerEra era))))

newtype StakeSnapshot era Source #

Constructors

StakeSnapshot (StakeSnapshots (EraCrypto (ShelleyLedgerEra era)))

decodeStakeSnapshot :: FromCBOR (StakeSnapshots (EraCrypto (ShelleyLedgerEra era))) => SerialisedStakeSnapshots era -> Either DecoderError (StakeSnapshot era) Source #

data EraHistory where Source #

Constructors

EraHistory :: forall (xs :: [Type]). CardanoBlock StandardCrypto ~ HardForkBlock xs => Interpreter xs -> EraHistory

newtype SystemStart Source #

System start

Slots are counted from the system start.

Constructors

SystemStart
Fields getSystemStart :: UTCTime

Instances

Instances details

FromJSON SystemStart

Instance details

Defined in Cardano.Slotting.Time

Methods

parseJSON :: Value -> Parser SystemStart #

parseJSONList :: Value -> Parser [SystemStart] #

omittedField :: Maybe SystemStart #

ToJSON SystemStart

Instance details

Defined in Cardano.Slotting.Time

Methods

toJSON :: SystemStart -> Value #

toEncoding :: SystemStart -> Encoding #

toJSONList :: [SystemStart] -> Value #

toEncodingList :: [SystemStart] -> Encoding #

omitField :: SystemStart -> Bool #

Generic SystemStart

Instance details

Defined in Cardano.Slotting.Time

Associated Types

type Rep SystemStart
Instance details Defined in Cardano.Slotting.Time type Rep SystemStart = D1 ('MetaData "SystemStart" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-886a3531c066a8cf893d904908b2d4b5847cecce4ba51139f879cc7ba241da23" 'True) (C1 ('MetaCons "SystemStart" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSystemStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Methods

from :: SystemStart -> Rep SystemStart x Source #

to :: Rep SystemStart x -> SystemStart Source #

Show SystemStart

Instance details

Defined in Cardano.Slotting.Time

Methods

showsPrec :: Int -> SystemStart -> ShowS Source #

show :: SystemStart -> String Source #

showList :: [SystemStart] -> ShowS Source #

FromCBOR SystemStart

Instance details

Defined in Cardano.Slotting.Time

Methods

fromCBOR :: Decoder s SystemStart Source #

label :: Proxy SystemStart -> Text Source #

ToCBOR SystemStart

Instance details

Defined in Cardano.Slotting.Time

Methods

toCBOR :: SystemStart -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy SystemStart -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SystemStart] -> Size Source #

DecCBOR SystemStart

Instance details

Defined in Cardano.Ledger.Binary.Decoding.DecCBOR

Methods

decCBOR :: Decoder s SystemStart Source #

dropCBOR :: Proxy SystemStart -> Decoder s () Source #

label :: Proxy SystemStart -> Text Source #

EncCBOR SystemStart

Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR :: SystemStart -> Encoding Source #

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy SystemStart -> Size Source #

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [SystemStart] -> Size Source #

Eq SystemStart

Instance details

Defined in Cardano.Slotting.Time

Methods

(==) :: SystemStart -> SystemStart -> Bool Source #

(/=) :: SystemStart -> SystemStart -> Bool Source #

NoThunks SystemStart

Instance details

Defined in Cardano.Slotting.Time

Methods

noThunks :: Context -> SystemStart -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> SystemStart -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy SystemStart -> String #

Serialise SystemStart

Instance details

Defined in Cardano.Slotting.Time

Methods

encode :: SystemStart -> Encoding

decode :: Decoder s SystemStart

encodeList :: [SystemStart] -> Encoding

decodeList :: Decoder s [SystemStart]

type Rep SystemStart

Instance details

Defined in Cardano.Slotting.Time

type Rep SystemStart = D1 ('MetaData "SystemStart" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-886a3531c066a8cf893d904908b2d4b5847cecce4ba51139f879cc7ba241da23" 'True) (C1 ('MetaCons "SystemStart" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSystemStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

newtype LedgerEpochInfo Source #

Constructors

LedgerEpochInfo
Fields unLedgerEpochInfo :: EpochInfo (Either Text)

toLedgerEpochInfo :: EraHistory -> LedgerEpochInfo Source #

newtype SlotsInEpoch Source #

Constructors

SlotsInEpoch Word64

newtype SlotsToEpochEnd Source #

Constructors

SlotsToEpochEnd Word64

slotToEpoch :: SlotNo -> EraHistory -> Either PastHorizonException (EpochNo, SlotsInEpoch, SlotsToEpochEnd) Source #

data family LedgerState blk Source #

Ledger state associated with a block

This is the Consensus notion of a ledger state. Each block type is associated with one of the Ledger types for the ledger state. Virtually every concept in this codebase revolves around this type, or the referenced blk. Whenever we use the type variable l, we intend to denote that the expected instantiation is either a LedgerState or some wrapper over it (like the ExtLedgerState).

The main operations we can do with a LedgerState are ticking (defined in IsLedger), and applying a block (defined in ApplyBlock).

Instances

Instances details

Inject LedgerState

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Nary

Methods

inject :: forall x (xs :: [Type]). CanHardFork xs => Exactly xs Bound -> Index xs x -> LedgerState x -> LedgerState (HardForkBlock xs) Source #

Isomorphic LedgerState

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary

Methods

project :: NoHardForks blk => LedgerState (HardForkBlock '[blk]) -> LedgerState blk Source #

inject :: NoHardForks blk => LedgerState blk -> LedgerState (HardForkBlock '[blk]) Source #

CanHardFork xs => Show (LedgerState (HardForkBlock xs))

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

showsPrec :: Int -> LedgerState (HardForkBlock xs) -> ShowS Source #

show :: LedgerState (HardForkBlock xs) -> String Source #

showList :: [LedgerState (HardForkBlock xs)] -> ShowS Source #

Bridge m a => Show (LedgerState (DualBlock m a))

Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

showsPrec :: Int -> LedgerState (DualBlock m a) -> ShowS Source #

show :: LedgerState (DualBlock m a) -> String Source #

showList :: [LedgerState (DualBlock m a)] -> ShowS Source #

CanHardFork xs => Eq (LedgerState (HardForkBlock xs))

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

(==) :: LedgerState (HardForkBlock xs) -> LedgerState (HardForkBlock xs) -> Bool Source #

(/=) :: LedgerState (HardForkBlock xs) -> LedgerState (HardForkBlock xs) -> Bool Source #

Bridge m a => Eq (LedgerState (DualBlock m a))

Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

(==) :: LedgerState (DualBlock m a) -> LedgerState (DualBlock m a) -> Bool Source #

(/=) :: LedgerState (DualBlock m a) -> LedgerState (DualBlock m a) -> Bool Source #

CanHardFork xs => NoThunks (LedgerState (HardForkBlock xs))

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

noThunks :: Context -> LedgerState (HardForkBlock xs) -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> LedgerState (HardForkBlock xs) -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy (LedgerState (HardForkBlock xs)) -> String #

NoThunks (LedgerState (DualBlock m a))

Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

noThunks :: Context -> LedgerState (DualBlock m a) -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> LedgerState (DualBlock m a) -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy (LedgerState (DualBlock m a)) -> String #

NoThunks (Ticked (LedgerState (DualBlock m a)))

Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

noThunks :: Context -> Ticked (LedgerState (DualBlock m a)) -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> Ticked (LedgerState (DualBlock m a)) -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy (Ticked (LedgerState (DualBlock m a))) -> String #

Bridge m a => GetTip (LedgerState (DualBlock m a))

Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

getTip :: LedgerState (DualBlock m a) -> Point (LedgerState (DualBlock m a)) Source #

Bridge m a => GetTip (Ticked (LedgerState (DualBlock m a)))

Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

getTip :: Ticked (LedgerState (DualBlock m a)) -> Point (Ticked (LedgerState (DualBlock m a))) Source #

Bridge m a => IsLedger (LedgerState (DualBlock m a))

Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Associated Types

type LedgerErr (LedgerState (DualBlock m a))
Instance details Defined in Ouroboros.Consensus.Ledger.Dual type LedgerErr (LedgerState (DualBlock m a)) = DualLedgerError m a
type AuxLedgerEvent (LedgerState (DualBlock m a))
Instance details Defined in Ouroboros.Consensus.Ledger.Dual type AuxLedgerEvent (LedgerState (DualBlock m a)) = AuxLedgerEvent (LedgerState m)