Safe Haskell	None
Language	Haskell2010

Cardano.Api.SpecialByron

Description

Special Byron values that we can submit to a node to propose an update proposal or to vote on an update proposal. These are not transactions.

Synopsis

newtype ByronUpdateProposal = ByronUpdateProposal {
- unByronUpdateProposal :: AProposal ByteString
}
data ByronProtocolParametersUpdate = ByronProtocolParametersUpdate {
- bPpuScriptVersion :: !(Maybe Word16)
- bPpuSlotDuration :: !(Maybe Natural)
- bPpuMaxBlockSize :: !(Maybe Natural)
- bPpuMaxHeaderSize :: !(Maybe Natural)
- bPpuMaxTxSize :: !(Maybe Natural)
- bPpuMaxProposalSize :: !(Maybe Natural)
- bPpuMpcThd :: !(Maybe LovelacePortion)
- bPpuHeavyDelThd :: !(Maybe LovelacePortion)
- bPpuUpdateVoteThd :: !(Maybe LovelacePortion)
- bPpuUpdateProposalThd :: !(Maybe LovelacePortion)
- bPpuUpdateProposalTTL :: !(Maybe SlotNumber)
- bPpuSoftforkRule :: !(Maybe SoftforkRule)
- bPpuTxFeePolicy :: !(Maybe TxFeePolicy)
- bPpuUnlockStakeEpoch :: !(Maybe EpochNumber)
}
data family AsType t
makeProtocolParametersUpdate :: ByronProtocolParametersUpdate -> ProtocolParametersUpdate
toByronLedgerUpdateProposal :: ByronUpdateProposal -> GenTx ByronBlock
newtype ByronVote = ByronVote {
- unByronVote :: AVote ByteString
}
makeByronUpdateProposal :: NetworkId -> ProtocolVersion -> SoftwareVersion -> SystemTag -> InstallerHash -> SomeByronSigningKey -> ByronProtocolParametersUpdate -> ByronUpdateProposal
makeByronVote :: NetworkId -> SomeByronSigningKey -> ByronUpdateProposal -> Bool -> ByronVote
toByronLedgertoByronVote :: ByronVote -> GenTx ByronBlock
applicationName :: ApplicationName
applicationVersion :: NumSoftwareVersion
softwareVersion :: SoftwareVersion

Documentation

newtype ByronUpdateProposal Source #

Byron era update proposal

Constructors

ByronUpdateProposal
Fields unByronUpdateProposal :: AProposal ByteString

Instances

Instances details

Eq ByronUpdateProposal Source #
Instance details Defined in Cardano.Api.SpecialByron Methods (==) :: ByronUpdateProposal -> ByronUpdateProposal -> Bool Source # (/=) :: ByronUpdateProposal -> ByronUpdateProposal -> Bool Source #
Show ByronUpdateProposal Source #
Instance details Defined in Cardano.Api.SpecialByron Methods showsPrec :: Int -> ByronUpdateProposal -> ShowS Source # show :: ByronUpdateProposal -> String Source # showList :: [ByronUpdateProposal] -> ShowS Source #
HasTypeProxy ByronUpdateProposal Source #
Instance details Defined in Cardano.Api.SpecialByron Associated Types data AsType ByronUpdateProposal Source # Methods proxyToAsType :: Proxy ByronUpdateProposal -> AsType ByronUpdateProposal Source #
SerialiseAsRawBytes ByronUpdateProposal Source #
Instance details Defined in Cardano.Api.SpecialByron Methods serialiseToRawBytes :: ByronUpdateProposal -> ByteString Source # deserialiseFromRawBytes :: AsType ByronUpdateProposal -> ByteString -> Either SerialiseAsRawBytesError ByronUpdateProposal Source #
data AsType ByronUpdateProposal Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronUpdateProposal = AsByronUpdateProposal

data ByronProtocolParametersUpdate Source #

Constructors

ByronProtocolParametersUpdate

Fields

bPpuScriptVersion :: !(Maybe Word16)
Redundant. This was meant to be the version of the Plutus smart contract language, however, there are no smart contracts nor scripts in the Byron era.
bPpuSlotDuration :: !(Maybe Natural)
Slot duration in milliseconds.
bPpuMaxBlockSize :: !(Maybe Natural)
Maximum block size in bytes.
bPpuMaxHeaderSize :: !(Maybe Natural)
Maximum block header size in bytes.
bPpuMaxTxSize :: !(Maybe Natural)
Maximum transaction size in bytes.
bPpuMaxProposalSize :: !(Maybe Natural)
Maximum update proposal size in bytes.
bPpuMpcThd :: !(Maybe LovelacePortion)
bPpuHeavyDelThd :: !(Maybe LovelacePortion)
Heavyweight delegation threshold. The delegate (i.e stakeholder) must possess no less than this threshold of stake in order to participate in heavyweight delegation.
bPpuUpdateVoteThd :: !(Maybe LovelacePortion)
bPpuUpdateProposalThd :: !(Maybe LovelacePortion)
bPpuUpdateProposalTTL :: !(Maybe SlotNumber)
bPpuSoftforkRule :: !(Maybe SoftforkRule)
Values defining the softfork resolution rule. When the stake belonging to block issuers, issuing a given block version, is greater than the current softfork resolution threshold, this block version is adopted.
bPpuTxFeePolicy :: !(Maybe TxFeePolicy)
Transaction fee policy represents a formula to compute the minimal allowed Fee for a transaction. Transactions with lesser fees won't be accepted.
bPpuUnlockStakeEpoch :: !(Maybe EpochNumber)
This has been re-purposed for unlocking the OuroborosBFT logic in the software. Relevant: CDEC-610

Instances

Instances details

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

data family AsType t Source #

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.

Instances

Instances details

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

makeProtocolParametersUpdate :: ByronProtocolParametersUpdate -> ProtocolParametersUpdate Source #

toByronLedgerUpdateProposal :: ByronUpdateProposal -> GenTx ByronBlock Source #

newtype ByronVote Source #

Byron era votes

Constructors

ByronVote
Fields unByronVote :: AVote ByteString

Instances

Instances details

Eq ByronVote Source #
Instance details Defined in Cardano.Api.SpecialByron Methods (==) :: ByronVote -> ByronVote -> Bool Source # (/=) :: ByronVote -> ByronVote -> Bool Source #
Show ByronVote Source #
Instance details Defined in Cardano.Api.SpecialByron Methods showsPrec :: Int -> ByronVote -> ShowS Source # show :: ByronVote -> String Source # showList :: [ByronVote] -> ShowS Source #
HasTypeProxy ByronVote Source #
Instance details Defined in Cardano.Api.SpecialByron Associated Types data AsType ByronVote Source # Methods proxyToAsType :: Proxy ByronVote -> AsType ByronVote Source #
SerialiseAsRawBytes ByronVote Source #
Instance details Defined in Cardano.Api.SpecialByron Methods serialiseToRawBytes :: ByronVote -> ByteString Source # deserialiseFromRawBytes :: AsType ByronVote -> ByteString -> Either SerialiseAsRawBytesError ByronVote Source #
data AsType ByronVote Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronVote = AsByronVote

makeByronUpdateProposal :: NetworkId -> ProtocolVersion -> SoftwareVersion -> SystemTag -> InstallerHash -> SomeByronSigningKey -> ByronProtocolParametersUpdate -> ByronUpdateProposal Source #

makeByronVote :: NetworkId -> SomeByronSigningKey -> ByronUpdateProposal -> Bool -> ByronVote Source #

toByronLedgertoByronVote :: ByronVote -> GenTx ByronBlock Source #

applicationName :: ApplicationName Source #

An application name. It has no functional impact in the Shelley eras onwards and therefore it is hardcoded.

applicationVersion :: NumSoftwareVersion Source #

An application version. It has no functional impact in the Shelley eras onwards and therefore it is hardcoded.

softwareVersion :: SoftwareVersion Source #

A software version composed of applicationVersion and applicationName. It has no functional impact in the Shelley eras onwards and therefore it is hardcoded.