| Safe Haskell | None |
|---|---|
| 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
- Script languages
- Scripts in a specific language
- Scripts in any language
- Scripts in a specific era
- Use of a script in an era as a witness
-
Inspecting
ScriptWitnesses - Languages supported in each era
- Simple scripts
- Plutus scripts
- Script data
- Validation
- Conversion to/from JSON
- Script execution units
- Script addresses
- Serialisation
- Errors
- Node interaction
- Node operation
- Genesis file
- Special transactions
- Protocol parameter updates
- 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 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
- shelleyBasedEra :: ShelleyBasedEra era
-
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)
- data family Hash keyrole :: Type
- castHash :: CastHash roleA roleB => Hash roleA -> Hash roleB
- data Address addrtype
- data ByronAddr
- data ShelleyAddr
-
data
NetworkId
- = Mainnet
- | Testnet ! NetworkMagic
- makeByronAddress :: NetworkId -> VerificationKey ByronKey -> Address ByronAddr
- data ByronKey
- data ByronKeyLegacy
- makeShelleyAddress :: NetworkId -> PaymentCredential -> StakeAddressReference -> Address ShelleyAddr
- data PaymentCredential
- newtype StakeAddressPointer = StakeAddressPointer { }
- data StakeAddressReference
- data PaymentKey
- data PaymentExtendedKey
-
data
AddressAny
- = AddressByron !( Address ByronAddr )
- | AddressShelley !( Address ShelleyAddr )
- 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
- ByronAddressInAnyEra :: AddressTypeInEra ByronAddr era
- ShelleyAddressInEra :: ShelleyBasedEra era -> AddressTypeInEra ShelleyAddr era
- byronAddressInEra :: Address ByronAddr -> AddressInEra era
- shelleyAddressInEra :: IsShelleyBasedEra era => Address ShelleyAddr -> AddressInEra era
- anyAddressInShelleyBasedEra :: IsShelleyBasedEra era => AddressAny -> AddressInEra era
- anyAddressInEra :: CardanoEra era -> AddressAny -> Maybe ( 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
- 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
- = AdaAssetId
- | AssetId ! PolicyId ! AssetName
- 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 :: forall era. Block era -> BlockHeader
-
data
ChainPoint
- = ChainPointAtGenesis
- | ChainPoint ! SlotNo !( Hash BlockHeader )
- newtype EpochNo = EpochNo { }
-
data
ChainTip
- = ChainTipAtGenesis
- | ChainTip ! SlotNo !( Hash BlockHeader ) ! BlockNo
- newtype BlockNo = BlockNo { }
- chainTipToChainPoint :: ChainTip -> ChainPoint
-
data
TxBody
era
where
- pattern TxBody :: TxBodyContent ViewTx era -> TxBody era
- makeTransactionBody :: forall 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
- = TxBodyEmptyTxIns
- | TxBodyEmptyTxInsCollateral
- | TxBodyEmptyTxOuts
- | TxBodyOutputNegative Quantity TxOutInAnyEra
- | TxBodyOutputOverflow Quantity TxOutInAnyEra
- | TxBodyMetadataError [( Word64 , TxMetadataRangeError )]
- | TxBodyMintAdaError
- | TxBodyMissingProtocolParams
- | TxBodyInIxOverflow TxIn
-
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 :: forall era. TxBody era -> TxId
- data TxIn = TxIn TxId TxIx
- 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 -> ScriptData -> TxOutDatum ctx era
- pattern TxOutDatumInTx :: ScriptDataSupportedInEra era -> ScriptData -> 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
- TxTotalCollateralNone :: TxTotalCollateral era
- TxTotalCollateral :: TxTotalAndReturnCollateralSupportedInEra era -> Lovelace -> TxTotalCollateral era
-
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
- TxExtraKeyWitnessesNone :: TxExtraKeyWitnesses era
- TxExtraKeyWitnesses :: TxExtraKeyWitnessesSupportedInEra era -> [ Hash PaymentKey ] -> TxExtraKeyWitnesses era
-
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
- TxUpdateProposalNone :: TxUpdateProposal era
- TxUpdateProposal :: UpdateProposalSupportedInEra era -> UpdateProposal -> TxUpdateProposal era
-
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
- data TxFeesImplicitInEra era where
-
data
ValidityUpperBoundSupportedInEra
era
where
- ValidityUpperBoundInShelleyEra :: ValidityUpperBoundSupportedInEra ShelleyEra
- ValidityUpperBoundInAllegraEra :: ValidityUpperBoundSupportedInEra AllegraEra
- ValidityUpperBoundInMaryEra :: ValidityUpperBoundSupportedInEra MaryEra
- ValidityUpperBoundInAlonzoEra :: ValidityUpperBoundSupportedInEra AlonzoEra
- ValidityUpperBoundInBabbageEra :: ValidityUpperBoundSupportedInEra BabbageEra
-
data
ValidityNoUpperBoundSupportedInEra
era
where
- ValidityNoUpperBoundInByronEra :: ValidityNoUpperBoundSupportedInEra ByronEra
- ValidityNoUpperBoundInAllegraEra :: ValidityNoUpperBoundSupportedInEra AllegraEra
- ValidityNoUpperBoundInMaryEra :: ValidityNoUpperBoundSupportedInEra MaryEra
- ValidityNoUpperBoundInAlonzoEra :: ValidityNoUpperBoundSupportedInEra AlonzoEra
- ValidityNoUpperBoundInBabbageEra :: ValidityNoUpperBoundSupportedInEra BabbageEra
-
data
ValidityLowerBoundSupportedInEra
era
where
- ValidityLowerBoundInAllegraEra :: ValidityLowerBoundSupportedInEra AllegraEra
- ValidityLowerBoundInMaryEra :: ValidityLowerBoundSupportedInEra MaryEra
- ValidityLowerBoundInAlonzoEra :: ValidityLowerBoundSupportedInEra AlonzoEra
- ValidityLowerBoundInBabbageEra :: ValidityLowerBoundSupportedInEra BabbageEra
-
data
TxMetadataSupportedInEra
era
where
- TxMetadataInShelleyEra :: TxMetadataSupportedInEra ShelleyEra
- TxMetadataInAllegraEra :: TxMetadataSupportedInEra AllegraEra
- TxMetadataInMaryEra :: TxMetadataSupportedInEra MaryEra
- TxMetadataInAlonzoEra :: TxMetadataSupportedInEra AlonzoEra
- TxMetadataInBabbageEra :: TxMetadataSupportedInEra BabbageEra
- 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
-
data
CertificatesSupportedInEra
era
where
- CertificatesInShelleyEra :: CertificatesSupportedInEra ShelleyEra
- CertificatesInAllegraEra :: CertificatesSupportedInEra AllegraEra
- CertificatesInMaryEra :: CertificatesSupportedInEra MaryEra
- CertificatesInAlonzoEra :: CertificatesSupportedInEra AlonzoEra
- CertificatesInBabbageEra :: CertificatesSupportedInEra BabbageEra
-
data
UpdateProposalSupportedInEra
era
where
- UpdateProposalInShelleyEra :: UpdateProposalSupportedInEra ShelleyEra
- UpdateProposalInAllegraEra :: UpdateProposalSupportedInEra AllegraEra
- UpdateProposalInMaryEra :: UpdateProposalSupportedInEra MaryEra
- UpdateProposalInAlonzoEra :: UpdateProposalSupportedInEra AlonzoEra
- UpdateProposalInBabbageEra :: UpdateProposalSupportedInEra BabbageEra
- 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)
- transactionFee :: forall era. IsShelleyBasedEra era => Natural -> Natural -> Tx era -> Lovelace
- toLedgerEpochInfo :: EraHistory mode -> EpochInfo ( Either Text )
- estimateTransactionFee :: forall era. IsShelleyBasedEra era => NetworkId -> Natural -> Natural -> Tx era -> Int -> Int -> Int -> Int -> Lovelace
- evaluateTransactionFee :: forall era. IsShelleyBasedEra era => ProtocolParameters -> TxBody era -> Word -> Word -> Lovelace
- estimateTransactionKeyWitnessCount :: TxBodyContent BuildTx era -> Word
- calculateMinimumUTxO :: ShelleyBasedEra era -> TxOut CtxTx era -> ProtocolParameters -> Either MinimumUTxOError Value
- data MinimumUTxOError
- evaluateTransactionExecutionUnits :: forall era mode. EraInMode era mode -> SystemStart -> EraHistory mode -> ProtocolParameters -> 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
- evaluateTransactionBalance :: forall era. IsShelleyBasedEra era => ProtocolParameters -> Set PoolId -> UTxO era -> TxBody era -> TxOutValue era
- makeTransactionBodyAutoBalance :: forall era mode. IsShelleyBasedEra era => EraInMode era mode -> SystemStart -> EraHistory mode -> ProtocolParameters -> Set PoolId -> UTxO era -> TxBodyContent BuildTx era -> AddressInEra era -> Maybe Word -> Either TxBodyErrorAutoBalance ( BalancedTxBody era)
- data BalancedTxBody era = BalancedTxBody ( 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
- TxScriptValidityNone :: TxScriptValidity era
- TxScriptValidity :: TxScriptValiditySupportedInEra era -> ScriptValidity -> TxScriptValidity era
- data ScriptValidity
- data TxScriptValiditySupportedInEra era where
- scriptValidityToTxScriptValidity :: ShelleyBasedEra era -> ScriptValidity -> TxScriptValidity era
- txScriptValiditySupportedInShelleyBasedEra :: ShelleyBasedEra era -> Maybe ( TxScriptValiditySupportedInEra era)
- txScriptValiditySupportedInCardanoEra :: CardanoEra era -> Maybe ( TxScriptValiditySupportedInEra era)
-
data
Tx
era
where
- pattern Tx :: TxBody era -> [ KeyWitness era] -> Tx era
- getTxBody :: forall era. Tx era -> TxBody era
- getTxWitnesses :: forall era. Tx era -> [ KeyWitness era]
- signByronTransaction :: NetworkId -> TxBody ByronEra -> [ SigningKey ByronKey ] -> Tx ByronEra
- signShelleyTransaction :: IsShelleyBasedEra era => TxBody era -> [ ShelleyWitnessSigningKey ] -> Tx era
- makeSignedTransaction :: forall era. [ KeyWitness era] -> TxBody era -> Tx era
- data KeyWitness era
- makeByronKeyWitness :: forall 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 :: forall era. IsShelleyBasedEra era => TxBody era -> ShelleyWitnessSigningKey -> KeyWitness era
- makeShelleyBootstrapWitness :: forall era. IsShelleyBasedEra era => WitnessNetworkIdOrByronAddress -> TxBody era -> SigningKey ByronKey -> KeyWitness era
- newtype TxMetadata = TxMetadata ( Map Word64 TxMetadataValue )
-
data
TxMetadataValue
- = TxMetaMap [( TxMetadataValue , TxMetadataValue )]
- | TxMetaList [ TxMetadataValue ]
- | TxMetaNumber Integer
- | TxMetaBytes ByteString
- | TxMetaText Text
- 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
-
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 SimpleScriptV1
- data SimpleScriptV2
- data PlutusScriptV1
- data PlutusScriptV2
-
data
ScriptLanguage
lang
where
- SimpleScriptLanguage :: SimpleScriptVersion lang -> ScriptLanguage lang
- PlutusScriptLanguage :: PlutusScriptVersion lang -> ScriptLanguage lang
- data SimpleScriptVersion lang where
- data PlutusScriptVersion lang where
-
data
AnyScriptLanguage
where
- AnyScriptLanguage :: ScriptLanguage lang -> AnyScriptLanguage
- data AnyPlutusScriptVersion where
-
class
HasTypeProxy
lang =>
IsScriptLanguage
lang
where
- scriptLanguage :: ScriptLanguage lang
- class IsScriptLanguage lang => IsSimpleScriptLanguage lang where
-
data
Script
lang
where
- SimpleScript :: !( SimpleScriptVersion lang) -> !( SimpleScript lang) -> Script lang
- 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 lang era -> SimpleScriptVersion lang -> SimpleScriptOrReferenceInput lang -> 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
- data ScriptDatum witctx where
- type ScriptRedeemer = ScriptData
- scriptWitnessScript :: ScriptWitness witctx era -> Maybe ( ScriptInEra era)
-
data
AnyScriptWitness
era
where
- AnyScriptWitness :: ScriptWitness witctx era -> AnyScriptWitness era
- data ScriptWitnessIndex
- renderScriptWitnessIndex :: ScriptWitnessIndex -> String
- collectTxBodyScriptWitnesses :: forall era. TxBodyContent BuildTx era -> [( ScriptWitnessIndex , AnyScriptWitness era)]
- mapTxScriptWitnesses :: forall era. ( forall witctx. ScriptWitnessIndex -> ScriptWitness witctx era -> Either TxBodyErrorAutoBalance ( ScriptWitness witctx era)) -> TxBodyContent BuildTx era -> Either TxBodyErrorAutoBalance ( TxBodyContent BuildTx era)
-
data
ScriptLanguageInEra
lang era
where
- SimpleScriptV1InShelley :: ScriptLanguageInEra SimpleScriptV1 ShelleyEra
- SimpleScriptV1InAllegra :: ScriptLanguageInEra SimpleScriptV1 AllegraEra
- SimpleScriptV1InMary :: ScriptLanguageInEra SimpleScriptV1 MaryEra
- SimpleScriptV1InAlonzo :: ScriptLanguageInEra SimpleScriptV1 AlonzoEra
- SimpleScriptV1InBabbage :: ScriptLanguageInEra SimpleScriptV1 BabbageEra
- SimpleScriptV2InAllegra :: ScriptLanguageInEra SimpleScriptV2 AllegraEra
- SimpleScriptV2InMary :: ScriptLanguageInEra SimpleScriptV2 MaryEra
- SimpleScriptV2InAlonzo :: ScriptLanguageInEra SimpleScriptV2 AlonzoEra
- SimpleScriptV2InBabbage :: ScriptLanguageInEra SimpleScriptV2 BabbageEra
- PlutusScriptV1InAlonzo :: ScriptLanguageInEra PlutusScriptV1 AlonzoEra
- PlutusScriptV1InBabbage :: ScriptLanguageInEra PlutusScriptV1 BabbageEra
- PlutusScriptV2InBabbage :: ScriptLanguageInEra PlutusScriptV2 BabbageEra
- scriptLanguageSupportedInEra :: CardanoEra era -> ScriptLanguage lang -> Maybe ( ScriptLanguageInEra lang era)
- languageOfScriptLanguageInEra :: ScriptLanguageInEra lang era -> ScriptLanguage lang
- eraOfScriptLanguageInEra :: ScriptLanguageInEra lang era -> ShelleyBasedEra era
-
data
SimpleScript
lang
where
- RequireSignature :: !( Hash PaymentKey ) -> SimpleScript lang
- RequireTimeBefore :: !( TimeLocksSupported lang) -> ! SlotNo -> SimpleScript lang
- RequireTimeAfter :: !( TimeLocksSupported lang) -> ! SlotNo -> SimpleScript lang
- RequireAllOf :: [ SimpleScript lang] -> SimpleScript lang
- RequireAnyOf :: [ SimpleScript lang] -> SimpleScript lang
- RequireMOf :: Int -> [ SimpleScript lang] -> SimpleScript lang
- data TimeLocksSupported lang where
- timeLocksSupported :: SimpleScriptVersion lang -> Maybe ( TimeLocksSupported lang)
- adjustSimpleScriptVersion :: SimpleScriptVersion lang' -> SimpleScript lang -> Maybe ( SimpleScript lang')
- data PlutusScript lang
- examplePlutusScriptAlwaysSucceeds :: WitCtx witctx -> PlutusScript PlutusScriptV1
- examplePlutusScriptAlwaysFails :: WitCtx witctx -> PlutusScript PlutusScriptV1
-
data
ScriptData
- = ScriptDataConstructor Integer [ ScriptData ]
- | ScriptDataMap [( ScriptData , ScriptData )]
- | ScriptDataList [ ScriptData ]
- | ScriptDataNumber Integer
- | ScriptDataBytes ByteString
- hashScriptData :: ScriptData -> Hash ScriptData
- data ScriptDataRangeError
- validateScriptData :: ScriptData -> Either ScriptDataRangeError ()
- data ScriptDataJsonSchema
- scriptDataFromJson :: ScriptDataJsonSchema -> Value -> Either ScriptDataJsonError ScriptData
- scriptDataToJson :: ScriptDataJsonSchema -> ScriptData -> Value
- data ScriptDataJsonError
- data ScriptDataJsonSchemaError
- data ExecutionUnits = ExecutionUnits { }
- data ExecutionUnitPrices = ExecutionUnitPrices { }
- newtype CostModel = CostModel ( Map Text Integer )
- validateCostModel :: PlutusScriptVersion lang -> CostModel -> Either InvalidCostModel ()
- data ScriptHash
- hashScript :: Script lang -> ScriptHash
- 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 :: forall b. [ FromSomeType SerialiseAsBech32 b] -> Text -> Either Bech32DecodeError b
- data Bech32DecodeError
- class HasTypeProxy addr => SerialiseAddress addr
- serialiseAddress :: SerialiseAddress addr => addr -> Text
- deserialiseAddress :: SerialiseAddress addr => AsType addr -> Text -> Maybe addr
- class HasTypeProxy a => SerialiseAsRawBytes a
- serialiseToRawBytes :: SerialiseAsRawBytes a => a -> ByteString
- deserialiseFromRawBytes :: SerialiseAsRawBytes a => AsType a -> ByteString -> Maybe a
- serialiseToRawBytesHex :: SerialiseAsRawBytes a => a -> ByteString
- deserialiseFromRawBytesHex :: SerialiseAsRawBytes a => AsType a -> ByteString -> Either RawBytesHexError a
- serialiseToRawBytesHexText :: SerialiseAsRawBytes a => a -> Text
-
class
SerialiseAsCBOR
a =>
HasTextEnvelope
a
where
- textEnvelopeType :: AsType a -> TextEnvelopeType
- textEnvelopeDefaultDescr :: a -> TextEnvelopeDescr
-
data
TextEnvelope
=
TextEnvelope
{
- teType :: ! TextEnvelopeType
- teDescription :: ! TextEnvelopeDescr
- teRawCBOR :: ! ByteString
- newtype TextEnvelopeType = TextEnvelopeType String
- data TextEnvelopeDescr
- data TextEnvelopeError
- textEnvelopeRawCBOR :: TextEnvelope -> ByteString
- serialiseToTextEnvelope :: forall 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)
- writeTxFileTextEnvelopeCddl :: IsCardanoEra era => FilePath -> Tx era -> IO ( Either ( FileError ()) ())
- writeTxWitnessFileTextEnvelopeCddl :: ShelleyBasedEra era -> FilePath -> KeyWitness era -> IO ( Either ( FileError ()) ())
- serialiseTxLedgerCddl :: forall era. IsCardanoEra era => Tx era -> TextEnvelopeCddl
- deserialiseTxLedgerCddl :: IsCardanoEra era => CardanoEra era -> TextEnvelopeCddl -> Either TextEnvelopeCddlError ( Tx era)
- serialiseWitnessLedgerCddl :: forall era. ShelleyBasedEra era -> KeyWitness era -> TextEnvelopeCddl
- deserialiseWitnessLedgerCddl :: ShelleyBasedEra era -> TextEnvelopeCddl -> Either TextEnvelopeCddlError ( KeyWitness era)
- data TextEnvelopeCddlError
-
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 { }
- envSecurityParam :: Env -> Word64
-
newtype
LedgerState
where
- LedgerState { }
- pattern LedgerStateAlonzo :: LedgerState ( ShelleyBlock protocol ( AlonzoEra StandardCrypto )) -> LedgerState
- pattern LedgerStateMary :: LedgerState ( ShelleyBlock protocol ( MaryEra StandardCrypto )) -> LedgerState
- pattern LedgerStateAllegra :: LedgerState ( ShelleyBlock protocol ( AllegraEra StandardCrypto )) -> LedgerState
- pattern LedgerStateShelley :: LedgerState ( ShelleyBlock protocol ( ShelleyEra StandardCrypto )) -> LedgerState
- pattern LedgerStateByron :: LedgerState ByronBlock -> LedgerState
- initialLedgerState :: FilePath -> ExceptT InitialLedgerStateError IO ( Env , 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
- data MIRDistributionDetails = MIRDistributionDetails { }
-
data
PoolReapDetails
=
PoolReapDetails
{
- prdEpochNo :: EpochNo
- prdRefunded :: Map StakeCredential ( Map ( Hash StakePoolKey ) Lovelace )
- prdUnclaimed :: Map StakeCredential ( Map ( Hash StakePoolKey ) Lovelace )
- toLedgerEvent :: ConvertLedgerEvent blk => WrapLedgerEvent blk -> Maybe LedgerEvent
- foldBlocks :: forall a. FilePath -> FilePath -> ValidationMode -> a -> ( Env -> LedgerState -> [ LedgerEvent ] -> BlockInMode CardanoMode -> a -> IO a) -> ExceptT FoldBlocksError IO a
- chainSyncClientWithLedgerState :: forall 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 :: forall 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
- data FoldBlocksError
-
data
GenesisConfigError
- = NEError ! Text
- | NEByronConfig ! FilePath ! ConfigurationError
- | NEShelleyConfig ! FilePath ! Text
- | NEAlonzoConfig ! 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
- AnyConsensusMode :: ConsensusMode mode -> AnyConsensusMode
- 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
- 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 :: forall 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
-
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
) 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
- TxInMode :: Tx era -> EraInMode era mode -> TxInMode mode
- TxInByronSpecial :: GenTx ByronBlock -> EraInMode ByronEra mode -> TxInMode mode
-
data
TxValidationErrorInMode
mode
where
- TxValidationErrorInMode :: TxValidationError era -> EraInMode era mode -> TxValidationErrorInMode mode
- TxValidationEraMismatch :: EraMismatch -> TxValidationErrorInMode mode
- runLocalTxSubmissionClient :: LocalTxSubmissionClient tx reject m a -> m ( LocalTxClientStIdle tx reject m a)
- submitTxToNodeLocal :: forall 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)
-
data
QueryUTxOFilter
- = QueryUTxOWhole
- | QueryUTxOByAddress ( Set AddressAny )
- | QueryUTxOByTxIn ( Set TxIn )
- newtype UTxO era = UTxO { }
- queryNodeLocalState :: forall 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)
-
newtype
LocalTxMonitorClient
txid tx slot (m ::
Type
->
Type
) a =
LocalTxMonitorClient
{
- runLocalTxMonitorClient :: m ( ClientStIdle txid tx slot m a)
-
data
LocalTxMonitoringQuery
mode
- = LocalTxMonitoringQueryTx (TxIdInMode mode)
- | LocalTxMonitoringSendNextTx
- | LocalTxMonitoringMempoolInformation
- data LocalTxMonitoringResult mode
-
data
MempoolSizeAndCapacity
=
MempoolSizeAndCapacity
{
- capacityInBytes :: ! Word32
- sizeInBytes :: ! Word32
- numberOfTxs :: ! Word32
- queryTxMonitoringLocal :: forall mode. LocalNodeConnectInfo mode -> LocalTxMonitoringQuery mode -> IO ( LocalTxMonitoringResult 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 { }
- 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 :: forall 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 -> ( NodeToClientVersion -> LocalStateQueryExpr ( BlockInMode mode) ChainPoint ( QueryInMode mode) () IO a) -> IO ( Either AcquiringFailure a)
- queryExpr :: QueryInMode mode a -> LocalStateQueryExpr block point ( QueryInMode mode) r IO a
- determineEraExpr :: ConsensusModeParams mode -> LocalStateQueryExpr block point ( QueryInMode mode) r IO 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
=
forall
fromEra toEra value.(
IsCardanoEra
fromEra,
IsCardanoEra
toEra,
Show
value) =>
EraCastError
{
- originalValue :: value
- fromEra :: CardanoEra fromEra
- toEra :: CardanoEra toEra
- constructBalancedTx :: IsShelleyBasedEra era => EraInMode era CardanoMode -> TxBodyContent BuildTx era -> AddressInEra era -> Maybe Word -> UTxO era -> ProtocolParameters -> EraHistory CardanoMode -> 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
- renderNotScriptLockedTxInsError :: ScriptLockedTxInsError -> Text
- renderTxInsExistError :: TxInsExistError -> Text
- txInsExistInUTxO :: [ TxIn ] -> UTxO era -> Either TxInsExistError ()
- notScriptLockedTxIns :: [ TxIn ] -> UTxO era -> Either ScriptLockedTxInsError ()
- textShow :: Show a => a -> Text
Eras
A type used as a tag to distinguish the Byron era.
Instances
| HasTypeProxy ByronEra Source # | |
| IsCardanoEra ByronEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| FromJSON ( EraInMode ByronEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes |
|
| FromJSON ( EraInMode ByronEra ByronMode ) Source # | |
| data AsType ByronEra Source # | |
|
Defined in Cardano.Api.Eras |
|
data ShelleyEra Source #
A type used as a tag to distinguish the Shelley era.
Instances
| HasTypeProxy ShelleyEra Source # | |
|
Defined in Cardano.Api.Eras Associated Types data AsType ShelleyEra Source # Methods proxyToAsType :: Proxy ShelleyEra -> AsType ShelleyEra Source # |
|
| IsShelleyBasedEra ShelleyEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra ShelleyEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| FromJSON ( EraInMode ShelleyEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes Methods parseJSON :: Value -> Parser ( EraInMode ShelleyEra CardanoMode ) Source # parseJSONList :: Value -> Parser [ EraInMode ShelleyEra CardanoMode ] Source # |
|
| FromJSON ( EraInMode ShelleyEra ShelleyMode ) Source # | |
|
Defined in Cardano.Api.Modes Methods parseJSON :: Value -> Parser ( EraInMode ShelleyEra ShelleyMode ) Source # parseJSONList :: Value -> Parser [ EraInMode ShelleyEra ShelleyMode ] Source # |
|
| data AsType ShelleyEra Source # | |
|
Defined in Cardano.Api.Eras |
|
data AllegraEra Source #
A type used as a tag to distinguish the Allegra era.
Instances
| HasTypeProxy AllegraEra Source # | |
|
Defined in Cardano.Api.Eras Associated Types data AsType AllegraEra Source # Methods proxyToAsType :: Proxy AllegraEra -> AsType AllegraEra Source # |
|
| IsShelleyBasedEra AllegraEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra AllegraEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| FromJSON ( EraInMode AllegraEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes Methods parseJSON :: Value -> Parser ( EraInMode AllegraEra CardanoMode ) Source # parseJSONList :: Value -> Parser [ EraInMode AllegraEra CardanoMode ] Source # |
|
| data AsType AllegraEra Source # | |
|
Defined in Cardano.Api.Eras |
|
A type used as a tag to distinguish the Mary era.
Instances
| HasTypeProxy MaryEra Source # | |
| IsShelleyBasedEra MaryEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra MaryEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| FromJSON ( EraInMode MaryEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes |
|
| data AsType MaryEra Source # | |
|
Defined in Cardano.Api.Eras |
|
A type used as a tag to distinguish the Alonzo era.
Instances
| HasTypeProxy AlonzoEra Source # | |
| IsShelleyBasedEra AlonzoEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra AlonzoEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| FromJSON ( EraInMode AlonzoEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes |
|
| data AsType AlonzoEra Source # | |
|
Defined in Cardano.Api.Eras |
|
data BabbageEra Source #
A type used as a tag to distinguish the Babbage era.
Instances
| HasTypeProxy BabbageEra Source # | |
|
Defined in Cardano.Api.Eras Associated Types data AsType BabbageEra Source # Methods proxyToAsType :: Proxy BabbageEra -> AsType BabbageEra Source # |
|
| IsShelleyBasedEra BabbageEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra BabbageEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| data AsType BabbageEra 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 BabbageEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra AlonzoEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra MaryEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra AllegraEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra ShelleyEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsCardanoEra ByronEra 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
| Eq ( InAnyCardanoEra Tx ) Source # | |
|
Defined in Cardano.Api.Tx Methods (==) :: InAnyCardanoEra Tx -> InAnyCardanoEra Tx -> Bool Source # (/=) :: InAnyCardanoEra Tx -> InAnyCardanoEra Tx -> Bool Source # |
|
| Show ( InAnyCardanoEra Tx ) Source # | |
|
Defined in Cardano.Api.Tx |
|
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
| 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 # |
|
| Show ( ShelleyBasedEra era) Source # | |
|
Defined in Cardano.Api.Eras |
|
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
shelleyBasedEra :: ShelleyBasedEra era Source #
Instances
| IsShelleyBasedEra BabbageEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsShelleyBasedEra AlonzoEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsShelleyBasedEra MaryEra Source # | |
|
Defined in Cardano.Api.Eras Methods |
|
| IsShelleyBasedEra AllegraEra 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
| 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 # |
|
| Show ( CardanoEraStyle era) Source # | |
|
Defined in Cardano.Api.Eras |
|
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.
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.
Instances
A type used as a tag to distinguish Byron addresses.
Instances
| HasTypeProxy ByronAddr Source # | |
| SerialiseAsRawBytes ( Address ByronAddr ) Source # | |
|
Defined in Cardano.Api.Address Methods serialiseToRawBytes :: Address ByronAddr -> ByteString Source # deserialiseFromRawBytes :: AsType ( Address ByronAddr ) -> ByteString -> Maybe ( Address ByronAddr ) Source # |
|
| SerialiseAddress ( Address ByronAddr ) Source # | |
| data AsType ByronAddr Source # | |
|
Defined in Cardano.Api.Address |
|
data ShelleyAddr Source #
A type used as a tag to distinguish Shelley addresses.
Instances
| HasTypeProxy ShelleyAddr Source # | |
|
Defined in Cardano.Api.Address Associated Types data AsType ShelleyAddr Source # Methods proxyToAsType :: Proxy ShelleyAddr -> AsType ShelleyAddr Source # |
|
| SerialiseAsRawBytes ( Address ShelleyAddr ) Source # | |
|
Defined in Cardano.Api.Address Methods serialiseToRawBytes :: Address ShelleyAddr -> ByteString Source # deserialiseFromRawBytes :: AsType ( Address ShelleyAddr ) -> ByteString -> Maybe ( Address ShelleyAddr ) Source # |
|
| SerialiseAsBech32 ( Address ShelleyAddr ) Source # | |
|
Defined in Cardano.Api.Address Methods bech32PrefixFor :: Address ShelleyAddr -> Text bech32PrefixesPermitted :: AsType ( Address ShelleyAddr ) -> [ Text ] |
|
| SerialiseAddress ( Address ShelleyAddr ) Source # | |
|
Defined in Cardano.Api.Address Methods serialiseAddress :: Address ShelleyAddr -> Text Source # deserialiseAddress :: AsType ( Address ShelleyAddr ) -> Text -> Maybe ( Address ShelleyAddr ) Source # |
|
| data AsType ShelleyAddr Source # | |
|
Defined in Cardano.Api.Address |
|
Byron addresses
Byron-era payment keys. Used for Byron addresses and witnessing transactions that spend from these addresses.
These use Ed25519 but with a 32byte "chaincode" used in HD derivation.
The inclusion of the chaincode is a design mistake but one that cannot
be corrected for the Byron era. The Shelley era
PaymentKey
s do not include
a chaincode. It is safe to use a zero or random chaincode for new Byron keys.
This is a type level tag, used with other interfaces like
Key
.
Instances
data ByronKeyLegacy Source #
Instances
Shelley addresses
makeShelleyAddress :: NetworkId -> PaymentCredential -> StakeAddressReference -> Address ShelleyAddr Source #
data PaymentCredential Source #
Constructors
| PaymentCredentialByKey ( Hash PaymentKey ) | |
| PaymentCredentialByScript ScriptHash |
Instances
| Eq PaymentCredential Source # | |
|
Defined in Cardano.Api.Address Methods (==) :: PaymentCredential -> PaymentCredential -> Bool Source # (/=) :: PaymentCredential -> PaymentCredential -> Bool Source # |
|
| Ord PaymentCredential Source # | |
|
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 # |
|
| Show PaymentCredential Source # | |
|
Defined in Cardano.Api.Address |
|
newtype StakeAddressPointer Source #
Constructors
| StakeAddressPointer | |
|
Fields |
|
Instances
| Eq StakeAddressPointer Source # | |
|
Defined in Cardano.Api.Address Methods (==) :: StakeAddressPointer -> StakeAddressPointer -> Bool Source # (/=) :: StakeAddressPointer -> StakeAddressPointer -> Bool Source # |
|
| Show StakeAddressPointer Source # | |
|
Defined in Cardano.Api.Address |
|
data StakeAddressReference Source #
Constructors
| StakeAddressByValue StakeCredential | |
| StakeAddressByPointer StakeAddressPointer | |
| NoStakeAddress |
Instances
| Eq StakeAddressReference Source # | |
|
Defined in Cardano.Api.Address Methods (==) :: StakeAddressReference -> StakeAddressReference -> Bool Source # (/=) :: StakeAddressReference -> StakeAddressReference -> Bool Source # |
|
| Show StakeAddressReference Source # | |
|
Defined in Cardano.Api.Address |
|
data PaymentKey Source #
Shelley-era payment keys. Used for Shelley payment addresses and witnessing transactions that spend from these addresses.
This is a type level tag, used with other interfaces like
Key
.
Instances
data PaymentExtendedKey Source #
Shelley-era payment keys using extended ed25519 cryptographic keys.
They can be used for Shelley payment addresses and witnessing transactions that spend from these addresses.
These extended keys are used by HD wallets. So this type provides interoperability with HD wallets. The ITN CLI also supported this key type.
The extended verification keys can be converted (via
castVerificationKey
)
to ordinary keys (i.e.
VerificationKey
PaymentKey
) but this is
not
the
case for the signing keys. The signing keys can be used to witness
transactions directly, with verification via their non-extended verification
key (
VerificationKey
PaymentKey
).
This is a type level tag, used with other interfaces like
Key
.
Instances
Addresses in any era
data AddressAny Source #
Either a Byron address or a Shelley address.
Sometimes we need to be able to work with either of the two types of address (Byron or Shelley addresses), but without reference to an era in which the address will be used. This type serves that purpose.
Constructors
| AddressByron !( Address ByronAddr ) | |
| AddressShelley !( Address ShelleyAddr ) |
Instances
Addresses in specific eras
data AddressInEra era where Source #
An
Address
that can be used in a particular ledger era.
All current ledger eras support Byron addresses. Shelley addresses are
supported in the
ShelleyEra
and later eras.
Constructors
| AddressInEra :: AddressTypeInEra addrtype era -> Address addrtype -> AddressInEra era |
Instances
isKeyAddress :: AddressInEra era -> Bool Source #
Is the UTxO at the address only spendable via a key witness.
data AddressTypeInEra addrtype era where Source #
Constructors
| ByronAddressInAnyEra :: AddressTypeInEra ByronAddr era | |
| ShelleyAddressInEra :: ShelleyBasedEra era -> AddressTypeInEra ShelleyAddr era |
Instances
| EraCast ( AddressTypeInEra addrtype) Source # | |
|
Defined in Cardano.Api.Address Methods eraCast :: ( IsCardanoEra fromEra, IsCardanoEra toEra) => CardanoEra toEra -> AddressTypeInEra addrtype fromEra -> Either EraCastError ( AddressTypeInEra addrtype toEra) Source # |
|
| Show ( AddressTypeInEra addrtype era) Source # | |
|
Defined in Cardano.Api.Address |
|
byronAddressInEra :: Address ByronAddr -> AddressInEra era Source #
shelleyAddressInEra :: IsShelleyBasedEra era => Address ShelleyAddr -> AddressInEra era Source #
anyAddressInShelleyBasedEra :: IsShelleyBasedEra era => AddressAny -> AddressInEra era Source #
anyAddressInEra :: CardanoEra era -> AddressAny -> Maybe ( AddressInEra era) Source #
toAddressAny :: Address addr -> AddressAny Source #
makeByronAddressInEra :: NetworkId -> VerificationKey ByronKey -> AddressInEra era Source #
makeShelleyAddressInEra :: IsShelleyBasedEra era => NetworkId -> PaymentCredential -> StakeAddressReference -> AddressInEra era Source #
Stake addresses
Constructing and inspecting stake addresses
data StakeAddress Source #
Instances
data StakeCredential Source #
Instances
Instances
data StakeExtendedKey Source #
Shelley-era stake keys using extended ed25519 cryptographic keys.
They can be used for Shelley stake addresses and witnessing transactions that use stake addresses.
These extended keys are used by HD wallets. So this type provides interoperability with HD wallets. The ITN CLI also supported this key type.
The extended verification keys can be converted (via
castVerificationKey
)
to ordinary keys (i.e.
VerificationKey
StakeKey
) but this is
not
the
case for the signing keys. The signing keys can be used to witness
transactions directly, with verification via their non-extended verification
key (
VerificationKey
StakeKey
).
This is a type level tag, used with other interfaces like
Key
.
Instances
Currency values
Ada / Lovelace
Instances
Multi-asset values
Instances
| Eq Quantity Source # | |
| Num Quantity Source # | |
|
Defined in Cardano.Api.Value Methods (+) :: Quantity -> Quantity -> Quantity Source # (-) :: Quantity -> Quantity -> Quantity Source # (*) :: Quantity -> Quantity -> Quantity Source # negate :: Quantity -> Quantity Source # abs :: Quantity -> Quantity Source # signum :: Quantity -> Quantity Source # fromInteger :: Integer -> Quantity Source # |
|
| Ord Quantity Source # | |
|
Defined in Cardano.Api.Value |
|
| Show Quantity Source # | |
| Semigroup Quantity Source # | |
| Monoid Quantity Source # | |
| ToJSON Quantity Source # | |
| FromJSON Quantity Source # | |
Constructors
| PolicyId | |
|
Fields |
|
Instances
| Eq PolicyId Source # | |
| Ord PolicyId Source # | |
|
Defined in Cardano.Api.Value |
|
| Show PolicyId Source # | |
| IsString PolicyId Source # | |
|
Defined in Cardano.Api.Value Methods fromString :: String -> PolicyId Source # |
|
| ToJSON PolicyId Source # | |
| FromJSON PolicyId Source # | |
| HasTypeProxy PolicyId Source # | |
| SerialiseAsRawBytes PolicyId Source # | |
|
Defined in Cardano.Api.Value Methods serialiseToRawBytes :: PolicyId -> ByteString Source # deserialiseFromRawBytes :: AsType PolicyId -> ByteString -> Maybe PolicyId Source # |
|
| data AsType PolicyId Source # | |
|
Defined in Cardano.Api.Value |
|
scriptPolicyId :: Script lang -> PolicyId Source #
Constructors
| AssetName ByteString |
Instances
Constructors
| AdaAssetId | |
| AssetId ! PolicyId ! AssetName |
Instances
| Eq AssetId Source # | |
| Ord AssetId Source # | |
|
Defined in Cardano.Api.Value |
|
| Show AssetId Source # | |
negateValue :: Value -> Value Source #
This lets you write
a - b
as
a <> negateValue b
.
newtype ValueNestedRep Source #
Constructors
| ValueNestedRep [ ValueNestedBundle ] |
Instances
data ValueNestedBundle Source #
A bundle within a
ValueNestedRep
for a single
PolicyId
, or for the
special case of ada.
Constructors
| ValueNestedBundleAda Quantity | |
| ValueNestedBundle PolicyId ( Map AssetName Quantity ) |
Instances
| Eq ValueNestedBundle Source # | |
|
Defined in Cardano.Api.Value Methods (==) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # (/=) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # |
|
| Ord ValueNestedBundle Source # | |
|
Defined in Cardano.Api.Value Methods compare :: ValueNestedBundle -> ValueNestedBundle -> Ordering Source # (<) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # (<=) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # (>) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # (>=) :: ValueNestedBundle -> ValueNestedBundle -> Bool Source # max :: ValueNestedBundle -> ValueNestedBundle -> ValueNestedBundle Source # min :: ValueNestedBundle -> ValueNestedBundle -> ValueNestedBundle Source # |
|
| Show ValueNestedBundle Source # | |
|
Defined in Cardano.Api.Value |
|
renderValuePretty :: Value -> Text Source #
Render a "prettified" textual representation of a
Value
.
Ada / Lovelace within multi-asset values
selectLovelace :: Value -> Lovelace Source #
lovelaceToValue :: Lovelace -> Value Source #
valueToLovelace :: Value -> Maybe Lovelace Source #
Check if the
Value
consists of
only
Lovelace
and no other assets,
and if so then return the Lovelace.
See also
selectLovelace
to select the Lovelace quantity from the Value,
ignoring other assets.
Blocks
Blocks in the context of an era
A blockchain block in a particular Cardano era.
Bundled Patterns
| pattern Block :: BlockHeader -> [ Tx era] -> Block era |
A block consists of a header and a body containing transactions. |
data BlockHeader Source #
Constructors
| BlockHeader ! SlotNo !( Hash BlockHeader ) ! BlockNo |
Instances
getBlockHeader :: forall era. Block era -> BlockHeader Source #
Points on the chain
data ChainPoint Source #
Constructors
| ChainPointAtGenesis | |
| ChainPoint ! SlotNo !( Hash BlockHeader ) |
Instances
| Eq ChainPoint Source # | |
|
Defined in Cardano.Api.Block Methods (==) :: ChainPoint -> ChainPoint -> Bool Source # (/=) :: ChainPoint -> ChainPoint -> Bool Source # |
|
| Show ChainPoint Source # | |
|
Defined in Cardano.Api.Block |
|
An epoch, i.e. the number of the epoch.
Instances
| Enum EpochNo | |
|
Defined in Cardano.Slotting.Slot Methods succ :: EpochNo -> EpochNo Source # pred :: EpochNo -> EpochNo Source # toEnum :: Int -> EpochNo Source # fromEnum :: EpochNo -> Int Source # enumFrom :: EpochNo -> [ EpochNo ] Source # enumFromThen :: EpochNo -> EpochNo -> [ EpochNo ] Source # enumFromTo :: EpochNo -> EpochNo -> [ EpochNo ] Source # enumFromThenTo :: EpochNo -> EpochNo -> EpochNo -> [ EpochNo ] Source # |
|
| Eq EpochNo | |
| Num EpochNo | |
|
Defined in Cardano.Slotting.Slot |
|
| Ord EpochNo | |
|
Defined in Cardano.Slotting.Slot |
|
| Show EpochNo | |
| Generic EpochNo | |
| NFData EpochNo | |
|
Defined in Cardano.Slotting.Slot |
|
| ToJSON EpochNo | |
| FromJSON EpochNo | |
| ToCBOR EpochNo | |
| FromCBOR EpochNo | |
| NoThunks EpochNo | |
| Serialise EpochNo | |
| Condense EpochNo | |
| type Rep EpochNo | |
|
Defined in Cardano.Slotting.Slot |
|
Tip of the chain
This is like a
ChainPoint
but is conventionally used for the tip of the
chain: that is the most recent block at the end of the chain.
It also carries the
BlockNo
of the chain tip.
Constructors
| ChainTipAtGenesis | |
| ChainTip ! SlotNo !( Hash BlockHeader ) ! BlockNo |
The 0-based index of the block in the blockchain. BlockNo is <= SlotNo and is only equal at slot N if there is a block for every slot where N <= SlotNo.
Instances
| Bounded BlockNo | |
| Enum BlockNo | |
|
Defined in Cardano.Slotting.Block Methods succ :: BlockNo -> BlockNo Source # pred :: BlockNo -> BlockNo Source # toEnum :: Int -> BlockNo Source # fromEnum :: BlockNo -> Int Source # enumFrom :: BlockNo -> [ BlockNo ] Source # enumFromThen :: BlockNo -> BlockNo -> [ BlockNo ] Source # enumFromTo :: BlockNo -> BlockNo -> [ BlockNo ] Source # enumFromThenTo :: BlockNo -> BlockNo -> BlockNo -> [ BlockNo ] Source # |
|
| Eq BlockNo | |
| Num BlockNo | |
|
Defined in Cardano.Slotting.Block |
|
| Ord BlockNo | |
|
Defined in Cardano.Slotting.Block |
|
| Show BlockNo | |
| Generic BlockNo | |
| NFData BlockNo | |
|
Defined in Cardano.Slotting.Block |
|
| ToCBOR BlockNo | |
| FromCBOR BlockNo | |
| NoThunks BlockNo | |
| Serialise BlockNo | |
| Condense BlockNo | |
| type Rep BlockNo | |
|
Defined in Cardano.Slotting.Block |
|
Building transactions
Building transactions
Constructing and inspecting transactions
Transaction bodies
data TxBody era where Source #
Bundled Patterns
| pattern TxBody :: TxBodyContent ViewTx era -> TxBody era |
Instances
| Eq ( TxBody era) Source # | |
| Show ( TxBody era) Source # | |
| HasTypeProxy era => HasTypeProxy ( TxBody era) Source # | |
| IsCardanoEra era => SerialiseAsCBOR ( TxBody era) Source # | |
|
Defined in Cardano.Api.TxBody Methods serialiseToCBOR :: TxBody era -> ByteString Source # deserialiseFromCBOR :: AsType ( TxBody era) -> ByteString -> Either DecoderError ( TxBody era) Source # |
|
| IsCardanoEra era => HasTextEnvelope ( TxBody era) Source # | |
|
Defined in Cardano.Api.TxBody Methods textEnvelopeType :: AsType ( TxBody era) -> TextEnvelopeType Source # textEnvelopeDefaultDescr :: TxBody era -> TextEnvelopeDescr Source # |
|
| data AsType ( TxBody era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
makeTransactionBody :: forall era. IsCardanoEra era => TxBodyContent BuildTx era -> Either TxBodyError ( TxBody era) Source #
data TxBodyContent build era Source #
Constructors
| TxBodyContent | |
|
Fields
|
|
Instances
| Eq ( TxBodyContent build era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxBodyContent build era -> TxBodyContent build era -> Bool Source # (/=) :: TxBodyContent build era -> TxBodyContent build era -> Bool Source # |
|
| Show ( TxBodyContent build era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxBodyError Source #
Constructors
Instances
| Eq TxBodyError Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxBodyError -> TxBodyError -> Bool Source # (/=) :: TxBodyError -> TxBodyError -> Bool Source # |
|
| Show TxBodyError Source # | |
|
Defined in Cardano.Api.TxBody |
|
| Error TxBodyError Source # | |
|
Defined in Cardano.Api.TxBody Methods displayError :: TxBodyError -> String Source # |
|
data TxBodyScriptData era where Source #
Constructors
| TxBodyNoScriptData :: TxBodyScriptData era | |
| TxBodyScriptData :: ScriptDataSupportedInEra era -> TxDats ( ShelleyLedgerEra era) -> Redeemers ( ShelleyLedgerEra era) -> TxBodyScriptData era |
Instances
| Eq ( TxBodyScriptData era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxBodyScriptData era -> TxBodyScriptData era -> Bool Source # (/=) :: TxBodyScriptData era -> TxBodyScriptData era -> Bool Source # |
|
| Show ( TxBodyScriptData era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
Transaction Ids
Constructors
| TxId ( Hash StandardCrypto EraIndependentTxBody ) |
Instances
| Eq TxId Source # | |
| Ord TxId Source # | |
|
Defined in Cardano.Api.TxIn |
|
| Show TxId Source # | |
| IsString TxId Source # | |
|
Defined in Cardano.Api.TxIn Methods fromString :: String -> TxId Source # |
|
| ToJSON TxId Source # | |
| ToJSONKey TxId Source # | |
|
Defined in Cardano.Api.TxIn Methods toJSONKey :: ToJSONKeyFunction TxId Source # toJSONKeyList :: ToJSONKeyFunction [ TxId ] Source # |
|
| FromJSON TxId Source # | |
| FromJSONKey TxId Source # | |
|
Defined in Cardano.Api.TxIn Methods |
|
| HasTypeProxy TxId Source # | |
| SerialiseAsRawBytes TxId Source # | |
|
Defined in Cardano.Api.TxIn Methods serialiseToRawBytes :: TxId -> ByteString Source # deserialiseFromRawBytes :: AsType TxId -> ByteString -> Maybe TxId Source # |
|
| data AsType TxId Source # | |
|
Defined in Cardano.Api.TxIn |
|
getTxId :: forall era. TxBody era -> TxId Source #
Calculate the transaction identifier for a
TxBody
.
Transaction inputs
Instances
| Eq TxIn Source # | |
| Ord TxIn Source # | |
|
Defined in Cardano.Api.TxIn |
|
| Show TxIn Source # | |
| ToJSON TxIn Source # | |
| ToJSONKey TxIn Source # | |
|
Defined in Cardano.Api.TxIn Methods toJSONKey :: ToJSONKeyFunction TxIn Source # toJSONKeyList :: ToJSONKeyFunction [ TxIn ] Source # |
|
| FromJSON TxIn Source # | |
| FromJSONKey TxIn Source # | |
|
Defined in Cardano.Api.TxIn Methods |
|
Instances
| Enum TxIx Source # | |
| Eq TxIx Source # | |
| Ord TxIx Source # | |
|
Defined in Cardano.Api.TxIn |
|
| Show TxIx Source # | |
| ToJSON TxIx Source # | |
| FromJSON TxIx Source # | |
renderTxIn :: TxIn -> Text Source #
Transaction outputs
The context is a transaction body
The context is the UTxO
Constructors
| TxOut ( AddressInEra era) ( TxOutValue era) ( TxOutDatum ctx era) ( ReferenceScript era) |
Instances
| EraCast ( TxOut ctx) Source # | |
|
Defined in Cardano.Api.TxBody Methods eraCast :: ( IsCardanoEra fromEra, IsCardanoEra toEra) => CardanoEra toEra -> TxOut ctx fromEra -> Either EraCastError ( TxOut ctx toEra) Source # |
|
| Eq ( TxOut ctx era) Source # | |
| Show ( TxOut ctx era) Source # | |
| IsCardanoEra era => ToJSON ( TxOut ctx era) Source # | |
| ( IsShelleyBasedEra era, IsCardanoEra era) => FromJSON ( TxOut CtxUTxO era) Source # | |
| ( IsShelleyBasedEra era, IsCardanoEra era) => FromJSON ( TxOut CtxTx era) Source # | |
data TxOutValue era where Source #
Constructors
| TxOutAdaOnly :: OnlyAdaSupportedInEra era -> Lovelace -> TxOutValue era | |
| TxOutValue :: MultiAssetSupportedInEra era -> Value -> TxOutValue era |
Instances
txOutValueToLovelace :: TxOutValue era -> Lovelace Source #
txOutValueToValue :: TxOutValue era -> Value Source #
lovelaceToTxOutValue :: IsCardanoEra era => Lovelace -> TxOutValue era Source #
data TxOutDatum ctx era where Source #
Constructors
| TxOutDatumNone :: TxOutDatum ctx era | |
| TxOutDatumHash :: ScriptDataSupportedInEra era -> Hash ScriptData -> TxOutDatum ctx era |
A transaction output that only specifies the hash of the datum, but not the full datum value. |
| TxOutDatumInline :: ReferenceTxInsScriptsInlineDatumsSupportedInEra era -> ScriptData -> TxOutDatum ctx era |
A transaction output that specifies the whole datum instead of the datum hash. Note that the datum map will not be updated with this datum, it only exists at the transaction output. |
Bundled Patterns
| pattern TxOutDatumInTx :: ScriptDataSupportedInEra era -> ScriptData -> TxOutDatum CtxTx era |
Instances
| EraCast ( TxOutDatum ctx) Source # | |
|
Defined in Cardano.Api.TxBody Methods eraCast :: ( IsCardanoEra fromEra, IsCardanoEra toEra) => CardanoEra toEra -> TxOutDatum ctx fromEra -> Either EraCastError ( TxOutDatum ctx toEra) Source # |
|
| Eq ( TxOutDatum ctx era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxOutDatum ctx era -> TxOutDatum ctx era -> Bool Source # (/=) :: TxOutDatum ctx era -> TxOutDatum ctx era -> Bool Source # |
|
| Show ( TxOutDatum ctx era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
Other transaction body types
data TxInsCollateral era where Source #
Constructors
| TxInsCollateralNone :: TxInsCollateral era | |
| TxInsCollateral :: CollateralSupportedInEra era -> [ TxIn ] -> TxInsCollateral era |
Instances
| Eq ( TxInsCollateral era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxInsCollateral era -> TxInsCollateral era -> Bool Source # (/=) :: TxInsCollateral era -> TxInsCollateral era -> Bool Source # |
|
| Show ( TxInsCollateral era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxInsReference build era where Source #
Constructors
| TxInsReferenceNone :: TxInsReference build era | |
| TxInsReference :: ReferenceTxInsScriptsInlineDatumsSupportedInEra era -> [ TxIn ] -> TxInsReference build era |
Instances
| Eq ( TxInsReference build era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxInsReference build era -> TxInsReference build era -> Bool Source # (/=) :: TxInsReference build era -> TxInsReference build era -> Bool Source # |
|
| Show ( TxInsReference build era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxTotalCollateral era where Source #
Constructors
| TxTotalCollateralNone :: TxTotalCollateral era | |
| TxTotalCollateral :: TxTotalAndReturnCollateralSupportedInEra era -> Lovelace -> TxTotalCollateral era |
Instances
| Eq ( TxTotalCollateral era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxTotalCollateral era -> TxTotalCollateral era -> Bool Source # (/=) :: TxTotalCollateral era -> TxTotalCollateral era -> Bool Source # |
|
| Show ( TxTotalCollateral era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxReturnCollateral ctx era where Source #
Constructors
| TxReturnCollateralNone :: TxReturnCollateral ctx era | |
| TxReturnCollateral :: TxTotalAndReturnCollateralSupportedInEra era -> TxOut ctx era -> TxReturnCollateral ctx era |
Instances
| Eq ( TxReturnCollateral ctx era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxReturnCollateral ctx era -> TxReturnCollateral ctx era -> Bool Source # (/=) :: TxReturnCollateral ctx era -> TxReturnCollateral ctx era -> Bool Source # |
|
| Show ( TxReturnCollateral ctx era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
Constructors
| TxFeeImplicit :: TxFeesImplicitInEra era -> TxFee era | |
| TxFeeExplicit :: TxFeesExplicitInEra era -> Lovelace -> TxFee era |
data TxValidityLowerBound era where Source #
Constructors
| TxValidityNoLowerBound :: TxValidityLowerBound era | |
| TxValidityLowerBound :: ValidityLowerBoundSupportedInEra era -> SlotNo -> TxValidityLowerBound era |
Instances
| Eq ( TxValidityLowerBound era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxValidityLowerBound era -> TxValidityLowerBound era -> Bool Source # (/=) :: TxValidityLowerBound era -> TxValidityLowerBound era -> Bool Source # |
|
| Show ( TxValidityLowerBound era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxValidityUpperBound era where Source #
This was formerly known as the TTL.
Constructors
| TxValidityNoUpperBound :: ValidityNoUpperBoundSupportedInEra era -> TxValidityUpperBound era | |
| TxValidityUpperBound :: ValidityUpperBoundSupportedInEra era -> SlotNo -> TxValidityUpperBound era |
Instances
| Eq ( TxValidityUpperBound era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxValidityUpperBound era -> TxValidityUpperBound era -> Bool Source # (/=) :: TxValidityUpperBound era -> TxValidityUpperBound era -> Bool Source # |
|
| Show ( TxValidityUpperBound era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
The 0-based index for the Ourboros time slot.
Instances
newtype EpochSlots Source #
The number of slots per epoch.
Constructors
| EpochSlots | |
|
Fields |
|
Instances
data TxMetadataInEra era where Source #
Constructors
| TxMetadataNone :: TxMetadataInEra era | |
| TxMetadataInEra :: TxMetadataSupportedInEra era -> TxMetadata -> TxMetadataInEra era |
Instances
| Eq ( TxMetadataInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxMetadataInEra era -> TxMetadataInEra era -> Bool Source # (/=) :: TxMetadataInEra era -> TxMetadataInEra era -> Bool Source # |
|
| Show ( TxMetadataInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxAuxScripts era where Source #
Constructors
| TxAuxScriptsNone :: TxAuxScripts era | |
| TxAuxScripts :: AuxScriptsSupportedInEra era -> [ ScriptInEra era] -> TxAuxScripts era |
Instances
| Eq ( TxAuxScripts era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxAuxScripts era -> TxAuxScripts era -> Bool Source # (/=) :: TxAuxScripts era -> TxAuxScripts era -> Bool Source # |
|
| Show ( TxAuxScripts era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxExtraKeyWitnesses era where Source #
Constructors
| TxExtraKeyWitnessesNone :: TxExtraKeyWitnesses era | |
| TxExtraKeyWitnesses :: TxExtraKeyWitnessesSupportedInEra era -> [ Hash PaymentKey ] -> TxExtraKeyWitnesses era |
Instances
| Eq ( TxExtraKeyWitnesses era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxExtraKeyWitnesses era -> TxExtraKeyWitnesses era -> Bool Source # (/=) :: TxExtraKeyWitnesses era -> TxExtraKeyWitnesses era -> Bool Source # |
|
| Show ( TxExtraKeyWitnesses era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxWithdrawals build era where Source #
Constructors
| TxWithdrawalsNone :: TxWithdrawals build era | |
| TxWithdrawals :: WithdrawalsSupportedInEra era -> [( StakeAddress , Lovelace , BuildTxWith build ( Witness WitCtxStake era))] -> TxWithdrawals build era |
Instances
| Eq ( TxWithdrawals build era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxWithdrawals build era -> TxWithdrawals build era -> Bool Source # (/=) :: TxWithdrawals build era -> TxWithdrawals build era -> Bool Source # |
|
| Show ( TxWithdrawals build era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxCertificates build era where Source #
Constructors
| TxCertificatesNone :: TxCertificates build era | |
| TxCertificates :: CertificatesSupportedInEra era -> [ Certificate ] -> BuildTxWith build ( Map StakeCredential ( Witness WitCtxStake era)) -> TxCertificates build era |
Instances
| Eq ( TxCertificates build era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxCertificates build era -> TxCertificates build era -> Bool Source # (/=) :: TxCertificates build era -> TxCertificates build era -> Bool Source # |
|
| Show ( TxCertificates build era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxUpdateProposal era where Source #
Constructors
| TxUpdateProposalNone :: TxUpdateProposal era | |
| TxUpdateProposal :: UpdateProposalSupportedInEra era -> UpdateProposal -> TxUpdateProposal era |
Instances
| Eq ( TxUpdateProposal era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxUpdateProposal era -> TxUpdateProposal era -> Bool Source # (/=) :: TxUpdateProposal era -> TxUpdateProposal era -> Bool Source # |
|
| Show ( TxUpdateProposal era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxMintValue build era where Source #
Constructors
| TxMintNone :: TxMintValue build era | |
| TxMintValue :: MultiAssetSupportedInEra era -> Value -> BuildTxWith build ( Map PolicyId ( ScriptWitness WitCtxMint era)) -> TxMintValue build era |
Instances
| Eq ( TxMintValue build era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxMintValue build era -> TxMintValue build era -> Bool Source # (/=) :: TxMintValue build era -> TxMintValue build era -> Bool Source # |
|
| Show ( TxMintValue build era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
Building vs viewing transactions
data BuildTxWith build a where Source #
Constructors
| ViewTx :: BuildTxWith ViewTx a | |
| BuildTxWith :: a -> BuildTxWith BuildTx a |
Instances
| Eq a => Eq ( BuildTxWith build a) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: BuildTxWith build a -> BuildTxWith build a -> Bool Source # (/=) :: BuildTxWith build a -> BuildTxWith build a -> Bool Source # |
|
| Show a => Show ( BuildTxWith build a) Source # | |
|
Defined in Cardano.Api.TxBody |
|
Era-dependent transaction body features
data CollateralSupportedInEra era where Source #
A representation of whether the era supports transactions with inputs used only for collateral for script fees.
The Alonzo and subsequent eras support collateral inputs.
Constructors
| CollateralInAlonzoEra :: CollateralSupportedInEra AlonzoEra | |
| CollateralInBabbageEra :: CollateralSupportedInEra BabbageEra |
Instances
| Eq ( CollateralSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: CollateralSupportedInEra era -> CollateralSupportedInEra era -> Bool Source # (/=) :: CollateralSupportedInEra era -> CollateralSupportedInEra era -> Bool Source # |
|
| Show ( CollateralSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data MultiAssetSupportedInEra era where Source #
A representation of whether the era supports multi-asset transactions.
The Mary and subsequent eras support multi-asset transactions.
The negation of this is
OnlyAdaSupportedInEra
.
Constructors
| MultiAssetInMaryEra :: MultiAssetSupportedInEra MaryEra |
Multi-asset transactions are supported in the
|
| MultiAssetInAlonzoEra :: MultiAssetSupportedInEra AlonzoEra |
Multi-asset transactions are supported in the
|
| MultiAssetInBabbageEra :: MultiAssetSupportedInEra BabbageEra |
Multi-asset transactions are supported in the
|
Instances
| Eq ( MultiAssetSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: MultiAssetSupportedInEra era -> MultiAssetSupportedInEra era -> Bool Source # (/=) :: MultiAssetSupportedInEra era -> MultiAssetSupportedInEra era -> Bool Source # |
|
| Show ( MultiAssetSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
| ToJSON ( MultiAssetSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods toJSON :: MultiAssetSupportedInEra era -> Value Source # toEncoding :: MultiAssetSupportedInEra era -> Encoding Source # toJSONList :: [ MultiAssetSupportedInEra era] -> Value Source # toEncodingList :: [ MultiAssetSupportedInEra era] -> Encoding Source # |
|
data OnlyAdaSupportedInEra era where Source #
A representation of whether the era supports only ada transactions.
Prior to the Mary era only ada transactions are supported. Multi-assets are supported from the Mary era onwards.
This is the negation of
MultiAssetSupportedInEra
. It exists since we need
evidence to be positive.
Constructors
| AdaOnlyInByronEra :: OnlyAdaSupportedInEra ByronEra | |
| AdaOnlyInShelleyEra :: OnlyAdaSupportedInEra ShelleyEra | |
| AdaOnlyInAllegraEra :: OnlyAdaSupportedInEra AllegraEra |
Instances
| Eq ( OnlyAdaSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: OnlyAdaSupportedInEra era -> OnlyAdaSupportedInEra era -> Bool Source # (/=) :: OnlyAdaSupportedInEra era -> OnlyAdaSupportedInEra era -> Bool Source # |
|
| Show ( OnlyAdaSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxFeesExplicitInEra era where Source #
A representation of whether the era requires explicitly specified fees in transactions.
The Byron era tx fees are implicit (as the difference bettween the sum of outputs and sum of inputs), but all later eras the fees are specified in the transaction explicitly.
Constructors
Instances
| Eq ( TxFeesExplicitInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxFeesExplicitInEra era -> TxFeesExplicitInEra era -> Bool Source # (/=) :: TxFeesExplicitInEra era -> TxFeesExplicitInEra era -> Bool Source # |
|
| Show ( TxFeesExplicitInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxFeesImplicitInEra era where Source #
A representation of whether the era requires implicitly specified fees in transactions.
This is the negation of
TxFeesExplicitInEra
.
Constructors
| TxFeesImplicitInByronEra :: TxFeesImplicitInEra ByronEra |
Instances
| Eq ( TxFeesImplicitInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxFeesImplicitInEra era -> TxFeesImplicitInEra era -> Bool Source # (/=) :: TxFeesImplicitInEra era -> TxFeesImplicitInEra era -> Bool Source # |
|
| Show ( TxFeesImplicitInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data ValidityUpperBoundSupportedInEra era where Source #
A representation of whether the era supports transactions with an upper bound on the range of slots in which they are valid.
The Shelley and subsequent eras support an upper bound on the validity range. In the Shelley era specifically it is actually required. It is optional in later eras.
Constructors
Instances
| Eq ( ValidityUpperBoundSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: ValidityUpperBoundSupportedInEra era -> ValidityUpperBoundSupportedInEra era -> Bool Source # (/=) :: ValidityUpperBoundSupportedInEra era -> ValidityUpperBoundSupportedInEra era -> Bool Source # |
|
| Show ( ValidityUpperBoundSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data ValidityNoUpperBoundSupportedInEra era where Source #
A representation of whether the era supports transactions having no upper bound on the range of slots in which they are valid.
Note that the
ShelleyEra
does not support
omitting a validity upper
bound. It was introduced as a
required
field in Shelley and then made
optional in Allegra and subsequent eras.
The Byron era supports this by virtue of the fact that it does not support validity ranges at all.
Constructors
Instances
| Eq ( ValidityNoUpperBoundSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: ValidityNoUpperBoundSupportedInEra era -> ValidityNoUpperBoundSupportedInEra era -> Bool Source # (/=) :: ValidityNoUpperBoundSupportedInEra era -> ValidityNoUpperBoundSupportedInEra era -> Bool Source # |
|
| Show ( ValidityNoUpperBoundSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data ValidityLowerBoundSupportedInEra era where Source #
A representation of whether the era supports transactions with a lower bound on the range of slots in which they are valid.
The Allegra and subsequent eras support an optional lower bound on the
validity range. No equivalent of
ValidityNoUpperBoundSupportedInEra
is
needed since all eras support having no lower bound.
Constructors
Instances
| Eq ( ValidityLowerBoundSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: ValidityLowerBoundSupportedInEra era -> ValidityLowerBoundSupportedInEra era -> Bool Source # (/=) :: ValidityLowerBoundSupportedInEra era -> ValidityLowerBoundSupportedInEra era -> Bool Source # |
|
| Show ( ValidityLowerBoundSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxMetadataSupportedInEra era where Source #
A representation of whether the era supports transaction metadata.
Transaction metadata is supported from the Shelley era onwards.
Constructors
Instances
| Eq ( TxMetadataSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxMetadataSupportedInEra era -> TxMetadataSupportedInEra era -> Bool Source # (/=) :: TxMetadataSupportedInEra era -> TxMetadataSupportedInEra era -> Bool Source # |
|
| Show ( TxMetadataSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data AuxScriptsSupportedInEra era where Source #
A representation of whether the era supports auxiliary scripts in transactions.
Auxiliary scripts are supported from the Allegra era onwards.
Constructors
Instances
| Eq ( AuxScriptsSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: AuxScriptsSupportedInEra era -> AuxScriptsSupportedInEra era -> Bool Source # (/=) :: AuxScriptsSupportedInEra era -> AuxScriptsSupportedInEra era -> Bool Source # |
|
| Show ( AuxScriptsSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxExtraKeyWitnessesSupportedInEra era where Source #
A representation of whether the era supports transactions that specify in the body that they need extra key witnesses, and where this fact is visible to scripts.
Extra key witnesses visible to scripts are supported from the Alonzo era onwards.
Constructors
| ExtraKeyWitnessesInAlonzoEra :: TxExtraKeyWitnessesSupportedInEra AlonzoEra | |
| ExtraKeyWitnessesInBabbageEra :: TxExtraKeyWitnessesSupportedInEra BabbageEra |
Instances
| Eq ( TxExtraKeyWitnessesSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxExtraKeyWitnessesSupportedInEra era -> TxExtraKeyWitnessesSupportedInEra era -> Bool Source # (/=) :: TxExtraKeyWitnessesSupportedInEra era -> TxExtraKeyWitnessesSupportedInEra era -> Bool Source # |
|
| Show ( TxExtraKeyWitnessesSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data ScriptDataSupportedInEra era where Source #
A representation of whether the era supports multi-asset transactions.
The Mary and subsequent eras support multi-asset transactions.
The negation of this is
OnlyAdaSupportedInEra
.
Constructors
| ScriptDataInAlonzoEra :: ScriptDataSupportedInEra AlonzoEra |
Script data is supported in transactions in the
|
| ScriptDataInBabbageEra :: ScriptDataSupportedInEra BabbageEra |
Instances
| Eq ( ScriptDataSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: ScriptDataSupportedInEra era -> ScriptDataSupportedInEra era -> Bool Source # (/=) :: ScriptDataSupportedInEra era -> ScriptDataSupportedInEra era -> Bool Source # |
|
| Show ( ScriptDataSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data WithdrawalsSupportedInEra era where Source #
A representation of whether the era supports withdrawals from reward accounts.
The Shelley and subsequent eras support stake addresses, their associated reward accounts and support for withdrawals from them.
Constructors
Instances
| Eq ( WithdrawalsSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: WithdrawalsSupportedInEra era -> WithdrawalsSupportedInEra era -> Bool Source # (/=) :: WithdrawalsSupportedInEra era -> WithdrawalsSupportedInEra era -> Bool Source # |
|
| Show ( WithdrawalsSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data CertificatesSupportedInEra era where Source #
A representation of whether the era supports
Certificate
s embedded in
transactions.
The Shelley and subsequent eras support such certificates.
Constructors
Instances
| Eq ( CertificatesSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: CertificatesSupportedInEra era -> CertificatesSupportedInEra era -> Bool Source # (/=) :: CertificatesSupportedInEra era -> CertificatesSupportedInEra era -> Bool Source # |
|
| Show ( CertificatesSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data UpdateProposalSupportedInEra era where Source #
A representation of whether the era supports
UpdateProposal
s embedded in
transactions.
The Shelley and subsequent eras support such update proposals. They Byron era has a notion of an update proposal, but it is a standalone chain object and not embedded in a transaction.
Constructors
Instances
| Eq ( UpdateProposalSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: UpdateProposalSupportedInEra era -> UpdateProposalSupportedInEra era -> Bool Source # (/=) :: UpdateProposalSupportedInEra era -> UpdateProposalSupportedInEra era -> Bool Source # |
|
| Show ( UpdateProposalSupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
Feature availability functions
collateralSupportedInEra :: CardanoEra era -> Maybe ( CollateralSupportedInEra era) Source #
multiAssetSupportedInEra :: CardanoEra era -> Either ( OnlyAdaSupportedInEra era) ( MultiAssetSupportedInEra era) Source #
txFeesExplicitInEra :: CardanoEra era -> Either ( TxFeesImplicitInEra era) ( TxFeesExplicitInEra era) Source #
validityUpperBoundSupportedInEra :: CardanoEra era -> Maybe ( ValidityUpperBoundSupportedInEra era) Source #
validityNoUpperBoundSupportedInEra :: CardanoEra era -> Maybe ( ValidityNoUpperBoundSupportedInEra era) Source #
validityLowerBoundSupportedInEra :: CardanoEra era -> Maybe ( ValidityLowerBoundSupportedInEra era) Source #
txMetadataSupportedInEra :: CardanoEra era -> Maybe ( TxMetadataSupportedInEra era) Source #
auxScriptsSupportedInEra :: CardanoEra era -> Maybe ( AuxScriptsSupportedInEra era) Source #
extraKeyWitnessesSupportedInEra :: CardanoEra era -> Maybe ( TxExtraKeyWitnessesSupportedInEra era) Source #
withdrawalsSupportedInEra :: CardanoEra era -> Maybe ( WithdrawalsSupportedInEra era) Source #
certificatesSupportedInEra :: CardanoEra era -> Maybe ( CertificatesSupportedInEra era) Source #
updateProposalSupportedInEra :: CardanoEra era -> Maybe ( UpdateProposalSupportedInEra era) Source #
scriptDataSupportedInEra :: CardanoEra era -> Maybe ( ScriptDataSupportedInEra era) Source #
totalAndReturnCollateralSupportedInEra :: CardanoEra era -> Maybe (TxTotalAndReturnCollateralSupportedInEra era) Source #
Fee calculation
Arguments
| :: forall era. IsShelleyBasedEra era | |
| => Natural |
The fixed tx fee |
| -> Natural |
The tx fee per byte |
| -> Tx era | |
| -> Lovelace |
Deprecated: Use
evaluateTransactionFee
instead
For a concrete fully-constructed transaction, determine the minimum fee that it needs to pay.
This function is simple, but if you are doing input selection then you probably want to consider estimateTransactionFee.
toLedgerEpochInfo :: EraHistory mode -> EpochInfo ( Either Text ) Source #
estimateTransactionFee Source #
Arguments
| :: forall era. IsShelleyBasedEra era | |
| => NetworkId | |
| -> Natural |
The fixed tx fee |
| -> Natural |
The tx fee per byte |
| -> Tx era | |
| -> Int |
The number of extra UTxO transaction inputs |
| -> Int |
The number of extra transaction outputs |
| -> Int |
The number of extra Shelley key witnesses |
| -> Int |
The number of extra Byron key witnesses |
| -> Lovelace |
This can estimate what the transaction fee will be, based on a starting base transaction, plus the numbers of the additional components of the transaction that may be added.
So for example with wallet coin selection, the base transaction should contain all the things not subject to coin selection (such as script inputs, metadata, withdrawals, certs etc)
evaluateTransactionFee Source #
Arguments
| :: forall era. IsShelleyBasedEra era | |
| => ProtocolParameters | |
| -> TxBody era | |
| -> Word |
The number of Shelley key witnesses |
| -> Word |
The number of Byron key witnesses |
| -> Lovelace |
Compute the transaction fee for a proposed transaction, with the assumption that there will be the given number of key witnesses (i.e. signatures).
TODO: we need separate args for Shelley vs Byron key sigs
estimateTransactionKeyWitnessCount :: TxBodyContent BuildTx era -> Word Source #
Give an approximate count of the number of key witnesses (i.e. signatures) a transaction will need.
This is an estimate not a precise count in that it can over-estimate: it makes conservative assumptions such as all inputs are from distinct addresses, but in principle multiple inputs can use the same address and we only need a witness per address.
Similarly there can be overlap between the regular and collateral inputs, but we conservatively assume they are distinct.
TODO: it is worth us considering a more precise count that relies on the UTxO to resolve which inputs are for distinct addresses, and also to count the number of Shelley vs Byron style witnesses.
Minimum required UTxO calculation
calculateMinimumUTxO :: ShelleyBasedEra era -> TxOut CtxTx era -> ProtocolParameters -> Either MinimumUTxOError Value Source #
data MinimumUTxOError Source #
Instances
| Show MinimumUTxOError Source # | |
|
Defined in Cardano.Api.Fees |
|
| Error MinimumUTxOError Source # | |
|
Defined in Cardano.Api.Fees Methods |
|
Script execution units
evaluateTransactionExecutionUnits :: forall era mode. EraInMode era mode -> SystemStart -> EraHistory mode -> ProtocolParameters -> UTxO era -> TxBody era -> Either TransactionValidityError ( Map ScriptWitnessIndex ( Either ScriptExecutionError ExecutionUnits )) Source #
Compute the
ExecutionUnits
needed for each script in the transaction.
This works by running all the scripts and counting how many execution units are actually used.
data ScriptExecutionError Source #
The different possible reasons that executing a script can fail,
as reported by
evaluateTransactionExecutionUnits
.
The first three of these are about failures before we even get to execute the script, and two are the result of execution.
Constructors
| ScriptErrorMissingTxIn TxIn |
The script depends on a
|
| ScriptErrorTxInWithoutDatum TxIn |
The
|
| ScriptErrorWrongDatum ( Hash ScriptData ) |
The
|
| ScriptErrorEvaluationFailed EvaluationError [ Text ] |
The script evaluation failed. This usually means it evaluated to an
error value. This is not a case of running out of execution units
(which is not possible for
|
| ScriptErrorExecutionUnitsOverflow |
The execution units overflowed a 64bit word. Congratulations if you encounter this error. With the current style of cost model this would need a script to run for over 7 months, which is somewhat more than the expected maximum of a few milliseconds. |
| ScriptErrorNotPlutusWitnessedTxIn ScriptWitnessIndex ScriptHash |
An attempt was made to spend a key witnessed tx input with a script witness. |
| ScriptErrorRedeemerPointsToUnknownScriptHash ScriptWitnessIndex |
The redeemer pointer points to a script hash that does not exist in the transaction nor in the UTxO as a reference script" |
| ScriptErrorMissingScript RdmrPtr ResolvablePointers |
A redeemer pointer points to a script that does not exist. |
| ScriptErrorMissingCostModel Language |
A cost model was missing for a language which was used. |
Instances
| Show ScriptExecutionError Source # | |
|
Defined in Cardano.Api.Fees |
|
| Error ScriptExecutionError Source # | |
|
Defined in Cardano.Api.Fees Methods |
|
data TransactionValidityError Source #
Constructors
| TransactionValidityIntervalError PastHorizonException |
The transaction validity interval is too far into the future. Transactions with Plutus scripts need to have a validity interval that is not so far in the future that we cannot reliably determine the UTC time corresponding to the validity interval expressed in slot numbers. This is because the Plutus scripts get given the transaction validity interval in UTC time, so that they are not sensitive to slot lengths. If either end of the validity interval is beyond the so called "time horizon" then the consensus algorithm is not able to reliably determine the relationship between slots and time. This is this situation in which this error is reported. For the Cardano mainnet the time horizon is 36 hours beyond the current time. This effectively means we cannot submit check or submit transactions that use Plutus scripts that have the end of their validity interval more than 36 hours into the future. |
| TransactionValidityTranslationError ( TranslationError StandardCrypto ) | |
| TransactionValidityCostModelError ( Map AnyPlutusScriptVersion CostModel ) String |
Instances
| Show TransactionValidityError Source # | |
|
Defined in Cardano.Api.Fees |
|
| Error TransactionValidityError Source # | |
|
Defined in Cardano.Api.Fees Methods |
|
Transaction balance
evaluateTransactionBalance :: forall era. IsShelleyBasedEra era => ProtocolParameters -> Set PoolId -> UTxO era -> TxBody era -> TxOutValue era Source #
Compute the total balance of the proposed transaction. Ultimately a valid transaction must be fully balanced: that is have a total value of zero.
Finding the (non-zero) balance of partially constructed transaction is useful for adjusting a transaction to be fully balanced.
Building transactions with automated fees and balancing
makeTransactionBodyAutoBalance Source #
Arguments
| :: forall era mode. IsShelleyBasedEra era | |
| => EraInMode era mode | |
| -> SystemStart | |
| -> EraHistory mode | |
| -> ProtocolParameters | |
| -> Set PoolId |
The set of registered stake pools |
| -> UTxO era |
Just the transaction inputs, not the entire
|
| -> TxBodyContent BuildTx era | |
| -> AddressInEra era |
Change address |
| -> Maybe Word |
Override key witnesses |
| -> Either TxBodyErrorAutoBalance ( BalancedTxBody era) |
This is much like
makeTransactionBody
but with greater automation to
calculate suitable values for several things.
In particular:
-
It calculates the correct script
ExecutionUnits(ignoring the provided values, which can thus be zero). -
It calculates the transaction fees, based on the script
ExecutionUnits, the currentProtocolParameters, and an estimate of the number of key witnesses (i.e. signatures). There is an override for the number of key witnesses. - It accepts a change address, calculates the balance of the transaction and puts the excess change into the change output.
- It also checks that the balance is positive and the change is above the minimum threshold.
To do this it needs more information than
makeTransactionBody
, all of
which can be queried from a local node.
data BalancedTxBody era Source #
Constructors
| BalancedTxBody | |
data TxBodyErrorAutoBalance Source #
The possible errors that can arise from
makeTransactionBodyAutoBalance
.
Constructors
| TxBodyError TxBodyError |
The same errors that can arise from
|
| TxBodyScriptExecutionError [( ScriptWitnessIndex , ScriptExecutionError )] |
One or more of the scripts fails to execute correctly. |
| TxBodyScriptBadScriptValidity |
One or more of the scripts were expected to fail validation, but none did. |
| TxBodyErrorAssetBalanceWrong Value |
The balance of the non-ada assets is not zero. The
|
| TxBodyErrorAdaBalanceNegative Lovelace |
There is not enough ada to cover both the outputs and the fees. The transaction should be changed to provide more input ada, or otherwise adjusted to need less (e.g. outputs, script etc). |
| TxBodyErrorAdaBalanceTooSmall |
Offending TxOut |
| TxBodyErrorByronEraNotSupported |
|
| TxBodyErrorMissingParamMinUTxO |
The
|
| TxBodyErrorValidityInterval TransactionValidityError |
The transaction validity interval is too far into the future.
See
|
| TxBodyErrorMinUTxONotMet |
Offending TxOut |
|
Fields
|
|
| TxBodyErrorMinUTxOMissingPParams MinimumUTxOError | |
| TxBodyErrorNonAdaAssetsUnbalanced Value | |
| TxBodyErrorScriptWitnessIndexMissingFromExecUnitsMap ScriptWitnessIndex ( Map ScriptWitnessIndex ExecutionUnits ) | |
Instances
| Show TxBodyErrorAutoBalance Source # | |
|
Defined in Cardano.Api.Fees |
|
| Error TxBodyErrorAutoBalance Source # | |
|
Defined in Cardano.Api.Fees Methods |
|
data TxScriptValidity era where Source #
A representation of whether the era supports tx script validity.
The Mary and subsequent eras support script validity.
Constructors
| TxScriptValidityNone :: TxScriptValidity era | |
| TxScriptValidity :: TxScriptValiditySupportedInEra era -> ScriptValidity -> TxScriptValidity era |
Tx script validity is supported in transactions in the
|
Instances
| Eq ( TxScriptValidity era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxScriptValidity era -> TxScriptValidity era -> Bool Source # (/=) :: TxScriptValidity era -> TxScriptValidity era -> Bool Source # |
|
| Show ( TxScriptValidity era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
data ScriptValidity Source #
Indicates whether a script is expected to fail or pass validation.
Constructors
| ScriptInvalid |
Script is expected to fail validation. Transactions marked as such can include scripts that fail validation. Such transactions may be submitted to the chain, in which case the collateral will be taken upon on chain script validation failure. |
| ScriptValid |
Script is expected to pass validation. Transactions marked as such cannot include scripts that fail validation. |
Instances
| Eq ScriptValidity Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: ScriptValidity -> ScriptValidity -> Bool Source # (/=) :: ScriptValidity -> ScriptValidity -> Bool Source # |
|
| Show ScriptValidity Source # | |
|
Defined in Cardano.Api.TxBody |
|
| ToCBOR ScriptValidity Source # | |
|
Defined in Cardano.Api.TxBody Methods toCBOR :: ScriptValidity -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ScriptValidity -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ ScriptValidity ] -> Size Source # |
|
| FromCBOR ScriptValidity Source # | |
|
Defined in Cardano.Api.TxBody |
|
data TxScriptValiditySupportedInEra era where Source #
Constructors
| TxScriptValiditySupportedInAlonzoEra :: TxScriptValiditySupportedInEra AlonzoEra | |
| TxScriptValiditySupportedInBabbageEra :: TxScriptValiditySupportedInEra BabbageEra |
Instances
| Eq ( TxScriptValiditySupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: TxScriptValiditySupportedInEra era -> TxScriptValiditySupportedInEra era -> Bool Source # (/=) :: TxScriptValiditySupportedInEra era -> TxScriptValiditySupportedInEra era -> Bool Source # |
|
| Show ( TxScriptValiditySupportedInEra era) Source # | |
|
Defined in Cardano.Api.TxBody |
|
scriptValidityToTxScriptValidity :: ShelleyBasedEra era -> ScriptValidity -> TxScriptValidity era Source #
txScriptValiditySupportedInShelleyBasedEra :: ShelleyBasedEra era -> Maybe ( TxScriptValiditySupportedInEra era) Source #
txScriptValiditySupportedInCardanoEra :: CardanoEra era -> Maybe ( TxScriptValiditySupportedInEra era) Source #
Signing transactions
Creating transaction witnesses one by one, or all in one go.
Bundled Patterns
| pattern Tx :: TxBody era -> [ KeyWitness era] -> Tx era |
Instances
| Eq ( InAnyCardanoEra Tx ) Source # | |
|
Defined in Cardano.Api.Tx Methods (==) :: InAnyCardanoEra Tx -> InAnyCardanoEra Tx -> Bool Source # (/=) :: InAnyCardanoEra Tx -> InAnyCardanoEra Tx -> Bool Source # |
|
| Eq ( Tx era) Source # | |
| Show ( InAnyCardanoEra Tx ) Source # | |
|
Defined in Cardano.Api.Tx |
|
| Show ( Tx era) Source # | |
| HasTypeProxy era => HasTypeProxy ( Tx era) Source # | |
| IsCardanoEra era => SerialiseAsCBOR ( Tx era) Source # | |
|
Defined in Cardano.Api.Tx Methods serialiseToCBOR :: Tx era -> ByteString Source # deserialiseFromCBOR :: AsType ( Tx era) -> ByteString -> Either DecoderError ( Tx era) Source # |
|
| IsCardanoEra era => HasTextEnvelope ( Tx era) Source # | |
|
Defined in Cardano.Api.Tx Methods textEnvelopeType :: AsType ( Tx era) -> TextEnvelopeType Source # textEnvelopeDefaultDescr :: Tx era -> TextEnvelopeDescr Source # |
|
| data AsType ( Tx era) Source # | |
|
Defined in Cardano.Api.Tx |
|
getTxWitnesses :: forall era. Tx era -> [ KeyWitness era] Source #
Signing in one go
signByronTransaction :: NetworkId -> TxBody ByronEra -> [ SigningKey ByronKey ] -> Tx ByronEra Source #
signShelleyTransaction :: IsShelleyBasedEra era => TxBody era -> [ ShelleyWitnessSigningKey ] -> Tx era Source #
Incremental signing and separate witnesses
makeSignedTransaction :: forall era. [ KeyWitness era] -> TxBody era -> Tx era Source #
data KeyWitness era Source #
Instances
makeByronKeyWitness :: forall key. IsByronKey key => NetworkId -> TxBody ByronEra -> SigningKey key -> KeyWitness ByronEra Source #
data ShelleyWitnessSigningKey Source #
Constructors
makeShelleyKeyWitness :: forall era. IsShelleyBasedEra era => TxBody era -> ShelleyWitnessSigningKey -> KeyWitness era Source #
makeShelleyBootstrapWitness :: forall era. IsShelleyBasedEra era => WitnessNetworkIdOrByronAddress -> TxBody era -> SigningKey ByronKey -> KeyWitness era Source #
Transaction metadata
Embedding additional structured data within transactions.
newtype TxMetadata Source #
Constructors
| TxMetadata ( Map Word64 TxMetadataValue ) |
Instances
Constructing metadata
data TxMetadataValue Source #
Constructors
| TxMetaMap [( TxMetadataValue , TxMetadataValue )] | |
| TxMetaList [ TxMetadataValue ] | |
| TxMetaNumber Integer | |
| TxMetaBytes ByteString | |
| TxMetaText Text |
Instances
| Eq TxMetadataValue Source # | |
|
Defined in Cardano.Api.TxMetadata Methods (==) :: TxMetadataValue -> TxMetadataValue -> Bool Source # (/=) :: TxMetadataValue -> TxMetadataValue -> Bool Source # |
|
| Ord TxMetadataValue Source # | |
|
Defined in Cardano.Api.TxMetadata Methods compare :: TxMetadataValue -> TxMetadataValue -> Ordering Source # (<) :: TxMetadataValue -> TxMetadataValue -> Bool Source # (<=) :: TxMetadataValue -> TxMetadataValue -> Bool Source # (>) :: TxMetadataValue -> TxMetadataValue -> Bool Source # (>=) :: TxMetadataValue -> TxMetadataValue -> Bool Source # max :: TxMetadataValue -> TxMetadataValue -> TxMetadataValue Source # min :: TxMetadataValue -> TxMetadataValue -> TxMetadataValue Source # |
|
| Show TxMetadataValue Source # | |
|
Defined in Cardano.Api.TxMetadata |
|
Validating metadata
validateTxMetadata :: TxMetadata -> Either [( Word64 , TxMetadataRangeError )] () Source #
Validate transaction metadata. This is for use with existing constructed metadata values, e.g. constructed manually or decoded from CBOR directly.
data TxMetadataRangeError Source #
An error in transaction metadata due to an out-of-range value.
Constructors
| TxMetadataNumberOutOfRange ! Integer |
The number is outside the maximum range of
|
| TxMetadataTextTooLong ! Int |
The length of a text string metadatum value exceeds the maximum of 64 bytes as UTF8. |
| TxMetadataBytesTooLong ! Int |
The length of a byte string metadatum value exceeds the maximum of 64 bytes. |
Instances
| Eq TxMetadataRangeError Source # | |
|
Defined in Cardano.Api.TxMetadata Methods (==) :: TxMetadataRangeError -> TxMetadataRangeError -> Bool Source # (/=) :: TxMetadataRangeError -> TxMetadataRangeError -> Bool Source # |
|
| Show TxMetadataRangeError Source # | |
|
Defined in Cardano.Api.TxMetadata |
|
| Error TxMetadataRangeError Source # | |
|
Defined in Cardano.Api.TxMetadata Methods |
|
Conversion to/from JSON
data TxMetadataJsonSchema Source #
Tx metadata is similar to JSON but not exactly the same. It has some deliberate limitations such as no support for floating point numbers or special forms for null or boolean values. It also has limitations on the length of strings. On the other hand, unlike JSON, it distinguishes between byte strings and text strings. It also supports any value as map keys rather than just string.
We provide two different mappings between tx metadata and JSON, useful for different purposes:
- A mapping that allows almost any JSON value to be converted into tx metadata. This does not require a specific JSON schema for the input. It does not expose the full representation capability of tx metadata.
- A mapping that exposes the full representation capability of tx metadata, but relies on a specific JSON schema for the input JSON.
In the "no schema" mapping, the idea is that (almost) any JSON can be turned into tx metadata and then converted back, without loss. That is, we can round-trip the JSON.
The subset of JSON supported is all JSON except: * No null or bool values * No floating point, only integers in the range of a 64bit signed integer * A limitation on string lengths
The approach for this mapping is to use whichever representation as tx metadata is most compact. In particular:
- JSON lists and maps represented as CBOR lists and maps
- JSON strings represented as CBOR strings
- JSON hex strings with "0x" prefix represented as CBOR byte strings
- JSON integer numbers represented as CBOR signed or unsigned numbers
- JSON maps with string keys that parse as numbers or hex byte strings, represented as CBOR map keys that are actually numbers or byte strings.
The string length limit depends on whether the hex string representation is used or not. For text strings the limit is 64 bytes for the UTF8 representation of the text string. For byte strings the limit is 64 bytes for the raw byte form (ie not the input hex, but after hex decoding).
In the "detailed schema" mapping, the idea is that we expose the full representation capability of the tx metadata in the form of a JSON schema. This means the full representation is available and can be controlled precisely. It also means any tx metadata can be converted into the JSON and back without loss. That is we can round-trip the tx metadata via the JSON and also round-trip schema-compliant JSON via tx metadata.
Constructors
| TxMetadataJsonNoSchema |
Use the "no schema" mapping between JSON and tx metadata as described above. |
| TxMetadataJsonDetailedSchema |
Use the "detailed schema" mapping between JSON and tx metadata as described above. |
Instances
| Eq TxMetadataJsonSchema Source # | |
|
Defined in Cardano.Api.TxMetadata Methods (==) :: TxMetadataJsonSchema -> TxMetadataJsonSchema -> Bool Source # (/=) :: TxMetadataJsonSchema -> TxMetadataJsonSchema -> Bool Source # |
|
| Show TxMetadataJsonSchema Source # | |
|
Defined in Cardano.Api.TxMetadata |
|
metadataFromJson :: TxMetadataJsonSchema -> Value -> Either TxMetadataJsonError TxMetadata Source #
Convert a value from JSON into tx metadata, using the given choice of mapping between JSON and tx metadata.
This may fail with a conversion error if the JSON is outside the supported
subset for the chosen mapping. See
TxMetadataJsonSchema
for the details.
metadataToJson :: TxMetadataJsonSchema -> TxMetadata -> Value Source #
Convert a tx metadata value into JSON , using the given choice of mapping between JSON and tx metadata.
This conversion is total but is not necessarily invertible.
See
TxMetadataJsonSchema
for the details.
data TxMetadataJsonError Source #
Constructors
| TxMetadataJsonToplevelNotMap | |
| TxMetadataJsonToplevelBadKey ! Text | |
| TxMetadataJsonSchemaError ! Word64 ! Value ! TxMetadataJsonSchemaError | |
| TxMetadataRangeError ! Word64 ! Value ! TxMetadataRangeError |
Instances
| Eq TxMetadataJsonError Source # | |
|
Defined in Cardano.Api.TxMetadata Methods (==) :: TxMetadataJsonError -> TxMetadataJsonError -> Bool Source # (/=) :: TxMetadataJsonError -> TxMetadataJsonError -> Bool Source # |
|
| Show TxMetadataJsonError Source # | |
|
Defined in Cardano.Api.TxMetadata |
|
| Error TxMetadataJsonError Source # | |
|
Defined in Cardano.Api.TxMetadata Methods |
|
data TxMetadataJsonSchemaError Source #
Constructors
Instances
| Eq TxMetadataJsonSchemaError Source # | |
|
Defined in Cardano.Api.TxMetadata Methods (==) :: TxMetadataJsonSchemaError -> TxMetadataJsonSchemaError -> Bool Source # (/=) :: TxMetadataJsonSchemaError -> TxMetadataJsonSchemaError -> Bool Source # |
|
| Show TxMetadataJsonSchemaError Source # | |
|
Defined in Cardano.Api.TxMetadata |
|
| Error TxMetadataJsonSchemaError Source # | |
|
Defined in Cardano.Api.TxMetadata Methods displayError :: TxMetadataJsonSchemaError -> String Source # |
|
Certificates
data Certificate Source #
Constructors
Instances
Registering stake address and delegating
Certificates that are embedded in transactions for registering and unregistering stake address, and for setting the stake pool delegation choice for a stake address.
Registering stake pools
Certificates that are embedded in transactions for registering and retiring stake pools. This includes updating the stake pool parameters.
data StakePoolParameters Source #
Instances
| Eq StakePoolParameters Source # | |
|
Defined in Cardano.Api.Certificate Methods (==) :: StakePoolParameters -> StakePoolParameters -> Bool Source # (/=) :: StakePoolParameters -> StakePoolParameters -> Bool Source # |
|
| Show StakePoolParameters Source # | |
|
Defined in Cardano.Api.Certificate |
|
data StakePoolRelay Source #
Instances
| Eq StakePoolRelay Source # | |
|
Defined in Cardano.Api.Certificate Methods (==) :: StakePoolRelay -> StakePoolRelay -> Bool Source # (/=) :: StakePoolRelay -> StakePoolRelay -> Bool Source # |
|
| Show StakePoolRelay Source # | |
|
Defined in Cardano.Api.Certificate |
|
data StakePoolMetadataReference Source #
Instances
| Eq StakePoolMetadataReference Source # | |
|
Defined in Cardano.Api.Certificate Methods (==) :: StakePoolMetadataReference -> StakePoolMetadataReference -> Bool Source # (/=) :: StakePoolMetadataReference -> StakePoolMetadataReference -> Bool Source # |
|
| Show StakePoolMetadataReference Source # | |
|
Defined in Cardano.Api.Certificate |
|
Stake pool off-chain metadata
data StakePoolMetadata Source #
A representation of the required fields for off-chain stake pool metadata.
Instances
validateAndHashStakePoolMetadata :: ByteString -> Either StakePoolMetadataValidationError ( StakePoolMetadata , Hash StakePoolMetadata ) Source #
Decode and validate the provided JSON-encoded bytes as
StakePoolMetadata
.
Return the decoded metadata and the hash of the original bytes.
data StakePoolMetadataValidationError Source #
A stake pool metadata validation error.
Instances
Scripts
Both
PaymentCredential
s and
StakeCredential
s can use scripts.
Script languages
data SimpleScriptV1 Source #
The original simple script language which supports
- require a signature from a given key (by verification key hash)
- n-way and combinator
- n-way or combinator
- m-of-n combinator
This version of the language was introduced in the
ShelleyEra
.
Instances
| HasTypeProxy SimpleScriptV1 Source # | |
|
Defined in Cardano.Api.Script Associated Types data AsType SimpleScriptV1 Source # Methods proxyToAsType :: Proxy SimpleScriptV1 -> AsType SimpleScriptV1 Source # |
|
| IsSimpleScriptLanguage SimpleScriptV1 Source # | |
|
Defined in Cardano.Api.Script Methods simpleScriptVersion :: SimpleScriptVersion SimpleScriptV1 Source # |
|
| IsScriptLanguage SimpleScriptV1 Source # | |
|
Defined in Cardano.Api.Script Methods |
|
| data AsType SimpleScriptV1 Source # | |
|
Defined in Cardano.Api.Script |
|
data SimpleScriptV2 Source #
The second version of the simple script language. It has all the features
of
SimpleScriptV1
plus new atomic predicates:
- require the time be before a given slot number
- require the time be after a given slot number
This version of the language was introduced in the
AllegraEra
.
Instances
| HasTypeProxy SimpleScriptV2 Source # | |
|
Defined in Cardano.Api.Script Associated Types data AsType SimpleScriptV2 Source # Methods proxyToAsType :: Proxy SimpleScriptV2 -> AsType SimpleScriptV2 Source # |
|
| IsSimpleScriptLanguage SimpleScriptV2 Source # | |
|
Defined in Cardano.Api.Script Methods simpleScriptVersion :: SimpleScriptVersion SimpleScriptV2 Source # |
|
| IsScriptLanguage SimpleScriptV2 Source # | |
|
Defined in Cardano.Api.Script Methods |
|
| data AsType SimpleScriptV2 Source # | |
|
Defined in Cardano.Api.Script |
|
data PlutusScriptV1 Source #
Place holder type to show what the pattern is to extend to multiple languages, not just multiple versions of a single language.
Instances
| HasTypeProxy PlutusScriptV1 Source # | |
|
Defined in Cardano.Api.Script Associated Types data AsType PlutusScriptV1 Source # Methods proxyToAsType :: Proxy PlutusScriptV1 -> AsType PlutusScriptV1 Source # |
|
| IsScriptLanguage PlutusScriptV1 Source # | |
|
Defined in Cardano.Api.Script Methods |
|
| data AsType PlutusScriptV1 Source # | |
|
Defined in Cardano.Api.Script |
|
data PlutusScriptV2 Source #
Instances
| HasTypeProxy PlutusScriptV2 Source # | |
|
Defined in Cardano.Api.Script Associated Types data AsType PlutusScriptV2 Source # Methods proxyToAsType :: Proxy PlutusScriptV2 -> AsType PlutusScriptV2 Source # |
|
| IsScriptLanguage PlutusScriptV2 Source # | |
|
Defined in Cardano.Api.Script Methods |
|
| data AsType PlutusScriptV2 Source # | |
|
Defined in Cardano.Api.Script |
|
data ScriptLanguage lang where Source #
Constructors
| SimpleScriptLanguage :: SimpleScriptVersion lang -> ScriptLanguage lang | |
| PlutusScriptLanguage :: PlutusScriptVersion lang -> ScriptLanguage lang |
Instances
| Eq ( ScriptLanguage lang) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: ScriptLanguage lang -> ScriptLanguage lang -> Bool Source # (/=) :: ScriptLanguage lang -> ScriptLanguage lang -> Bool Source # |
|
| Show ( ScriptLanguage lang) Source # | |
|
Defined in Cardano.Api.Script |
|
| TestEquality ScriptLanguage Source # | |
|
Defined in Cardano.Api.Script Methods testEquality :: forall (a :: k) (b :: k). ScriptLanguage a -> ScriptLanguage b -> Maybe (a :~: b) Source # |
|
data SimpleScriptVersion lang where Source #
Constructors
| SimpleScriptV1 :: SimpleScriptVersion SimpleScriptV1 | |
| SimpleScriptV2 :: SimpleScriptVersion SimpleScriptV2 |
Instances
| Eq ( SimpleScriptVersion lang) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: SimpleScriptVersion lang -> SimpleScriptVersion lang -> Bool Source # (/=) :: SimpleScriptVersion lang -> SimpleScriptVersion lang -> Bool Source # |
|
| Show ( SimpleScriptVersion lang) Source # | |
|
Defined in Cardano.Api.Script |
|
| TestEquality SimpleScriptVersion Source # | |
|
Defined in Cardano.Api.Script Methods testEquality :: forall (a :: k) (b :: k). SimpleScriptVersion a -> SimpleScriptVersion b -> Maybe (a :~: b) Source # |
|
data PlutusScriptVersion lang where Source #
Constructors
| PlutusScriptV1 :: PlutusScriptVersion PlutusScriptV1 | |
| PlutusScriptV2 :: PlutusScriptVersion PlutusScriptV2 |
Instances
| Eq ( PlutusScriptVersion lang) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: PlutusScriptVersion lang -> PlutusScriptVersion lang -> Bool Source # (/=) :: PlutusScriptVersion lang -> PlutusScriptVersion lang -> Bool Source # |
|
| Show ( PlutusScriptVersion lang) Source # | |
|
Defined in Cardano.Api.Script |
|
| TestEquality PlutusScriptVersion Source # | |
|
Defined in Cardano.Api.Script Methods testEquality :: forall (a :: k) (b :: k). PlutusScriptVersion a -> PlutusScriptVersion b -> Maybe (a :~: b) Source # |
|
data AnyScriptLanguage where Source #
Constructors
| AnyScriptLanguage :: ScriptLanguage lang -> AnyScriptLanguage |
Instances
data AnyPlutusScriptVersion where Source #
Constructors
| AnyPlutusScriptVersion :: PlutusScriptVersion lang -> AnyPlutusScriptVersion |
Instances
class HasTypeProxy lang => IsScriptLanguage lang where Source #
Methods
scriptLanguage :: ScriptLanguage lang Source #
Instances
| IsScriptLanguage PlutusScriptV2 Source # | |
|
Defined in Cardano.Api.Script Methods |
|
| IsScriptLanguage PlutusScriptV1 Source # | |
|
Defined in Cardano.Api.Script Methods |
|
| IsScriptLanguage SimpleScriptV2 Source # | |
|
Defined in Cardano.Api.Script Methods |
|
| IsScriptLanguage SimpleScriptV1 Source # | |
|
Defined in Cardano.Api.Script Methods |
|
class IsScriptLanguage lang => IsSimpleScriptLanguage lang where Source #
Methods
Instances
| IsSimpleScriptLanguage SimpleScriptV2 Source # | |
|
Defined in Cardano.Api.Script Methods simpleScriptVersion :: SimpleScriptVersion SimpleScriptV2 Source # |
|
| IsSimpleScriptLanguage SimpleScriptV1 Source # | |
|
Defined in Cardano.Api.Script Methods simpleScriptVersion :: SimpleScriptVersion SimpleScriptV1 Source # |
|
Scripts in a specific language
data Script lang where Source #
A script in a particular language.
See also
ScriptInAnyLang
for a script in any of the known languages.
See also
ScriptInEra
for a script in a language that is available within
a particular era.
Note that some but not all scripts have an external JSON syntax, hence this
type has no JSON serialisation instances. The
SimpleScript
family of
languages do have a JSON syntax and thus have
ToJSON
/
FromJSON
instances.
Constructors
| SimpleScript :: !( SimpleScriptVersion lang) -> !( SimpleScript lang) -> Script lang | |
| PlutusScript :: !( PlutusScriptVersion lang) -> !( PlutusScript lang) -> Script lang |
Instances
| Eq ( Script lang) Source # | |
| Show ( Script lang) Source # | |
| HasTypeProxy lang => HasTypeProxy ( Script lang) Source # | |
| IsScriptLanguage lang => SerialiseAsCBOR ( Script lang) Source # | |
|
Defined in Cardano.Api.Script Methods serialiseToCBOR :: Script lang -> ByteString Source # deserialiseFromCBOR :: AsType ( Script lang) -> ByteString -> Either DecoderError ( Script lang) Source # |
|
| IsScriptLanguage lang => HasTextEnvelope ( Script lang) Source # | |
|
Defined in Cardano.Api.Script Methods textEnvelopeType :: AsType ( Script lang) -> TextEnvelopeType Source # textEnvelopeDefaultDescr :: Script lang -> TextEnvelopeDescr Source # |
|
| data AsType ( Script lang) Source # | |
|
Defined in Cardano.Api.Script |
|
Scripts in any language
data ScriptInAnyLang where Source #
Sometimes it is necessary to handle all languages without making static type distinctions between languages. For example, when reading external input, or before the era context is known.
Use
toScriptInEra
to convert to a script in the context of an era.
Constructors
| ScriptInAnyLang :: ScriptLanguage lang -> Script lang -> ScriptInAnyLang |
Instances
| Eq ScriptInAnyLang Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: ScriptInAnyLang -> ScriptInAnyLang -> Bool Source # (/=) :: ScriptInAnyLang -> ScriptInAnyLang -> Bool Source # |
|
| Show ScriptInAnyLang Source # | |
|
Defined in Cardano.Api.Script |
|
| ToJSON ScriptInAnyLang Source # | |
|
Defined in Cardano.Api.Script Methods toJSON :: ScriptInAnyLang -> Value Source # toEncoding :: ScriptInAnyLang -> Encoding Source # toJSONList :: [ ScriptInAnyLang ] -> Value Source # toEncodingList :: [ ScriptInAnyLang ] -> Encoding Source # |
|
| FromJSON ScriptInAnyLang Source # | |
|
Defined in Cardano.Api.Script Methods parseJSON :: Value -> Parser ScriptInAnyLang Source # parseJSONList :: Value -> Parser [ ScriptInAnyLang ] Source # |
|
| HasTypeProxy ScriptInAnyLang Source # | |
|
Defined in Cardano.Api.Script Associated Types data AsType ScriptInAnyLang Source # Methods proxyToAsType :: Proxy ScriptInAnyLang -> AsType ScriptInAnyLang Source # |
|
| data AsType ScriptInAnyLang Source # | |
|
Defined in Cardano.Api.Script |
|
toScriptInAnyLang :: Script lang -> ScriptInAnyLang Source #
Convert a script in a specific statically-known language to a
ScriptInAnyLang
.
No inverse to this is provided, just do case analysis on the
ScriptLanguage
field within the
ScriptInAnyLang
constructor.
Scripts in a specific era
data ScriptInEra era where Source #
Constructors
| ScriptInEra :: ScriptLanguageInEra lang era -> Script lang -> ScriptInEra era |
Instances
| Eq ( ScriptInEra era) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: ScriptInEra era -> ScriptInEra era -> Bool Source # (/=) :: ScriptInEra era -> ScriptInEra era -> Bool Source # |
|
| Show ( ScriptInEra era) Source # | |
|
Defined in Cardano.Api.Script |
|
| HasTypeProxy era => HasTypeProxy ( ScriptInEra era) Source # | |
|
Defined in Cardano.Api.Script Associated Types data AsType ( ScriptInEra era) Source # Methods proxyToAsType :: Proxy ( ScriptInEra era) -> AsType ( ScriptInEra era) Source # |
|
| data AsType ( ScriptInEra era) Source # | |
|
Defined in Cardano.Api.Script |
|
toScriptInEra :: CardanoEra era -> ScriptInAnyLang -> Maybe ( ScriptInEra era) Source #
Given a target era and a script in some language, check if the language is
supported in that era, and if so return a
ScriptInEra
.
eraOfScriptInEra :: ScriptInEra era -> ShelleyBasedEra era Source #
Use of a script in an era as a witness
data WitCtxTxIn Source #
A tag type for the context in which a script is used in a transaction.
This type tags the context as being to witness a transaction input.
data WitCtxMint Source #
A tag type for the context in which a script is used in a transaction.
This type tags the context as being to witness minting.
data WitCtxStake Source #
A tag type for the context in which a script is used in a transaction.
This type tags the context as being to witness the use of stake addresses in both certificates and withdrawals.
data WitCtx witctx where Source #
This GADT provides a value-level representation of all the witness contexts. This enables pattern matching on the context to allow them to be treated in a non-uniform way.
Constructors
| WitCtxTxIn :: WitCtx WitCtxTxIn | |
| WitCtxMint :: WitCtx WitCtxMint | |
| WitCtxStake :: WitCtx WitCtxStake |
data ScriptWitness witctx era where Source #
A use of a script within a transaction body to witness that something is being used in an authorised manner. That can be
- spending a transaction input
- minting tokens
- using a certificate (stake address certs specifically)
- withdrawing from a reward account
For simple script languages, the use of the script is the same in all contexts. For Plutus scripts, using a script involves supplying a redeemer. In addition, Plutus scripts used for spending inputs must also supply the datum value used when originally creating the TxOut that is now being spent.
Constructors
| SimpleScriptWitness :: ScriptLanguageInEra lang era -> SimpleScriptVersion lang -> SimpleScriptOrReferenceInput lang -> ScriptWitness witctx era | |
| PlutusScriptWitness :: ScriptLanguageInEra lang era -> PlutusScriptVersion lang -> PlutusScriptOrReferenceInput lang -> ScriptDatum witctx -> ScriptRedeemer -> ExecutionUnits -> ScriptWitness witctx era |
Instances
| Eq ( ScriptWitness witctx era) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: ScriptWitness witctx era -> ScriptWitness witctx era -> Bool Source # (/=) :: ScriptWitness witctx era -> ScriptWitness witctx era -> Bool Source # |
|
| Show ( ScriptWitness witctx era) Source # | |
|
Defined in Cardano.Api.Script |
|
data Witness witctx era where Source #
Constructors
| KeyWitness :: KeyWitnessInCtx witctx -> Witness witctx era | |
| ScriptWitness :: ScriptWitnessInCtx witctx -> ScriptWitness witctx era -> Witness witctx era |
data KeyWitnessInCtx witctx where Source #
Constructors
| KeyWitnessForSpending :: KeyWitnessInCtx WitCtxTxIn | |
| KeyWitnessForStakeAddr :: KeyWitnessInCtx WitCtxStake |
Instances
| Eq ( KeyWitnessInCtx witctx) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: KeyWitnessInCtx witctx -> KeyWitnessInCtx witctx -> Bool Source # (/=) :: KeyWitnessInCtx witctx -> KeyWitnessInCtx witctx -> Bool Source # |
|
| Show ( KeyWitnessInCtx witctx) Source # | |
|
Defined in Cardano.Api.Script |
|
data ScriptWitnessInCtx witctx where Source #
Constructors
| ScriptWitnessForSpending :: ScriptWitnessInCtx WitCtxTxIn | |
| ScriptWitnessForMinting :: ScriptWitnessInCtx WitCtxMint | |
| ScriptWitnessForStakeAddr :: ScriptWitnessInCtx WitCtxStake |
Instances
| Eq ( ScriptWitnessInCtx witctx) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: ScriptWitnessInCtx witctx -> ScriptWitnessInCtx witctx -> Bool Source # (/=) :: ScriptWitnessInCtx witctx -> ScriptWitnessInCtx witctx -> Bool Source # |
|
| Show ( ScriptWitnessInCtx witctx) Source # | |
|
Defined in Cardano.Api.Script |
|
data ScriptDatum witctx where Source #
Constructors
| ScriptDatumForTxIn :: ScriptData -> ScriptDatum WitCtxTxIn | |
| InlineScriptDatum :: ScriptDatum WitCtxTxIn | |
| NoScriptDatumForMint :: ScriptDatum WitCtxMint | |
| NoScriptDatumForStake :: ScriptDatum WitCtxStake |
Instances
| Eq ( ScriptDatum witctx) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: ScriptDatum witctx -> ScriptDatum witctx -> Bool Source # (/=) :: ScriptDatum witctx -> ScriptDatum witctx -> Bool Source # |
|
| Show ( ScriptDatum witctx) Source # | |
|
Defined in Cardano.Api.Script |
|
type ScriptRedeemer = ScriptData Source #
scriptWitnessScript :: ScriptWitness witctx era -> Maybe ( ScriptInEra era) Source #
Inspecting
ScriptWitness
es
data AnyScriptWitness era where Source #
A
ScriptWitness
in any
WitCtx
. This lets us handle heterogeneous
collections of script witnesses from multiple contexts.
Constructors
| AnyScriptWitness :: ScriptWitness witctx era -> AnyScriptWitness era |
data ScriptWitnessIndex Source #
Identify the location of a
ScriptWitness
within the context of a
TxBody
. These are indexes of the objects within the transaction that
need or can use script witnesses: inputs, minted assets, withdrawals and
certificates. These are simple numeric indices, enumerated from zero.
Thus the indices are not stable if the transaction body is modified.
Constructors
| ScriptWitnessIndexTxIn ! Word |
The n'th transaction input, in the order of the
|
| ScriptWitnessIndexMint ! Word | |
| ScriptWitnessIndexCertificate ! Word |
The n'th certificate, in the list order of the certificates. |
| ScriptWitnessIndexWithdrawal ! Word |
The n'th withdrawal, in the order of the
|
Instances
| Eq ScriptWitnessIndex Source # | |
|
Defined in Cardano.Api.TxBody Methods (==) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # (/=) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # |
|
| Ord ScriptWitnessIndex Source # | |
|
Defined in Cardano.Api.TxBody Methods compare :: ScriptWitnessIndex -> ScriptWitnessIndex -> Ordering Source # (<) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # (<=) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # (>) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # (>=) :: ScriptWitnessIndex -> ScriptWitnessIndex -> Bool Source # max :: ScriptWitnessIndex -> ScriptWitnessIndex -> ScriptWitnessIndex Source # min :: ScriptWitnessIndex -> ScriptWitnessIndex -> ScriptWitnessIndex Source # |
|
| Show ScriptWitnessIndex Source # | |
|
Defined in Cardano.Api.TxBody |
|
collectTxBodyScriptWitnesses :: forall era. TxBodyContent BuildTx era -> [( ScriptWitnessIndex , AnyScriptWitness era)] Source #
mapTxScriptWitnesses :: forall era. ( forall witctx. ScriptWitnessIndex -> ScriptWitness witctx era -> Either TxBodyErrorAutoBalance ( ScriptWitness witctx era)) -> TxBodyContent BuildTx era -> Either TxBodyErrorAutoBalance ( TxBodyContent BuildTx era) Source #
Languages supported in each era
data ScriptLanguageInEra lang era where Source #
Constructors
Instances
| Eq ( ScriptLanguageInEra lang era) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: ScriptLanguageInEra lang era -> ScriptLanguageInEra lang era -> Bool Source # (/=) :: ScriptLanguageInEra lang era -> ScriptLanguageInEra lang era -> Bool Source # |
|
| Show ( ScriptLanguageInEra lang era) Source # | |
|
Defined in Cardano.Api.Script |
|
| ToJSON ( ScriptLanguageInEra lang era) Source # | |
|
Defined in Cardano.Api.Script Methods toJSON :: ScriptLanguageInEra lang era -> Value Source # toEncoding :: ScriptLanguageInEra lang era -> Encoding Source # toJSONList :: [ ScriptLanguageInEra lang era] -> Value Source # toEncodingList :: [ ScriptLanguageInEra lang era] -> Encoding Source # |
|
scriptLanguageSupportedInEra :: CardanoEra era -> ScriptLanguage lang -> Maybe ( ScriptLanguageInEra lang era) Source #
Check if a given script language is supported in a given era, and if so return the evidence.
languageOfScriptLanguageInEra :: ScriptLanguageInEra lang era -> ScriptLanguage lang Source #
eraOfScriptLanguageInEra :: ScriptLanguageInEra lang era -> ShelleyBasedEra era Source #
Simple scripts
Making multi-signature and time-lock scripts.
data SimpleScript lang where Source #
Constructors
| RequireSignature :: !( Hash PaymentKey ) -> SimpleScript lang | |
| RequireTimeBefore :: !( TimeLocksSupported lang) -> ! SlotNo -> SimpleScript lang | |
| RequireTimeAfter :: !( TimeLocksSupported lang) -> ! SlotNo -> SimpleScript lang | |
| RequireAllOf :: [ SimpleScript lang] -> SimpleScript lang | |
| RequireAnyOf :: [ SimpleScript lang] -> SimpleScript lang | |
| RequireMOf :: Int -> [ SimpleScript lang] -> SimpleScript lang |
Instances
data TimeLocksSupported lang where Source #
Time lock feature in the
SimpleScript
language.
The constructors of this type serve as evidence that the timelocks feature is supported in particular versions of the language.
Constructors
| TimeLocksInSimpleScriptV2 :: TimeLocksSupported SimpleScriptV2 |
Instances
| Eq ( TimeLocksSupported lang) Source # | |
|
Defined in Cardano.Api.Script Methods (==) :: TimeLocksSupported lang -> TimeLocksSupported lang -> Bool Source # (/=) :: TimeLocksSupported lang -> TimeLocksSupported lang -> Bool Source # |
|
| Show ( TimeLocksSupported lang) Source # | |
|
Defined in Cardano.Api.Script |
|
timeLocksSupported :: SimpleScriptVersion lang -> Maybe ( TimeLocksSupported lang) Source #
adjustSimpleScriptVersion :: SimpleScriptVersion lang' -> SimpleScript lang -> Maybe ( SimpleScript lang') Source #
Try converting the
SimpleScript
into a different version of the language.
This will work when the script only uses the features of the target language
version. For example converting from
SimpleScriptV2
to
SimpleScriptV1
will work if the script happens not to use time locks feature. On the other
hand converting
SimpleScriptV1
to
SimpleScriptV2
will always work because
it is backwards compatible.
Plutus scripts
data PlutusScript lang Source #
Plutus scripts.
Note that Plutus scripts have a binary serialisation but no JSON serialisation.
Instances
examplePlutusScriptAlwaysSucceeds :: WitCtx witctx -> PlutusScript PlutusScriptV1 Source #
An example Plutus script that always succeeds, irrespective of inputs.
For example, if one were to use this for a payment address then it would allow anyone to spend from it.
The exact script depends on the context in which it is to be used.
examplePlutusScriptAlwaysFails :: WitCtx witctx -> PlutusScript PlutusScriptV1 Source #
An example Plutus script that always fails, irrespective of inputs.
For example, if one were to use this for a payment address then it would be impossible for anyone to ever spend from it.
The exact script depends on the context in which it is to be used.
Script data
data ScriptData Source #
Constructors
| ScriptDataConstructor | |
|
Fields
|
|
| ScriptDataMap [( ScriptData , ScriptData )] |
Key value pairs |
| ScriptDataList [ ScriptData ] |
Elements |
| ScriptDataNumber Integer | |
| ScriptDataBytes ByteString | |
Instances
Validation
data ScriptDataRangeError Source #
An error in script data due to an out-of-range value.
Constructors
| ScriptDataNumberOutOfRange ! Integer |
The number is outside the maximum range of
|
| ScriptDataConstructorOutOfRange ! Integer |
The number is outside the maximum range of
|
| ScriptDataBytesTooLong ! Int |
The length of a byte string metadatum value exceeds the maximum of 64 bytes. |
Instances
| Eq ScriptDataRangeError Source # | |
|
Defined in Cardano.Api.ScriptData Methods (==) :: ScriptDataRangeError -> ScriptDataRangeError -> Bool Source # (/=) :: ScriptDataRangeError -> ScriptDataRangeError -> Bool Source # |
|
| Show ScriptDataRangeError Source # | |
|
Defined in Cardano.Api.ScriptData |
|
| Error ScriptDataRangeError Source # | |
|
Defined in Cardano.Api.ScriptData Methods |
|
validateScriptData :: ScriptData -> Either ScriptDataRangeError () Source #
Validate script data. This is for use with existing constructed script data values, e.g. constructed manually or decoded from CBOR directly.
Conversion to/from JSON
data ScriptDataJsonSchema Source #
Script data is similar to JSON but not exactly the same. It has some deliberate limitations such as no support for floating point numbers or special forms for null or boolean values. It also has limitations on the length of strings. On the other hand, unlike JSON, it distinguishes between byte strings and text strings. It also supports any value as map keys rather than just string. It also supports alternatives / tagged unions, used for representing constructors for Plutus data values.
We provide two different mappings between script data and JSON, useful for different purposes:
- A mapping that allows almost any JSON value to be converted into script data. This does not require a specific JSON schema for the input. It does not expose the full representation capability of script data.
- A mapping that exposes the full representation capability of script data, but relies on a specific JSON schema for the input JSON.
In the "no schema" mapping, the idea is that (almost) any JSON can be turned into script data and then converted back, without loss. That is, we can round-trip the JSON.
The subset of JSON supported is all JSON except: * No null or bool values * No floating point, only integers in the range of a 64bit signed integer * A limitation on string lengths
The approach for this mapping is to use whichever representation as script data is most compact. In particular:
- JSON lists and maps represented as CBOR lists and maps
- JSON strings represented as CBOR strings
- JSON hex strings with "0x" prefix represented as CBOR byte strings
- JSON integer numbers represented as CBOR signed or unsigned numbers
- JSON maps with string keys that parse as numbers or hex byte strings, represented as CBOR map keys that are actually numbers or byte strings.
The string length limit depends on whether the hex string representation is used or not. For text strings the limit is 64 bytes for the UTF8 representation of the text string. For byte strings the limit is 64 bytes for the raw byte form (ie not the input hex, but after hex decoding).
In the "detailed schema" mapping, the idea is that we expose the full representation capability of the script data in the form of a JSON schema. This means the full representation is available and can be controlled precisely. It also means any script data can be converted into the JSON and back without loss. That is we can round-trip the script data via the JSON and also round-trip schema-compliant JSON via script data.
Constructors
| ScriptDataJsonNoSchema |
Use the "no schema" mapping between JSON and script data as described above. |
| ScriptDataJsonDetailedSchema |
Use the "detailed schema" mapping between JSON and script data as described above. |
Instances
| Eq ScriptDataJsonSchema Source # | |
|
Defined in Cardano.Api.ScriptData Methods (==) :: ScriptDataJsonSchema -> ScriptDataJsonSchema -> Bool Source # (/=) :: ScriptDataJsonSchema -> ScriptDataJsonSchema -> Bool Source # |
|
| Show ScriptDataJsonSchema Source # | |
|
Defined in Cardano.Api.ScriptData |
|
scriptDataFromJson :: ScriptDataJsonSchema -> Value -> Either ScriptDataJsonError ScriptData Source #
Convert a value from JSON into script data, using the given choice of mapping between JSON and script data.
This may fail with a conversion error if the JSON is outside the supported
subset for the chosen mapping. See
ScriptDataJsonSchema
for the details.
scriptDataToJson :: ScriptDataJsonSchema -> ScriptData -> Value Source #
Convert a script data value into JSON , using the given choice of mapping between JSON and script data.
This conversion is total but is not necessarily invertible.
See
ScriptDataJsonSchema
for the details.
data ScriptDataJsonError Source #
Constructors
| ScriptDataJsonSchemaError ! Value ! ScriptDataJsonSchemaError | |
| ScriptDataRangeError ! Value ! ScriptDataRangeError |
Instances
| Eq ScriptDataJsonError Source # | |
|
Defined in Cardano.Api.ScriptData Methods (==) :: ScriptDataJsonError -> ScriptDataJsonError -> Bool Source # (/=) :: ScriptDataJsonError -> ScriptDataJsonError -> Bool Source # |
|
| Show ScriptDataJsonError Source # | |
|
Defined in Cardano.Api.ScriptData |
|
| Error ScriptDataJsonError Source # | |
|
Defined in Cardano.Api.ScriptData Methods |
|
data ScriptDataJsonSchemaError Source #
Constructors
Instances
| Eq ScriptDataJsonSchemaError Source # | |
|
Defined in Cardano.Api.ScriptData Methods (==) :: ScriptDataJsonSchemaError -> ScriptDataJsonSchemaError -> Bool Source # (/=) :: ScriptDataJsonSchemaError -> ScriptDataJsonSchemaError -> Bool Source # |
|
| Show ScriptDataJsonSchemaError Source # | |
|
Defined in Cardano.Api.ScriptData |
|
| Error ScriptDataJsonSchemaError Source # | |
|
Defined in Cardano.Api.ScriptData Methods displayError :: ScriptDataJsonSchemaError -> String Source # |
|
Script execution units
data ExecutionUnits Source #
The units for how long a script executes for and how much memory it uses. This is used to declare the resources used by a particular use of a script.
This type is also used to describe the limits for the maximum overall execution units per transaction or per block.
Constructors
| ExecutionUnits | |
|
Fields
|
|
Instances
data ExecutionUnitPrices Source #
The prices for
ExecutionUnits
as a fraction of a
Lovelace
.
These are used to determine the fee for the use of a script within a
transaction, based on the
ExecutionUnits
needed by the use of the script.
Constructors
| ExecutionUnitPrices | |
|
Fields |
|
Instances
validateCostModel :: PlutusScriptVersion lang -> CostModel -> Either InvalidCostModel () Source #
Script addresses
Making addresses from scripts.
data ScriptHash Source #
We have this type separate from the
Hash
type to avoid the script
hash type being parametrised by the era. The representation is era
independent, and there are many places where we want to use a script
hash where we don't want things to be era-parametrised.
Instances
hashScript :: Script lang -> ScriptHash Source #
Serialisation
Support for serialising data in JSON, CBOR and text files.
CBOR
class HasTypeProxy a => SerialiseAsCBOR a Source #
Instances
class Typeable a => ToCBOR a Source #
Minimal complete definition
Instances
class Typeable a => FromCBOR a Source #
Minimal complete definition
Instances
serialiseToCBOR :: SerialiseAsCBOR a => a -> ByteString Source #
deserialiseFromCBOR :: SerialiseAsCBOR a => AsType a -> ByteString -> Either DecoderError a Source #
JSON
A type that can be converted to JSON.
Instances in general
must
specify
toJSON
and
should
(but don't need
to) specify
toEncoding
.
An example type and instance:
-- Allow ourselves to writeTextliterals. {-# LANGUAGE OverloadedStrings #-} data Coord = Coord { x :: Double, y :: Double } instanceToJSONCoord wheretoJSON(Coord x y) =object["x".=x, "y".=y]toEncoding(Coord x y) =pairs("x".=x<>"y".=y)
Instead of manually writing your
ToJSON
instance, there are two options
to do it automatically:
- Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time. The generated instance is optimized for your type so it will probably be more efficient than the following option.
-
The compiler can provide a default generic implementation for
toJSON.
To use the second, simply add a
deriving
clause to your
datatype and declare a
Generic
ToJSON
instance. If you require nothing other than
defaultOptions
, it is sufficient to write (and this is the only
alternative where the default
toJSON
implementation is sufficient):
{-# LANGUAGE DeriveGeneric #-}
import GHC.Generics
data Coord = Coord { x :: Double, y :: Double } deriving Generic
instance ToJSON Coord where
toEncoding = genericToEncoding defaultOptions
If on the other hand you wish to customize the generic decoding, you have to implement both methods:
customOptions =defaultOptions{fieldLabelModifier=maptoUpper} instanceToJSONCoord wheretoJSON=genericToJSONcustomOptionstoEncoding=genericToEncodingcustomOptions
Previous versions of this library only had the
toJSON
method. Adding
toEncoding
had two reasons:
-
toEncoding is more efficient for the common case that the output of
toJSONis directly serialized to aByteString. Further, expressing either method in terms of the other would be non-optimal. -
The choice of defaults allows a smooth transition for existing users:
Existing instances that do not define
toEncodingstill compile and have the correct semantics. This is ensured by making the default implementation oftoEncodingusetoJSON. This produces correct results, but since it performs an intermediate conversion to aValue, it will be less efficient than directly emitting anEncoding. (this also means that specifying nothing more thaninstance ToJSON Coordwould be sufficient as a generically decoding instance, but there probably exists no good reason to not specifytoEncodingin new instances.)
Instances
A type that can be converted from JSON, with the possibility of failure.
In many cases, you can get the compiler to generate parsing code for you (see below). To begin, let's cover writing an instance by hand.
There are various reasons a conversion could fail. For example, an
Object
could be missing a required key, an
Array
could be of
the wrong size, or a value could be of an incompatible type.
The basic ways to signal a failed conversion are as follows:
-
failyields a custom error message: it is the recommended way of reporting a failure; -
empty(ormzero) is uninformative: use it when the error is meant to be caught by some(;<|>) -
typeMismatchcan be used to report a failure when the encountered value is not of the expected JSON type;unexpectedis an appropriate alternative when more than one type may be expected, or to keep the expected type implicit.
prependFailure
(or
modifyFailure
) add more information to a parser's
error messages.
An example type and instance using
typeMismatch
and
prependFailure
:
-- Allow ourselves to writeTextliterals. {-# LANGUAGE OverloadedStrings #-} data Coord = Coord { x :: Double, y :: Double } instanceFromJSONCoord whereparseJSON(Objectv) = Coord<$>v.:"x"<*>v.:"y" -- We do not expect a non-Objectvalue here. -- We could useemptyto fail, buttypeMismatch-- gives a much more informative error message.parseJSONinvalid =prependFailure"parsing Coord failed, " (typeMismatch"Object" invalid)
For this common case of only being concerned with a single
type of JSON value, the functions
withObject
,
withScientific
, etc.
are provided. Their use is to be preferred when possible, since
they are more terse. Using
withObject
, we can rewrite the above instance
(assuming the same language extension and data type) as:
instanceFromJSONCoord whereparseJSON=withObject"Coord" $ \v -> Coord<$>v.:"x"<*>v.:"y"
Instead of manually writing your
FromJSON
instance, there are two options
to do it automatically:
- Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time. The generated instance is optimized for your type so it will probably be more efficient than the following option.
-
The compiler can provide a default generic implementation for
parseJSON.
To use the second, simply add a
deriving
clause to your
datatype and declare a
Generic
FromJSON
instance for your datatype without giving
a definition for
parseJSON
.
For example, the previous example can be simplified to just:
{-# LANGUAGE DeriveGeneric #-}
import GHC.Generics
data Coord = Coord { x :: Double, y :: Double } deriving Generic
instance FromJSON Coord
The default implementation will be equivalent to
parseJSON =
; if you need different
options, you can customize the generic decoding by defining:
genericParseJSON
defaultOptions
customOptions =defaultOptions{fieldLabelModifier=maptoUpper} instanceFromJSONCoord whereparseJSON=genericParseJSONcustomOptions
Instances
serialiseToJSON :: ToJSON a => a -> ByteString Source #
deserialiseFromJSON :: FromJSON a => AsType a -> ByteString -> Either JsonDecodeError a Source #
newtype JsonDecodeError Source #
Constructors
| JsonDecodeError String |
Instances
| Eq JsonDecodeError Source # | |
|
Defined in Cardano.Api.SerialiseJSON Methods (==) :: JsonDecodeError -> JsonDecodeError -> Bool Source # (/=) :: JsonDecodeError -> JsonDecodeError -> Bool Source # |
|
| Show JsonDecodeError Source # | |
|
Defined in Cardano.Api.SerialiseJSON |
|
| Error JsonDecodeError Source # | |
|
Defined in Cardano.Api.SerialiseJSON Methods displayError :: JsonDecodeError -> String Source # |
|
readFileJSON :: FromJSON a => AsType a -> FilePath -> IO ( Either ( FileError JsonDecodeError ) a) Source #
prettyPrintJSON :: ToJSON a => a -> ByteString Source #
Bech32
class ( HasTypeProxy a, SerialiseAsRawBytes a) => SerialiseAsBech32 a Source #
Minimal complete definition
bech32PrefixFor, bech32PrefixesPermitted
Instances
serialiseToBech32 :: SerialiseAsBech32 a => a -> Text Source #
deserialiseFromBech32 :: SerialiseAsBech32 a => AsType a -> Text -> Either Bech32DecodeError a Source #
deserialiseAnyOfFromBech32 :: forall b. [ FromSomeType SerialiseAsBech32 b] -> Text -> Either Bech32DecodeError b Source #
data Bech32DecodeError Source #
Bech32 decoding error.
Constructors
| Bech32DecodingError ! DecodingError |
There was an error decoding the string as Bech32. |
| Bech32UnexpectedPrefix ! Text !( Set Text ) |
The human-readable prefix in the Bech32-encoded string is not one of the ones expected. |
| Bech32DataPartToBytesError ! Text |
There was an error in extracting a
|
| Bech32DeserialiseFromBytesError ! ByteString |
There was an error in deserialising the bytes into a value of the expected type. |
| Bech32WrongPrefix ! Text ! Text |
The human-readable prefix in the Bech32-encoded string does not correspond to the prefix that should be used for the payload value. |
Instances
| Eq Bech32DecodeError Source # | |
|
Defined in Cardano.Api.SerialiseBech32 Methods (==) :: Bech32DecodeError -> Bech32DecodeError -> Bool Source # (/=) :: Bech32DecodeError -> Bech32DecodeError -> Bool Source # |
|
| Show Bech32DecodeError Source # | |
|
Defined in Cardano.Api.SerialiseBech32 |
|
| Error Bech32DecodeError Source # | |
|
Defined in Cardano.Api.SerialiseBech32 Methods |
|
Addresses
Address serialisation is (sadly) special
class HasTypeProxy addr => SerialiseAddress addr Source #
Address serialisation uses different serialisation formats for different kinds of addresses, so it needs its own class.
In particular, Byron addresses are typically formatted in base 58, while Shelley addresses (payment and stake) are formatted using Bech32.
Minimal complete definition
Instances
| SerialiseAddress StakeAddress Source # | |
|
Defined in Cardano.Api.Address Methods serialiseAddress :: StakeAddress -> Text Source # deserialiseAddress :: AsType StakeAddress -> Text -> Maybe StakeAddress Source # |
|
| SerialiseAddress AddressAny Source # | |
|
Defined in Cardano.Api.Address Methods serialiseAddress :: AddressAny -> Text Source # deserialiseAddress :: AsType AddressAny -> Text -> Maybe AddressAny Source # |
|
| IsCardanoEra era => SerialiseAddress ( AddressInEra era) Source # | |
|
Defined in Cardano.Api.Address Methods serialiseAddress :: AddressInEra era -> Text Source # deserialiseAddress :: AsType ( AddressInEra era) -> Text -> Maybe ( AddressInEra era) Source # |
|
| SerialiseAddress ( Address ShelleyAddr ) Source # | |
|
Defined in Cardano.Api.Address Methods serialiseAddress :: Address ShelleyAddr -> Text Source # deserialiseAddress :: AsType ( Address ShelleyAddr ) -> Text -> Maybe ( Address ShelleyAddr ) Source # |
|
| SerialiseAddress ( Address ByronAddr ) Source # | |
serialiseAddress :: SerialiseAddress addr => addr -> Text Source #
deserialiseAddress :: SerialiseAddress addr => AsType addr -> Text -> Maybe addr Source #
Raw binary
Some types have a natural raw binary format.
class HasTypeProxy a => SerialiseAsRawBytes a Source #
Minimal complete definition
Instances
serialiseToRawBytes :: SerialiseAsRawBytes a => a -> ByteString Source #
deserialiseFromRawBytes :: SerialiseAsRawBytes a => AsType a -> ByteString -> Maybe a Source #
serialiseToRawBytesHex :: SerialiseAsRawBytes a => a -> ByteString Source #
deserialiseFromRawBytesHex :: SerialiseAsRawBytes a => AsType a -> ByteString -> Either RawBytesHexError a Source #
serialiseToRawBytesHexText :: SerialiseAsRawBytes a => a -> Text Source #
Text envelope
Support for a envelope file format with text headers and a hex-encoded binary payload.
class SerialiseAsCBOR a => HasTextEnvelope a where Source #
Minimal complete definition
Methods
textEnvelopeType :: AsType a -> TextEnvelopeType Source #
Instances
data TextEnvelope Source #
A
TextEnvelope
is a structured envelope for serialised binary values
with an external format with a semi-readable textual format.
It contains a "type" field, e.g. "PublicKeyByron" or "TxSignedShelley" to indicate the type of the encoded data. This is used as a sanity check and to help readers.
It also contains a "title" field which is free-form, and could be used to indicate the role or purpose to a reader.
Constructors
| TextEnvelope | |
|
Fields
|
|
Instances
newtype TextEnvelopeType Source #
Constructors
| TextEnvelopeType String |
Instances
data TextEnvelopeDescr Source #
Instances
data TextEnvelopeError Source #
The errors that the pure
TextEnvelope
parsing/decoding functions can return.
Constructors
| TextEnvelopeTypeError ![ TextEnvelopeType ] ! TextEnvelopeType |
expected, actual |
| TextEnvelopeDecodeError ! DecoderError | |
| TextEnvelopeAesonDecodeError ! String |
Instances
| Eq TextEnvelopeError Source # | |
|
Defined in Cardano.Api.SerialiseTextEnvelope Methods (==) :: TextEnvelopeError -> TextEnvelopeError -> Bool Source # (/=) :: TextEnvelopeError -> TextEnvelopeError -> Bool Source # |
|
| Show TextEnvelopeError Source # | |
|
Defined in Cardano.Api.SerialiseTextEnvelope |
|
| Error TextEnvelopeError Source # | |
|
Defined in Cardano.Api.SerialiseTextEnvelope Methods |
|
serialiseToTextEnvelope :: forall a. HasTextEnvelope a => Maybe TextEnvelopeDescr -> a -> TextEnvelope Source #
deserialiseFromTextEnvelope :: HasTextEnvelope a => AsType a -> TextEnvelope -> Either TextEnvelopeError a Source #
readFileTextEnvelope :: HasTextEnvelope a => AsType a -> FilePath -> IO ( Either ( FileError TextEnvelopeError ) a) Source #
writeFileTextEnvelope :: HasTextEnvelope a => FilePath -> Maybe TextEnvelopeDescr -> a -> IO ( Either ( FileError ()) ()) Source #
writeFileTextEnvelopeWithOwnerPermissions :: HasTextEnvelope a => FilePath -> Maybe TextEnvelopeDescr -> a -> IO ( Either ( FileError ()) ()) Source #
readTextEnvelopeFromFile :: FilePath -> IO ( Either ( FileError TextEnvelopeError ) TextEnvelope ) Source #
readTextEnvelopeOfTypeFromFile :: TextEnvelopeType -> FilePath -> IO ( Either ( FileError TextEnvelopeError ) TextEnvelope ) Source #
Text envelope CDDL
Support for serialising values in the ledger's CDDL format. Note, this will be deprecated in the future in favour of a single API.
data FromSomeTypeCDDL c b where Source #
This GADT allows us to deserialise a tx or key witness without having to provide the era.
Constructors
| FromCDDLTx | |
|
Fields
|
|
| FromCDDLWitness | |
|
Fields
|
|
readFileTextEnvelopeCddlAnyOf :: [ FromSomeTypeCDDL TextEnvelopeCddl b] -> FilePath -> IO ( Either ( FileError TextEnvelopeCddlError ) b) Source #
writeTxFileTextEnvelopeCddl :: IsCardanoEra era => FilePath -> Tx era -> IO ( Either ( FileError ()) ()) Source #
writeTxWitnessFileTextEnvelopeCddl :: ShelleyBasedEra era -> FilePath -> KeyWitness era -> IO ( Either ( FileError ()) ()) Source #
serialiseTxLedgerCddl :: forall era. IsCardanoEra era => Tx era -> TextEnvelopeCddl Source #
deserialiseTxLedgerCddl :: IsCardanoEra era => CardanoEra era -> TextEnvelopeCddl -> Either TextEnvelopeCddlError ( Tx era) Source #
serialiseWitnessLedgerCddl :: forall era. ShelleyBasedEra era -> KeyWitness era -> TextEnvelopeCddl Source #
deserialiseWitnessLedgerCddl :: ShelleyBasedEra era -> TextEnvelopeCddl -> Either TextEnvelopeCddlError ( KeyWitness era) Source #
data TextEnvelopeCddlError Source #
Constructors
Instances
| Eq TextEnvelopeCddlError Source # | |
|
Defined in Cardano.Api.SerialiseLedgerCddl Methods (==) :: TextEnvelopeCddlError -> TextEnvelopeCddlError -> Bool Source # (/=) :: TextEnvelopeCddlError -> TextEnvelopeCddlError -> Bool Source # |
|
| Show TextEnvelopeCddlError Source # | |
|
Defined in Cardano.Api.SerialiseLedgerCddl |
|
| Error TextEnvelopeCddlError Source # | |
|
Defined in Cardano.Api.SerialiseLedgerCddl Methods |
|
Reading one of several key types
data FromSomeType (c :: Type -> Constraint ) b where Source #
Constructors
| FromSomeType :: c a => AsType a -> (a -> b) -> FromSomeType c b |
deserialiseFromTextEnvelopeAnyOf :: [ FromSomeType HasTextEnvelope b] -> TextEnvelope -> Either TextEnvelopeError b Source #
readFileTextEnvelopeAnyOf :: [ FromSomeType HasTextEnvelope b] -> FilePath -> IO ( Either ( FileError TextEnvelopeError ) b) Source #
Errors
class Show e => Error e where Source #
Methods
displayError :: e -> String Source #
Instances
throwErrorAsException :: Error e => e -> IO a Source #
The preferred approach is to use
Except
or
ExceptT
, but you can if
necessary use IO exceptions.
Constructors
| FileError FilePath e | |
| FileErrorTempFile | |
| FileIOError FilePath IOException | |
Node interaction
Operations that involve talking to a local Cardano node.
Queries
Submitting transactions
High level protocol interaction with a Cardano node
Initialization / Accumulation
Constructors
| Env | |
envSecurityParam :: Env -> Word64 Source #
newtype LedgerState Source #
Constructors
| LedgerState | |
|
Fields |
|
Bundled Patterns
| pattern LedgerStateAlonzo :: LedgerState ( ShelleyBlock protocol ( AlonzoEra StandardCrypto )) -> LedgerState | |
| pattern LedgerStateMary :: LedgerState ( ShelleyBlock protocol ( MaryEra StandardCrypto )) -> LedgerState | |
| pattern LedgerStateAllegra :: LedgerState ( ShelleyBlock protocol ( AllegraEra StandardCrypto )) -> LedgerState | |
| pattern LedgerStateShelley :: LedgerState ( ShelleyBlock protocol ( ShelleyEra StandardCrypto )) -> LedgerState | |
| pattern LedgerStateByron :: LedgerState ByronBlock -> LedgerState |
Arguments
| :: FilePath |
Path to the cardano-node config file (e.g. to cardano-node project configuration cardano/mainnet-config.json) |
| -> ExceptT InitialLedgerStateError IO ( Env , LedgerState ) |
The environment and initial ledger state |
Get the environment and initial ledger state.
Arguments
| :: Env |
The environment returned by
|
| -> LedgerState |
The current ledger state |
| -> ValidationMode | |
| -> Block era |
Some block to apply |
| -> Either LedgerStateError ( LedgerState , [ LedgerEvent ]) |
The new ledger state (or an error). |
Apply a single block to the current ledger state.
data ValidationMode Source #
How to do validation when applying a block to a ledger state.
Constructors
| FullValidation |
Do all validation implied by the ledger layer's
|
| QuickValidation |
Only check that the previous hash from the block matches the head hash of the ledger state. |
Ledger Events
data LedgerEvent Source #
Constructors
| PoolRegistration Certificate |
The given pool is being registered for the first time on chain. |
| PoolReRegistration Certificate |
The given pool already exists and is being re-registered. |
| IncrementalRewardsDistribution EpochNo ( Map StakeCredential ( Set ( Reward StandardCrypto ))) |
Incremental rewards are being computed. |
| RewardsDistribution EpochNo ( Map StakeCredential ( Set ( Reward StandardCrypto ))) |
Reward distribution has completed. |
| MIRDistribution MIRDistributionDetails |
MIR are being distributed. |
| PoolReap PoolReapDetails |
Pools have been reaped and deposits refunded. |
data MIRDistributionDetails Source #
Details of fund transfers due to MIR certificates.
Note that the transfers from reserves to treasury and treasury to reserves are inverse; a transfer of 100 ADA in either direction will result in a net movement of 0, but we include both directions for assistance in debugging.
Constructors
| MIRDistributionDetails | |
data PoolReapDetails Source #
Constructors
| PoolReapDetails | |
|
Fields
|
|
toLedgerEvent :: ConvertLedgerEvent blk => WrapLedgerEvent blk -> Maybe LedgerEvent Source #
Traversing the block chain
Arguments
| :: forall a. FilePath |
Path to the cardano-node config file (e.g. to cardano-node project configuration cardano/mainnet-config.json) |
| -> FilePath |
Path to local cardano-node socket. This is the path specified by the
|
| -> ValidationMode | |
| -> a |
The initial accumulator state. |
| -> ( Env -> LedgerState -> [ LedgerEvent ] -> BlockInMode CardanoMode -> a -> IO a) |
Accumulator function Takes:
And returns:
Note: This function can safely assume no rollback will occur even though internally this is implemented with a client protocol that may require rollback. This is achieved by only calling the accumulator on states/blocks that are older than the security parameter, k. This has the side effect of truncating the last k blocks before the node's tip. |
| -> ExceptT FoldBlocksError IO a |
The final state |
Monadic fold over all blocks and ledger states. Stopping
k
blocks before
the node's tip where
k
is the security parameter.
chainSyncClientWithLedgerState Source #
Arguments
| :: forall m a. Monad m | |
| => Env | |
| -> LedgerState |
Initial ledger state |
| -> ValidationMode | |
| -> ChainSyncClient ( BlockInMode CardanoMode , Either LedgerStateError ( LedgerState , [ LedgerEvent ])) ChainPoint ChainTip m a |
A client to wrap. The block is annotated with a 'Either LedgerStateError
LedgerState'. This is either an error from validating a block or
the current
|
| -> ChainSyncClient ( BlockInMode CardanoMode ) ChainPoint ChainTip m a |
A client that acts just like the wrapped client but doesn't require the
|
Wrap a
ChainSyncClient
with logic that tracks the ledger state.
chainSyncClientPipelinedWithLedgerState :: forall 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 Source #
Errors
data LedgerStateError Source #
Constructors
| ApplyBlockHashMismatch Text |
When using QuickValidation, the block hash did not match the expected block hash after applying a new block to the current ledger state. |
| ApplyBlockError ( HardForkLedgerError ( CardanoEras StandardCrypto )) |
When using FullValidation, an error occurred when applying a new block to the current ledger state. |
| InvalidRollback |
Encountered a rollback larger than the security parameter. |
|
Fields
|
|
Instances
| Show LedgerStateError Source # | |
|
Defined in Cardano.Api.LedgerState |
|
data FoldBlocksError Source #
data GenesisConfigError Source #
Constructors
| NEError ! Text | |
| NEByronConfig ! FilePath ! ConfigurationError | |
| NEShelleyConfig ! FilePath ! Text | |
| NEAlonzoConfig ! FilePath ! Text | |
| NECardanoConfig ! Text |
data InitialLedgerStateError Source #
Constructors
| ILSEConfigFile Text |
Failed to read or parse the network config file. |
| ILSEGenesisFile GenesisConfigError |
Failed to read or parse a genesis file linked from the network config file. |
| ILSELedgerConsensusConfig GenesisConfigError |
Failed to derive the Ledger or Consensus config. |
Low level protocol interaction with a Cardano node
connectToLocalNode :: LocalNodeConnectInfo mode -> LocalNodeClientProtocolsInMode mode -> IO () Source #
Establish a connection to a local node and execute the given set of protocol handlers.
connectToLocalNodeWithVersion :: LocalNodeConnectInfo mode -> ( NodeToClientVersion -> LocalNodeClientProtocolsInMode mode) -> IO () Source #
Establish a connection to a local node and execute the given set of protocol handlers parameterized on the negotiated node-to-client protocol version.
data LocalNodeConnectInfo mode Source #
Constructors
| LocalNodeConnectInfo | |
|
Fields |
|
data AnyConsensusMode where Source #
Constructors
| AnyConsensusMode :: ConsensusMode mode -> AnyConsensusMode |
Instances
| Show AnyConsensusMode Source # | |
|
Defined in Cardano.Api.Modes |
|
renderMode :: AnyConsensusMode -> Text Source #
data ConsensusMode mode where Source #
This GADT provides a value-level representation of all the consensus modes. This enables pattern matching on the era to allow them to be treated in a non-uniform way.
Constructors
| CardanoMode :: ConsensusMode CardanoMode |
Instances
| Show ( ConsensusMode mode) Source # | |
|
Defined in Cardano.Api.Modes |
|
consensusModeOnly :: ConsensusModeParams mode -> ConsensusMode mode Source #
data ConsensusModeIsMultiEra mode where Source #
The subset of consensus modes that consist of multiple eras. Some features are not supported in single-era modes (for exact compatibility without using the hard fork combination at all).
Constructors
| CardanoModeIsMultiEra :: ConsensusModeIsMultiEra CardanoMode |
Instances
| Show ( ConsensusModeIsMultiEra mode) Source # | |
|
Defined in Cardano.Api.Modes |
|
data AnyConsensusModeParams where Source #
Constructors
| AnyConsensusModeParams :: ConsensusModeParams mode -> AnyConsensusModeParams |
Instances
| Show AnyConsensusModeParams Source # | |
|
Defined in Cardano.Api.Modes |
|
data ConsensusModeParams mode where Source #
The consensus-mode-specific parameters needed to connect to a local node that is using each consensus mode.
It is in fact only the Byron era that requires extra parameters, but this is
of course inherited by the
CardanoMode
that uses the Byron era. The reason
this parameter is needed stems from unfortunate design decisions from the
legacy Byron era. The slots per epoch are needed to be able to
decode
epoch boundary blocks from the Byron era.
It is possible in future that we may be able to eliminate this parameter by discovering it from the node during the initial handshake.
Constructors
| ByronModeParams :: EpochSlots -> ConsensusModeParams ByronMode | |
| ShelleyModeParams :: ConsensusModeParams ShelleyMode | |
| CardanoModeParams :: EpochSlots -> ConsensusModeParams CardanoMode |
Instances
| Show ( ConsensusModeParams mode) Source # | |
|
Defined in Cardano.Api.Modes |
|
type family ConsensusProtocol era where ... Source #
type family ChainDepStateProtocol era where ... Source #
Equations
type family ConsensusBlockForMode mode where ... Source #
A closed type family that maps between the consensus mode (from this API) and the block type used by the consensus libraries.
type family ConsensusBlockForEra era where ... Source #
Equations
data EraInMode era mode where Source #
A representation of which
CardanoEra
s are included in each
ConsensusMode
.
Constructors
Instances
toEraInMode :: CardanoEra era -> ConsensusMode mode -> Maybe ( EraInMode era mode) Source #
data LocalNodeClientProtocols block point tip slot tx txid txerr query m Source #
The protocols we can use with a local node. Use in conjunction with
connectToLocalNode
.
These protocols use the types from the rest of this API. The conversion
to/from the types used by the underlying wire formats is handled by
connectToLocalNode
.
Constructors
| LocalNodeClientProtocols | |
|
Fields
|
|
data LocalNodeClientParams where Source #
This type defines the boundary between the mode-parametrised style used in this API and the block-parametrised style used by the underlying network and consensus libraries.
This interface itself is in the block-parametrised style, with the block type itself being an hidden/existential type.
It bundles together all the necessary class instances, the consensus protocol client identifier, and the set of client side mini-protocol handlers for the node-to-client protocol.
Constructors
| 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 :: forall mode block. ConsensusBlockForMode mode ~ block => ConsensusModeParams mode -> ( NodeToClientVersion -> LocalNodeClientProtocolsInMode mode) -> LocalNodeClientParams Source #
Convert from the mode-parametrised style to the block-parametrised style.
data LocalChainSyncClient block point tip m Source #
Constructors
| NoLocalChainSyncClient | |
| LocalChainSyncClientPipelined ( ChainSyncClientPipelined block point tip m ()) | |
| LocalChainSyncClient ( ChainSyncClient block point tip m ()) |
data CardanoMode Source #
The Cardano consensus mode consists of all the eras currently in use on
the Cardano mainnet. This is currently: the
ByronEra
;
ShelleyEra
,
AllegraEra
and
MaryEra
, in that order.
This mode will be extended with new eras as the Cardano mainnet develops.
Instances
| FromJSON ( EraInMode AlonzoEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes |
|
| FromJSON ( EraInMode MaryEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes |
|
| FromJSON ( EraInMode AllegraEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes Methods parseJSON :: Value -> Parser ( EraInMode AllegraEra CardanoMode ) Source # parseJSONList :: Value -> Parser [ EraInMode AllegraEra CardanoMode ] Source # |
|
| FromJSON ( EraInMode ShelleyEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes Methods parseJSON :: Value -> Parser ( EraInMode ShelleyEra CardanoMode ) Source # parseJSONList :: Value -> Parser [ EraInMode ShelleyEra CardanoMode ] Source # |
|
| FromJSON ( EraInMode ByronEra CardanoMode ) Source # | |
|
Defined in Cardano.Api.Modes |
|
Chain sync protocol
To construct a
ChainSyncClient
see
Cardano.Api.Client
or
Cardano.Api.ClientPipelined
.
newtype ChainSyncClient header point tip (m :: Type -> Type ) a Source #
A chain sync protocol client, on top of some effect
m
.
The first choice of request is within that
m
.
Constructors
| ChainSyncClient | |
|
Fields
|
|
newtype ChainSyncClientPipelined header point tip (m :: Type -> Type ) a Source #
Pipelined chain sync client. It can only pipeline
MsgRequestNext
messages, while the
MsgFindIntersect
are non pipelined. This has a penalty
cost of an RTT, but they are send relatively seldom and their response might
impact how many messages one would like to pipeline. It also simplifies the
receiver callback.
Constructors
| ChainSyncClientPipelined | |
|
Fields
|
|
data BlockInMode mode where Source #
A
Block
in one of the eras supported by a given protocol mode.
For multi-era modes such as the
CardanoMode
this type is a sum of the
different block types for all the eras. It is used in the ChainSync protocol.
Constructors
| BlockInMode :: IsCardanoEra era => Block era -> EraInMode era mode -> BlockInMode mode |
Instances
| Show ( BlockInMode mode) Source # | |
|
Defined in Cardano.Api.Block |
|
type LocalNodeClientProtocolsInMode mode = LocalNodeClientProtocols ( BlockInMode mode) ChainPoint ChainTip SlotNo ( TxInMode mode) (TxIdInMode mode) ( TxValidationErrorInMode mode) ( QueryInMode mode) IO Source #
Local tx submission
data LocalTxSubmissionClient tx reject (m :: Type -> Type ) a Source #
data TxInMode mode where Source #
A
Tx
in one of the eras supported by a given protocol mode.
For multi-era modes such as the
CardanoMode
this type is a sum of the
different transaction types for all the eras. It is used in the
LocalTxSubmission protocol.
Constructors
| TxInMode :: Tx era -> EraInMode era mode -> TxInMode mode |
Everything we consider a normal transaction. |
| TxInByronSpecial :: GenTx ByronBlock -> EraInMode ByronEra mode -> TxInMode mode |
Byron has various things we can post to the chain which are not actually transactions. This covers: update proposals, votes and delegation certs. |
data TxValidationErrorInMode mode where Source #
A
TxValidationError
in one of the eras supported by a given protocol
mode.
This is used in the LocalStateQuery protocol.
Constructors
| TxValidationErrorInMode :: TxValidationError era -> EraInMode era mode -> TxValidationErrorInMode mode | |
| TxValidationEraMismatch :: EraMismatch -> TxValidationErrorInMode mode |
Instances
| Show ( TxValidationErrorInMode mode) Source # | |
|
Defined in Cardano.Api.InMode |
|
runLocalTxSubmissionClient :: LocalTxSubmissionClient tx reject m a -> m ( LocalTxClientStIdle tx reject m a) Source #
submitTxToNodeLocal :: forall mode. LocalNodeConnectInfo mode -> TxInMode mode -> IO ( SubmitResult ( TxValidationErrorInMode mode)) Source #
Local state query
newtype LocalStateQueryClient block point (query :: Type -> Type ) (m :: Type -> Type ) a Source #
Constructors
| LocalStateQueryClient | |
|
Fields
|
|
data QueryInMode mode result where Source #
Constructors
| QueryCurrentEra :: ConsensusModeIsMultiEra mode -> QueryInMode mode AnyCardanoEra | |
| QueryInEra :: EraInMode era mode -> QueryInEra era result -> QueryInMode mode ( Either EraMismatch result) | |
| QueryEraHistory :: ConsensusModeIsMultiEra mode -> QueryInMode mode ( EraHistory mode) | |
| QuerySystemStart :: QueryInMode mode SystemStart | |
| QueryChainBlockNo :: QueryInMode mode ( WithOrigin BlockNo ) | |
| QueryChainPoint :: ConsensusMode mode -> QueryInMode mode ChainPoint |
Instances
| Show ( QueryInMode mode result) Source # | |
|
Defined in Cardano.Api.Query |
|
newtype SystemStart Source #
System start
Slots are counted from the system start.
Constructors
| SystemStart | |
|
Fields |
|
Instances
data QueryInEra era result where Source #
Constructors
| QueryByronUpdateState :: QueryInEra ByronEra ByronUpdateState | |
| QueryInShelleyBasedEra :: ShelleyBasedEra era -> QueryInShelleyBasedEra era result -> QueryInEra era result |
Instances
| Show ( QueryInEra era result) Source # | |
|
Defined in Cardano.Api.Query |
|
data QueryInShelleyBasedEra era result where Source #
Constructors
Instances
| Show ( QueryInShelleyBasedEra era result) Source # | |
|
Defined in Cardano.Api.Query |
|
data QueryUTxOFilter Source #
Getting the whole UTxO is obviously not efficient since the result can be huge. Filtering by address is also not efficient because it requires a linear search.
The
QueryUTxOFilterByTxIn
is efficient since it fits with the structure of
the UTxO (which is indexed by
TxIn
).
Constructors
| QueryUTxOWhole |
O(n) time and space for utxo size n |
| QueryUTxOByAddress ( Set AddressAny ) |
O(n) time, O(m) space for utxo size n, and address set size m |
| QueryUTxOByTxIn ( Set TxIn ) |
O(m log n) time, O(m) space for utxo size n, and address set size m |
Instances
| Eq QueryUTxOFilter Source # | |
|
Defined in Cardano.Api.Query Methods (==) :: QueryUTxOFilter -> QueryUTxOFilter -> Bool Source # (/=) :: QueryUTxOFilter -> QueryUTxOFilter -> Bool Source # |
|
| Show QueryUTxOFilter Source # | |
|
Defined in Cardano.Api.Query |
|
Instances
| EraCast UTxO Source # | |
|
Defined in Cardano.Api.Query Methods eraCast :: ( IsCardanoEra fromEra, IsCardanoEra toEra) => CardanoEra toEra -> UTxO fromEra -> Either EraCastError ( UTxO toEra) Source # |
|
| Eq ( UTxO era) Source # | |
| Show ( UTxO era) Source # | |
| IsCardanoEra era => ToJSON ( UTxO era) Source # | |
| ( IsCardanoEra era, IsShelleyBasedEra era, FromJSON ( TxOut CtxUTxO era)) => FromJSON ( UTxO era) Source # | |
queryNodeLocalState :: forall mode result. LocalNodeConnectInfo mode -> Maybe ChainPoint -> QueryInMode mode result -> IO ( Either AcquiringFailure result) Source #
executeQueryCardanoMode :: CardanoEra era -> NetworkId -> QueryInMode CardanoMode ( Either EraMismatch result) -> IO ( Either QueryConvenienceError result) Source #
Execute a query against the local node. The local node must be in CardanoMode.
Local tx monitoring
newtype LocalTxMonitorClient txid tx slot (m :: Type -> Type ) a Source #
A tx monitor client, on top of some effect
m
.
Constructors
| LocalTxMonitorClient | |
|
Fields
|
|
data LocalTxMonitoringQuery mode Source #
Constructors
| LocalTxMonitoringQueryTx (TxIdInMode mode) |
Query if a particular tx exists in the mempool. Note that, the absence of a transaction does not imply anything about how the transaction was processed: it may have been dropped, or inserted in a block. |
| LocalTxMonitoringSendNextTx |
The mempool is modeled as an ordered list of transactions and thus, can
be traversed linearly.
|
| LocalTxMonitoringMempoolInformation |
Ask the server about the current mempool's capacity and sizes. This is fixed in a given snapshot. |
data LocalTxMonitoringResult mode Source #
Constructors
| LocalTxMonitoringTxExists TxId SlotNo |
Slot number at which the mempool snapshot was taken |
| LocalTxMonitoringTxDoesNotExist TxId SlotNo |
Slot number at which the mempool snapshot was taken |
| LocalTxMonitoringNextTx ( Maybe ( TxInMode mode)) SlotNo |
Slot number at which the mempool snapshot was taken |
| LocalTxMonitoringMempoolSizeAndCapacity MempoolSizeAndCapacity SlotNo |
Slot number at which the mempool snapshot was taken |
data MempoolSizeAndCapacity Source #
Describes the MemPool sizes and capacity for a given snapshot.
Constructors
| MempoolSizeAndCapacity | |
|
Fields
|
|
Instances
queryTxMonitoringLocal :: forall mode. LocalNodeConnectInfo mode -> LocalTxMonitoringQuery mode -> IO ( LocalTxMonitoringResult mode) Source #
data EraHistory mode where Source #
Constructors
| EraHistory :: ConsensusBlockForMode mode ~ HardForkBlock xs => ConsensusMode mode -> Interpreter xs -> EraHistory mode |
getProgress :: SlotNo -> EraHistory mode -> Either PastHorizonException ( RelativeTime , SlotLength ) Source #
Common queries
determineEra :: ConsensusModeParams mode -> LocalNodeConnectInfo mode -> IO ( Either AcquiringFailure AnyCardanoEra ) Source #
Query the node to determine which era it is in.
getLocalChainTip :: LocalNodeConnectInfo mode -> IO ChainTip Source #
Node operation
Support for the steps needed to operate a node
Operational certificates
data OperationalCertificate Source #
Instances
data OperationalCertificateIssueCounter Source #
Instances
| Eq OperationalCertificateIssueCounter Source # | |
| Show OperationalCertificateIssueCounter Source # | |
|
Defined in Cardano.Api.OperationalCertificate |
|
| ToCBOR OperationalCertificateIssueCounter Source # | |
|
Defined in Cardano.Api.OperationalCertificate Methods toCBOR :: OperationalCertificateIssueCounter -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy OperationalCertificateIssueCounter -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ OperationalCertificateIssueCounter ] -> Size Source # |
|
| FromCBOR OperationalCertificateIssueCounter Source # | |
|
Defined in Cardano.Api.OperationalCertificate |
|
| HasTypeProxy OperationalCertificateIssueCounter Source # | |
|
Defined in Cardano.Api.OperationalCertificate Associated Types |
|
| SerialiseAsCBOR OperationalCertificateIssueCounter Source # | |
| HasTextEnvelope OperationalCertificateIssueCounter Source # | |
| data AsType OperationalCertificateIssueCounter Source # | |
data OperationalCertIssueError Source #
Instances
| Show OperationalCertIssueError Source # | |
|
Defined in Cardano.Api.OperationalCertificate |
|
| Error OperationalCertIssueError Source # | |
|
Defined in Cardano.Api.OperationalCertificate Methods displayError :: OperationalCertIssueError -> String Source # |
|
issueOperationalCertificate :: VerificationKey KesKey -> Either ( SigningKey StakePoolKey ) ( SigningKey GenesisDelegateExtendedKey ) -> KESPeriod -> OperationalCertificateIssueCounter -> Either OperationalCertIssueError ( OperationalCertificate , OperationalCertificateIssueCounter ) Source #
Genesis file
Types and functions needed to inspect or create a genesis file.
data GenesisKey Source #
Instances
data GenesisExtendedKey Source #
Shelley-era genesis keys using extended ed25519 cryptographic keys.
These serve the same role as normal genesis keys, but are here to support legacy Byron genesis keys which used extended keys.
The extended verification keys can be converted (via
castVerificationKey
)
to ordinary keys (i.e.
VerificationKey
GenesisKey
) but this is
not
the
case for the signing keys. The signing keys can be used to witness
transactions directly, with verification via their non-extended verification
key (
VerificationKey
GenesisKey
).
This is a type level tag, used with other interfaces like
Key
.
Instances
data GenesisDelegateKey Source #
Instances
data GenesisDelegateExtendedKey Source #
Shelley-era genesis keys using extended ed25519 cryptographic keys.
These serve the same role as normal genesis keys, but are here to support legacy Byron genesis keys which used extended keys.
The extended verification keys can be converted (via
castVerificationKey
)
to ordinary keys (i.e.
VerificationKey
GenesisKey
) but this is
not
the
case for the signing keys. The signing keys can be used to witness
transactions directly, with verification via their non-extended verification
key (
VerificationKey
GenesisKey
).
This is a type level tag, used with other interfaces like
Key
.
Instances
data GenesisUTxOKey Source #
Instances
genesisUTxOPseudoTxIn :: NetworkId -> Hash GenesisUTxOKey -> TxIn Source #
Compute the
TxIn
of the initial UTxO pseudo-transaction corresponding
to the given address in the genesis initial funds.
The Shelley initial UTxO is constructed from the
sgInitialFunds
which
is not a full UTxO but just a map from addresses to coin values.
This gets turned into a UTxO by making a pseudo-transaction for each address,
with the 0th output being the coin value. So to spend from the initial UTxO
we need this same
TxIn
to use as an input to the spending transaction.
Genesis parameters
data GenesisParameters Source #
Constructors
| GenesisParameters | |
|
Fields
|
|
Special transactions
There are various additional things that can be embedded in a transaction for special operations.
makeMIRCertificate :: MIRPot -> MIRTarget -> Certificate Source #
makeGenesisKeyDelegationCertificate :: Hash GenesisKey -> Hash GenesisDelegateKey -> Hash VrfKey -> Certificate Source #
The
MIRTarget
determines the target of a
MIRCertificate
.
A
MIRCertificate
moves lovelace from either the reserves or the treasury
to either a collection of stake credentials or to the other pot.
Constructors
| StakeAddressesMIR [( StakeCredential , Lovelace )] |
Use
|
| SendToReservesMIR Lovelace |
Use
|
| SendToTreasuryMIR Lovelace |
Use
|
Protocol parameter updates
data UpdateProposal Source #
Constructors
| UpdateProposal !( Map ( Hash GenesisKey ) ProtocolParametersUpdate ) ! EpochNo |
Instances
data ProtocolParametersUpdate Source #
The representation of a change in the
ProtocolParameters
.
Constructors
| ProtocolParametersUpdate | |
|
Fields
|
|
Instances
makeShelleyUpdateProposal :: ProtocolParametersUpdate -> [ Hash GenesisKey ] -> EpochNo -> UpdateProposal Source #
data PraosNonce Source #
Instances
newtype NetworkMagic Source #
NetworkMagic is used to differentiate between different networks during the initial handshake.
Constructors
| NetworkMagic | |
|
Fields |
|
Instances
| Eq NetworkMagic | |
|
Defined in Ouroboros.Network.Magic Methods (==) :: NetworkMagic -> NetworkMagic -> Bool Source # (/=) :: NetworkMagic -> NetworkMagic -> Bool Source # |
|
| Show NetworkMagic | |
|
Defined in Ouroboros.Network.Magic |
|
| Generic NetworkMagic | |
|
Defined in Ouroboros.Network.Magic Methods from :: NetworkMagic -> Rep NetworkMagic x Source # to :: Rep NetworkMagic x -> NetworkMagic Source # |
|
| NoThunks NetworkMagic | |
|
Defined in Ouroboros.Network.Magic |
|
| type Rep NetworkMagic | |
|
Defined in Ouroboros.Network.Magic
type
Rep
NetworkMagic
=
D1
('
MetaData
"NetworkMagic" "Ouroboros.Network.Magic" "ouroboros-network-0.1.0.1-2UgqzRSdBh49QYumtriFSI" '
True
) (
C1
('
MetaCons
"NetworkMagic" '
PrefixI
'
True
) (
S1
('
MetaSel
('
Just
"unNetworkMagic") '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedLazy
) (
Rec0
Word32
)))
|
|
Conversions
toLedgerPParams :: ShelleyBasedEra era -> ProtocolParameters -> PParams ( ShelleyLedgerEra era) Source #
fromLedgerPParams :: ShelleyBasedEra era -> PParams ( ShelleyLedgerEra era) -> ProtocolParameters Source #
fromLedgerTxOuts :: forall era. ShelleyBasedEra era -> TxBody ( ShelleyLedgerEra era) -> TxBodyScriptData era -> [ TxOut CtxTx era] Source #
toLedgerUTxO :: ShelleyLedgerEra era ~ ledgerera => Crypto ledgerera ~ StandardCrypto => ShelleyBasedEra era -> UTxO era -> UTxO ledgerera Source #
newtype SlotsInEpoch Source #
Constructors
| SlotsInEpoch Word64 |
newtype SlotsToEpochEnd Source #
Constructors
| SlotsToEpochEnd Word64 |
slotToEpoch :: SlotNo -> EraHistory mode -> Either PastHorizonException ( EpochNo , SlotsInEpoch , SlotsToEpochEnd ) Source #
Node socket related
newtype EnvSocketError Source #
Constructors
| CliEnvVarLookup Text |
Instances
| Show EnvSocketError Source # | |
|
Defined in Cardano.Api.Environment |
|
newtype SocketPath Source #
Constructors
| SocketPath | |
|
Fields |
|
Instances
| Eq SocketPath Source # | |
|
Defined in Cardano.Api.Environment Methods (==) :: SocketPath -> SocketPath -> Bool Source # (/=) :: SocketPath -> SocketPath -> Bool Source # |
|
| Ord SocketPath Source # | |
|
Defined in Cardano.Api.Environment Methods compare :: SocketPath -> SocketPath -> Ordering Source # (<) :: SocketPath -> SocketPath -> Bool Source # (<=) :: SocketPath -> SocketPath -> Bool Source # (>) :: SocketPath -> SocketPath -> Bool Source # (>=) :: SocketPath -> SocketPath -> Bool Source # max :: SocketPath -> SocketPath -> SocketPath Source # min :: SocketPath -> SocketPath -> SocketPath Source # |
|
| Show SocketPath Source # | |
|
Defined in Cardano.Api.Environment |
|
| FromJSON SocketPath Source # | |
|
Defined in Cardano.Api.Environment Methods parseJSON :: Value -> Parser SocketPath Source # parseJSONList :: Value -> Parser [ SocketPath ] Source # |
|
readEnvSocketPath :: IO ( Either EnvSocketError SocketPath ) Source #
Read the node socket path from the environment. Fails if the environment variable is not set.
data NodeToClientVersion Source #
Enumeration of node to client protocol versions.
Constructors
| NodeToClientV_9 |
enabled
|
| NodeToClientV_10 |
added
|
| NodeToClientV_11 |
added
|
| NodeToClientV_12 |
added
|
| NodeToClientV_13 |
enabled
|
Instances
Monadic queries
data LocalStateQueryExpr block point query r m a Source #
Monadic type for constructing local state query expressions.
Use
queryExpr
in a do block to construct queries of this type and convert
the expression to a
LocalStateQueryClient
with
setupLocalStateQueryExpr
.
Some consideration was made to use Applicative instead of Monad as the abstraction in order to support pipelining, but we actually have a fair amount of code where the next query depends on the result of the former and therefore actually need Monad.
In order to make pipelining still possible we can explore the use of Selective Functors which would allow us to straddle both worlds.
Instances
| Monad ( LocalStateQueryExpr block point query r m) Source # | |
|
Defined in Cardano.Api.IPC.Monad Methods (>>=) :: LocalStateQueryExpr block point query r m a -> (a -> LocalStateQueryExpr block point query r m b) -> LocalStateQueryExpr block point query r m b Source # (>>) :: LocalStateQueryExpr block point query r m a -> LocalStateQueryExpr block point query r m b -> LocalStateQueryExpr block point query r m b Source # return :: a -> LocalStateQueryExpr block point query r m a Source # |
|
| Functor ( LocalStateQueryExpr block point query r m) Source # | |
|
Defined in Cardano.Api.IPC.Monad Methods fmap :: (a -> b) -> LocalStateQueryExpr block point query r m a -> LocalStateQueryExpr block point query r m b Source # (<$) :: a -> LocalStateQueryExpr block point query r m b -> LocalStateQueryExpr block point query r m a Source # |
|
| Applicative ( LocalStateQueryExpr block point query r m) Source # | |
|
Defined in Cardano.Api.IPC.Monad Methods pure :: a -> LocalStateQueryExpr block point query r m a Source # (<*>) :: LocalStateQueryExpr block point query r m (a -> b) -> LocalStateQueryExpr block point query r m a -> LocalStateQueryExpr block point query r m b Source # liftA2 :: (a -> b -> c) -> LocalStateQueryExpr block point query r m a -> LocalStateQueryExpr block point query r m b -> LocalStateQueryExpr block point query r m c Source # (*>) :: LocalStateQueryExpr block point query r m a -> LocalStateQueryExpr block point query r m b -> LocalStateQueryExpr block point query r m b Source # (<*) :: LocalStateQueryExpr block point query r m a -> LocalStateQueryExpr block point query r m b -> LocalStateQueryExpr block point query r m a Source # |
|
| MonadIO m => MonadIO ( LocalStateQueryExpr block point query r m) Source # | |
|
Defined in Cardano.Api.IPC.Monad Methods liftIO :: IO a -> LocalStateQueryExpr block point query r m a Source # |
|
executeLocalStateQueryExpr :: LocalNodeConnectInfo mode -> Maybe ChainPoint -> ( NodeToClientVersion -> LocalStateQueryExpr ( BlockInMode mode) ChainPoint ( QueryInMode mode) () IO a) -> IO ( Either AcquiringFailure a) Source #
Execute a local state query expression.
queryExpr :: QueryInMode mode a -> LocalStateQueryExpr block point ( QueryInMode mode) r IO a Source #
Use
queryExpr
in a do block to construct monadic local state queries.
determineEraExpr :: ConsensusModeParams mode -> LocalStateQueryExpr block point ( QueryInMode mode) r IO AnyCardanoEra Source #
A monad expression that determines what era the node is in.
chainPointToHeaderHash :: ChainPoint -> Maybe ( Hash BlockHeader ) Source #
makeChainTip :: WithOrigin BlockNo -> ChainPoint -> ChainTip Source #
writeSecrets :: FilePath -> [ Char ] -> [ Char ] -> (a -> ByteString ) -> [a] -> IO () Source #
Cast functions
class EraCast (f :: Type -> Type ) where Source #
Methods
eraCast :: ( IsCardanoEra fromEra, IsCardanoEra toEra) => CardanoEra toEra -> f fromEra -> Either EraCastError (f toEra) Source #
Instances
data EraCastError Source #
Constructors
| forall fromEra toEra value.( IsCardanoEra fromEra, IsCardanoEra toEra, Show value) => EraCastError | |
|
Fields
|
|
Convenience functions
Transaction construction
Arguments
| :: IsShelleyBasedEra era | |
| => EraInMode era CardanoMode | |
| -> TxBodyContent BuildTx era | |
| -> AddressInEra era |
Change address |
| -> Maybe Word |
Override key witnesses |
| -> UTxO era |
Just the transaction inputs, not the entire
|
| -> ProtocolParameters | |
| -> EraHistory CardanoMode | |
| -> SystemStart | |
| -> Set PoolId |
The set of registered stake pools |
| -> [ ShelleyWitnessSigningKey ] | |
| -> Either TxBodyErrorAutoBalance ( Tx era) |
Construct a balanced transaction. See Cardano.Api.Convenience.Query.queryStateForBalancedTx for a convenient way of querying the node to get the required arguements for constructBalancedTx.
Queries
data QueryConvenienceError Source #
queryStateForBalancedTx :: CardanoEra era -> NetworkId -> [ TxIn ] -> IO ( Either QueryConvenienceError ( UTxO era, ProtocolParameters , EraHistory CardanoMode , SystemStart , Set PoolId )) Source #
A convenience function to query the relevant information, from the local node, for Cardano.Api.Convenience.Construction.constructBalancedTx
Constraint satisfaction functions
getIsCardanoEraConstraint :: CardanoEra era -> ( IsCardanoEra era => a) -> a Source #
Misc
newtype ScriptLockedTxInsError Source #
Constructors
| ScriptLockedTxIns [ TxIn ] |
data TxInsExistError Source #
Constructors
| TxInsDoNotExist [ TxIn ] | |
| EmptyUTxO |
txInsExistInUTxO :: [ TxIn ] -> UTxO era -> Either TxInsExistError () Source #
notScriptLockedTxIns :: [ TxIn ] -> UTxO era -> Either ScriptLockedTxInsError () Source #