Safe Haskell	None
Language	Haskell2010

Cardano.Api.Shelley

Contents

Genesis
Cryptographic key interface
Hashes
Type Proxies
Payment addresses
Stake addresses
Building transactions
Arbitrary signing
Signing transactions
- Incremental signing and separate witnesses
Blocks
Transaction metadata
Protocol parameters
Scripts
Reference Scripts
Certificates
- Operational certificates
Stake Pool
Governance Actions
DRep

Description

This module provides a library interface that is intended to be the complete API for Shelley covering everything, including exposing constructors for the lower level types.

Synopsis

module Cardano.Api
data ShelleyGenesis c = ShelleyGenesis {
- sgSystemStart :: !UTCTime
- sgNetworkMagic :: !Word32
- sgNetworkId :: !Network
- sgActiveSlotsCoeff :: !PositiveUnitInterval
- sgSecurityParam :: !Word64
- sgEpochLength :: !EpochSize
- sgSlotsPerKESPeriod :: !Word64
- sgMaxKESEvolutions :: !Word64
- sgSlotLength :: !NominalDiffTimeMicro
- sgUpdateQuorum :: !Word64
- sgMaxLovelaceSupply :: !Word64
- sgProtocolParams :: !(PParams (ShelleyEra c))
- sgGenDelegs :: !(Map (KeyHash 'Genesis c) (GenDelegPair c))
- sgInitialFunds :: ListMap (Addr c) Coin
- sgStaking :: ShelleyGenesisStaking c
}
shelleyGenesisDefaults :: ShelleyGenesis StandardCrypto
alonzoGenesisDefaults :: CardanoEra era -> AlonzoGenesis
decodeAlonzoGenesis :: forall era t (m :: Type -> Type). MonadTransError String t m => Maybe (CardanoEra era) -> ByteString -> t m AlonzoGenesis
conwayGenesisDefaults :: ConwayGenesis StandardCrypto
class (Eq (VerificationKey keyrole), Show (VerificationKey keyrole), SerialiseAsRawBytes (Hash keyrole), HasTextEnvelope (VerificationKey keyrole), HasTextEnvelope (SigningKey keyrole)) => Key keyrole where
- data VerificationKey keyrole
- data SigningKey keyrole
- getVerificationKey :: SigningKey keyrole -> VerificationKey keyrole
- deterministicSigningKey :: AsType keyrole -> Seed -> SigningKey keyrole
- deterministicSigningKeySeedSize :: AsType keyrole -> Word
- verificationKeyHash :: VerificationKey keyrole -> Hash keyrole
data family VerificationKey keyrole
data family SigningKey keyrole
data family Hash keyrole
data family AsType t
data Address addrtype where
- ShelleyAddress :: Network -> PaymentCredential StandardCrypto -> StakeReference StandardCrypto -> Address ShelleyAddr
toShelleyAddr :: AddressInEra era -> Addr StandardCrypto
fromShelleyAddr :: ShelleyBasedEra era -> Addr StandardCrypto -> AddressInEra era
fromShelleyAddrIsSbe :: ShelleyBasedEra era -> Addr StandardCrypto -> AddressInEra era
fromShelleyAddrToAny :: Addr StandardCrypto -> AddressAny
toShelleyStakeCredential :: StakeCredential -> StakeCredential StandardCrypto
fromShelleyStakeCredential :: StakeCredential StandardCrypto -> StakeCredential
data NetworkId
- = Mainnet
- | Testnet !NetworkMagic
data PaymentCredential
- = PaymentCredentialByKey (Hash PaymentKey)
- | PaymentCredentialByScript ScriptHash
data StakeAddress where
- StakeAddress :: Network -> StakeCredential StandardCrypto -> StakeAddress
data StakeAddressReference
- = StakeAddressByValue StakeCredential
- | StakeAddressByPointer StakeAddressPointer
- | NoStakeAddress
data StakeCredential
- = StakeCredentialByKey (Hash StakeKey)
- | StakeCredentialByScript ScriptHash
toShelleyStakeAddr :: StakeAddress -> RewardAccount StandardCrypto
fromShelleyStakeAddr :: RewardAccount StandardCrypto -> StakeAddress
fromShelleyStakeReference :: StakeReference StandardCrypto -> StakeAddressReference
fromShelleyPaymentCredential :: PaymentCredential StandardCrypto -> PaymentCredential
data TxBody era where
- ShelleyTxBody :: forall era. ShelleyBasedEra era -> TxBody (ShelleyLedgerEra era) -> [Script (ShelleyLedgerEra era)] -> TxBodyScriptData era -> Maybe (TxAuxData (ShelleyLedgerEra era)) -> TxScriptValidity era -> TxBody era
newtype TxId = TxId (Hash StandardCrypto EraIndependentTxBody)
toShelleyTxId :: TxId -> TxId StandardCrypto
fromShelleyTxId :: TxId StandardCrypto -> TxId
getTxIdShelley :: (EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto, EraTxBody (ShelleyLedgerEra era)) => ShelleyBasedEra era -> TxBody (ShelleyLedgerEra era) -> TxId
data TxIn = TxIn TxId TxIx
toShelleyTxIn :: TxIn -> TxIn StandardCrypto
fromShelleyTxIn :: TxIn StandardCrypto -> TxIn
data TxOut ctx era = TxOut (AddressInEra era) (TxOutValue era) (TxOutDatum ctx era) (ReferenceScript era)
toShelleyTxOut :: (HasCallStack, ShelleyLedgerEra era ~ ledgerera) => ShelleyBasedEra era -> TxOut CtxUTxO era -> TxOut ledgerera
fromShelleyTxOut :: ShelleyBasedEra era -> TxOut (ShelleyLedgerEra era) -> TxOut ctx era
newtype TxIx = TxIx Word
toMaryValue :: Value -> MaryValue StandardCrypto
fromMaryValue :: MaryValue StandardCrypto -> Value
calcMinimumDeposit :: Value -> Lovelace -> Lovelace
signArbitraryBytesKes :: SigningKey KesKey -> Period -> ByteString -> SignedKES (KES StandardCrypto) ByteString
data Tx era where
- ShelleyTx :: forall era. ShelleyBasedEra era -> Tx (ShelleyLedgerEra era) -> Tx era
data KeyWitness era where
- ShelleyBootstrapWitness :: forall era. ShelleyBasedEra era -> BootstrapWitness StandardCrypto -> KeyWitness era
- ShelleyKeyWitness :: forall era. ShelleyBasedEra era -> WitVKey 'Witness StandardCrypto -> KeyWitness era
data ShelleyWitnessSigningKey
- = WitnessPaymentKey (SigningKey PaymentKey)
- | WitnessPaymentExtendedKey (SigningKey PaymentExtendedKey)
- | WitnessStakeKey (SigningKey StakeKey)
- | WitnessStakeExtendedKey (SigningKey StakeExtendedKey)
- | WitnessStakePoolKey (SigningKey StakePoolKey)
- | WitnessGenesisKey (SigningKey GenesisKey)
- | WitnessGenesisExtendedKey (SigningKey GenesisExtendedKey)
- | WitnessGenesisDelegateKey (SigningKey GenesisDelegateKey)
- | WitnessGenesisDelegateExtendedKey (SigningKey GenesisDelegateExtendedKey)
data ShelleySigningKey
- = ShelleyNormalSigningKey (SignKeyDSIGN StandardCrypto)
- | ShelleyExtendedSigningKey XPrv
getShelleyKeyWitnessVerificationKey :: ShelleySigningKey -> VKey 'Witness StandardCrypto
getTxBodyAndWitnesses :: Tx era -> (TxBody era, [KeyWitness era])
makeShelleySignature :: SignableRepresentation tosign => tosign -> ShelleySigningKey -> SignedDSIGN StandardCrypto tosign
toShelleySigningKey :: ShelleyWitnessSigningKey -> ShelleySigningKey
fromConsensusBlock :: CardanoBlock StandardCrypto ~ block => block -> BlockInMode
toConsensusBlock :: CardanoBlock StandardCrypto ~ block => BlockInMode -> block
fromConsensusTip :: CardanoBlock StandardCrypto ~ block => Tip block -> ChainTip
fromConsensusPointHF :: forall block (xs :: [Type]). HeaderHash block ~ OneEraHash xs => Point block -> ChainPoint
toConsensusPointHF :: forall block (xs :: [Type]). HeaderHash block ~ OneEraHash xs => ChainPoint -> Point block
toShelleyMetadata :: Map Word64 TxMetadataValue -> Map Word64 Metadatum
fromShelleyMetadata :: Map Word64 Metadatum -> Map Word64 TxMetadataValue
toShelleyMetadatum :: TxMetadataValue -> Metadatum
fromShelleyMetadatum :: Metadatum -> TxMetadataValue
newtype LedgerProtocolParameters era = LedgerProtocolParameters {
- unLedgerProtocolParameters :: PParams (ShelleyLedgerEra era)
}
data EraBasedProtocolParametersUpdate era where
- ShelleyEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams ShelleyEra -> DeprecatedAfterBabbagePParams ShelleyEra -> ShelleyToAlonzoPParams ShelleyEra -> EraBasedProtocolParametersUpdate ShelleyEra
- AllegraEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams AllegraEra -> ShelleyToAlonzoPParams AllegraEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate AllegraEra
- MaryEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams MaryEra -> ShelleyToAlonzoPParams MaryEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate MaryEra
- AlonzoEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> ShelleyToAlonzoPParams AlonzoEra -> AlonzoOnwardsPParams AlonzoEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate AlonzoEra
- BabbageEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> AlonzoOnwardsPParams BabbageEra -> DeprecatedAfterBabbagePParams ShelleyEra -> IntroducedInBabbagePParams BabbageEra -> EraBasedProtocolParametersUpdate BabbageEra
- ConwayEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> AlonzoOnwardsPParams ConwayEra -> IntroducedInBabbagePParams ConwayEra -> IntroducedInConwayPParams (ShelleyLedgerEra ConwayEra) -> EraBasedProtocolParametersUpdate ConwayEra
data CommonProtocolParametersUpdate = CommonProtocolParametersUpdate {
- cppMinFeeA :: StrictMaybe Coin
- cppMinFeeB :: StrictMaybe Coin
- cppMaxBlockBodySize :: StrictMaybe Word32
- cppMaxTxSize :: StrictMaybe Word32
- cppMaxBlockHeaderSize :: StrictMaybe Word16
- cppKeyDeposit :: StrictMaybe Coin
- cppPoolDeposit :: StrictMaybe Coin
- cppPoolRetireMaxEpoch :: StrictMaybe EpochInterval
- cppStakePoolTargetNum :: StrictMaybe Natural
- cppPoolPledgeInfluence :: StrictMaybe NonNegativeInterval
- cppTreasuryExpansion :: StrictMaybe UnitInterval
- cppMonetaryExpansion :: StrictMaybe UnitInterval
- cppMinPoolCost :: StrictMaybe Coin
}
data AlonzoOnwardsPParams ledgerera = AlonzoOnwardsPParams {
- alCostModels :: StrictMaybe CostModels
- alPrices :: StrictMaybe Prices
- alMaxTxExUnits :: StrictMaybe ExUnits
- alMaxBlockExUnits :: StrictMaybe ExUnits
- alMaxValSize :: StrictMaybe Natural
- alCollateralPercentage :: StrictMaybe Natural
- alMaxCollateralInputs :: StrictMaybe Natural
}
newtype DeprecatedAfterBabbagePParams ledgerera = DeprecatedAfterBabbagePParams (StrictMaybe ProtVer)
newtype DeprecatedAfterMaryPParams ledgerera = DeprecatedAfterMaryPParams (StrictMaybe Coin)
data ShelleyToAlonzoPParams ledgerera = ShelleyToAlonzoPParams (StrictMaybe Nonce) (StrictMaybe UnitInterval)
newtype IntroducedInBabbagePParams era = IntroducedInBabbagePParams (StrictMaybe CoinPerByte)
data IntroducedInConwayPParams era = IntroducedInConwayPParams {
- icPoolVotingThresholds :: StrictMaybe PoolVotingThresholds
- icDRepVotingThresholds :: StrictMaybe DRepVotingThresholds
- icMinCommitteeSize :: StrictMaybe Natural
- icCommitteeTermLength :: StrictMaybe EpochInterval
- icGovActionLifetime :: StrictMaybe EpochInterval
- icGovActionDeposit :: StrictMaybe Coin
- icDRepDeposit :: StrictMaybe Coin
- icDRepActivity :: StrictMaybe EpochInterval
- icMinFeeRefScriptCostPerByte :: StrictMaybe NonNegativeInterval
}
createEraBasedProtocolParamUpdate :: ShelleyBasedEra era -> EraBasedProtocolParametersUpdate era -> PParamsUpdate (ShelleyLedgerEra era)
convertToLedgerProtocolParameters :: ShelleyBasedEra era -> ProtocolParameters -> Either ProtocolParametersConversionError (LedgerProtocolParameters era)
data ProtocolParameters = ProtocolParameters {
- protocolParamProtocolVersion :: (Natural, Natural)
- protocolParamDecentralization :: Maybe Rational
- protocolParamExtraPraosEntropy :: Maybe PraosNonce
- protocolParamMaxBlockHeaderSize :: Natural
- protocolParamMaxBlockBodySize :: Natural
- protocolParamMaxTxSize :: Natural
- protocolParamTxFeeFixed :: Coin
- protocolParamTxFeePerByte :: Coin
- protocolParamMinUTxOValue :: Maybe Coin
- protocolParamStakeAddressDeposit :: Coin
- protocolParamStakePoolDeposit :: Coin
- protocolParamMinPoolCost :: Coin
- protocolParamPoolRetireMaxEpoch :: EpochInterval
- protocolParamStakePoolTargetNum :: Natural
- protocolParamPoolPledgeInfluence :: Rational
- protocolParamMonetaryExpansion :: Rational
- protocolParamTreasuryCut :: Rational
- protocolParamCostModels :: Map AnyPlutusScriptVersion CostModel
- protocolParamPrices :: Maybe ExecutionUnitPrices
- protocolParamMaxTxExUnits :: Maybe ExecutionUnits
- protocolParamMaxBlockExUnits :: Maybe ExecutionUnits
- protocolParamMaxValueSize :: Maybe Natural
- protocolParamCollateralPercent :: Maybe Natural
- protocolParamMaxCollateralInputs :: Maybe Natural
- protocolParamUTxOCostPerByte :: Maybe Coin
}
checkProtocolParameters :: ShelleyBasedEra era -> ProtocolParameters -> Either ProtocolParametersError ()
data ProtocolParametersError
- = PParamsErrorMissingMinUTxoValue !AnyCardanoEra
- | PParamsErrorMissingAlonzoProtocolParameter
fromShelleyBasedScript :: ShelleyBasedEra era -> Script (ShelleyLedgerEra era) -> ScriptInEra era
toShelleyScript :: ScriptInEra era -> Script (ShelleyLedgerEra era)
toShelleyMultiSig :: SimpleScript -> Either MultiSigError (MultiSig (ShelleyLedgerEra ShelleyEra))
fromShelleyMultiSig :: MultiSig (ShelleyLedgerEra ShelleyEra) -> SimpleScript
toAllegraTimelock :: (AllegraEraScript era, EraCrypto era ~ StandardCrypto, NativeScript era ~ Timelock era) => SimpleScript -> NativeScript era
fromAllegraTimelock :: (AllegraEraScript era, EraCrypto era ~ StandardCrypto) => NativeScript era -> SimpleScript
toShelleyScriptHash :: ScriptHash -> ScriptHash StandardCrypto
fromShelleyScriptHash :: ScriptHash StandardCrypto -> ScriptHash
data PlutusScript lang where
- PlutusScriptSerialised :: forall lang. ShortByteString -> PlutusScript lang
data PlutusScriptOrReferenceInput lang
- = PScript (PlutusScript lang)
- | PReferenceScript TxIn (Maybe ScriptHash)
data SimpleScriptOrReferenceInput lang
- = SScript SimpleScript
- | SReferenceScript TxIn (Maybe ScriptHash)
toPlutusData :: ScriptData -> Data
fromPlutusData :: Data -> ScriptData
toAlonzoData :: Era ledgerera => HashableScriptData -> Data ledgerera
fromAlonzoData :: Data ledgerera -> HashableScriptData
toAlonzoPrices :: ExecutionUnitPrices -> Either ProtocolParametersConversionError Prices
fromAlonzoPrices :: Prices -> ExecutionUnitPrices
toAlonzoExUnits :: ExecutionUnits -> ExUnits
fromAlonzoExUnits :: ExUnits -> ExecutionUnits
toScriptIndex :: AlonzoEraOnwards era -> PlutusPurpose AsIx (ShelleyLedgerEra era) -> ScriptWitnessIndex
scriptDataFromJsonDetailedSchema :: Value -> Either ScriptDataJsonSchemaError HashableScriptData
scriptDataToJsonDetailedSchema :: HashableScriptData -> Value
calculateExecutionUnitsLovelace :: Prices -> ExecutionUnits -> Maybe Coin
data ReferenceScript era where
- ReferenceScript :: forall era. BabbageEraOnwards era -> ScriptInAnyLang -> ReferenceScript era
- ReferenceScriptNone :: forall era. ReferenceScript era
refScriptToShelleyScript :: ShelleyBasedEra era -> ReferenceScript era -> StrictMaybe (Script (ShelleyLedgerEra era))
data Certificate era where
- ShelleyRelatedCertificate :: forall era. ShelleyToBabbageEra era -> ShelleyTxCert (ShelleyLedgerEra era) -> Certificate era
- ConwayCertificate :: forall era. ConwayEraOnwards era -> ConwayTxCert (ShelleyLedgerEra era) -> Certificate era
toShelleyCertificate :: Certificate era -> TxCert (ShelleyLedgerEra era)
fromShelleyCertificate :: ShelleyBasedEra era -> TxCert (ShelleyLedgerEra era) -> Certificate era
toShelleyPoolParams :: StakePoolParameters -> PoolParams StandardCrypto
data OperationalCertificate = OperationalCertificate !(OCert StandardCrypto) !(VerificationKey StakePoolKey)
data OperationalCertificateIssueCounter = OperationalCertificateIssueCounter {
- opCertIssueCount :: !Word64
- opCertIssueColdKey :: !(VerificationKey StakePoolKey)
}
data OperationalCertIssueError = OperationalCertKeyMismatch (VerificationKey StakePoolKey) (VerificationKey StakePoolKey)
data StakePoolMetadata = StakePoolMetadata !Text !Text !Text !Text
stakePoolName :: StakePoolMetadata -> Text
stakePoolDescription :: StakePoolMetadata -> Text
stakePoolTicker :: StakePoolMetadata -> Text
stakePoolHomepage :: StakePoolMetadata -> Text
data StakePoolMetadataReference = StakePoolMetadataReference Text (Hash StakePoolMetadata)
stakePoolMetadataURL :: StakePoolMetadataReference -> Text
stakePoolMetadataHash :: StakePoolMetadataReference -> Hash StakePoolMetadata
data StakePoolParameters = StakePoolParameters PoolId (Hash VrfKey) Coin Rational StakeAddress Coin [Hash StakeKey] [StakePoolRelay] (Maybe StakePoolMetadataReference)
stakePoolId :: StakePoolParameters -> PoolId
stakePoolVRF :: StakePoolParameters -> Hash VrfKey
stakePoolCost :: StakePoolParameters -> Coin
stakePoolMargin :: StakePoolParameters -> Rational
stakePoolRewardAccount :: StakePoolParameters -> StakeAddress
stakePoolPledge :: StakePoolParameters -> Coin
stakePoolOwners :: StakePoolParameters -> [Hash StakeKey]
stakePoolRelays :: StakePoolParameters -> [StakePoolRelay]
stakePoolMetadata :: StakePoolParameters -> Maybe StakePoolMetadataReference
data StakePoolRelay
- = StakePoolRelayIp (Maybe IPv4) (Maybe IPv6) (Maybe PortNumber)
- | StakePoolRelayDnsARecord ByteString (Maybe PortNumber)
- | StakePoolRelayDnsSrvRecord ByteString
newtype EpochNo = EpochNo {
- unEpochNo :: Word64
}
createAnchor :: Url -> ByteString -> Anchor StandardCrypto
createPreviousGovernanceActionId :: forall era (r :: GovActionPurpose). EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto => TxId -> Word16 -> GovPurposeId r (ShelleyLedgerEra era)
createGovernanceActionId :: TxId -> Word16 -> GovActionId StandardCrypto
newtype DRepMetadata = DRepMetadata ByteString
data DRepMetadataReference = DRepMetadataReference Text (Hash DRepMetadata)
data StakePoolKey
type PoolId = Hash StakePoolKey
data KesKey
newtype KESPeriod = KESPeriod {
- unKESPeriod :: Word
}
data VrfKey
data LocalNodeConnectInfo = LocalNodeConnectInfo ConsensusModeParams NetworkId SocketPath
data LocalNodeClientProtocols block point tip slot tx txid txerr (query :: Type -> Type) (m :: Type -> Type) = LocalNodeClientProtocols (LocalChainSyncClient block point tip m) (Maybe (LocalTxSubmissionClient tx txerr m ())) (Maybe (LocalStateQueryClient block point query m ())) (Maybe (LocalTxMonitorClient txid tx slot m ()))
type family ShelleyLedgerEra era = (ledgerera :: Type) | ledgerera -> era where ...
data LedgerEvent
- = PoolRegistration
- | PoolReRegistration
- | IncrementalRewardsDistribution EpochNo (Map StakeCredential (Set (Reward StandardCrypto)))
- | RewardsDistribution EpochNo (Map StakeCredential (Set (Reward StandardCrypto)))
- | MIRDistribution MIRDistributionDetails
- | PoolReap PoolReapDetails
- | SuccessfulPlutusScript (NonEmpty (PlutusWithContext StandardCrypto))
- | FailedPlutusScript (NonEmpty (PlutusWithContext StandardCrypto))
- | NewGovernanceProposals (TxId StandardCrypto) AnyProposals
- | EpochBoundaryRatificationState AnyRatificationState
data AnyProposals = EraPParams era => AnyProposals (Proposals era)
data AnyRatificationState = EraPParams era => AnyRatificationState (RatifyState era)
data MIRDistributionDetails = MIRDistributionDetails {
- mirddReservePayouts :: Map StakeCredential Coin
- mirddTreasuryPayouts :: Map StakeCredential Coin
- mirddReservesToTreasury :: Coin
- mirddTreasuryToReserves :: Coin
}
data PoolReapDetails = PoolReapDetails {
- prdEpochNo :: EpochNo
- prdRefunded :: Map StakeCredential (Map (Hash StakePoolKey) Coin)
- prdUnclaimed :: Map StakeCredential (Map (Hash StakePoolKey) Coin)
}
toLedgerEvent :: ConvertLedgerEvent blk => WrapLedgerEvent blk -> Maybe LedgerEvent
newtype DebugLedgerState era = DebugLedgerState {
- unDebugLedgerState :: NewEpochState (ShelleyLedgerEra era)
}
decodeDebugLedgerState :: FromCBOR (DebugLedgerState era) => SerialisedDebugLedgerState era -> Either (ByteString, DecoderError) (DebugLedgerState era)
newtype ProtocolState era = ProtocolState (Serialised (ChainDepState (ConsensusProtocol era)))
decodeProtocolState :: FromCBOR (ChainDepState (ConsensusProtocol era)) => ProtocolState era -> Either (ByteString, DecoderError) (ChainDepState (ConsensusProtocol era))
newtype SerialisedDebugLedgerState era = SerialisedDebugLedgerState (Serialised (NewEpochState (ShelleyLedgerEra era)))
newtype CurrentEpochState era = CurrentEpochState (EpochState (ShelleyLedgerEra era))
newtype SerialisedCurrentEpochState era = SerialisedCurrentEpochState (Serialised (EpochState (ShelleyLedgerEra era)))
decodeCurrentEpochState :: ShelleyBasedEra era -> SerialisedCurrentEpochState era -> Either DecoderError (CurrentEpochState era)
newtype PoolState era = PoolState (PState (ShelleyLedgerEra era))
newtype SerialisedPoolState era = SerialisedPoolState (Serialised (PState (ShelleyLedgerEra era)))
decodePoolState :: (Era (ShelleyLedgerEra era), DecCBOR (PState (ShelleyLedgerEra era))) => SerialisedPoolState era -> Either DecoderError (PoolState era)
newtype PoolDistribution era = PoolDistribution {
- unPoolDistr :: PoolDistr (EraCrypto (ShelleyLedgerEra era))
}
newtype SerialisedPoolDistribution era = SerialisedPoolDistribution (Serialised (PoolDistr (EraCrypto (ShelleyLedgerEra era))))
decodePoolDistribution :: Crypto (EraCrypto (ShelleyLedgerEra era)) => ShelleyBasedEra era -> SerialisedPoolDistribution era -> Either DecoderError (PoolDistribution era)
newtype StakeSnapshot era = StakeSnapshot (StakeSnapshots (EraCrypto (ShelleyLedgerEra era)))
newtype SerialisedStakeSnapshots era = SerialisedStakeSnapshots (Serialised (StakeSnapshots (EraCrypto (ShelleyLedgerEra era))))
decodeStakeSnapshot :: FromCBOR (StakeSnapshots (EraCrypto (ShelleyLedgerEra era))) => SerialisedStakeSnapshots era -> Either DecoderError (StakeSnapshot era)
newtype UTxO era = UTxO {
- unUTxO :: Map TxIn (TxOut CtxUTxO era)
}
data AcquiringFailure
- = AFPointTooOld
- | AFPointNotOnChain
newtype SystemStart = SystemStart {
- getSystemStart :: UTCTime
}
data GovernanceAction era
- = MotionOfNoConfidence (StrictMaybe (GovPurposeId 'CommitteePurpose (ShelleyLedgerEra era)))
- | ProposeNewConstitution (StrictMaybe (GovPurposeId 'ConstitutionPurpose (ShelleyLedgerEra era))) (Anchor StandardCrypto) (StrictMaybe (ScriptHash StandardCrypto))
- | ProposeNewCommittee (StrictMaybe (GovPurposeId 'CommitteePurpose (ShelleyLedgerEra era))) [Credential 'ColdCommitteeRole StandardCrypto] (Map (Credential 'ColdCommitteeRole StandardCrypto) EpochNo) Rational
- | InfoAct
- | TreasuryWithdrawal [(Network, StakeCredential, Coin)] !(StrictMaybe (ScriptHash StandardCrypto))
- | InitiateHardfork (StrictMaybe (GovPurposeId 'HardForkPurpose (ShelleyLedgerEra era))) ProtVer
- | UpdatePParams (StrictMaybe (GovPurposeId 'PParamUpdatePurpose (ShelleyLedgerEra era))) (PParamsUpdate (ShelleyLedgerEra era)) !(StrictMaybe (ScriptHash StandardCrypto))
newtype GovernanceActionId era = GovernanceActionId {
- unGovernanceActionId :: GovActionId (EraCrypto (ShelleyLedgerEra era))
}
newtype Proposal era = Proposal {
- unProposal :: ProposalProcedure (ShelleyLedgerEra era)
}
newtype VotingProcedure era = VotingProcedure {
- unVotingProcedure :: VotingProcedure (ShelleyLedgerEra era)
}
newtype VotingProcedures era = VotingProcedures {
- unVotingProcedures :: VotingProcedures (ShelleyLedgerEra era)
}
data GovernancePoll = GovernancePoll {
- govPollQuestion :: Text
- govPollAnswers :: [Text]
- govPollNonce :: Maybe Word
}
data GovernancePollAnswer = GovernancePollAnswer {
- govAnsPoll :: Hash GovernancePoll
- govAnsChoice :: Word
}
data GovernancePollError
- = ErrGovernancePollMismatch GovernancePollMismatchError
- | ErrGovernancePollNoAnswer
- | ErrGovernancePollUnauthenticated
- | ErrGovernancePollMalformedAnswer DecoderError
- | ErrGovernancePollInvalidAnswer GovernancePollInvalidAnswerError
data Vote
- = No
- | Yes
- | Abstain
newtype Voter era = Voter (Voter (EraCrypto (ShelleyLedgerEra era)))
createProposalProcedure :: ShelleyBasedEra era -> Network -> Coin -> StakeCredential -> GovernanceAction era -> Anchor StandardCrypto -> Proposal era
createVotingProcedure :: ConwayEraOnwards era -> Vote -> Maybe (Url, Text) -> VotingProcedure era
renderGovernancePollError :: GovernancePollError -> Text
fromProposalProcedure :: ShelleyBasedEra era -> Proposal era -> (Coin, Hash StakeKey, GovernanceAction era)
hashGovernancePoll :: GovernancePoll -> Hash GovernancePoll
verifyPollAnswer :: GovernancePoll -> InAnyShelleyBasedEra Tx -> Either GovernancePollError [Hash PaymentKey]
data LeadershipError
- = LeaderErrDecodeLedgerStateFailure
- | LeaderErrDecodeProtocolStateFailure (ByteString, DecoderError)
- | LeaderErrDecodeProtocolEpochStateFailure DecoderError
- | LeaderErrGenesisSlot
- | LeaderErrStakePoolHasNoStake PoolId
- | LeaderErrStakeDistribUnstable SlotNo SlotNo SlotNo SlotNo
- | LeaderErrSlotRangeCalculationFailure Text
- | LeaderErrCandidateNonceStillEvolving
currentEpochEligibleLeadershipSlots :: ShelleyBasedEra era -> ShelleyGenesis StandardCrypto -> EpochInfo (Either Text) -> PParams (ShelleyLedgerEra era) -> ProtocolState era -> PoolId -> SigningKey VrfKey -> SerialisedPoolDistribution era -> EpochNo -> Either LeadershipError (Set SlotNo)
evaluateTransactionExecutionUnitsShelley :: ShelleyBasedEra era -> SystemStart -> LedgerEpochInfo -> LedgerProtocolParameters era -> UTxO era -> Tx (ShelleyLedgerEra era) -> Either (TransactionValidityError era) (Map ScriptWitnessIndex (Either ScriptExecutionError (EvalTxExecutionUnitsLog, ExecutionUnits)))
nextEpochEligibleLeadershipSlots :: ShelleyBasedEra era -> ShelleyGenesis StandardCrypto -> SerialisedCurrentEpochState era -> ProtocolState era -> PoolId -> SigningKey VrfKey -> PParams (ShelleyLedgerEra era) -> EpochInfo (Either Text) -> (ChainTip, EpochNo) -> Either LeadershipError (Set SlotNo)
shelleyPayAddrToPlutusPubKHash :: Address ShelleyAddr -> Maybe PubKeyHash
toConsensusGenTx :: CardanoBlock StandardCrypto ~ block => TxInMode -> GenTx block
fromAlonzoCostModels :: CostModels -> Map AnyPlutusScriptVersion CostModel
toLedgerNonce :: Maybe PraosNonce -> Nonce
toShelleyNetwork :: NetworkId -> Network
fromShelleyPoolParams :: PoolParams StandardCrypto -> StakePoolParameters
fromLedgerPParamsUpdate :: ShelleyBasedEra era -> PParamsUpdate (ShelleyLedgerEra era) -> ProtocolParametersUpdate
emptyVotingProcedures :: VotingProcedures era
mergeVotingProcedures :: VotingProcedures era -> VotingProcedures era -> Either (VotesMergingConflict era) (VotingProcedures era)
singletonVotingProcedures :: ConwayEraOnwards era -> Voter (EraCrypto (ShelleyLedgerEra era)) -> GovActionId (EraCrypto (ShelleyLedgerEra era)) -> VotingProcedure (ShelleyLedgerEra era) -> VotingProcedures era
newtype VotesMergingConflict era = VotesMergingConflict (Voter (EraCrypto (ShelleyLedgerEra era)), [GovActionId (EraCrypto (ShelleyLedgerEra era))])

Documentation

module Cardano.Api

Genesis

data ShelleyGenesis c Source #

Shelley genesis information

Note that this is needed only for a pure Shelley network, hence it being defined here rather than in its own module. In mainnet, Shelley will transition naturally from Byron, and thus will never have its own genesis information.

Constructors

ShelleyGenesis

Fields

sgSystemStart :: !UTCTime
sgNetworkMagic :: !Word32
sgNetworkId :: !Network
sgActiveSlotsCoeff :: !PositiveUnitInterval
sgSecurityParam :: !Word64
sgEpochLength :: !EpochSize
sgSlotsPerKESPeriod :: !Word64
sgMaxKESEvolutions :: !Word64
sgSlotLength :: !NominalDiffTimeMicro
sgUpdateQuorum :: !Word64
sgMaxLovelaceSupply :: !Word64
sgProtocolParams :: !(PParams (ShelleyEra c))
sgGenDelegs :: !(Map (KeyHash 'Genesis c) (GenDelegPair c))
sgInitialFunds :: ListMap (Addr c) Coin
sgInitialFunds is intentionally kept lazy, as it can otherwise cause out-of-memory problems in testing and benchmarking.
sgStaking :: ShelleyGenesisStaking c
sgStaking is intentionally kept lazy, as it can otherwise cause out-of-memory problems in testing and benchmarking.

Instances

Instances details

Crypto c => FromJSON (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

parseJSON :: Value -> Parser (ShelleyGenesis c)

parseJSONList :: Value -> Parser [ShelleyGenesis c]

omittedField :: Maybe (ShelleyGenesis c)

Crypto c => ToJSON (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toJSON :: ShelleyGenesis c -> Value

toEncoding :: ShelleyGenesis c -> Encoding

toJSONList :: [ShelleyGenesis c] -> Value

toEncodingList :: [ShelleyGenesis c] -> Encoding

omitField :: ShelleyGenesis c -> Bool

Generic (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Associated Types

type Rep (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

from :: ShelleyGenesis c -> Rep (ShelleyGenesis c) x Source #

to :: Rep (ShelleyGenesis c) x -> ShelleyGenesis c Source #

Crypto c => Show (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

showsPrec :: Int -> ShelleyGenesis c -> ShowS Source #

show :: ShelleyGenesis c -> String Source #

showList :: [ShelleyGenesis c] -> ShowS Source #

Crypto c => FromCBOR (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

fromCBOR :: Decoder s (ShelleyGenesis c) Source #

label :: Proxy (ShelleyGenesis c) -> Text Source #

Crypto c => ToCBOR (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toCBOR :: ShelleyGenesis c -> Encoding Source #

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

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

Crypto c => DecCBOR (ShelleyGenesis c)

Genesis are always encoded with the version of era they are defined in.

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

decCBOR :: Decoder s (ShelleyGenesis c) Source #

dropCBOR :: Proxy (ShelleyGenesis c) -> Decoder s () Source #

label :: Proxy (ShelleyGenesis c) -> Text Source #

Crypto c => EncCBOR (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

encCBOR :: ShelleyGenesis c -> Encoding Source #

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

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

Crypto c => Eq (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

(==) :: ShelleyGenesis c -> ShelleyGenesis c -> Bool Source #

(/=) :: ShelleyGenesis c -> ShelleyGenesis c -> Bool Source #

Crypto c => NoThunks (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

noThunks :: Context -> ShelleyGenesis c -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> ShelleyGenesis c -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy (ShelleyGenesis c) -> String #

type Rep (ShelleyGenesis c)

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

shelleyGenesisDefaults :: ShelleyGenesis StandardCrypto #

alonzoGenesisDefaults :: CardanoEra era -> AlonzoGenesis #

decodeAlonzoGenesis :: forall era t (m :: Type -> Type). MonadTransError String t m => Maybe (CardanoEra era) -> ByteString -> t m AlonzoGenesis #

conwayGenesisDefaults :: ConwayGenesis StandardCrypto #

Cryptographic key interface

class (Eq (VerificationKey keyrole), Show (VerificationKey keyrole), SerialiseAsRawBytes (Hash keyrole), HasTextEnvelope (VerificationKey keyrole), HasTextEnvelope (SigningKey keyrole)) => Key keyrole where #

Associated Types

data VerificationKey keyrole #

data SigningKey keyrole #

Methods

getVerificationKey :: SigningKey keyrole -> VerificationKey keyrole #

deterministicSigningKey :: AsType keyrole -> Seed -> SigningKey keyrole #

deterministicSigningKeySeedSize :: AsType keyrole -> Word #

verificationKeyHash :: VerificationKey keyrole -> Hash keyrole #

Instances

Instances details

Key ByronKey

Instance details

Defined in Cardano.Api.Keys.Byron

Associated Types

newtype VerificationKey ByronKey
Instance details Defined in Cardano.Api.Keys.Byron newtype VerificationKey ByronKey = ByronVerificationKey VerificationKey
newtype SigningKey ByronKey
Instance details Defined in Cardano.Api.Keys.Byron newtype SigningKey ByronKey = ByronSigningKey SigningKey

Methods

getVerificationKey :: SigningKey ByronKey -> VerificationKey ByronKey #

deterministicSigningKey :: AsType ByronKey -> Seed -> SigningKey ByronKey #

deterministicSigningKeySeedSize :: AsType ByronKey -> Word #

verificationKeyHash :: VerificationKey ByronKey -> Hash ByronKey #

Key ByronKeyLegacy

Instance details

Defined in Cardano.Api.Keys.Byron

Associated Types

newtype VerificationKey ByronKeyLegacy
Instance details Defined in Cardano.Api.Keys.Byron newtype VerificationKey ByronKeyLegacy = ByronVerificationKeyLegacy VerificationKey
newtype SigningKey ByronKeyLegacy
Instance details Defined in Cardano.Api.Keys.Byron newtype SigningKey ByronKeyLegacy = ByronSigningKeyLegacy SigningKey

Key KesKey

Instance details

Defined in Cardano.Api.Keys.Praos

Associated Types

newtype VerificationKey KesKey
Instance details Defined in Cardano.Api.Keys.Praos newtype VerificationKey KesKey = KesVerificationKey (VerKeyKES StandardCrypto)
newtype SigningKey KesKey
Instance details Defined in Cardano.Api.Keys.Praos newtype SigningKey KesKey = KesSigningKey (SignKeyKES StandardCrypto)

Methods

getVerificationKey :: SigningKey KesKey -> VerificationKey KesKey #

deterministicSigningKey :: AsType KesKey -> Seed -> SigningKey KesKey #

deterministicSigningKeySeedSize :: AsType KesKey -> Word #

verificationKeyHash :: VerificationKey KesKey -> Hash KesKey #

Key VrfKey

Instance details

Defined in Cardano.Api.Keys.Praos

Associated Types

newtype VerificationKey VrfKey
Instance details Defined in Cardano.Api.Keys.Praos newtype VerificationKey VrfKey = VrfVerificationKey (VerKeyVRF StandardCrypto)
newtype SigningKey VrfKey
Instance details Defined in Cardano.Api.Keys.Praos newtype SigningKey VrfKey = VrfSigningKey (SignKeyVRF StandardCrypto)

Methods

getVerificationKey :: SigningKey VrfKey -> VerificationKey VrfKey #

deterministicSigningKey :: AsType VrfKey -> Seed -> SigningKey VrfKey #

deterministicSigningKeySeedSize :: AsType VrfKey -> Word #

verificationKeyHash :: VerificationKey VrfKey -> Hash VrfKey #

Key CommitteeColdExtendedKey

Instance details

data AsType AddressAny
Instance details Defined in Cardano.Api.Address data AsType AddressAny = AsAddressAny
data AsType ByronAddr
Instance details Defined in Cardano.Api.Address data AsType ByronAddr = AsByronAddr
data AsType ShelleyAddr
Instance details Defined in Cardano.Api.Address data AsType ShelleyAddr = AsShelleyAddr
data AsType StakeAddress
Instance details Defined in Cardano.Api.Address data AsType StakeAddress = AsStakeAddress
data AsType BlockHeader
Instance details Defined in Cardano.Api.Block data AsType BlockHeader = AsBlockHeader
data AsType DRepMetadata
Instance details Defined in Cardano.Api.DRepMetadata data AsType DRepMetadata = AsDRepMetadata
data AsType AllegraEra
Instance details Defined in Cardano.Api.Eras.Core data AsType AllegraEra = AsAllegraEra
data AsType AlonzoEra
Instance details Defined in Cardano.Api.Eras.Core data AsType AlonzoEra = AsAlonzoEra
data AsType BabbageEra
Instance details Defined in Cardano.Api.Eras.Core data AsType BabbageEra = AsBabbageEra
data AsType ByronEra
Instance details Defined in Cardano.Api.Eras.Core data AsType ByronEra = AsByronEra
data AsType ConwayEra
Instance details Defined in Cardano.Api.Eras.Core data AsType ConwayEra = AsConwayEra
data AsType MaryEra
Instance details Defined in Cardano.Api.Eras.Core data AsType MaryEra = AsMaryEra
data AsType ShelleyEra
Instance details Defined in Cardano.Api.Eras.Core data AsType ShelleyEra = AsShelleyEra
data AsType GovernancePoll
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePoll = AsGovernancePoll
data AsType GovernancePollAnswer
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePollAnswer = AsGovernancePollAnswer
data AsType ByronKey
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKey = AsByronKey
data AsType ByronKeyLegacy
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKeyLegacy = AsByronKeyLegacy
data AsType KesKey
Instance details Defined in Cardano.Api.Keys.Praos data AsType KesKey = AsKesKey
data AsType VrfKey
Instance details Defined in Cardano.Api.Keys.Praos data AsType VrfKey = AsVrfKey
data AsType CommitteeColdExtendedKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeColdExtendedKey = AsCommitteeColdExtendedKey
data AsType CommitteeColdKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeColdKey = AsCommitteeColdKey
data AsType CommitteeHotExtendedKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeHotExtendedKey = AsCommitteeHotExtendedKey
data AsType CommitteeHotKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeHotKey = AsCommitteeHotKey
data AsType DRepExtendedKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepExtendedKey = AsDRepExtendedKey
data AsType DRepKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepKey = AsDRepKey
data AsType GenesisDelegateExtendedKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateExtendedKey = AsGenesisDelegateExtendedKey
data AsType GenesisDelegateKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateKey = AsGenesisDelegateKey
data AsType GenesisExtendedKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisExtendedKey = AsGenesisExtendedKey
data AsType GenesisKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisKey = AsGenesisKey
data AsType GenesisUTxOKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisUTxOKey = AsGenesisUTxOKey
data AsType PaymentExtendedKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentExtendedKey = AsPaymentExtendedKey
data AsType PaymentKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentKey = AsPaymentKey
data AsType StakeExtendedKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeExtendedKey = AsStakeExtendedKey
data AsType StakeKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeKey = AsStakeKey
data AsType StakePoolKey
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakePoolKey = AsStakePoolKey
data AsType OperationalCertificate
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificate = AsOperationalCertificate
data AsType OperationalCertificateIssueCounter
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificateIssueCounter = AsOperationalCertificateIssueCounter
data AsType PraosNonce
Instance details Defined in Cardano.Api.ProtocolParameters data AsType PraosNonce = AsPraosNonce
data AsType UpdateProposal
Instance details Defined in Cardano.Api.ProtocolParameters data AsType UpdateProposal = AsUpdateProposal
data AsType PlutusScriptV1
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV1 = AsPlutusScriptV1
data AsType PlutusScriptV2
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV2 = AsPlutusScriptV2
data AsType PlutusScriptV3
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV3 = AsPlutusScriptV3
data AsType ScriptHash
Instance details Defined in Cardano.Api.Script data AsType ScriptHash = AsScriptHash
data AsType ScriptInAnyLang
Instance details Defined in Cardano.Api.Script data AsType ScriptInAnyLang = AsScriptInAnyLang
data AsType SimpleScript'
Instance details Defined in Cardano.Api.Script data AsType SimpleScript' = AsSimpleScript
data AsType HashableScriptData
Instance details Defined in Cardano.Api.ScriptData data AsType HashableScriptData = AsHashableScriptData
data AsType ScriptData
Instance details Defined in Cardano.Api.ScriptData data AsType ScriptData = AsScriptData
data AsType TextEnvelope
Instance details Defined in Cardano.Api.SerialiseTextEnvelope data AsType TextEnvelope = AsTextEnvelope
data AsType ByronUpdateProposal
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronUpdateProposal = AsByronUpdateProposal
data AsType ByronVote
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronVote = AsByronVote
data AsType StakePoolMetadata
Instance details Defined in Cardano.Api.StakePoolMetadata data AsType StakePoolMetadata = AsStakePoolMetadata
data AsType TxId
Instance details Defined in Cardano.Api.TxIn data AsType TxId = AsTxId
data AsType TxMetadata
Instance details Defined in Cardano.Api.TxMetadata data AsType TxMetadata = AsTxMetadata
data AsType AssetName
Instance details Defined in Cardano.Api.Value data AsType AssetName = AsAssetName
data AsType PolicyId
Instance details Defined in Cardano.Api.Value data AsType PolicyId = AsPolicyId
data AsType (Address addrtype)
Instance details Defined in Cardano.Api.Address data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (AddressInEra era)
Instance details Defined in Cardano.Api.Address data AsType (AddressInEra era) = AsAddressInEra (AsType era)
data AsType (Certificate era)
Instance details Defined in Cardano.Api.Certificate data AsType (Certificate era) = AsCertificate
data AsType (Proposal era)
Instance details Defined in Cardano.Api.Governance.Actions.ProposalProcedure data AsType (Proposal era) = AsProposal
data AsType (VotingProcedure era)
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedure era) = AsVote
data AsType (VotingProcedures era)
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedures era) = AsVotingProcedures
data AsType (Hash a)
Instance details Defined in Cardano.Api.Hash data AsType (Hash a) = AsHash (AsType a)
data AsType (SigningKey a)
Instance details Defined in Cardano.Api.Keys.Class data AsType (SigningKey a) = AsSigningKey (AsType a)
data AsType (VerificationKey a)
Instance details Defined in Cardano.Api.Keys.Class data AsType (VerificationKey a) = AsVerificationKey (AsType a)
data AsType (PlutusScript lang)
Instance details Defined in Cardano.Api.Script data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)
data AsType (Script lang)
Instance details Defined in Cardano.Api.Script data AsType (Script lang) = AsScript (AsType lang)
data AsType (ScriptInEra era)
Instance details Defined in Cardano.Api.Script data AsType (ScriptInEra era) = AsScriptInEra (AsType era)
data AsType (KeyWitness era)
Instance details Defined in Cardano.Api.Tx.Sign data AsType (KeyWitness era) = AsKeyWitness (AsType era)
data AsType (Tx era)
Instance details Defined in Cardano.Api.Tx.Sign data AsType (Tx era) = AsTx (AsType era)
data AsType (TxBody era)
Instance details Defined in Cardano.Api.Tx.Sign data AsType (TxBody era) = AsTxBody (AsType era)

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

PaymentCredentialByKey (Hash PaymentKey)
PaymentCredentialByScript ScriptHash

Show PaymentCredential
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> PaymentCredential -> ShowS Source # show :: PaymentCredential -> String Source # showList :: [PaymentCredential] -> ShowS Source #
Eq PaymentCredential
Instance details Defined in Cardano.Api.Address Methods (==) :: PaymentCredential -> PaymentCredential -> Bool Source # (/=) :: PaymentCredential -> PaymentCredential -> Bool Source #
Ord PaymentCredential
Instance details Defined in Cardano.Api.Address Methods compare :: PaymentCredential -> PaymentCredential -> Ordering Source # (<) :: PaymentCredential -> PaymentCredential -> Bool Source # (<=) :: PaymentCredential -> PaymentCredential -> Bool Source # (>) :: PaymentCredential -> PaymentCredential -> Bool Source # (>=) :: PaymentCredential -> PaymentCredential -> Bool Source # max :: PaymentCredential -> PaymentCredential -> PaymentCredential Source # min :: PaymentCredential -> PaymentCredential -> PaymentCredential Source #

StakeAddressByValue StakeCredential
StakeAddressByPointer StakeAddressPointer
NoStakeAddress

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

StakeCredentialByKey (Hash StakeKey)
StakeCredentialByScript ScriptHash

ToJSON StakeCredential
Instance details Defined in Cardano.Api.Address Methods toJSON :: StakeCredential -> Value toEncoding :: StakeCredential -> Encoding toJSONList :: [StakeCredential] -> Value toEncodingList :: [StakeCredential] -> Encoding omitField :: StakeCredential -> Bool
Show StakeCredential
Instance details Defined in Cardano.Api.Address Methods showsPrec :: Int -> StakeCredential -> ShowS Source # show :: StakeCredential -> String Source # showList :: [StakeCredential] -> ShowS Source #
Eq StakeCredential
Instance details Defined in Cardano.Api.Address Methods (==) :: StakeCredential -> StakeCredential -> Bool Source # (/=) :: StakeCredential -> StakeCredential -> Bool Source #
Ord StakeCredential
Instance details Defined in Cardano.Api.Address Methods compare :: StakeCredential -> StakeCredential -> Ordering Source # (<) :: StakeCredential -> StakeCredential -> Bool Source # (<=) :: StakeCredential -> StakeCredential -> Bool Source # (>) :: StakeCredential -> StakeCredential -> Bool Source # (>=) :: StakeCredential -> StakeCredential -> Bool Source # max :: StakeCredential -> StakeCredential -> StakeCredential Source # min :: StakeCredential -> StakeCredential -> StakeCredential Source #

FromJSON TxIn
Instance details Defined in Cardano.Api.TxIn Methods parseJSON :: Value -> Parser TxIn parseJSONList :: Value -> Parser [TxIn] omittedField :: Maybe TxIn
FromJSONKey TxIn
Instance details Defined in Cardano.Api.TxIn Methods fromJSONKey :: FromJSONKeyFunction TxIn fromJSONKeyList :: FromJSONKeyFunction [TxIn]
ToJSON TxIn
Instance details Defined in Cardano.Api.TxIn Methods toJSON :: TxIn -> Value toEncoding :: TxIn -> Encoding toJSONList :: [TxIn] -> Value toEncodingList :: [TxIn] -> Encoding omitField :: TxIn -> Bool
ToJSONKey TxIn
Instance details Defined in Cardano.Api.TxIn Methods toJSONKey :: ToJSONKeyFunction TxIn toJSONKeyList :: ToJSONKeyFunction [TxIn]
Show TxIn
Instance details Defined in Cardano.Api.TxIn Methods showsPrec :: Int -> TxIn -> ShowS Source # show :: TxIn -> String Source # showList :: [TxIn] -> ShowS Source #
Eq TxIn
Instance details Defined in Cardano.Api.TxIn Methods (==) :: TxIn -> TxIn -> Bool Source # (/=) :: TxIn -> TxIn -> Bool Source #
Ord TxIn
Instance details Defined in Cardano.Api.TxIn Methods compare :: TxIn -> TxIn -> Ordering Source # (<) :: TxIn -> TxIn -> Bool Source # (<=) :: TxIn -> TxIn -> Bool Source # (>) :: TxIn -> TxIn -> Bool Source # (>=) :: TxIn -> TxIn -> Bool Source # max :: TxIn -> TxIn -> TxIn Source # min :: TxIn -> TxIn -> TxIn Source #
Pretty TxIn
Instance details Defined in Cardano.Api.TxIn Methods pretty :: TxIn -> Doc ann # prettyList :: [TxIn] -> Doc ann #

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

FromJSON TxIx
Instance details Defined in Cardano.Api.TxIn Methods parseJSON :: Value -> Parser TxIx parseJSONList :: Value -> Parser [TxIx] omittedField :: Maybe TxIx
ToJSON TxIx
Instance details Defined in Cardano.Api.TxIn Methods toJSON :: TxIx -> Value toEncoding :: TxIx -> Encoding toJSONList :: [TxIx] -> Value toEncodingList :: [TxIx] -> Encoding omitField :: TxIx -> Bool
Enum TxIx
Instance details Defined in Cardano.Api.TxIn Methods succ :: TxIx -> TxIx Source # pred :: TxIx -> TxIx Source # toEnum :: Int -> TxIx Source # fromEnum :: TxIx -> Int Source # enumFrom :: TxIx -> [TxIx] Source # enumFromThen :: TxIx -> TxIx -> [TxIx] Source # enumFromTo :: TxIx -> TxIx -> [TxIx] Source # enumFromThenTo :: TxIx -> TxIx -> TxIx -> [TxIx] Source #
Show TxIx
Instance details Defined in Cardano.Api.TxIn Methods showsPrec :: Int -> TxIx -> ShowS Source # show :: TxIx -> String Source # showList :: [TxIx] -> ShowS Source #
Eq TxIx
Instance details Defined in Cardano.Api.TxIn Methods (==) :: TxIx -> TxIx -> Bool Source # (/=) :: TxIx -> TxIx -> Bool Source #
Ord TxIx
Instance details Defined in Cardano.Api.TxIn Methods compare :: TxIx -> TxIx -> Ordering Source # (<) :: TxIx -> TxIx -> Bool Source # (<=) :: TxIx -> TxIx -> Bool Source # (>) :: TxIx -> TxIx -> Bool Source # (>=) :: TxIx -> TxIx -> Bool Source # max :: TxIx -> TxIx -> TxIx Source # min :: TxIx -> TxIx -> TxIx Source #

ShelleyBootstrapWitness :: forall era. ShelleyBasedEra era -> BootstrapWitness StandardCrypto -> KeyWitness era
ShelleyKeyWitness :: forall era. ShelleyBasedEra era -> WitVKey 'Witness StandardCrypto -> KeyWitness era

WitnessPaymentKey (SigningKey PaymentKey)
WitnessPaymentExtendedKey (SigningKey PaymentExtendedKey)
WitnessStakeKey (SigningKey StakeKey)
WitnessStakeExtendedKey (SigningKey StakeExtendedKey)
WitnessStakePoolKey (SigningKey StakePoolKey)
WitnessGenesisKey (SigningKey GenesisKey)
WitnessGenesisExtendedKey (SigningKey GenesisExtendedKey)
WitnessGenesisDelegateKey (SigningKey GenesisDelegateKey)
WitnessGenesisDelegateExtendedKey (SigningKey GenesisDelegateExtendedKey)

ShelleyNormalSigningKey (SignKeyDSIGN StandardCrypto)
ShelleyExtendedSigningKey XPrv

LedgerProtocolParameters
Fields unLedgerProtocolParameters :: PParams (ShelleyLedgerEra era)

IsShelleyBasedEra era => Show (LedgerProtocolParameters era)
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> LedgerProtocolParameters era -> ShowS Source # show :: LedgerProtocolParameters era -> String Source # showList :: [LedgerProtocolParameters era] -> ShowS Source #
IsShelleyBasedEra era => Eq (LedgerProtocolParameters era)
Instance details Defined in Cardano.Api.ProtocolParameters Methods (==) :: LedgerProtocolParameters era -> LedgerProtocolParameters era -> Bool Source # (/=) :: LedgerProtocolParameters era -> LedgerProtocolParameters era -> Bool Source #

ShelleyEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams ShelleyEra -> DeprecatedAfterBabbagePParams ShelleyEra -> ShelleyToAlonzoPParams ShelleyEra -> EraBasedProtocolParametersUpdate ShelleyEra
AllegraEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams AllegraEra -> ShelleyToAlonzoPParams AllegraEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate AllegraEra
MaryEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> DeprecatedAfterMaryPParams MaryEra -> ShelleyToAlonzoPParams MaryEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate MaryEra
AlonzoEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> ShelleyToAlonzoPParams AlonzoEra -> AlonzoOnwardsPParams AlonzoEra -> DeprecatedAfterBabbagePParams ShelleyEra -> EraBasedProtocolParametersUpdate AlonzoEra
BabbageEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> AlonzoOnwardsPParams BabbageEra -> DeprecatedAfterBabbagePParams ShelleyEra -> IntroducedInBabbagePParams BabbageEra -> EraBasedProtocolParametersUpdate BabbageEra
ConwayEraBasedProtocolParametersUpdate :: CommonProtocolParametersUpdate -> AlonzoOnwardsPParams ConwayEra -> IntroducedInBabbagePParams ConwayEra -> IntroducedInConwayPParams (ShelleyLedgerEra ConwayEra) -> EraBasedProtocolParametersUpdate ConwayEra

Show (EraBasedProtocolParametersUpdate era)
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> EraBasedProtocolParametersUpdate era -> ShowS Source # show :: EraBasedProtocolParametersUpdate era -> String Source # showList :: [EraBasedProtocolParametersUpdate era] -> ShowS Source #

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

AlonzoOnwardsPParams
Fields alCostModels :: StrictMaybe CostModels alPrices :: StrictMaybe Prices alMaxTxExUnits :: StrictMaybe ExUnits alMaxBlockExUnits :: StrictMaybe ExUnits alMaxValSize :: StrictMaybe Natural alCollateralPercentage :: StrictMaybe Natural alMaxCollateralInputs :: StrictMaybe Natural

Documentation

Genesis

Instances

Cryptographic key interface

Instances

Instances

Instances

Hashes

Instances

Type Proxies

Instances

Payment addresses

Instances

Instances

Stake addresses

Instances

Instances

Instances

Instances

Building transactions

Instances

Instances

Instances

Instances

Instances

Arbitrary signing

Signing transactions

Instances

Incremental signing and separate witnesses

Instances

Blocks

Transaction metadata

Protocol parameters

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Scripts

Instances

Instances

Instances

Reference Scripts

Instances

Certificates

Instances

Operational certificates

Instances

Instances

Instances

Stake Pool

Instances

Instances

Instances

Instances

Instances

Governance Actions

DRep

Instances

Instances

Stake pool operator's keys

Instances

KES keys

Instances

Instances

VRF keys

Instances

Low level protocol interaction with a Cardano node

Shelley based eras

Ledger Events

Instances

Instances

Instances

Instances

Show (AlonzoOnwardsPParams ledgerera)
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> AlonzoOnwardsPParams ledgerera -> ShowS Source # show :: AlonzoOnwardsPParams ledgerera -> String Source # showList :: [AlonzoOnwardsPParams ledgerera] -> ShowS Source #

Show (DeprecatedAfterBabbagePParams ledgerera)
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> DeprecatedAfterBabbagePParams ledgerera -> ShowS Source # show :: DeprecatedAfterBabbagePParams ledgerera -> String Source # showList :: [DeprecatedAfterBabbagePParams ledgerera] -> ShowS Source #

Show (DeprecatedAfterMaryPParams ledgerera)
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> DeprecatedAfterMaryPParams ledgerera -> ShowS Source # show :: DeprecatedAfterMaryPParams ledgerera -> String Source # showList :: [DeprecatedAfterMaryPParams ledgerera] -> ShowS Source #

Show (ShelleyToAlonzoPParams ledgerera)
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> ShelleyToAlonzoPParams ledgerera -> ShowS Source # show :: ShelleyToAlonzoPParams ledgerera -> String Source # showList :: [ShelleyToAlonzoPParams ledgerera] -> ShowS Source #

Show (IntroducedInBabbagePParams era)
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> IntroducedInBabbagePParams era -> ShowS Source # show :: IntroducedInBabbagePParams era -> String Source # showList :: [IntroducedInBabbagePParams era] -> ShowS Source #

Show (IntroducedInConwayPParams era)
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> IntroducedInConwayPParams era -> ShowS Source # show :: IntroducedInConwayPParams era -> String Source # showList :: [IntroducedInConwayPParams era] -> ShowS Source #

PParamsErrorMissingMinUTxoValue !AnyCardanoEra
PParamsErrorMissingAlonzoProtocolParameter

Show ProtocolParametersError
Instance details Defined in Cardano.Api.ProtocolParameters Methods showsPrec :: Int -> ProtocolParametersError -> ShowS Source # show :: ProtocolParametersError -> String Source # showList :: [ProtocolParametersError] -> ShowS Source #
Error ProtocolParametersError
Instance details Defined in Cardano.Api.ProtocolParameters Methods prettyError :: ProtocolParametersError -> Doc ann #

PScript (PlutusScript lang)
PReferenceScript TxIn (Maybe ScriptHash)

Show (PlutusScriptOrReferenceInput lang)
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> PlutusScriptOrReferenceInput lang -> ShowS Source # show :: PlutusScriptOrReferenceInput lang -> String Source # showList :: [PlutusScriptOrReferenceInput lang] -> ShowS Source #
Eq (PlutusScriptOrReferenceInput lang)
Instance details Defined in Cardano.Api.Script Methods (==) :: PlutusScriptOrReferenceInput lang -> PlutusScriptOrReferenceInput lang -> Bool Source # (/=) :: PlutusScriptOrReferenceInput lang -> PlutusScriptOrReferenceInput lang -> Bool Source #