Safe Haskell	Safe-Inferred
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 mode result where
- QueryCurrentEra ∷ ConsensusModeIsMultiEra mode → QueryInMode mode AnyCardanoEra
- QueryInEra ∷ EraInMode era mode → QueryInEra era result → QueryInMode mode (Either EraMismatch result)
- QueryEraHistory ∷ ConsensusModeIsMultiEra mode → QueryInMode mode (EraHistory mode)
- QuerySystemStart ∷ QueryInMode mode SystemStart
- QueryChainBlockNo ∷ QueryInMode mode (WithOrigin BlockNo)
- QueryChainPoint ∷ ConsensusMode mode → QueryInMode mode ChainPoint
data QueryInEra era result where
- QueryByronUpdateState ∷ QueryInEra ByronEra ByronUpdateState
- QueryInShelleyBasedEra ∷ ShelleyBasedEra era → QueryInShelleyBasedEra era result → QueryInEra era result
data QueryInShelleyBasedEra era result where
- QueryEpoch ∷ QueryInShelleyBasedEra era EpochNo
- QueryGenesisParameters ∷ QueryInShelleyBasedEra era GenesisParameters
- QueryProtocolParameters ∷ QueryInShelleyBasedEra era ProtocolParameters
- QueryProtocolParametersUpdate ∷ QueryInShelleyBasedEra era (Map (Hash GenesisKey) ProtocolParametersUpdate)
- QueryStakeDistribution ∷ QueryInShelleyBasedEra era (Map (Hash StakePoolKey) Rational)
- QueryUTxO ∷ QueryUTxOFilter → QueryInShelleyBasedEra era (UTxO era)
- QueryStakeAddresses ∷ Set StakeCredential → NetworkId → QueryInShelleyBasedEra era (Map StakeAddress Lovelace, Map StakeAddress PoolId)
- QueryStakePools ∷ QueryInShelleyBasedEra era (Set PoolId)
- QueryStakePoolParameters ∷ Set PoolId → QueryInShelleyBasedEra era (Map PoolId StakePoolParameters)
- QueryDebugLedgerState ∷ QueryInShelleyBasedEra era (SerialisedDebugLedgerState era)
- QueryProtocolState ∷ QueryInShelleyBasedEra era (ProtocolState era)
- QueryCurrentEpochState ∷ QueryInShelleyBasedEra era (SerialisedCurrentEpochState era)
- QueryPoolState ∷ Maybe (Set PoolId) → QueryInShelleyBasedEra era (SerialisedPoolState era)
- QueryPoolDistribution ∷ Maybe (Set PoolId) → QueryInShelleyBasedEra era (SerialisedPoolDistribution era)
- QueryStakeSnapshot ∷ Maybe (Set PoolId) → QueryInShelleyBasedEra era (SerialisedStakeSnapshots era)
data QueryUTxOFilter
- = QueryUTxOWhole
- | QueryUTxOByAddress (Set AddressAny)
- | QueryUTxOByTxIn (Set TxIn)
newtype UTxO era = UTxO {
- unUTxO ∷ Map TxIn (TxOut CtxUTxO era)
}
data UTxOInAnyEra where
- UTxOInAnyEra ∷ CardanoEra era → UTxO era → UTxOInAnyEra
toConsensusQuery ∷ ∀ mode block result. ConsensusBlockForMode mode ~ block ⇒ QueryInMode mode result → Some (Query block)
fromConsensusQueryResult ∷ ∀ mode block result result'. ConsensusBlockForMode mode ~ block ⇒ QueryInMode mode 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))
data DebugLedgerState era where
- DebugLedgerState ∷ ShelleyLedgerEra era ~ ledgerera ⇒ NewEpochState ledgerera → DebugLedgerState era
decodeDebugLedgerState ∷ ∀ era. FromCBOR (DebugLedgerState era) ⇒ SerialisedDebugLedgerState era → Either ByteString (DebugLedgerState era)
newtype SerialisedCurrentEpochState era = SerialisedCurrentEpochState (Serialised (EpochState (ShelleyLedgerEra era)))
newtype CurrentEpochState era = CurrentEpochState (EpochState (ShelleyLedgerEra era))
decodeCurrentEpochState ∷ ∀ era. (Era (ShelleyLedgerEra era), HashAnnotated (TxBody (ShelleyLedgerEra era)) EraIndependentTxBody (Crypto (ShelleyLedgerEra era))) ⇒ FromSharedCBOR (TxOut (ShelleyLedgerEra era)) ⇒ Share (TxOut (ShelleyLedgerEra era)) ~ Interns (Credential 'Staking (Crypto (ShelleyLedgerEra era))) ⇒ FromCBOR (PParams (ShelleyLedgerEra era)) ⇒ FromCBOR (Value (ShelleyLedgerEra era)) ⇒ FromCBOR (State (EraRule "PPUP" (ShelleyLedgerEra era))) ⇒ SerialisedCurrentEpochState era → Either DecoderError (CurrentEpochState era)
newtype SerialisedPoolState era = SerialisedPoolState (Serialised (PState (Crypto (ShelleyLedgerEra era))))
newtype PoolState era = PoolState (PState (Crypto (ShelleyLedgerEra era)))
decodePoolState ∷ ∀ era. FromCBOR (PState (Crypto (ShelleyLedgerEra era))) ⇒ SerialisedPoolState era → Either DecoderError (PoolState era)
newtype SerialisedPoolDistribution era = SerialisedPoolDistribution (Serialised (PoolDistr (Crypto (ShelleyLedgerEra era))))
newtype PoolDistribution era = PoolDistribution {
- unPoolDistr ∷ PoolDistr (Crypto (ShelleyLedgerEra era))
}
decodePoolDistribution ∷ ∀ era. FromCBOR (PoolDistr (Crypto (ShelleyLedgerEra era))) ⇒ SerialisedPoolDistribution era → Either DecoderError (PoolDistribution era)
newtype SerialisedStakeSnapshots era = SerialisedStakeSnapshots (Serialised (StakeSnapshots (Crypto (ShelleyLedgerEra era))))
newtype StakeSnapshot era = StakeSnapshot (StakeSnapshots (Crypto (ShelleyLedgerEra era)))
decodeStakeSnapshot ∷ ∀ era. FromCBOR (StakeSnapshots (Crypto (ShelleyLedgerEra era))) ⇒ SerialisedStakeSnapshots era → Either DecoderError (StakeSnapshot era)
data EraHistory mode where
- EraHistory ∷ ConsensusBlockForMode mode ~ HardForkBlock xs ⇒ ConsensusMode mode → Interpreter xs → EraHistory mode
newtype SystemStart = SystemStart {
- getSystemStart ∷ UTCTime
}
newtype LedgerEpochInfo = LedgerEpochInfo {
- unLedgerEpochInfo ∷ EpochInfo (Either Text)
}
toLedgerEpochInfo ∷ EraHistory mode → LedgerEpochInfo
newtype SlotsInEpoch = SlotsInEpoch Word64
newtype SlotsToEpochEnd = SlotsToEpochEnd Word64
slotToEpoch ∷ SlotNo → EraHistory mode → Either PastHorizonException (EpochNo, SlotsInEpoch, SlotsToEpochEnd)
data family LedgerState blk
getProgress ∷ SlotNo → EraHistory mode → Either PastHorizonException (RelativeTime, SlotLength)
toLedgerUTxO ∷ ShelleyLedgerEra era ~ ledgerera ⇒ Crypto ledgerera ~ StandardCrypto ⇒ ShelleyBasedEra era → UTxO era → UTxO ledgerera
fromLedgerUTxO ∷ ShelleyLedgerEra era ~ ledgerera ⇒ Crypto ledgerera ~ StandardCrypto ⇒ ShelleyBasedEra era → UTxO ledgerera → UTxO era

Queries

data QueryInMode mode result where Source #

Constructors

QueryCurrentEra ∷ ConsensusModeIsMultiEra mode → QueryInMode mode AnyCardanoEra
QueryInEra ∷ EraInMode era mode → QueryInEra era result → QueryInMode mode (Either EraMismatch result)
QueryEraHistory ∷ ConsensusModeIsMultiEra mode → QueryInMode mode (EraHistory mode)
QuerySystemStart ∷ QueryInMode mode SystemStart
QueryChainBlockNo ∷ QueryInMode mode (WithOrigin BlockNo)
QueryChainPoint ∷ ConsensusMode mode → QueryInMode mode ChainPoint

Instances

Instances details

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

data QueryInEra era result where Source #

Constructors

QueryByronUpdateState ∷ QueryInEra ByronEra ByronUpdateState
QueryInShelleyBasedEra ∷ 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 ∷ QueryInShelleyBasedEra era EpochNo
QueryGenesisParameters ∷ QueryInShelleyBasedEra era GenesisParameters
QueryProtocolParameters ∷ QueryInShelleyBasedEra era ProtocolParameters
QueryProtocolParametersUpdate ∷ QueryInShelleyBasedEra era (Map (Hash GenesisKey) ProtocolParametersUpdate)
QueryStakeDistribution ∷ QueryInShelleyBasedEra era (Map (Hash StakePoolKey) Rational)
QueryUTxO ∷ QueryUTxOFilter → QueryInShelleyBasedEra era (UTxO era)
QueryStakeAddresses ∷ Set StakeCredential → NetworkId → QueryInShelleyBasedEra era (Map StakeAddress Lovelace, Map StakeAddress PoolId)
QueryStakePools ∷ QueryInShelleyBasedEra era (Set PoolId)
QueryStakePoolParameters ∷ Set PoolId → QueryInShelleyBasedEra era (Map PoolId StakePoolParameters)
QueryDebugLedgerState ∷ QueryInShelleyBasedEra era (SerialisedDebugLedgerState era)
QueryProtocolState ∷ QueryInShelleyBasedEra era (ProtocolState era)
QueryCurrentEpochState ∷ QueryInShelleyBasedEra era (SerialisedCurrentEpochState era)
QueryPoolState ∷ Maybe (Set PoolId) → QueryInShelleyBasedEra era (SerialisedPoolState era)
QueryPoolDistribution ∷ Maybe (Set PoolId) → QueryInShelleyBasedEra era (SerialisedPoolDistribution era)
QueryStakeSnapshot ∷ Maybe (Set PoolId) → QueryInShelleyBasedEra era (SerialisedStakeSnapshots era)

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 #
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

EraCast UTxO Source #
Instance details Defined in Cardano.Api.Query Methods eraCast ∷ (IsCardanoEra fromEra, IsCardanoEra toEra) ⇒ CardanoEra toEra → UTxO fromEra → Either EraCastError (UTxO toEra) Source #
(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] #
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 #
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 ∷ 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 ∷ ∀ mode block result. ConsensusBlockForMode mode ~ block ⇒ QueryInMode mode result → Some (Query block) Source #

fromConsensusQueryResult ∷ ∀ mode block result result'. ConsensusBlockForMode mode ~ block ⇒ QueryInMode mode 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 #

data DebugLedgerState era where Source #

Constructors

DebugLedgerState ∷ ShelleyLedgerEra era ~ ledgerera ⇒ NewEpochState ledgerera → DebugLedgerState era

Instances

Instances details

(IsShelleyBasedEra era, ShelleyLedgerEra era ~ ledgerera, ShelleyBasedEra ledgerera, ToJSON (PParams ledgerera), ToJSON (PParamsUpdate ledgerera), ToJSON (TxOut ledgerera), Share (TxOut (ShelleyLedgerEra era)) ~ Interns (Credential 'Staking (Crypto (ShelleyLedgerEra era)))) ⇒ ToJSON (DebugLedgerState era) Source #
Instance details Defined in Cardano.Api.Query Methods toJSON ∷ DebugLedgerState era → Value # toEncoding ∷ DebugLedgerState era → Encoding # toJSONList ∷ [DebugLedgerState era] → Value # toEncodingList ∷ [DebugLedgerState era] → Encoding #
(Typeable era, Era (ShelleyLedgerEra era), FromCBOR (PParams (ShelleyLedgerEra era)), FromCBOR (StashedAVVMAddresses (ShelleyLedgerEra era)), FromCBOR (Value (ShelleyLedgerEra era)), FromCBOR (State (EraRule "PPUP" (ShelleyLedgerEra era))), Share (TxOut (ShelleyLedgerEra era)) ~ Interns (Credential 'Staking (Crypto (ShelleyLedgerEra era))), FromSharedCBOR (TxOut (ShelleyLedgerEra era)), HashAnnotated (TxBody (ShelleyLedgerEra era)) EraIndependentTxBody (Crypto (ShelleyLedgerEra era))) ⇒ FromCBOR (DebugLedgerState era) Source #
Instance details Defined in Cardano.Api.Query Methods fromCBOR ∷ Decoder s (DebugLedgerState era) # label ∷ Proxy (DebugLedgerState era) → Text #

decodeDebugLedgerState ∷ ∀ era. FromCBOR (DebugLedgerState era) ⇒ SerialisedDebugLedgerState era → Either ByteString (DebugLedgerState era) Source #

newtype SerialisedCurrentEpochState era Source #

Constructors

SerialisedCurrentEpochState (Serialised (EpochState (ShelleyLedgerEra era)))

newtype CurrentEpochState era Source #

Constructors

CurrentEpochState (EpochState (ShelleyLedgerEra era))

decodeCurrentEpochState ∷ ∀ era. (Era (ShelleyLedgerEra era), HashAnnotated (TxBody (ShelleyLedgerEra era)) EraIndependentTxBody (Crypto (ShelleyLedgerEra era))) ⇒ FromSharedCBOR (TxOut (ShelleyLedgerEra era)) ⇒ Share (TxOut (ShelleyLedgerEra era)) ~ Interns (Credential 'Staking (Crypto (ShelleyLedgerEra era))) ⇒ FromCBOR (PParams (ShelleyLedgerEra era)) ⇒ FromCBOR (Value (ShelleyLedgerEra era)) ⇒ FromCBOR (State (EraRule "PPUP" (ShelleyLedgerEra era))) ⇒ SerialisedCurrentEpochState era → Either DecoderError (CurrentEpochState era) Source #

newtype SerialisedPoolState era Source #

Constructors

SerialisedPoolState (Serialised (PState (Crypto (ShelleyLedgerEra era))))

newtype PoolState era Source #

Constructors

PoolState (PState (Crypto (ShelleyLedgerEra era)))

decodePoolState ∷ ∀ era. FromCBOR (PState (Crypto (ShelleyLedgerEra era))) ⇒ SerialisedPoolState era → Either DecoderError (PoolState era) Source #

newtype SerialisedPoolDistribution era Source #

Constructors

SerialisedPoolDistribution (Serialised (PoolDistr (Crypto (ShelleyLedgerEra era))))

newtype PoolDistribution era Source #

Constructors

PoolDistribution
Fields unPoolDistr ∷ PoolDistr (Crypto (ShelleyLedgerEra era))

decodePoolDistribution ∷ ∀ era. FromCBOR (PoolDistr (Crypto (ShelleyLedgerEra era))) ⇒ SerialisedPoolDistribution era → Either DecoderError (PoolDistribution era) Source #

newtype SerialisedStakeSnapshots era Source #

Constructors

SerialisedStakeSnapshots (Serialised (StakeSnapshots (Crypto (ShelleyLedgerEra era))))

newtype StakeSnapshot era Source #

Constructors

StakeSnapshot (StakeSnapshots (Crypto (ShelleyLedgerEra era)))

decodeStakeSnapshot ∷ ∀ era. FromCBOR (StakeSnapshots (Crypto (ShelleyLedgerEra era))) ⇒ SerialisedStakeSnapshots era → Either DecoderError (StakeSnapshot era) Source #

data EraHistory mode where Source #

Constructors

EraHistory ∷ ConsensusBlockForMode mode ~ HardForkBlock xs ⇒ ConsensusMode mode → Interpreter xs → EraHistory mode

newtype SystemStart #

Constructors

SystemStart
Fields getSystemStart ∷ UTCTime

Instances

Instances details

FromJSON SystemStart Source #
Instance details Defined in Cardano.Api.Orphans Methods parseJSON ∷ Value → Parser SystemStart # parseJSONList ∷ Value → Parser [SystemStart] #
ToJSON SystemStart Source #
Instance details Defined in Cardano.Api.Orphans Methods toJSON ∷ SystemStart → Value # toEncoding ∷ SystemStart → Encoding # toJSONList ∷ [SystemStart] → Value # toEncodingList ∷ [SystemStart] → Encoding #
Generic SystemStart
Instance details Defined in Cardano.Slotting.Time Associated Types type Rep SystemStart ∷ Type → Type Source # 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 # label ∷ Proxy SystemStart → Text #
ToCBOR SystemStart
Instance details Defined in Cardano.Slotting.Time Methods toCBOR ∷ SystemStart → Encoding # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SystemStart → Size # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SystemStart] → Size #
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.1.0.2-5ecadb882e6f1896225ef3f366c408bfc73edba8fb7d935db3b12f51d1c1f954" '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 mode → LedgerEpochInfo Source #

newtype SlotsInEpoch Source #

Constructors

SlotsInEpoch Word64

newtype SlotsToEpochEnd Source #

Constructors

SlotsToEpochEnd Word64

slotToEpoch ∷ SlotNo → EraHistory mode → Either PastHorizonException (EpochNo, SlotsInEpoch, SlotsToEpochEnd) Source #

data family LedgerState blk #

Instances

Instances details

Isomorphic LedgerState
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary Methods project ∷ NoHardForks blk ⇒ LedgerState (HardForkBlock '[blk]) → LedgerState blk inject ∷ NoHardForks blk ⇒ LedgerState blk → LedgerState (HardForkBlock '[blk])
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 #
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 #
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
Isomorphic (Ticked :.: LedgerState)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary Methods project ∷ NoHardForks blk ⇒ (Ticked :.: LedgerState) (HardForkBlock '[blk]) → (Ticked :.: LedgerState) blk inject ∷ NoHardForks blk ⇒ (Ticked :.: LedgerState) blk → (Ticked :.: LedgerState) (HardForkBlock '[blk])
data LedgerState ByronBlock
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger data LedgerState ByronBlock = ByronLedgerState { byronLedgerTipBlockNo ∷ !(WithOrigin BlockNo) byronLedgerState ∷ !ChainValidationState byronLedgerTransition ∷ !ByronTransition }
type TranslationError era (LedgerState :.: ShelleyBlock proto)
Instance details Defined in Ouroboros.Consensus.Shelley.ShelleyHFC type TranslationError era (LedgerState :.: ShelleyBlock proto) = Void
type Rep (LedgerState ByronBlock)
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger type Rep (LedgerState ByronBlock) = D1 ('MetaData "LedgerState" "Ouroboros.Consensus.Byron.Ledger.Ledger" "ouroboros-consensus-byron-0.3.0.0-55355aed7bf789d81db27e002be656a9bdc0cfdd7818139c6d5332aa839cf3ff" 'False) (C1 ('MetaCons "ByronLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "byronLedgerTipBlockNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin BlockNo)) :: (S1 ('MetaSel ('Just "byronLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChainValidationState) :: S1 ('MetaSel ('Just "byronLedgerTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ByronTransition))))
type Rep (LedgerState (ShelleyBlock proto era))
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Ledger type Rep (LedgerState (ShelleyBlock proto era)) = D1 ('MetaData "LedgerState" "Ouroboros.Consensus.Shelley.Ledger.Ledger" "ouroboros-consensus-shelley-0.3.0.0-8390b905acf9c54051084c783ac6bb1c1fade074098b9c129336a4916013b427" 'False) (C1 ('MetaCons "ShelleyLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "shelleyLedgerTip") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin (ShelleyTip proto era))) :: (S1 ('MetaSel ('Just "shelleyLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NewEpochState era)) :: S1 ('MetaSel ('Just "shelleyLedgerTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShelleyTransition))))
type Rep (Ticked (LedgerState (HardForkBlock xs)))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type Rep (Ticked (LedgerState (HardForkBlock xs))) = D1 ('MetaData "Ticked" "Ouroboros.Consensus.HardFork.Combinator.Ledger" "ouroboros-consensus-0.3.0.0-589da4a149a52859a2e47db76afd3bf850a0360b6794060f213fa498a03d1073" 'False) (C1 ('MetaCons "TickedHardForkLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "tickedHardForkLedgerStateTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TransitionInfo) :*: S1 ('MetaSel ('Just "tickedHardForkLedgerStatePerEra") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HardForkState (Ticked :.: LedgerState) xs))))
type Rep (Ticked (LedgerState ByronBlock))
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger type Rep (Ticked (LedgerState ByronBlock)) = D1 ('MetaData "Ticked" "Ouroboros.Consensus.Byron.Ledger.Ledger" "ouroboros-consensus-byron-0.3.0.0-55355aed7bf789d81db27e002be656a9bdc0cfdd7818139c6d5332aa839cf3ff" 'False) (C1 ('MetaCons "TickedByronLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "tickedByronLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChainValidationState) :*: S1 ('MetaSel ('Just "untickedByronLedgerTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ByronTransition)))
type Rep (Ticked (LedgerState (ShelleyBlock proto era)))
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Ledger type Rep (Ticked (LedgerState (ShelleyBlock proto era))) = D1 ('MetaData "Ticked" "Ouroboros.Consensus.Shelley.Ledger.Ledger" "ouroboros-consensus-shelley-0.3.0.0-8390b905acf9c54051084c783ac6bb1c1fade074098b9c129336a4916013b427" 'False) (C1 ('MetaCons "TickedShelleyLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "untickedShelleyLedgerTip") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin (ShelleyTip proto era))) :: (S1 ('MetaSel ('Just "tickedShelleyLedgerTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShelleyTransition) :: S1 ('MetaSel ('Just "tickedShelleyLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NewEpochState era)))))
type AuxLedgerEvent (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type AuxLedgerEvent (LedgerState (HardForkBlock xs)) = OneEraLedgerEvent xs
type AuxLedgerEvent (LedgerState ByronBlock)
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger type AuxLedgerEvent (LedgerState ByronBlock) = VoidLedgerEvent (LedgerState ByronBlock)
type AuxLedgerEvent (LedgerState (ShelleyBlock proto era))
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Ledger type AuxLedgerEvent (LedgerState (ShelleyBlock proto era)) = ShelleyLedgerEvent era
type LedgerCfg (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics type LedgerCfg (LedgerState (HardForkBlock xs)) = HardForkLedgerConfig xs
type LedgerCfg (LedgerState ByronBlock)
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger type LedgerCfg (LedgerState ByronBlock) = Config
type LedgerCfg (LedgerState (ShelleyBlock proto era))
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Ledger type LedgerCfg (LedgerState (ShelleyBlock proto era)) = ShelleyLedgerConfig era
type LedgerErr (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type LedgerErr (LedgerState (HardForkBlock xs)) = HardForkLedgerError xs
type LedgerErr (LedgerState ByronBlock)
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger type LedgerErr (LedgerState ByronBlock) = ChainValidationError
type LedgerErr (LedgerState (ShelleyBlock proto era))
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Ledger type LedgerErr (LedgerState (ShelleyBlock proto era)) = ShelleyLedgerError era
newtype LedgerState (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics newtype LedgerState (HardForkBlock xs) = HardForkLedgerState { hardForkLedgerStatePerEra ∷ HardForkState LedgerState xs }
data Ticked (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger data Ticked (LedgerState (HardForkBlock xs)) = TickedHardForkLedgerState { tickedHardForkLedgerStateTransition ∷ !TransitionInfo tickedHardForkLedgerStatePerEra ∷ !(HardForkState (Ticked :.: LedgerState) xs) }
data Ticked (LedgerState ByronBlock)
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger data Ticked (LedgerState ByronBlock) = TickedByronLedgerState { tickedByronLedgerState ∷ !ChainValidationState untickedByronLedgerTransition ∷ !ByronTransition }
data Ticked (LedgerState (ShelleyBlock proto era))
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Ledger data Ticked (LedgerState (ShelleyBlock proto era)) = TickedShelleyLedgerState { untickedShelleyLedgerTip ∷ !(WithOrigin (ShelleyTip proto era)) tickedShelleyLedgerTransition ∷ !ShelleyTransition tickedShelleyLedgerState ∷ !(NewEpochState era) }
type HeaderHash (LedgerState blk)
Instance details Defined in Ouroboros.Consensus.Ledger.Basics type HeaderHash (LedgerState blk) = HeaderHash blk
data LedgerState (ShelleyBlock proto era)
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Ledger data LedgerState (ShelleyBlock proto era) = ShelleyLedgerState { shelleyLedgerTip ∷ !(WithOrigin (ShelleyTip proto era)) shelleyLedgerState ∷ !(NewEpochState era) shelleyLedgerTransition ∷ !ShelleyTransition }

getProgress ∷ SlotNo → EraHistory mode → Either PastHorizonException (RelativeTime, SlotLength) Source #

Internal conversion functions

toLedgerUTxO ∷ ShelleyLedgerEra era ~ ledgerera ⇒ Crypto ledgerera ~ StandardCrypto ⇒ ShelleyBasedEra era → UTxO era → UTxO ledgerera Source #

fromLedgerUTxO ∷ ShelleyLedgerEra era ~ ledgerera ⇒ Crypto ledgerera ~ StandardCrypto ⇒ ShelleyBasedEra era → UTxO ledgerera → UTxO era Source #