| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Cardano.Api
Contents
- Eras
- Type tags
- Cryptographic key interface
- Payment addresses
- Stake addresses
- Currency values
- Blocks
- Building transactions
- Building transactions
- Transaction bodies
- Transaction Ids
- Transaction inputs
- Transaction outputs
- Other transaction body types
- Building vs viewing transactions
- Era-dependent transaction body features
- Feature availability functions
- Fee calculation
- Minimum required UTxO calculation
- Script execution units
- Transaction balance
- Building transactions with automated fees and balancing
- Signing transactions
- Transaction metadata
- Certificates
- Stake pool off-chain metadata
- Scripts
- Serialisation
- Errors
- Node interaction
- Node operation
- Genesis file
- Special transactions
- Protocol parameter updates
- Protocol parameters
- Node socket related
- Convenience functions
Description
This module provides a library interface for interacting with Cardano as a user of the system.
It is intended to be the complete API covering everything but without exposing constructors that reveal any lower level types.
In the interest of simplicity it glosses over some details of the system. Most simple tools should be able to work just using this interface, however you can go deeper and expose the types from the underlying libraries using Cardano.Api.Byron or Cardano.Api.Shelley.
Synopsis
- data ByronEra
- data ShelleyEra
- data AllegraEra
- data MaryEra
- data AlonzoEra
- data BabbageEra
- data ConwayEra
- data CardanoEra era where
- class HasTypeProxy era ⇒ IsCardanoEra era where
- cardanoEra ∷ CardanoEra era
- data AnyCardanoEra where
- AnyCardanoEra ∷ IsCardanoEra era ⇒ CardanoEra era → AnyCardanoEra
- anyCardanoEra ∷ CardanoEra era → AnyCardanoEra
- data InAnyCardanoEra thing where
- InAnyCardanoEra ∷ IsCardanoEra era ⇒ CardanoEra era → thing era → InAnyCardanoEra thing
- data ShelleyBasedEra era where
- class IsCardanoEra era ⇒ IsShelleyBasedEra era where
- data InAnyShelleyBasedEra thing where
- InAnyShelleyBasedEra ∷ IsShelleyBasedEra era ⇒ ShelleyBasedEra era → thing era → InAnyShelleyBasedEra thing
- data CardanoEraStyle era where
- LegacyByronEra ∷ CardanoEraStyle ByronEra
- ShelleyBasedEra ∷ IsShelleyBasedEra era ⇒ ShelleyBasedEra era → CardanoEraStyle era
- cardanoEraStyle ∷ CardanoEra era → CardanoEraStyle era
- shelleyBasedToCardanoEra ∷ ShelleyBasedEra era → CardanoEra era
- type Byron = ByronEra
- type Shelley = ShelleyEra
- type Allegra = AllegraEra
- type Mary = MaryEra
- class HasTypeProxy t where
- data AsType t
- proxyToAsType ∷ Proxy t → AsType t
- class (Eq (VerificationKey keyrole), Show (VerificationKey keyrole), SerialiseAsRawBytes (Hash keyrole), HasTextEnvelope (VerificationKey keyrole), HasTextEnvelope (SigningKey keyrole)) ⇒ Key keyrole where
- data VerificationKey keyrole ∷ Type
- data SigningKey keyrole ∷ Type
- getVerificationKey ∷ SigningKey keyrole → VerificationKey keyrole
- deterministicSigningKey ∷ AsType keyrole → Seed → SigningKey keyrole
- deterministicSigningKeySeedSize ∷ AsType keyrole → Word
- verificationKeyHash ∷ VerificationKey keyrole → Hash keyrole
- castVerificationKey ∷ CastVerificationKeyRole keyroleA keyroleB ⇒ VerificationKey keyroleA → VerificationKey keyroleB
- castSigningKey ∷ CastSigningKeyRole keyroleA keyroleB ⇒ SigningKey keyroleA → SigningKey keyroleB
- generateSigningKey ∷ Key keyrole ⇒ AsType keyrole → IO (SigningKey keyrole)
- generateInsecureSigningKey ∷ (Key keyrole, SerialiseAsRawBytes (SigningKey keyrole)) ⇒ StdGen → AsType keyrole → IO (SigningKey keyrole, StdGen)
- data family Hash keyrole ∷ Type
- castHash ∷ CastHash roleA roleB ⇒ Hash roleA → Hash roleB
- data Address addrtype
- data ByronAddr
- data ShelleyAddr
- data NetworkId
- makeByronAddress ∷ NetworkId → VerificationKey ByronKey → Address ByronAddr
- data ByronKey
- data ByronKeyLegacy
- makeShelleyAddress ∷ NetworkId → PaymentCredential → StakeAddressReference → Address ShelleyAddr
- data PaymentCredential
- newtype StakeAddressPointer = StakeAddressPointer {
- unStakeAddressPointer ∷ Ptr
- data StakeAddressReference
- data PaymentKey
- data PaymentExtendedKey
- data AddressAny
- lexPlausibleAddressString ∷ Parser Text
- parseAddressAny ∷ Parser AddressAny
- data AddressInEra era where
- AddressInEra ∷ AddressTypeInEra addrtype era → Address addrtype → AddressInEra era
- isKeyAddress ∷ AddressInEra era → Bool
- data AddressTypeInEra addrtype era where
- byronAddressInEra ∷ Address ByronAddr → AddressInEra era
- shelleyAddressInEra ∷ IsShelleyBasedEra era ⇒ Address ShelleyAddr → AddressInEra era
- anyAddressInShelleyBasedEra ∷ IsShelleyBasedEra era ⇒ AddressAny → AddressInEra era
- anyAddressInEra ∷ CardanoEra era → AddressAny → Either String (AddressInEra era)
- toAddressAny ∷ Address addr → AddressAny
- makeByronAddressInEra ∷ NetworkId → VerificationKey ByronKey → AddressInEra era
- makeShelleyAddressInEra ∷ IsShelleyBasedEra era ⇒ NetworkId → PaymentCredential → StakeAddressReference → AddressInEra era
- data StakeAddress
- data StakeCredential
- makeStakeAddress ∷ NetworkId → StakeCredential → StakeAddress
- stakeAddressCredential ∷ StakeAddress → StakeCredential
- data StakeKey
- data StakeExtendedKey
- newtype Lovelace = Lovelace Integer
- newtype Quantity = Quantity Integer
- newtype PolicyId = PolicyId {}
- scriptPolicyId ∷ Script lang → PolicyId
- newtype AssetName = AssetName ByteString
- data AssetId
- data Value
- parseValue ∷ Parser Value
- policyId ∷ Parser PolicyId
- selectAsset ∷ Value → AssetId → Quantity
- valueFromList ∷ [(AssetId, Quantity)] → Value
- valueToList ∷ Value → [(AssetId, Quantity)]
- filterValue ∷ (AssetId → Bool) → Value → Value
- negateValue ∷ Value → Value
- newtype ValueNestedRep = ValueNestedRep [ValueNestedBundle]
- data ValueNestedBundle
- valueToNestedRep ∷ Value → ValueNestedRep
- valueFromNestedRep ∷ ValueNestedRep → Value
- renderValue ∷ Value → Text
- renderValuePretty ∷ Value → Text
- quantityToLovelace ∷ Quantity → Lovelace
- lovelaceToQuantity ∷ Lovelace → Quantity
- selectLovelace ∷ Value → Lovelace
- lovelaceToValue ∷ Lovelace → Value
- valueToLovelace ∷ Value → Maybe Lovelace
- data Block era where
- pattern Block ∷ BlockHeader → [Tx era] → Block era
- data BlockHeader = BlockHeader !SlotNo !(Hash BlockHeader) !BlockNo
- getBlockHeader ∷ ∀ era. Block era → BlockHeader
- data ChainPoint
- newtype EpochNo = EpochNo {}
- data ChainTip
- newtype BlockNo = BlockNo {}
- chainTipToChainPoint ∷ ChainTip → ChainPoint
- data TxBody era where
- pattern TxBody ∷ TxBodyContent ViewTx era → TxBody era
- createAndValidateTransactionBody ∷ ∀ era. IsCardanoEra era ⇒ TxBodyContent BuildTx era → Either TxBodyError (TxBody era)
- makeTransactionBody ∷ ∀ era. IsCardanoEra era ⇒ TxBodyContent BuildTx era → Either TxBodyError (TxBody era)
- data TxBodyContent build era = TxBodyContent {
- txIns ∷ TxIns build era
- txInsCollateral ∷ TxInsCollateral era
- txInsReference ∷ TxInsReference build era
- txOuts ∷ [TxOut CtxTx era]
- txTotalCollateral ∷ TxTotalCollateral era
- txReturnCollateral ∷ TxReturnCollateral CtxTx era
- txFee ∷ TxFee era
- txValidityRange ∷ (TxValidityLowerBound era, TxValidityUpperBound era)
- txMetadata ∷ TxMetadataInEra era
- txAuxScripts ∷ TxAuxScripts era
- txExtraKeyWits ∷ TxExtraKeyWitnesses era
- txProtocolParams ∷ BuildTxWith build (Maybe ProtocolParameters)
- txWithdrawals ∷ TxWithdrawals build era
- txCertificates ∷ TxCertificates build era
- txUpdateProposal ∷ TxUpdateProposal era
- txMintValue ∷ TxMintValue build era
- txScriptValidity ∷ TxScriptValidity era
- data TxBodyError
- data TxBodyScriptData era where
- TxBodyNoScriptData ∷ TxBodyScriptData era
- TxBodyScriptData ∷ ScriptDataSupportedInEra era → TxDats (ShelleyLedgerEra era) → Redeemers (ShelleyLedgerEra era) → TxBodyScriptData era
- newtype TxId = TxId (Hash StandardCrypto EraIndependentTxBody)
- getTxId ∷ ∀ era. TxBody era → TxId
- data TxIn = TxIn TxId TxIx
- type TxIns build era = [(TxIn, BuildTxWith build (Witness WitCtxTxIn era))]
- newtype TxIx = TxIx Word
- renderTxIn ∷ TxIn → Text
- data CtxTx
- data CtxUTxO
- data TxOut ctx era = TxOut (AddressInEra era) (TxOutValue era) (TxOutDatum ctx era) (ReferenceScript era)
- data TxOutValue era where
- TxOutAdaOnly ∷ OnlyAdaSupportedInEra era → Lovelace → TxOutValue era
- TxOutValue ∷ MultiAssetSupportedInEra era → Value → TxOutValue era
- txOutValueToLovelace ∷ TxOutValue era → Lovelace
- txOutValueToValue ∷ TxOutValue era → Value
- lovelaceToTxOutValue ∷ IsCardanoEra era ⇒ Lovelace → TxOutValue era
- data TxOutDatum ctx era where
- TxOutDatumNone ∷ TxOutDatum ctx era
- TxOutDatumHash ∷ ScriptDataSupportedInEra era → Hash ScriptData → TxOutDatum ctx era
- TxOutDatumInline ∷ ReferenceTxInsScriptsInlineDatumsSupportedInEra era → HashableScriptData → TxOutDatum ctx era
- pattern TxOutDatumInTx ∷ ScriptDataSupportedInEra era → HashableScriptData → TxOutDatum CtxTx era
- parseHash ∷ SerialiseAsRawBytes (Hash a) ⇒ AsType (Hash a) → Parser (Hash a)
- data TxInsCollateral era where
- TxInsCollateralNone ∷ TxInsCollateral era
- TxInsCollateral ∷ CollateralSupportedInEra era → [TxIn] → TxInsCollateral era
- data TxInsReference build era where
- TxInsReferenceNone ∷ TxInsReference build era
- TxInsReference ∷ ReferenceTxInsScriptsInlineDatumsSupportedInEra era → [TxIn] → TxInsReference build era
- data TxTotalCollateral era where
- data TxReturnCollateral ctx era where
- TxReturnCollateralNone ∷ TxReturnCollateral ctx era
- TxReturnCollateral ∷ TxTotalAndReturnCollateralSupportedInEra era → TxOut ctx era → TxReturnCollateral ctx era
- data TxFee era where
- TxFeeImplicit ∷ TxFeesImplicitInEra era → TxFee era
- TxFeeExplicit ∷ TxFeesExplicitInEra era → Lovelace → TxFee era
- data TxValidityLowerBound era where
- data TxValidityUpperBound era where
- newtype SlotNo = SlotNo {}
- newtype EpochSlots = EpochSlots {}
- data TxMetadataInEra era where
- TxMetadataNone ∷ TxMetadataInEra era
- TxMetadataInEra ∷ TxMetadataSupportedInEra era → TxMetadata → TxMetadataInEra era
- data TxAuxScripts era where
- TxAuxScriptsNone ∷ TxAuxScripts era
- TxAuxScripts ∷ AuxScriptsSupportedInEra era → [ScriptInEra era] → TxAuxScripts era
- data TxExtraKeyWitnesses era where
- data TxWithdrawals build era where
- TxWithdrawalsNone ∷ TxWithdrawals build era
- TxWithdrawals ∷ WithdrawalsSupportedInEra era → [(StakeAddress, Lovelace, BuildTxWith build (Witness WitCtxStake era))] → TxWithdrawals build era
- data TxCertificates build era where
- TxCertificatesNone ∷ TxCertificates build era
- TxCertificates ∷ CertificatesSupportedInEra era → [Certificate] → BuildTxWith build (Map StakeCredential (Witness WitCtxStake era)) → TxCertificates build era
- data TxUpdateProposal era where
- data TxMintValue build era where
- TxMintNone ∷ TxMintValue build era
- TxMintValue ∷ MultiAssetSupportedInEra era → Value → BuildTxWith build (Map PolicyId (ScriptWitness WitCtxMint era)) → TxMintValue build era
- data BuildTxWith build a where
- ViewTx ∷ BuildTxWith ViewTx a
- BuildTxWith ∷ a → BuildTxWith BuildTx a
- data BuildTx
- data ViewTx
- data CollateralSupportedInEra era where
- data MultiAssetSupportedInEra era where
- data OnlyAdaSupportedInEra era where
- data TxFeesExplicitInEra era where
- TxFeesExplicitInShelleyEra ∷ TxFeesExplicitInEra ShelleyEra
- TxFeesExplicitInAllegraEra ∷ TxFeesExplicitInEra AllegraEra
- TxFeesExplicitInMaryEra ∷ TxFeesExplicitInEra MaryEra
- TxFeesExplicitInAlonzoEra ∷ TxFeesExplicitInEra AlonzoEra
- TxFeesExplicitInBabbageEra ∷ TxFeesExplicitInEra BabbageEra
- TxFeesExplicitInConwayEra ∷ TxFeesExplicitInEra ConwayEra
- data TxFeesImplicitInEra era where
- data ValidityUpperBoundSupportedInEra era where
- ValidityUpperBoundInShelleyEra ∷ ValidityUpperBoundSupportedInEra ShelleyEra
- ValidityUpperBoundInAllegraEra ∷ ValidityUpperBoundSupportedInEra AllegraEra
- ValidityUpperBoundInMaryEra ∷ ValidityUpperBoundSupportedInEra MaryEra
- ValidityUpperBoundInAlonzoEra ∷ ValidityUpperBoundSupportedInEra AlonzoEra
- ValidityUpperBoundInBabbageEra ∷ ValidityUpperBoundSupportedInEra BabbageEra
- ValidityUpperBoundInConwayEra ∷ ValidityUpperBoundSupportedInEra ConwayEra
- data ValidityNoUpperBoundSupportedInEra era where
- ValidityNoUpperBoundInByronEra ∷ ValidityNoUpperBoundSupportedInEra ByronEra
- ValidityNoUpperBoundInAllegraEra ∷ ValidityNoUpperBoundSupportedInEra AllegraEra
- ValidityNoUpperBoundInMaryEra ∷ ValidityNoUpperBoundSupportedInEra MaryEra
- ValidityNoUpperBoundInAlonzoEra ∷ ValidityNoUpperBoundSupportedInEra AlonzoEra
- ValidityNoUpperBoundInBabbageEra ∷ ValidityNoUpperBoundSupportedInEra BabbageEra
- ValidityNoUpperBoundInConwayEra ∷ ValidityNoUpperBoundSupportedInEra ConwayEra
- data ValidityLowerBoundSupportedInEra era where
- ValidityLowerBoundInAllegraEra ∷ ValidityLowerBoundSupportedInEra AllegraEra
- ValidityLowerBoundInMaryEra ∷ ValidityLowerBoundSupportedInEra MaryEra
- ValidityLowerBoundInAlonzoEra ∷ ValidityLowerBoundSupportedInEra AlonzoEra
- ValidityLowerBoundInBabbageEra ∷ ValidityLowerBoundSupportedInEra BabbageEra
- ValidityLowerBoundInConwayEra ∷ ValidityLowerBoundSupportedInEra ConwayEra
- data TxMetadataSupportedInEra era where
- TxMetadataInShelleyEra ∷ TxMetadataSupportedInEra ShelleyEra
- TxMetadataInAllegraEra ∷ TxMetadataSupportedInEra AllegraEra
- TxMetadataInMaryEra ∷ TxMetadataSupportedInEra MaryEra
- TxMetadataInAlonzoEra ∷ TxMetadataSupportedInEra AlonzoEra
- TxMetadataInBabbageEra ∷ TxMetadataSupportedInEra BabbageEra
- TxMetadataInConwayEra ∷ TxMetadataSupportedInEra ConwayEra
- data AuxScriptsSupportedInEra era where
- data TxExtraKeyWitnessesSupportedInEra era where
- data ScriptDataSupportedInEra era where
- data WithdrawalsSupportedInEra era where
- WithdrawalsInShelleyEra ∷ WithdrawalsSupportedInEra ShelleyEra
- WithdrawalsInAllegraEra ∷ WithdrawalsSupportedInEra AllegraEra
- WithdrawalsInMaryEra ∷ WithdrawalsSupportedInEra MaryEra
- WithdrawalsInAlonzoEra ∷ WithdrawalsSupportedInEra AlonzoEra
- WithdrawalsInBabbageEra ∷ WithdrawalsSupportedInEra BabbageEra
- WithdrawalsInConwayEra ∷ WithdrawalsSupportedInEra ConwayEra
- data CertificatesSupportedInEra era where
- CertificatesInShelleyEra ∷ CertificatesSupportedInEra ShelleyEra
- CertificatesInAllegraEra ∷ CertificatesSupportedInEra AllegraEra
- CertificatesInMaryEra ∷ CertificatesSupportedInEra MaryEra
- CertificatesInAlonzoEra ∷ CertificatesSupportedInEra AlonzoEra
- CertificatesInBabbageEra ∷ CertificatesSupportedInEra BabbageEra
- CertificatesInConwayEra ∷ CertificatesSupportedInEra ConwayEra
- data UpdateProposalSupportedInEra era where
- UpdateProposalInShelleyEra ∷ UpdateProposalSupportedInEra ShelleyEra
- UpdateProposalInAllegraEra ∷ UpdateProposalSupportedInEra AllegraEra
- UpdateProposalInMaryEra ∷ UpdateProposalSupportedInEra MaryEra
- UpdateProposalInAlonzoEra ∷ UpdateProposalSupportedInEra AlonzoEra
- UpdateProposalInBabbageEra ∷ UpdateProposalSupportedInEra BabbageEra
- UpdateProposalInConwayEra ∷ UpdateProposalSupportedInEra ConwayEra
- data TxTotalAndReturnCollateralSupportedInEra era where
- collateralSupportedInEra ∷ CardanoEra era → Maybe (CollateralSupportedInEra era)
- multiAssetSupportedInEra ∷ CardanoEra era → Either (OnlyAdaSupportedInEra era) (MultiAssetSupportedInEra era)
- txFeesExplicitInEra ∷ CardanoEra era → Either (TxFeesImplicitInEra era) (TxFeesExplicitInEra era)
- validityUpperBoundSupportedInEra ∷ CardanoEra era → Maybe (ValidityUpperBoundSupportedInEra era)
- validityNoUpperBoundSupportedInEra ∷ CardanoEra era → Maybe (ValidityNoUpperBoundSupportedInEra era)
- validityLowerBoundSupportedInEra ∷ CardanoEra era → Maybe (ValidityLowerBoundSupportedInEra era)
- txMetadataSupportedInEra ∷ CardanoEra era → Maybe (TxMetadataSupportedInEra era)
- auxScriptsSupportedInEra ∷ CardanoEra era → Maybe (AuxScriptsSupportedInEra era)
- extraKeyWitnessesSupportedInEra ∷ CardanoEra era → Maybe (TxExtraKeyWitnessesSupportedInEra era)
- withdrawalsSupportedInEra ∷ CardanoEra era → Maybe (WithdrawalsSupportedInEra era)
- certificatesSupportedInEra ∷ CardanoEra era → Maybe (CertificatesSupportedInEra era)
- updateProposalSupportedInEra ∷ CardanoEra era → Maybe (UpdateProposalSupportedInEra era)
- scriptDataSupportedInEra ∷ CardanoEra era → Maybe (ScriptDataSupportedInEra era)
- totalAndReturnCollateralSupportedInEra ∷ CardanoEra era → Maybe (TxTotalAndReturnCollateralSupportedInEra era)
- newtype LedgerEpochInfo = LedgerEpochInfo {
- unLedgerEpochInfo ∷ EpochInfo (Either Text)
- transactionFee ∷ ∀ era. IsShelleyBasedEra era ⇒ Natural → Natural → Tx era → Lovelace
- toLedgerEpochInfo ∷ EraHistory mode → LedgerEpochInfo
- estimateTransactionFee ∷ ∀ era. IsShelleyBasedEra era ⇒ NetworkId → Natural → Natural → Tx era → Int → Int → Int → Int → Lovelace
- evaluateTransactionFee ∷ ∀ era. IsShelleyBasedEra era ⇒ BundledProtocolParameters era → TxBody era → Word → Word → Lovelace
- estimateTransactionKeyWitnessCount ∷ TxBodyContent BuildTx era → Word
- calculateMinimumUTxO ∷ ShelleyBasedEra era → TxOut CtxTx era → BundledProtocolParameters era → Either MinimumUTxOError Lovelace
- data MinimumUTxOError
- evaluateTransactionExecutionUnits ∷ ∀ era. SystemStart → LedgerEpochInfo → BundledProtocolParameters era → UTxO era → TxBody era → Either TransactionValidityError (Map ScriptWitnessIndex (Either ScriptExecutionError ExecutionUnits))
- data ScriptExecutionError
- = ScriptErrorMissingTxIn TxIn
- | ScriptErrorTxInWithoutDatum TxIn
- | ScriptErrorWrongDatum (Hash ScriptData)
- | ScriptErrorEvaluationFailed EvaluationError [Text]
- | ScriptErrorExecutionUnitsOverflow
- | ScriptErrorNotPlutusWitnessedTxIn ScriptWitnessIndex ScriptHash
- | ScriptErrorRedeemerPointsToUnknownScriptHash ScriptWitnessIndex
- | ScriptErrorMissingScript RdmrPtr ResolvablePointers
- | ScriptErrorMissingCostModel Language
- data TransactionValidityError
- = TransactionValidityIntervalError PastHorizonException
- | TransactionValidityTranslationError (TranslationError StandardCrypto)
- | TransactionValidityCostModelError (Map AnyPlutusScriptVersion CostModel) String
- evaluateTransactionBalance ∷ ∀ era. IsShelleyBasedEra era ⇒ BundledProtocolParameters era → Set PoolId → UTxO era → TxBody era → TxOutValue era
- makeTransactionBodyAutoBalance ∷ ∀ era. IsShelleyBasedEra era ⇒ SystemStart → LedgerEpochInfo → ProtocolParameters → Set PoolId → UTxO era → TxBodyContent BuildTx era → AddressInEra era → Maybe Word → Either TxBodyErrorAutoBalance (BalancedTxBody era)
- data BalancedTxBody era = BalancedTxBody (TxBodyContent BuildTx era) (TxBody era) (TxOut CtxTx era) Lovelace
- data TxBodyErrorAutoBalance
- = TxBodyError TxBodyError
- | TxBodyScriptExecutionError [(ScriptWitnessIndex, ScriptExecutionError)]
- | TxBodyScriptBadScriptValidity
- | TxBodyErrorAssetBalanceWrong Value
- | TxBodyErrorAdaBalanceNegative Lovelace
- | TxBodyErrorAdaBalanceTooSmall TxOutInAnyEra Lovelace Lovelace
- | TxBodyErrorByronEraNotSupported
- | TxBodyErrorMissingParamMinUTxO
- | TxBodyErrorValidityInterval TransactionValidityError
- | TxBodyErrorMinUTxONotMet TxOutInAnyEra Lovelace
- | TxBodyErrorMinUTxOMissingPParams MinimumUTxOError
- | TxBodyErrorNonAdaAssetsUnbalanced Value
- | TxBodyErrorScriptWitnessIndexMissingFromExecUnitsMap ScriptWitnessIndex (Map ScriptWitnessIndex ExecutionUnits)
- data TxScriptValidity era where
- data ScriptValidity
- data TxScriptValiditySupportedInEra era where
- scriptValidityToTxScriptValidity ∷ ShelleyBasedEra era → ScriptValidity → TxScriptValidity era
- txScriptValiditySupportedInShelleyBasedEra ∷ ShelleyBasedEra era → Maybe (TxScriptValiditySupportedInEra era)
- txScriptValiditySupportedInCardanoEra ∷ CardanoEra era → Maybe (TxScriptValiditySupportedInEra era)
- txScriptValidityToScriptValidity ∷ TxScriptValidity era → ScriptValidity
- data Tx era where
- pattern Tx ∷ TxBody era → [KeyWitness era] → Tx era
- getTxBody ∷ ∀ era. Tx era → TxBody era
- getTxWitnesses ∷ ∀ era. Tx era → [KeyWitness era]
- signByronTransaction ∷ NetworkId → TxBody ByronEra → [SigningKey ByronKey] → Tx ByronEra
- signShelleyTransaction ∷ IsShelleyBasedEra era ⇒ TxBody era → [ShelleyWitnessSigningKey] → Tx era
- makeSignedTransaction ∷ ∀ era. [KeyWitness era] → TxBody era → Tx era
- data KeyWitness era
- makeByronKeyWitness ∷ ∀ key. IsByronKey key ⇒ NetworkId → TxBody ByronEra → SigningKey key → KeyWitness ByronEra
- 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)
- | WitnessGenesisUTxOKey (SigningKey GenesisUTxOKey)
- makeShelleyKeyWitness ∷ ∀ era. IsShelleyBasedEra era ⇒ TxBody era → ShelleyWitnessSigningKey → KeyWitness era
- makeShelleyBootstrapWitness ∷ ∀ era. IsShelleyBasedEra era ⇒ WitnessNetworkIdOrByronAddress → TxBody era → SigningKey ByronKey → KeyWitness era
- newtype TxMetadata = TxMetadata (Map Word64 TxMetadataValue)
- data TxMetadataValue
- makeTransactionMetadata ∷ Map Word64 TxMetadataValue → TxMetadata
- validateTxMetadata ∷ TxMetadata → Either [(Word64, TxMetadataRangeError)] ()
- data TxMetadataRangeError
- data TxMetadataJsonSchema
- metadataFromJson ∷ TxMetadataJsonSchema → Value → Either TxMetadataJsonError TxMetadata
- metadataToJson ∷ TxMetadataJsonSchema → TxMetadata → Value
- metadataValueToJsonNoSchema ∷ TxMetadataValue → Value
- data TxMetadataJsonError
- data TxMetadataJsonSchemaError
- = TxMetadataJsonNullNotAllowed
- | TxMetadataJsonBoolNotAllowed
- | TxMetadataJsonNumberNotInteger !Double
- | TxMetadataJsonNotObject !Value
- | TxMetadataJsonBadObject ![(Text, Value)]
- | TxMetadataJsonBadMapPair !Value
- | TxMetadataJsonTypeMismatch !Text !Value
- data Certificate
- = StakeAddressRegistrationCertificate StakeCredential
- | StakeAddressDeregistrationCertificate StakeCredential
- | StakeAddressDelegationCertificate StakeCredential PoolId
- | StakePoolRegistrationCertificate StakePoolParameters
- | StakePoolRetirementCertificate PoolId EpochNo
- | GenesisKeyDelegationCertificate (Hash GenesisKey) (Hash GenesisDelegateKey) (Hash VrfKey)
- | MIRCertificate MIRPot MIRTarget
- makeStakeAddressRegistrationCertificate ∷ StakeCredential → Certificate
- makeStakeAddressDeregistrationCertificate ∷ StakeCredential → Certificate
- makeStakeAddressDelegationCertificate ∷ StakeCredential → PoolId → Certificate
- makeStakePoolRegistrationCertificate ∷ StakePoolParameters → Certificate
- makeStakePoolRetirementCertificate ∷ PoolId → EpochNo → Certificate
- data StakePoolParameters
- data StakePoolRelay
- data StakePoolMetadataReference
- data StakePoolMetadata
- validateAndHashStakePoolMetadata ∷ ByteString → Either StakePoolMetadataValidationError (StakePoolMetadata, Hash StakePoolMetadata)
- data StakePoolMetadataValidationError
- data SimpleScript'
- data PlutusScriptV1
- data PlutusScriptV2
- data ScriptLanguage lang where
- data PlutusScriptVersion lang where
- data AnyScriptLanguage where
- data AnyPlutusScriptVersion where
- class IsScriptLanguage lang ⇒ IsPlutusScriptLanguage lang where
- class HasTypeProxy lang ⇒ IsScriptLanguage lang where
- scriptLanguage ∷ ScriptLanguage lang
- data Script lang where
- SimpleScript ∷ !SimpleScript → Script SimpleScript'
- PlutusScript ∷ !(PlutusScriptVersion lang) → !(PlutusScript lang) → Script lang
- data ScriptInAnyLang where
- ScriptInAnyLang ∷ ScriptLanguage lang → Script lang → ScriptInAnyLang
- toScriptInAnyLang ∷ Script lang → ScriptInAnyLang
- data ScriptInEra era where
- ScriptInEra ∷ ScriptLanguageInEra lang era → Script lang → ScriptInEra era
- toScriptInEra ∷ CardanoEra era → ScriptInAnyLang → Maybe (ScriptInEra era)
- eraOfScriptInEra ∷ ScriptInEra era → ShelleyBasedEra era
- data WitCtxTxIn
- data WitCtxMint
- data WitCtxStake
- data WitCtx witctx where
- data ScriptWitness witctx era where
- SimpleScriptWitness ∷ ScriptLanguageInEra SimpleScript' era → SimpleScriptOrReferenceInput SimpleScript' → ScriptWitness witctx era
- PlutusScriptWitness ∷ ScriptLanguageInEra lang era → PlutusScriptVersion lang → PlutusScriptOrReferenceInput lang → ScriptDatum witctx → ScriptRedeemer → ExecutionUnits → ScriptWitness witctx era
- data Witness witctx era where
- KeyWitness ∷ KeyWitnessInCtx witctx → Witness witctx era
- ScriptWitness ∷ ScriptWitnessInCtx witctx → ScriptWitness witctx era → Witness witctx era
- data KeyWitnessInCtx witctx where
- data ScriptWitnessInCtx witctx where
- class IsScriptWitnessInCtx ctx where
- data ScriptDatum witctx where
- type ScriptRedeemer = HashableScriptData
- scriptWitnessScript ∷ ScriptWitness witctx era → Maybe (ScriptInEra era)
- data AnyScriptWitness era where
- AnyScriptWitness ∷ ScriptWitness witctx era → AnyScriptWitness era
- data ScriptWitnessIndex
- renderScriptWitnessIndex ∷ ScriptWitnessIndex → String
- collectTxBodyScriptWitnesses ∷ ∀ era. TxBodyContent BuildTx era → [(ScriptWitnessIndex, AnyScriptWitness era)]
- mapTxScriptWitnesses ∷ ∀ era. (∀ witctx. ScriptWitnessIndex → ScriptWitness witctx era → Either TxBodyErrorAutoBalance (ScriptWitness witctx era)) → TxBodyContent BuildTx era → Either TxBodyErrorAutoBalance (TxBodyContent BuildTx era)
- data ScriptLanguageInEra lang era where
- SimpleScriptInShelley ∷ ScriptLanguageInEra SimpleScript' ShelleyEra
- SimpleScriptInAllegra ∷ ScriptLanguageInEra SimpleScript' AllegraEra
- SimpleScriptInMary ∷ ScriptLanguageInEra SimpleScript' MaryEra
- SimpleScriptInAlonzo ∷ ScriptLanguageInEra SimpleScript' AlonzoEra
- SimpleScriptInBabbage ∷ ScriptLanguageInEra SimpleScript' BabbageEra
- SimpleScriptInConway ∷ ScriptLanguageInEra SimpleScript' ConwayEra
- PlutusScriptV1InAlonzo ∷ ScriptLanguageInEra PlutusScriptV1 AlonzoEra
- PlutusScriptV1InBabbage ∷ ScriptLanguageInEra PlutusScriptV1 BabbageEra
- PlutusScriptV1InConway ∷ ScriptLanguageInEra PlutusScriptV1 ConwayEra
- PlutusScriptV2InBabbage ∷ ScriptLanguageInEra PlutusScriptV2 BabbageEra
- PlutusScriptV2InConway ∷ ScriptLanguageInEra PlutusScriptV2 ConwayEra
- scriptLanguageSupportedInEra ∷ CardanoEra era → ScriptLanguage lang → Maybe (ScriptLanguageInEra lang era)
- languageOfScriptLanguageInEra ∷ ScriptLanguageInEra lang era → ScriptLanguage lang
- eraOfScriptLanguageInEra ∷ ScriptLanguageInEra lang era → ShelleyBasedEra era
- data SimpleScript
- data PlutusScript lang
- examplePlutusScriptAlwaysSucceeds ∷ WitCtx witctx → PlutusScript PlutusScriptV1
- examplePlutusScriptAlwaysFails ∷ WitCtx witctx → PlutusScript PlutusScriptV1
- data HashableScriptData
- hashScriptDataBytes ∷ HashableScriptData → Hash ScriptData
- getOriginalScriptDataBytes ∷ HashableScriptData → ByteString
- getScriptData ∷ HashableScriptData → ScriptData
- unsafeHashableScriptData ∷ ScriptData → HashableScriptData
- data ScriptData
- hashScriptData ∷ HashableScriptData → Hash ScriptData
- newtype ScriptDataRangeError = ScriptDataConstructorOutOfRange Integer
- validateScriptData ∷ ScriptData → Either ScriptDataRangeError ()
- data ScriptDataJsonSchema
- scriptDataFromJson ∷ ScriptDataJsonSchema → Value → Either ScriptDataJsonError HashableScriptData
- scriptDataToJson ∷ ScriptDataJsonSchema → HashableScriptData → Value
- data ScriptDataJsonError
- data ScriptDataJsonSchemaError
- = ScriptDataJsonNullNotAllowed
- | ScriptDataJsonBoolNotAllowed
- | ScriptDataJsonNumberNotInteger !Double
- | ScriptDataJsonNotObject !Value
- | ScriptDataJsonBadObject ![(Text, Value)]
- | ScriptDataJsonBadMapPair !Value
- | ScriptDataJsonTypeMismatch !Text !Value
- data ScriptDataJsonBytesError
- scriptDataJsonToHashable ∷ ScriptDataJsonSchema → Value → Either ScriptDataJsonBytesError HashableScriptData
- data ExecutionUnits = ExecutionUnits {}
- data ExecutionUnitPrices = ExecutionUnitPrices {}
- newtype CostModel = CostModel (Map Text Integer)
- validateCostModel ∷ PlutusScriptVersion lang → CostModel → Either InvalidCostModel ()
- data ScriptHash
- hashScript ∷ Script lang → ScriptHash
- data InputFormat a where
- data InputDecodeError
- deserialiseInput ∷ ∀ a. AsType a → NonEmpty (InputFormat a) → ByteString → Either InputDecodeError a
- deserialiseInputAnyOf ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → ByteString → Either InputDecodeError b
- renderInputDecodeError ∷ InputDecodeError → Text
- data SomeAddressVerificationKey
- = AByronVerificationKey (VerificationKey ByronKey)
- | APaymentVerificationKey (VerificationKey PaymentKey)
- | APaymentExtendedVerificationKey (VerificationKey PaymentExtendedKey)
- | AGenesisUTxOVerificationKey (VerificationKey GenesisUTxOKey)
- | AGenesisExtendedVerificationKey (VerificationKey GenesisExtendedKey)
- | AGenesisDelegateExtendedVerificationKey (VerificationKey GenesisDelegateExtendedKey)
- | AKesVerificationKey (VerificationKey KesKey)
- | AVrfVerificationKey (VerificationKey VrfKey)
- | AStakeVerificationKey (VerificationKey StakeKey)
- | AStakeExtendedVerificationKey (VerificationKey StakeExtendedKey)
- deserialiseAnyVerificationKey ∷ ByteString → Either InputDecodeError SomeAddressVerificationKey
- deserialiseAnyVerificationKeyBech32 ∷ ByteString → Either Bech32DecodeError SomeAddressVerificationKey
- deserialiseAnyVerificationKeyTextEnvelope ∷ ByteString → Either TextEnvelopeError SomeAddressVerificationKey
- renderSomeAddressVerificationKey ∷ SomeAddressVerificationKey → Text
- class HasTypeProxy a ⇒ SerialiseAsCBOR a
- class Typeable a ⇒ ToCBOR a
- class Typeable a ⇒ FromCBOR a
- serialiseToCBOR ∷ SerialiseAsCBOR a ⇒ a → ByteString
- deserialiseFromCBOR ∷ SerialiseAsCBOR a ⇒ AsType a → ByteString → Either DecoderError a
- class ToJSON a
- class FromJSON a
- serialiseToJSON ∷ ToJSON a ⇒ a → ByteString
- deserialiseFromJSON ∷ FromJSON a ⇒ AsType a → ByteString → Either JsonDecodeError a
- newtype JsonDecodeError = JsonDecodeError String
- readFileJSON ∷ FromJSON a ⇒ AsType a → FilePath → IO (Either (FileError JsonDecodeError) a)
- writeFileJSON ∷ ToJSON a ⇒ FilePath → a → IO (Either (FileError ()) ())
- prettyPrintJSON ∷ ToJSON a ⇒ a → ByteString
- class (HasTypeProxy a, SerialiseAsRawBytes a) ⇒ SerialiseAsBech32 a
- serialiseToBech32 ∷ SerialiseAsBech32 a ⇒ a → Text
- deserialiseFromBech32 ∷ SerialiseAsBech32 a ⇒ AsType a → Text → Either Bech32DecodeError a
- deserialiseAnyOfFromBech32 ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → Text → Either Bech32DecodeError b
- data Bech32DecodeError
- = Bech32DecodingError !DecodingError
- | Bech32UnexpectedPrefix !Text !(Set Text)
- | Bech32DataPartToBytesError !Text
- | Bech32DeserialiseFromBytesError !ByteString
- | Bech32WrongPrefix !Text !Text
- class HasTypeProxy addr ⇒ SerialiseAddress addr
- serialiseAddress ∷ SerialiseAddress addr ⇒ addr → Text
- deserialiseAddress ∷ SerialiseAddress addr ⇒ AsType addr → Text → Maybe addr
- class (HasTypeProxy a, Typeable a) ⇒ SerialiseAsRawBytes a
- serialiseToRawBytes ∷ SerialiseAsRawBytes a ⇒ a → ByteString
- deserialiseFromRawBytes ∷ SerialiseAsRawBytes a ⇒ AsType a → ByteString → Either SerialiseAsRawBytesError a
- eitherDeserialiseFromRawBytes ∷ SerialiseAsRawBytes a ⇒ AsType a → ByteString → Either SerialiseAsRawBytesError a
- serialiseToRawBytesHex ∷ SerialiseAsRawBytes a ⇒ a → ByteString
- deserialiseFromRawBytesHex ∷ SerialiseAsRawBytes a ⇒ AsType a → ByteString → Either RawBytesHexError a
- serialiseToRawBytesHexText ∷ SerialiseAsRawBytes a ⇒ a → Text
- data RawBytesHexError
- class SerialiseAsCBOR a ⇒ HasTextEnvelope a where
- data TextEnvelope = TextEnvelope {}
- newtype TextEnvelopeType = TextEnvelopeType String
- data TextEnvelopeDescr
- data TextEnvelopeError
- = TextEnvelopeTypeError ![TextEnvelopeType] !TextEnvelopeType
- | TextEnvelopeDecodeError !DecoderError
- | TextEnvelopeAesonDecodeError !String
- textEnvelopeRawCBOR ∷ TextEnvelope → ByteString
- textEnvelopeToJSON ∷ HasTextEnvelope a ⇒ Maybe TextEnvelopeDescr → a → ByteString
- serialiseToTextEnvelope ∷ ∀ a. HasTextEnvelope a ⇒ Maybe TextEnvelopeDescr → a → TextEnvelope
- deserialiseFromTextEnvelope ∷ HasTextEnvelope a ⇒ AsType a → TextEnvelope → Either TextEnvelopeError a
- readFileTextEnvelope ∷ HasTextEnvelope a ⇒ AsType a → FilePath → IO (Either (FileError TextEnvelopeError) a)
- writeFileTextEnvelope ∷ HasTextEnvelope a ⇒ FilePath → Maybe TextEnvelopeDescr → a → IO (Either (FileError ()) ())
- writeFileTextEnvelopeWithOwnerPermissions ∷ HasTextEnvelope a ⇒ FilePath → Maybe TextEnvelopeDescr → a → IO (Either (FileError ()) ())
- readTextEnvelopeFromFile ∷ FilePath → IO (Either (FileError TextEnvelopeError) TextEnvelope)
- readTextEnvelopeOfTypeFromFile ∷ TextEnvelopeType → FilePath → IO (Either (FileError TextEnvelopeError) TextEnvelope)
- data FromSomeTypeCDDL c b where
- FromCDDLTx ∷ Text → (InAnyCardanoEra Tx → b) → FromSomeTypeCDDL TextEnvelopeCddl b
- FromCDDLWitness ∷ Text → (InAnyCardanoEra KeyWitness → b) → FromSomeTypeCDDL TextEnvelopeCddl b
- readFileTextEnvelopeCddlAnyOf ∷ [FromSomeTypeCDDL TextEnvelopeCddl b] → FilePath → IO (Either (FileError TextEnvelopeCddlError) b)
- deserialiseFromTextEnvelopeCddlAnyOf ∷ [FromSomeTypeCDDL TextEnvelopeCddl b] → TextEnvelopeCddl → Either TextEnvelopeCddlError b
- writeTxFileTextEnvelopeCddl ∷ IsCardanoEra era ⇒ FilePath → Tx era → IO (Either (FileError ()) ())
- writeTxWitnessFileTextEnvelopeCddl ∷ ShelleyBasedEra era → FilePath → KeyWitness era → IO (Either (FileError ()) ())
- serialiseTxLedgerCddl ∷ ∀ era. IsCardanoEra era ⇒ Tx era → TextEnvelopeCddl
- deserialiseTxLedgerCddl ∷ IsCardanoEra era ⇒ CardanoEra era → TextEnvelopeCddl → Either TextEnvelopeCddlError (Tx era)
- serialiseWitnessLedgerCddl ∷ ∀ era. ShelleyBasedEra era → KeyWitness era → TextEnvelopeCddl
- deserialiseWitnessLedgerCddl ∷ ShelleyBasedEra era → TextEnvelopeCddl → Either TextEnvelopeCddlError (KeyWitness era)
- data TextEnvelopeCddl = TextEnvelopeCddl {}
- data TextEnvelopeCddlError
- readKeyFile ∷ AsType a → NonEmpty (InputFormat a) → FilePath → IO (Either (FileError InputDecodeError) a)
- readKeyFileTextEnvelope ∷ HasTextEnvelope a ⇒ AsType a → FilePath → IO (Either (FileError InputDecodeError) a)
- readKeyFileAnyOf ∷ ∀ b. [FromSomeType SerialiseAsBech32 b] → [FromSomeType HasTextEnvelope b] → FilePath → IO (Either (FileError InputDecodeError) b)
- data FromSomeType (c ∷ Type → Constraint) b where
- FromSomeType ∷ c a ⇒ AsType a → (a → b) → FromSomeType c b
- deserialiseFromTextEnvelopeAnyOf ∷ [FromSomeType HasTextEnvelope b] → TextEnvelope → Either TextEnvelopeError b
- readFileTextEnvelopeAnyOf ∷ [FromSomeType HasTextEnvelope b] → FilePath → IO (Either (FileError TextEnvelopeError) b)
- class Show e ⇒ Error e where
- displayError ∷ e → String
- throwErrorAsException ∷ Error e ⇒ e → IO a
- data FileError e
- data Env = Env {
- envLedgerConfig ∷ HardForkLedgerConfig (CardanoEras StandardCrypto)
- envProtocolConfig ∷ ConsensusConfig (HardForkProtocol (CardanoEras StandardCrypto))
- envSecurityParam ∷ Env → Word64
- newtype LedgerState where
- LedgerState {
- clsState ∷ LedgerState (HardForkBlock (CardanoEras StandardCrypto))
- pattern LedgerStateByron ∷ LedgerState ByronBlock → LedgerState
- pattern LedgerStateShelley ∷ LedgerState (ShelleyBlock protocol (ShelleyEra StandardCrypto)) → LedgerState
- pattern LedgerStateAllegra ∷ LedgerState (ShelleyBlock protocol (AllegraEra StandardCrypto)) → LedgerState
- pattern LedgerStateMary ∷ LedgerState (ShelleyBlock protocol (MaryEra StandardCrypto)) → LedgerState
- pattern LedgerStateAlonzo ∷ LedgerState (ShelleyBlock protocol (AlonzoEra StandardCrypto)) → LedgerState
- pattern LedgerStateBabbage ∷ LedgerState (ShelleyBlock protocol (BabbageEra StandardCrypto)) → LedgerState
- pattern LedgerStateConway ∷ LedgerState (ShelleyBlock protocol (ConwayEra StandardCrypto)) → LedgerState
- LedgerState {
- initialLedgerState ∷ FilePath → ExceptT InitialLedgerStateError IO (Env, LedgerState)
- encodeLedgerState ∷ LedgerState → Encoding
- decodeLedgerState ∷ ∀ s. Decoder s LedgerState
- applyBlock ∷ Env → LedgerState → ValidationMode → Block era → Either LedgerStateError (LedgerState, [LedgerEvent])
- data ValidationMode
- data LedgerEvent
- = PoolRegistration Certificate
- | PoolReRegistration Certificate
- | IncrementalRewardsDistribution EpochNo (Map StakeCredential (Set (Reward StandardCrypto)))
- | RewardsDistribution EpochNo (Map StakeCredential (Set (Reward StandardCrypto)))
- | MIRDistribution MIRDistributionDetails
- | PoolReap PoolReapDetails
- | SuccessfulPlutusScript (NonEmpty PlutusDebug)
- | FailedPlutusScript (NonEmpty PlutusDebug)
- data MIRDistributionDetails = MIRDistributionDetails {}
- data PoolReapDetails = PoolReapDetails {}
- toLedgerEvent ∷ ConvertLedgerEvent blk ⇒ WrapLedgerEvent blk → Maybe LedgerEvent
- foldBlocks ∷ ∀ a. FilePath → FilePath → ValidationMode → a → (Env → LedgerState → [LedgerEvent] → BlockInMode CardanoMode → a → IO a) → ExceptT FoldBlocksError IO a
- chainSyncClientWithLedgerState ∷ ∀ m a. Monad m ⇒ Env → LedgerState → ValidationMode → ChainSyncClient (BlockInMode CardanoMode, Either LedgerStateError (LedgerState, [LedgerEvent])) ChainPoint ChainTip m a → ChainSyncClient (BlockInMode CardanoMode) ChainPoint ChainTip m a
- chainSyncClientPipelinedWithLedgerState ∷ ∀ m a. Monad m ⇒ Env → LedgerState → ValidationMode → ChainSyncClientPipelined (BlockInMode CardanoMode, Either LedgerStateError (LedgerState, [LedgerEvent])) ChainPoint ChainTip m a → ChainSyncClientPipelined (BlockInMode CardanoMode) ChainPoint ChainTip m a
- data LedgerStateError
- = ApplyBlockHashMismatch Text
- | ApplyBlockError (HardForkLedgerError (CardanoEras StandardCrypto))
- | InvalidRollback SlotNo ChainPoint
- data FoldBlocksError
- data GenesisConfigError
- = NEError !Text
- | NEByronConfig !FilePath !ConfigurationError
- | NEShelleyConfig !FilePath !Text
- | NEAlonzoConfig !FilePath !Text
- | NEConwayConfig !FilePath !Text
- | NECardanoConfig !Text
- data InitialLedgerStateError
- renderLedgerStateError ∷ LedgerStateError → Text
- renderFoldBlocksError ∷ FoldBlocksError → Text
- renderGenesisConfigError ∷ GenesisConfigError → Text
- renderInitialLedgerStateError ∷ InitialLedgerStateError → Text
- connectToLocalNode ∷ LocalNodeConnectInfo mode → LocalNodeClientProtocolsInMode mode → IO ()
- connectToLocalNodeWithVersion ∷ LocalNodeConnectInfo mode → (NodeToClientVersion → LocalNodeClientProtocolsInMode mode) → IO ()
- data LocalNodeConnectInfo mode = LocalNodeConnectInfo {}
- data AnyConsensusMode where
- renderMode ∷ AnyConsensusMode → Text
- data ConsensusMode mode where
- consensusModeOnly ∷ ConsensusModeParams mode → ConsensusMode mode
- data ConsensusModeIsMultiEra mode where
- data AnyConsensusModeParams where
- data ConsensusModeParams mode where
- type family ConsensusProtocol era where ...
- type family ChainDepStateProtocol era where ...
- type family ConsensusBlockForMode mode where ...
- type family ConsensusBlockForEra era where ...
- data EraInMode era mode where
- ByronEraInByronMode ∷ EraInMode ByronEra ByronMode
- ShelleyEraInShelleyMode ∷ EraInMode ShelleyEra ShelleyMode
- ByronEraInCardanoMode ∷ EraInMode ByronEra CardanoMode
- ShelleyEraInCardanoMode ∷ EraInMode ShelleyEra CardanoMode
- AllegraEraInCardanoMode ∷ EraInMode AllegraEra CardanoMode
- MaryEraInCardanoMode ∷ EraInMode MaryEra CardanoMode
- AlonzoEraInCardanoMode ∷ EraInMode AlonzoEra CardanoMode
- BabbageEraInCardanoMode ∷ EraInMode BabbageEra CardanoMode
- ConwayEraInCardanoMode ∷ EraInMode ConwayEra CardanoMode
- toEraInMode ∷ CardanoEra era → ConsensusMode mode → Maybe (EraInMode era mode)
- data LocalNodeClientProtocols block point tip slot tx txid txerr query m = LocalNodeClientProtocols {
- localChainSyncClient ∷ LocalChainSyncClient block point tip m
- localTxSubmissionClient ∷ Maybe (LocalTxSubmissionClient tx txerr m ())
- localStateQueryClient ∷ Maybe (LocalStateQueryClient block point query m ())
- localTxMonitoringClient ∷ Maybe (LocalTxMonitorClient txid tx slot m ())
- data LocalNodeClientParams where
- LocalNodeClientParamsSingleBlock ∷ (ProtocolClient block, LedgerSupportsProtocol (ShelleyBlock (TPraos StandardCrypto) (ShelleyEra StandardCrypto))) ⇒ ProtocolClientInfoArgs block → (NodeToClientVersion → LocalNodeClientProtocolsForBlock block) → LocalNodeClientParams
- LocalNodeClientParamsCardano ∷ (ProtocolClient block, CardanoHardForkConstraints (ConsensusCryptoForBlock block)) ⇒ ProtocolClientInfoArgs block → (NodeToClientVersion → LocalNodeClientProtocolsForBlock block) → LocalNodeClientParams
- mkLocalNodeClientParams ∷ ∀ mode block. ConsensusBlockForMode mode ~ block ⇒ ConsensusModeParams mode → (NodeToClientVersion → LocalNodeClientProtocolsInMode mode) → LocalNodeClientParams
- data LocalChainSyncClient block point tip m
- = NoLocalChainSyncClient
- | LocalChainSyncClientPipelined (ChainSyncClientPipelined block point tip m ())
- | LocalChainSyncClient (ChainSyncClient block point tip m ())
- data CardanoMode
- data BlockType blk where
- ByronBlockType ∷ BlockType ByronBlockHFC
- ShelleyBlockType ∷ BlockType (ShelleyBlockHFC (TPraos StandardCrypto) StandardShelley)
- CardanoBlockType ∷ BlockType (CardanoBlock StandardCrypto)
- class (RunNode blk, IOLike m) ⇒ Protocol m blk where
- data ProtocolInfoArgs m blk
- protocolInfo ∷ ProtocolInfoArgs m blk → ProtocolInfo m blk
- newtype ChainSyncClient header point tip (m ∷ Type → Type) a = ChainSyncClient {
- runChainSyncClient ∷ m (ClientStIdle header point tip m a)
- newtype ChainSyncClientPipelined header point tip (m ∷ Type → TYPE LiftedRep) a = ChainSyncClientPipelined {
- runChainSyncClientPipelined ∷ m (ClientPipelinedStIdle 'Z header point tip m a)
- data BlockInMode mode where
- BlockInMode ∷ IsCardanoEra era ⇒ Block era → EraInMode era mode → BlockInMode mode
- type LocalNodeClientProtocolsInMode mode = LocalNodeClientProtocols (BlockInMode mode) ChainPoint ChainTip SlotNo (TxInMode mode) (TxIdInMode mode) (TxValidationErrorInMode mode) (QueryInMode mode) IO
- data LocalTxSubmissionClient tx reject (m ∷ Type → Type) a
- data TxInMode mode where
- data TxValidationErrorInMode mode where
- TxValidationErrorInMode ∷ TxValidationError era → EraInMode era mode → TxValidationErrorInMode mode
- TxValidationEraMismatch ∷ EraMismatch → TxValidationErrorInMode mode
- data SubmitResult reason
- = SubmitSuccess
- | SubmitFail reason
- runLocalTxSubmissionClient ∷ LocalTxSubmissionClient tx reject m a → m (LocalTxClientStIdle tx reject m a)
- submitTxToNodeLocal ∷ ∀ mode. LocalNodeConnectInfo mode → TxInMode mode → IO (SubmitResult (TxValidationErrorInMode mode))
- newtype LocalStateQueryClient block point (query ∷ Type → Type) (m ∷ Type → Type) a = LocalStateQueryClient {
- runLocalStateQueryClient ∷ m (ClientStIdle block point query m a)
- 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
- newtype SystemStart = SystemStart {}
- 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
- newtype UTxO era = UTxO {}
- queryNodeLocalState ∷ ∀ mode result. LocalNodeConnectInfo mode → Maybe ChainPoint → QueryInMode mode result → IO (Either AcquiringFailure result)
- executeQueryCardanoMode ∷ CardanoEra era → NetworkId → QueryInMode CardanoMode (Either EraMismatch result) → IO (Either QueryConvenienceError result)
- data UnsupportedNtcVersionError = UnsupportedNtcVersionError !MinNodeToClientVersion !NodeToClientVersion
- newtype LocalTxMonitorClient txid tx slot (m ∷ Type → Type) a = LocalTxMonitorClient {
- runLocalTxMonitorClient ∷ m (ClientStIdle txid tx slot m a)
- data LocalTxMonitoringQuery mode
- data LocalTxMonitoringResult mode
- data MempoolSizeAndCapacity = MempoolSizeAndCapacity {}
- queryTxMonitoringLocal ∷ ∀ mode. LocalNodeConnectInfo mode → LocalTxMonitoringQuery mode → IO (LocalTxMonitoringResult mode)
- data TxIdInMode mode where
- TxIdInMode ∷ TxId → EraInMode era mode → TxIdInMode mode
- data EraHistory mode where
- EraHistory ∷ ConsensusBlockForMode mode ~ HardForkBlock xs ⇒ ConsensusMode mode → Interpreter xs → EraHistory mode
- getProgress ∷ SlotNo → EraHistory mode → Either PastHorizonException (RelativeTime, SlotLength)
- determineEra ∷ ConsensusModeParams mode → LocalNodeConnectInfo mode → IO (Either AcquiringFailure AnyCardanoEra)
- getLocalChainTip ∷ LocalNodeConnectInfo mode → IO ChainTip
- data OperationalCertificate
- data OperationalCertificateIssueCounter
- data OperationalCertIssueError
- getHotKey ∷ OperationalCertificate → VerificationKey KesKey
- getKesPeriod ∷ OperationalCertificate → Word
- getOpCertCount ∷ OperationalCertificate → Word64
- issueOperationalCertificate ∷ VerificationKey KesKey → Either (SigningKey StakePoolKey) (SigningKey GenesisDelegateExtendedKey) → KESPeriod → OperationalCertificateIssueCounter → Either OperationalCertIssueError (OperationalCertificate, OperationalCertificateIssueCounter)
- data GenesisKey
- data GenesisExtendedKey
- data GenesisDelegateKey
- data GenesisDelegateExtendedKey
- data GenesisUTxOKey
- genesisUTxOPseudoTxIn ∷ NetworkId → Hash GenesisUTxOKey → TxIn
- data GenesisParameters = GenesisParameters {
- protocolParamSystemStart ∷ UTCTime
- protocolParamNetworkId ∷ NetworkId
- protocolParamActiveSlotsCoefficient ∷ Rational
- protocolParamSecurity ∷ Int
- protocolParamEpochLength ∷ EpochSize
- protocolParamSlotLength ∷ NominalDiffTime
- protocolParamSlotsPerKESPeriod ∷ Int
- protocolParamMaxKESEvolutions ∷ Int
- protocolParamUpdateQuorum ∷ Int
- protocolParamMaxLovelaceSupply ∷ Lovelace
- protocolInitialUpdateableProtocolParameters ∷ ProtocolParameters
- makeMIRCertificate ∷ MIRPot → MIRTarget → Certificate
- makeGenesisKeyDelegationCertificate ∷ Hash GenesisKey → Hash GenesisDelegateKey → Hash VrfKey → Certificate
- data MIRTarget
- data UpdateProposal = UpdateProposal !(Map (Hash GenesisKey) ProtocolParametersUpdate) !EpochNo
- data ProtocolParametersUpdate = ProtocolParametersUpdate {
- protocolUpdateProtocolVersion ∷ Maybe (Natural, Natural)
- protocolUpdateDecentralization ∷ Maybe Rational
- protocolUpdateExtraPraosEntropy ∷ Maybe (Maybe PraosNonce)
- protocolUpdateMaxBlockHeaderSize ∷ Maybe Natural
- protocolUpdateMaxBlockBodySize ∷ Maybe Natural
- protocolUpdateMaxTxSize ∷ Maybe Natural
- protocolUpdateTxFeeFixed ∷ Maybe Natural
- protocolUpdateTxFeePerByte ∷ Maybe Natural
- protocolUpdateMinUTxOValue ∷ Maybe Lovelace
- protocolUpdateStakeAddressDeposit ∷ Maybe Lovelace
- protocolUpdateStakePoolDeposit ∷ Maybe Lovelace
- protocolUpdateMinPoolCost ∷ Maybe Lovelace
- protocolUpdatePoolRetireMaxEpoch ∷ Maybe EpochNo
- protocolUpdateStakePoolTargetNum ∷ Maybe Natural
- protocolUpdatePoolPledgeInfluence ∷ Maybe Rational
- protocolUpdateMonetaryExpansion ∷ Maybe Rational
- protocolUpdateTreasuryCut ∷ Maybe Rational
- protocolUpdateUTxOCostPerWord ∷ Maybe Lovelace
- protocolUpdateCostModels ∷ Map AnyPlutusScriptVersion CostModel
- protocolUpdatePrices ∷ Maybe ExecutionUnitPrices
- protocolUpdateMaxTxExUnits ∷ Maybe ExecutionUnits
- protocolUpdateMaxBlockExUnits ∷ Maybe ExecutionUnits
- protocolUpdateMaxValueSize ∷ Maybe Natural
- protocolUpdateCollateralPercent ∷ Maybe Natural
- protocolUpdateMaxCollateralInputs ∷ Maybe Natural
- protocolUpdateUTxOCostPerByte ∷ Maybe Lovelace
- makeShelleyUpdateProposal ∷ ProtocolParametersUpdate → [Hash GenesisKey] → EpochNo → UpdateProposal
- data PraosNonce
- makePraosNonce ∷ ByteString → PraosNonce
- newtype NetworkMagic = NetworkMagic {}
- data BundledProtocolParameters era where
- bundleProtocolParams ∷ CardanoEra era → ProtocolParameters → BundledProtocolParameters era
- unbundleProtocolParams ∷ BundledProtocolParameters era → ProtocolParameters
- toLedgerPParams ∷ ShelleyBasedEra era → ProtocolParameters → PParams (ShelleyLedgerEra era)
- fromLedgerPParams ∷ ShelleyBasedEra era → PParams (ShelleyLedgerEra era) → ProtocolParameters
- toCtxUTxOTxOut ∷ TxOut CtxTx era → TxOut CtxUTxO era
- fromNetworkMagic ∷ NetworkMagic → NetworkId
- toNetworkMagic ∷ NetworkId → NetworkMagic
- fromLedgerTxOuts ∷ ∀ era. ShelleyBasedEra era → TxBody (ShelleyLedgerEra era) → TxBodyScriptData era → [TxOut CtxTx era]
- toLedgerUTxO ∷ ShelleyLedgerEra era ~ ledgerera ⇒ Crypto ledgerera ~ StandardCrypto ⇒ ShelleyBasedEra era → UTxO era → UTxO ledgerera
- runParsecParser ∷ Parser a → Text → Parser a
- newtype SlotsInEpoch = SlotsInEpoch Word64
- newtype SlotsToEpochEnd = SlotsToEpochEnd Word64
- slotToEpoch ∷ SlotNo → EraHistory mode → Either PastHorizonException (EpochNo, SlotsInEpoch, SlotsToEpochEnd)
- newtype EnvSocketError = CliEnvVarLookup Text
- newtype SocketPath = SocketPath {}
- readEnvSocketPath ∷ IO (Either EnvSocketError SocketPath)
- renderEnvSocketError ∷ EnvSocketError → Text
- data NodeToClientVersion
- data LocalStateQueryExpr block point query r m a
- executeLocalStateQueryExpr ∷ LocalNodeConnectInfo mode → Maybe ChainPoint → LocalStateQueryExpr (BlockInMode mode) ChainPoint (QueryInMode mode) () IO a → IO (Either AcquiringFailure a)
- queryExpr ∷ QueryInMode mode a → LocalStateQueryExpr block point (QueryInMode mode) r IO (Either UnsupportedNtcVersionError a)
- determineEraExpr ∷ ConsensusModeParams mode → LocalStateQueryExpr block point (QueryInMode mode) r IO (Either UnsupportedNtcVersionError AnyCardanoEra)
- chainPointToSlotNo ∷ ChainPoint → Maybe SlotNo
- chainPointToHeaderHash ∷ ChainPoint → Maybe (Hash BlockHeader)
- makeChainTip ∷ WithOrigin BlockNo → ChainPoint → ChainTip
- parseFilePath ∷ String → String → Parser FilePath
- writeSecrets ∷ FilePath → [Char] → [Char] → (a → ByteString) → [a] → IO ()
- class EraCast (f ∷ Type → Type) where
- eraCast ∷ (IsCardanoEra fromEra, IsCardanoEra toEra) ⇒ CardanoEra toEra → f fromEra → Either EraCastError (f toEra)
- data EraCastError = ∀ fromEra toEra value.(IsCardanoEra fromEra, IsCardanoEra toEra, Show value) ⇒ EraCastError {
- originalValue ∷ value
- fromEra ∷ CardanoEra fromEra
- toEra ∷ CardanoEra toEra
- constructBalancedTx ∷ IsShelleyBasedEra era ⇒ TxBodyContent BuildTx era → AddressInEra era → Maybe Word → UTxO era → ProtocolParameters → LedgerEpochInfo → SystemStart → Set PoolId → [ShelleyWitnessSigningKey] → Either TxBodyErrorAutoBalance (Tx era)
- data QueryConvenienceError
- queryStateForBalancedTx ∷ CardanoEra era → NetworkId → [TxIn] → IO (Either QueryConvenienceError (UTxO era, ProtocolParameters, EraHistory CardanoMode, SystemStart, Set PoolId))
- renderQueryConvenienceError ∷ QueryConvenienceError → Text
- getIsCardanoEraConstraint ∷ CardanoEra era → (IsCardanoEra era ⇒ a) → a
- newtype ScriptLockedTxInsError = ScriptLockedTxIns [TxIn]
- data TxInsExistError
- = TxInsDoNotExist [TxIn]
- | EmptyUTxO
- renderEra ∷ AnyCardanoEra → Text
- renderNotScriptLockedTxInsError ∷ ScriptLockedTxInsError → Text
- renderTxInsExistError ∷ TxInsExistError → Text
- txInsExistInUTxO ∷ [TxIn] → UTxO era → Either TxInsExistError ()
- notScriptLockedTxIns ∷ [TxIn] → UTxO era → Either ScriptLockedTxInsError ()
- textShow ∷ Show a ⇒ a → Text
- bounded ∷ ∀ a. (Bounded a, Integral a, Show a) ⇒ String → ReadM a
Eras
A type used as a tag to distinguish the Byron era.
Instances
| IsCardanoEra ByronEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| HasTypeProxy ByronEra Source # | |
| FromJSON (EraInMode ByronEra ByronMode) Source # | |
| FromJSON (EraInMode ByronEra CardanoMode) Source # | |
Defined in Cardano.Api.Modes Methods parseJSON ∷ Value → Parser (EraInMode ByronEra CardanoMode) # parseJSONList ∷ Value → Parser [EraInMode ByronEra CardanoMode] # | |
| data AsType ByronEra Source # | |
Defined in Cardano.Api.Eras | |
data ShelleyEra Source #
A type used as a tag to distinguish the Shelley era.
Instances
| IsCardanoEra ShelleyEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra ShelleyEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| HasTypeProxy ShelleyEra Source # | |
Defined in Cardano.Api.Eras Associated Types data AsType ShelleyEra Source # Methods proxyToAsType ∷ Proxy ShelleyEra → AsType ShelleyEra Source # | |
| FromJSON (EraInMode ShelleyEra CardanoMode) Source # | |
Defined in Cardano.Api.Modes Methods parseJSON ∷ Value → Parser (EraInMode ShelleyEra CardanoMode) # parseJSONList ∷ Value → Parser [EraInMode ShelleyEra CardanoMode] # | |
| FromJSON (EraInMode ShelleyEra ShelleyMode) Source # | |
Defined in Cardano.Api.Modes Methods parseJSON ∷ Value → Parser (EraInMode ShelleyEra ShelleyMode) # parseJSONList ∷ Value → Parser [EraInMode ShelleyEra ShelleyMode] # | |
| data AsType ShelleyEra Source # | |
Defined in Cardano.Api.Eras | |
data AllegraEra Source #
A type used as a tag to distinguish the Allegra era.
Instances
| IsCardanoEra AllegraEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra AllegraEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| HasTypeProxy AllegraEra Source # | |
Defined in Cardano.Api.Eras Associated Types data AsType AllegraEra Source # Methods proxyToAsType ∷ Proxy AllegraEra → AsType AllegraEra Source # | |
| FromJSON (EraInMode AllegraEra CardanoMode) Source # | |
Defined in Cardano.Api.Modes Methods parseJSON ∷ Value → Parser (EraInMode AllegraEra CardanoMode) # parseJSONList ∷ Value → Parser [EraInMode AllegraEra CardanoMode] # | |
| data AsType AllegraEra Source # | |
Defined in Cardano.Api.Eras | |
A type used as a tag to distinguish the Mary era.
Instances
| IsCardanoEra MaryEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra MaryEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| HasTypeProxy MaryEra Source # | |
| FromJSON (EraInMode MaryEra CardanoMode) Source # | |
Defined in Cardano.Api.Modes Methods parseJSON ∷ Value → Parser (EraInMode MaryEra CardanoMode) # parseJSONList ∷ Value → Parser [EraInMode MaryEra CardanoMode] # | |
| data AsType MaryEra Source # | |
Defined in Cardano.Api.Eras | |
A type used as a tag to distinguish the Alonzo era.
Instances
| IsCardanoEra AlonzoEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra AlonzoEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| HasTypeProxy AlonzoEra Source # | |
| FromJSON (EraInMode AlonzoEra CardanoMode) Source # | |
Defined in Cardano.Api.Modes Methods parseJSON ∷ Value → Parser (EraInMode AlonzoEra CardanoMode) # parseJSONList ∷ Value → Parser [EraInMode AlonzoEra CardanoMode] # | |
| data AsType AlonzoEra Source # | |
Defined in Cardano.Api.Eras | |
data BabbageEra Source #
A type used as a tag to distinguish the Babbage era.
Instances
| IsCardanoEra BabbageEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra BabbageEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| HasTypeProxy BabbageEra Source # | |
Defined in Cardano.Api.Eras Associated Types data AsType BabbageEra Source # Methods proxyToAsType ∷ Proxy BabbageEra → AsType BabbageEra Source # | |
| FromJSON (EraInMode BabbageEra CardanoMode) Source # | |
Defined in Cardano.Api.Modes Methods parseJSON ∷ Value → Parser (EraInMode BabbageEra CardanoMode) # parseJSONList ∷ Value → Parser [EraInMode BabbageEra CardanoMode] # | |
| data AsType BabbageEra Source # | |
Defined in Cardano.Api.Eras | |
A type used as a tag to distinguish the Conway era.
Instances
| IsCardanoEra ConwayEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra ConwayEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| HasTypeProxy ConwayEra Source # | |
| FromJSON (EraInMode ConwayEra CardanoMode) Source # | |
Defined in Cardano.Api.Modes Methods parseJSON ∷ Value → Parser (EraInMode ConwayEra CardanoMode) # parseJSONList ∷ Value → Parser [EraInMode ConwayEra CardanoMode] # | |
| data AsType ConwayEra Source # | |
Defined in Cardano.Api.Eras | |
data CardanoEra era where Source #
This GADT provides a value-level representation of all the Cardano eras. This enables pattern matching on the era to allow them to be treated in a non-uniform way.
This can be used in combination with the IsCardanoEra class to get access
to this value.
In combination this can often enable code that handles all eras, and does so uniformly where possible, and non-uniformly where necessary.
Constructors
Instances
class HasTypeProxy era ⇒ IsCardanoEra era where Source #
The class of Cardano eras. This allows uniform handling of all Cardano
eras, but also non-uniform by making case distinctions on the CardanoEra
constructors, or the CardanoEraStyle constructors via cardanoEraStyle.
Methods
cardanoEra ∷ CardanoEra era Source #
Instances
| IsCardanoEra AllegraEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsCardanoEra AlonzoEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsCardanoEra BabbageEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsCardanoEra ByronEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsCardanoEra ConwayEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsCardanoEra MaryEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsCardanoEra ShelleyEra Source # | |
Defined in Cardano.Api.Eras Methods | |
data AnyCardanoEra where Source #
Constructors
| AnyCardanoEra ∷ IsCardanoEra era ⇒ CardanoEra era → AnyCardanoEra |
Instances
anyCardanoEra ∷ CardanoEra era → AnyCardanoEra Source #
Like the AnyCardanoEra constructor but does not demand a IsCardanoEra
class constraint.
data InAnyCardanoEra thing where Source #
This pairs up some era-dependent type with a CardanoEra value that tells
us what era it is, but hides the era type. This is useful when the era is
not statically known, for example when deserialising from a file.
Constructors
| InAnyCardanoEra ∷ IsCardanoEra era ⇒ CardanoEra era → thing era → InAnyCardanoEra thing |
Instances
| Show (InAnyCardanoEra Tx) Source # | |
Defined in Cardano.Api.Tx | |
| Eq (InAnyCardanoEra Tx) Source # | |
Defined in Cardano.Api.Tx Methods (==) ∷ InAnyCardanoEra Tx → InAnyCardanoEra Tx → Bool Source # (/=) ∷ InAnyCardanoEra Tx → InAnyCardanoEra Tx → Bool Source # | |
Shelley-based eras
data ShelleyBasedEra era where Source #
While the Byron and Shelley eras are quite different, there are several eras that are based on Shelley with only minor differences. It is useful to be able to treat the Shelley-based eras in a mostly-uniform way.
Values of this type witness the fact that the era is Shelley-based. This can be used to constrain the era to being a Shelley-based on. It allows non-uniform handling making case distinctions on the constructor.
Constructors
Instances
| Show (ShelleyBasedEra era) Source # | |
Defined in Cardano.Api.Eras | |
| NFData (ShelleyBasedEra era) Source # | |
Defined in Cardano.Api.Eras Methods rnf ∷ ShelleyBasedEra era → () Source # | |
| Eq (ShelleyBasedEra era) Source # | |
Defined in Cardano.Api.Eras Methods (==) ∷ ShelleyBasedEra era → ShelleyBasedEra era → Bool Source # (/=) ∷ ShelleyBasedEra era → ShelleyBasedEra era → Bool Source # | |
| Ord (ShelleyBasedEra era) Source # | |
Defined in Cardano.Api.Eras Methods compare ∷ ShelleyBasedEra era → ShelleyBasedEra era → Ordering Source # (<) ∷ ShelleyBasedEra era → ShelleyBasedEra era → Bool Source # (<=) ∷ ShelleyBasedEra era → ShelleyBasedEra era → Bool Source # (>) ∷ ShelleyBasedEra era → ShelleyBasedEra era → Bool Source # (>=) ∷ ShelleyBasedEra era → ShelleyBasedEra era → Bool Source # max ∷ ShelleyBasedEra era → ShelleyBasedEra era → ShelleyBasedEra era Source # min ∷ ShelleyBasedEra era → ShelleyBasedEra era → ShelleyBasedEra era Source # | |
class IsCardanoEra era ⇒ IsShelleyBasedEra era where Source #
The class of eras that are based on Shelley. This allows uniform handling
of Shelley-based eras, but also non-uniform by making case distinctions on
the ShelleyBasedEra constructors.
Methods
Instances
| IsShelleyBasedEra AllegraEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra AlonzoEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra BabbageEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra ConwayEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra MaryEra Source # | |
Defined in Cardano.Api.Eras Methods | |
| IsShelleyBasedEra ShelleyEra Source # | |
Defined in Cardano.Api.Eras Methods | |
data InAnyShelleyBasedEra thing where Source #
This pairs up some era-dependent type with a ShelleyBasedEra value that
tells us what era it is, but hides the era type. This is useful when the era
is not statically known, for example when deserialising from a file.
Constructors
| InAnyShelleyBasedEra ∷ IsShelleyBasedEra era ⇒ ShelleyBasedEra era → thing era → InAnyShelleyBasedEra thing |
data CardanoEraStyle era where Source #
This is the same essential information as CardanoEra but instead of a
flat set of alternative eras, it is factored into the legcy Byron era and
the current Shelley-based eras.
This way of factoring the eras is useful because in many cases the major differences are between the Byron and Shelley-based eras, and the Shelley-based eras can often be treated uniformly.
Constructors
| LegacyByronEra ∷ CardanoEraStyle ByronEra | |
| ShelleyBasedEra ∷ IsShelleyBasedEra era ⇒ ShelleyBasedEra era → CardanoEraStyle era |
Instances
| Show (CardanoEraStyle era) Source # | |
Defined in Cardano.Api.Eras | |
| Eq (CardanoEraStyle era) Source # | |
Defined in Cardano.Api.Eras Methods (==) ∷ CardanoEraStyle era → CardanoEraStyle era → Bool Source # (/=) ∷ CardanoEraStyle era → CardanoEraStyle era → Bool Source # | |
| Ord (CardanoEraStyle era) Source # | |
Defined in Cardano.Api.Eras Methods compare ∷ CardanoEraStyle era → CardanoEraStyle era → Ordering Source # (<) ∷ CardanoEraStyle era → CardanoEraStyle era → Bool Source # (<=) ∷ CardanoEraStyle era → CardanoEraStyle era → Bool Source # (>) ∷ CardanoEraStyle era → CardanoEraStyle era → Bool Source # (>=) ∷ CardanoEraStyle era → CardanoEraStyle era → Bool Source # max ∷ CardanoEraStyle era → CardanoEraStyle era → CardanoEraStyle era Source # min ∷ CardanoEraStyle era → CardanoEraStyle era → CardanoEraStyle era Source # | |
cardanoEraStyle ∷ CardanoEra era → CardanoEraStyle era Source #
The CardanoEraStyle for a CardanoEra.
shelleyBasedToCardanoEra ∷ ShelleyBasedEra era → CardanoEra era Source #
Converts a ShelleyBasedEra to the broader CardanoEra.
Deprecated
type Shelley = ShelleyEra Source #
Deprecated: Use ShelleyEra or ShelleyAddr as appropriate
type Allegra = AllegraEra Source #
Deprecated: Use AllegraEra instead
Type tags
class HasTypeProxy t where Source #
Associated Types
A family of singleton types used in this API to indicate which type to use where it would otherwise be ambiguous or merely unclear.
Values of this type are passed to deserialisation functions for example.
Methods
proxyToAsType ∷ Proxy t → AsType t Source #
Instances
Cryptographic key interface
class (Eq (VerificationKey keyrole), Show (VerificationKey keyrole), SerialiseAsRawBytes (Hash keyrole), HasTextEnvelope (VerificationKey keyrole), HasTextEnvelope (SigningKey keyrole)) ⇒ Key keyrole where Source #
An interface for cryptographic keys used for signatures with a SigningKey
and a VerificationKey key.
This interface does not provide actual signing or verifying functions since this API is concerned with the management of keys: generating and serialising.
Associated Types
data VerificationKey keyrole ∷ Type Source #
The type of cryptographic verification key, for each key role.
data SigningKey keyrole ∷ Type Source #
The type of cryptographic signing key, for each key role.
Methods
getVerificationKey ∷ SigningKey keyrole → VerificationKey keyrole Source #
Get the corresponding verification key from a signing key.
deterministicSigningKey ∷ AsType keyrole → Seed → SigningKey keyrole Source #
Generate a SigningKey deterministically, given a Seed. The
required size of the seed is given by deterministicSigningKeySeedSize.
deterministicSigningKeySeedSize ∷ AsType keyrole → Word Source #
verificationKeyHash ∷ VerificationKey keyrole → Hash keyrole Source #
Instances
castVerificationKey ∷ CastVerificationKeyRole keyroleA keyroleB ⇒ VerificationKey keyroleA → VerificationKey keyroleB Source #
Change the role of a VerificationKey, if the representation permits.
castSigningKey ∷ CastSigningKeyRole keyroleA keyroleB ⇒ SigningKey keyroleA → SigningKey keyroleB Source #
Change the role of a SigningKey, if the representation permits.
generateSigningKey ∷ Key keyrole ⇒ AsType keyrole → IO (SigningKey keyrole) Source #
Generate a SigningKey using a seed from operating system entropy.
generateInsecureSigningKey ∷ (Key keyrole, SerialiseAsRawBytes (SigningKey keyrole)) ⇒ StdGen → AsType keyrole → IO (SigningKey keyrole, StdGen) Source #
Hashes
In Cardano most keys are identified by their hash, and hashes are used in many other places.
data family Hash keyrole ∷ Type Source #
Instances
Payment addresses
Constructing and inspecting normal payment addresses
data Address addrtype Source #
Addresses are used as locations where assets live. The address determines the rights needed to spend assets at the address: in particular holding some signing key or being able to satisfy the conditions of a script.
There are currently two types of address:
- Byron addresses, which use the type tag
ByronAddr; and - Shelley addresses, which use the type tag
ShelleyAddr. Notably, Shelley addresses support scripts and stake delegation.
The address type is subtly from the ledger era in which each
address type is valid: while Byron addresses are the only choice in the
Byron era, the Shelley era and all subsequent eras support both Byron and
Shelley addresses. The Address type param only says the type of the address
(either Byron or Shelley). The AddressInEra type connects the address type
with the era in which it is supported.