API Overview
This page provides an overview of the library's module structure
and main types.
Eras
Modules for handling Cardano's era system.
| Module |
Description |
Cardano.Read.Ledger.Eras |
Re-exports era types |
Cardano.Read.Ledger.Eras.KnownEras |
Era type-level list and constraints |
Cardano.Read.Ledger.Eras.EraValue |
Era-polymorphic value wrapper |
EraValue
The EraValue type wraps values that exist in a specific era:
data EraValue f where
EraValue :: IsEra era => f era -> EraValue f
Blocks
Modules for reading block-level data.
| Module |
Description |
Cardano.Read.Ledger.Block.Block |
Block type and era extraction |
Cardano.Read.Ledger.Block.BHeader |
Block header access |
Cardano.Read.Ledger.Block.BlockNo |
Block number extraction |
Cardano.Read.Ledger.Block.SlotNo |
Slot number extraction |
Cardano.Read.Ledger.Block.HeaderHash |
Block header hash |
Cardano.Read.Ledger.Block.Txs |
Transaction list extraction |
Transactions
Modules for reading transaction components.
Core
| Module |
Description |
Cardano.Read.Ledger.Tx.Tx |
Transaction type |
Cardano.Read.Ledger.Tx.TxId |
Transaction ID |
Cardano.Read.Ledger.Tx.CBOR |
CBOR serialization |
Cardano.Read.Ledger.Tx.Eras |
Transaction era utilities |
| Module |
Description |
Cardano.Read.Ledger.Tx.Inputs |
Transaction inputs |
Cardano.Read.Ledger.Tx.Outputs |
Transaction outputs |
Cardano.Read.Ledger.Tx.Output |
Single output type |
Cardano.Read.Ledger.Tx.CollateralInputs |
Collateral inputs (Alonzo+) |
Cardano.Read.Ledger.Tx.CollateralOutputs |
Collateral outputs (Babbage+) |
Cardano.Read.Ledger.Tx.ReferenceInputs |
Reference inputs (Babbage+) |
| Module |
Description |
Cardano.Read.Ledger.Tx.Fee |
Transaction fee |
Cardano.Read.Ledger.Tx.Validity |
Validity interval |
Cardano.Read.Ledger.Tx.Metadata |
Auxiliary metadata |
Cardano.Read.Ledger.Tx.Certificates |
Stake certificates |
Cardano.Read.Ledger.Tx.Withdrawals |
Stake withdrawals |
Cardano.Read.Ledger.Tx.Mint |
Token minting/burning |
Scripts and Witnesses
| Module |
Description |
Cardano.Read.Ledger.Tx.Witnesses |
Transaction witnesses |
Cardano.Read.Ledger.Tx.ScriptValidity |
Script validation tag |
Cardano.Read.Ledger.Tx.Integrity |
Script integrity hash |
Cardano.Read.Ledger.Tx.ExtraSigs |
Required extra signers |
Common Types
| Module |
Description |
Cardano.Read.Ledger.Address |
Address types |
Cardano.Read.Ledger.Value |
Multi-asset values |
Cardano.Read.Ledger.Hash |
Hash utilities |
Cardano.Read.Ledger.PParams |
Protocol parameters |