Safe Haskell	None
Language	Haskell2010

Bcc.Api.SpecialCole

Description

Special Cole 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 ColeUpdateProposal = ColeUpdateProposal {
- unColeUpdateProposal ∷ AProposal ByteString
}
data ColeProtocolParametersUpdate = ColeProtocolParametersUpdate {
- bPpuScriptVersion ∷ !(Maybe Word16)
- bPpuSlotDuration ∷ !(Maybe Natural)
- bPpuMaxBlockSize ∷ !(Maybe Natural)
- bPpuMaxHeaderSize ∷ !(Maybe Natural)
- bPpuMaxTxSize ∷ !(Maybe Natural)
- bPpuMaxProposalSize ∷ !(Maybe Natural)
- bPpuMpcThd ∷ !(Maybe EntropicPortion)
- bPpuHeavyDelThd ∷ !(Maybe EntropicPortion)
- bPpuUpdateVoteThd ∷ !(Maybe EntropicPortion)
- bPpuUpdateProposalThd ∷ !(Maybe EntropicPortion)
- bPpuUpdateProposalTTL ∷ !(Maybe SlotNumber)
- bPpuSoftforkRule ∷ !(Maybe SoftforkRule)
- bPpuTxFeePolicy ∷ !(Maybe TxFeePolicy)
- bPpuUnlockStakeEpoch ∷ !(Maybe EpochNumber)
}
data family AsType t
makeProtocolParametersUpdate ∷ ColeProtocolParametersUpdate → ProtocolParametersUpdate
toColeLedgerUpdateProposal ∷ ColeUpdateProposal → GenTx ColeBlock
newtype ColeVote = ColeVote {
- unColeVote ∷ AVote ByteString
}
makeColeUpdateProposal ∷ NetworkId → ProtocolVersion → SoftwareVersion → SystemTag → InstallerHash → SomeColeSigningKey → ColeProtocolParametersUpdate → ColeUpdateProposal
makeColeVote ∷ NetworkId → SomeColeSigningKey → ColeUpdateProposal → Bool → ColeVote
toColeLedgertoColeVote ∷ ColeVote → GenTx ColeBlock

Documentation

newtype ColeUpdateProposal Source #

Cole era update proposal

Constructors

ColeUpdateProposal
Fields unColeUpdateProposal ∷ AProposal ByteString

Instances

Instances details

Eq ColeUpdateProposal Source #
Instance details Defined in Bcc.Api.SpecialCole Methods (==) ∷ ColeUpdateProposal → ColeUpdateProposal → Bool Source # (/=) ∷ ColeUpdateProposal → ColeUpdateProposal → Bool Source #
Show ColeUpdateProposal Source #
Instance details Defined in Bcc.Api.SpecialCole Methods showsPrec ∷ Int → ColeUpdateProposal → ShowS Source # show ∷ ColeUpdateProposal → String Source # showList ∷ [ColeUpdateProposal] → ShowS Source #
HasTypeProxy ColeUpdateProposal Source #
Instance details Defined in Bcc.Api.SpecialCole Associated Types data AsType ColeUpdateProposal Source # Methods proxyToAsType ∷ Proxy ColeUpdateProposal → AsType ColeUpdateProposal Source #
SerialiseAsRawBytes ColeUpdateProposal Source #
Instance details Defined in Bcc.Api.SpecialCole Methods serialiseToRawBytes ∷ ColeUpdateProposal → ByteString Source # deserialiseFromRawBytes ∷ AsType ColeUpdateProposal → ByteString → Maybe ColeUpdateProposal Source #
data AsType ColeUpdateProposal Source #
Instance details Defined in Bcc.Api.SpecialCole data AsType ColeUpdateProposal = AsColeUpdateProposal

data ColeProtocolParametersUpdate Source #

Constructors

ColeProtocolParametersUpdate

Fields

bPpuScriptVersion ∷ !(Maybe Word16)
Redundant. This was meant to be the version of the Zerepoch smart contract language, however, there are no smart contracts nor scripts in the Cole 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)
Maxiumum transaction size in bytes.
bPpuMaxProposalSize ∷ !(Maybe Natural)
Maximum update proposal size in bytes.
bPpuMpcThd ∷ !(Maybe EntropicPortion)
bPpuHeavyDelThd ∷ !(Maybe EntropicPortion)
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 EntropicPortion)
bPpuUpdateProposalThd ∷ !(Maybe EntropicPortion)
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 ShardagnosticBFT logic in the software. Relevant: CDEC-610

Instances

Instances details

Show ColeProtocolParametersUpdate Source #
Instance details Defined in Bcc.Api.SpecialCole Methods showsPrec ∷ Int → ColeProtocolParametersUpdate → ShowS Source # show ∷ ColeProtocolParametersUpdate → String Source # showList ∷ [ColeProtocolParametersUpdate] → 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 AurumEra Source #
Instance details Defined in Bcc.Api.Eras data AsType AurumEra = AsAurumEra
data AsType JenEra Source #
Instance details Defined in Bcc.Api.Eras data AsType JenEra = AsJenEra
data AsType EvieEra Source #
Instance details Defined in Bcc.Api.Eras data AsType EvieEra = AsEvieEra
data AsType SophieEra Source #
Instance details Defined in Bcc.Api.Eras data AsType SophieEra = AsSophieEra
data AsType ColeEra Source #
Instance details Defined in Bcc.Api.Eras data AsType ColeEra = AsColeEra
data AsType TextEnvelope Source #
Instance details Defined in Bcc.Api.SerialiseTextEnvelope data AsType TextEnvelope = AsTextEnvelope
data AsType TxMetadata Source #
Instance details Defined in Bcc.Api.TxMetadata data AsType TxMetadata = AsTxMetadata
data AsType StakePoolKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType StakePoolKey = AsStakePoolKey
data AsType VestedDelegateExtendedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType VestedDelegateExtendedKey = AsVestedDelegateExtendedKey
data AsType VestedDelegateKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType VestedDelegateKey = AsVestedDelegateKey
data AsType VestedExtendedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType VestedExtendedKey = AsVestedExtendedKey
data AsType VestedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType VestedKey = AsVestedKey
data AsType GenesisVestedDelegateExtendedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType GenesisVestedDelegateExtendedKey = AsGenesisVestedDelegateExtendedKey
data AsType GenesisVestedDelegateKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType GenesisVestedDelegateKey = AsGenesisVestedDelegateKey
data AsType GenesisVestedExtendedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType GenesisVestedExtendedKey = AsGenesisVestedExtendedKey
data AsType GenesisVestedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType GenesisVestedKey = AsGenesisVestedKey
data AsType VestedUTxOKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType VestedUTxOKey = AsVestedUTxOKey
data AsType GenesisUTxOKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType GenesisUTxOKey = AsGenesisUTxOKey
data AsType GenesisDelegateExtendedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType GenesisDelegateExtendedKey = AsGenesisDelegateExtendedKey
data AsType GenesisDelegateKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType GenesisDelegateKey = AsGenesisDelegateKey
data AsType GenesisExtendedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType GenesisExtendedKey = AsGenesisExtendedKey
data AsType GenesisKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType GenesisKey = AsGenesisKey
data AsType StakeExtendedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType StakeExtendedKey = AsStakeExtendedKey
data AsType StakeKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType StakeKey = AsStakeKey
data AsType PaymentExtendedKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType PaymentExtendedKey = AsPaymentExtendedKey
data AsType PaymentKey Source #
Instance details Defined in Bcc.Api.KeysSophie data AsType PaymentKey = AsPaymentKey
data AsType ScriptData Source #
Instance details Defined in Bcc.Api.ScriptData data AsType ScriptData = AsScriptData
data AsType ScriptHash Source #
Instance details Defined in Bcc.Api.Script data AsType ScriptHash = AsScriptHash
data AsType ScriptInAnyLang Source #
Instance details Defined in Bcc.Api.Script data AsType ScriptInAnyLang = AsScriptInAnyLang
data AsType ZerepochScriptV1 Source #
Instance details Defined in Bcc.Api.Script data AsType ZerepochScriptV1 = AsZerepochScriptV1
data AsType SimpleScriptV2 Source #
Instance details Defined in Bcc.Api.Script data AsType SimpleScriptV2 = AsSimpleScriptV2
data AsType SimpleScriptV1 Source #
Instance details Defined in Bcc.Api.Script data AsType SimpleScriptV1 = AsSimpleScriptV1
data AsType ColeKeyLegacy Source #
Instance details Defined in Bcc.Api.KeysCole data AsType ColeKeyLegacy = AsColeKeyLegacy
data AsType ColeKey Source #
Instance details Defined in Bcc.Api.KeysCole data AsType ColeKey = AsColeKey
data AsType ColeVote Source #
Instance details Defined in Bcc.Api.SpecialCole data AsType ColeVote = AsColeVote
data AsType ColeUpdateProposal Source #
Instance details Defined in Bcc.Api.SpecialCole data AsType ColeUpdateProposal = AsColeUpdateProposal
data AsType VrfKey Source #
Instance details Defined in Bcc.Api.KeysOptimum data AsType VrfKey = AsVrfKey
data AsType KesKey Source #
Instance details Defined in Bcc.Api.KeysOptimum data AsType KesKey = AsKesKey
data AsType StakePoolMetadata Source #
Instance details Defined in Bcc.Api.StakePoolMetadata data AsType StakePoolMetadata = AsStakePoolMetadata
data AsType StakeAddress Source #
Instance details Defined in Bcc.Api.Address data AsType StakeAddress = AsStakeAddress
data AsType AddressAny Source #
Instance details Defined in Bcc.Api.Address data AsType AddressAny = AsAddressAny
data AsType SophieAddr Source #
Instance details Defined in Bcc.Api.Address data AsType SophieAddr = AsSophieAddr
data AsType ColeAddr Source #
Instance details Defined in Bcc.Api.Address data AsType ColeAddr = AsColeAddr
data AsType AssetName Source #
Instance details Defined in Bcc.Api.Value data AsType AssetName = AsAssetName
data AsType PolicyId Source #
Instance details Defined in Bcc.Api.Value data AsType PolicyId = AsPolicyId
data AsType UpdateProposal Source #
Instance details Defined in Bcc.Api.ProtocolParameters data AsType UpdateProposal = AsUpdateProposal
data AsType OptimumNonce Source #
Instance details Defined in Bcc.Api.ProtocolParameters data AsType OptimumNonce = AsOptimumNonce
data AsType Certificate Source #
Instance details Defined in Bcc.Api.Certificate data AsType Certificate = AsCertificate
data AsType TxId Source #
Instance details Defined in Bcc.Api.TxBody data AsType TxId = AsTxId
data AsType BlockHeader Source #
Instance details Defined in Bcc.Api.Block data AsType BlockHeader = AsBlockHeader
data AsType OperationalCertificateIssueCounter Source #
Instance details Defined in Bcc.Api.OperationalCertificate data AsType OperationalCertificateIssueCounter = AsOperationalCertificateIssueCounter
data AsType OperationalCertificate Source #
Instance details Defined in Bcc.Api.OperationalCertificate data AsType OperationalCertificate = AsOperationalCertificate
data AsType (Hash a) Source #
Instance details Defined in Bcc.Api.Hash data AsType (Hash a) = AsHash (AsType a)
data AsType (VerificationKey a) Source #
Instance details Defined in Bcc.Api.Key data AsType (VerificationKey a) = AsVerificationKey (AsType a)
data AsType (SigningKey a) Source #
Instance details Defined in Bcc.Api.Key data AsType (SigningKey a) = AsSigningKey (AsType a)
data AsType (ZerepochScript lang) Source #
Instance details Defined in Bcc.Api.Script data AsType (ZerepochScript lang) = AsZerepochScript (AsType lang)
data AsType (SimpleScript lang) Source #
Instance details Defined in Bcc.Api.Script data AsType (SimpleScript lang) = AsSimpleScript (AsType lang)
data AsType (ScriptInEra era) Source #
Instance details Defined in Bcc.Api.Script data AsType (ScriptInEra era) = AsScriptInEra (AsType era)
data AsType (Script lang) Source #
Instance details Defined in Bcc.Api.Script data AsType (Script lang) = AsScript (AsType lang)
data AsType (AddressInEra era) Source #
Instance details Defined in Bcc.Api.Address data AsType (AddressInEra era) = AsAddressInEra (AsType era)
data AsType (Address addrtype) Source #
Instance details Defined in Bcc.Api.Address data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (TxBody era) Source #
Instance details Defined in Bcc.Api.TxBody data AsType (TxBody era) = AsTxBody (AsType era)
data AsType (KeyWitness era) Source #
Instance details Defined in Bcc.Api.Tx data AsType (KeyWitness era) = AsKeyWitness (AsType era)
data AsType (Tx era) Source #
Instance details Defined in Bcc.Api.Tx data AsType (Tx era) = AsTx (AsType era)

makeProtocolParametersUpdate ∷ ColeProtocolParametersUpdate → ProtocolParametersUpdate Source #

toColeLedgerUpdateProposal ∷ ColeUpdateProposal → GenTx ColeBlock Source #

newtype ColeVote Source #

Cole era votes

Constructors

ColeVote
Fields unColeVote ∷ AVote ByteString

Instances

Instances details

Eq ColeVote Source #
Instance details Defined in Bcc.Api.SpecialCole Methods (==) ∷ ColeVote → ColeVote → Bool Source # (/=) ∷ ColeVote → ColeVote → Bool Source #
Show ColeVote Source #
Instance details Defined in Bcc.Api.SpecialCole Methods showsPrec ∷ Int → ColeVote → ShowS Source # show ∷ ColeVote → String Source # showList ∷ [ColeVote] → ShowS Source #
HasTypeProxy ColeVote Source #
Instance details Defined in Bcc.Api.SpecialCole Associated Types data AsType ColeVote Source # Methods proxyToAsType ∷ Proxy ColeVote → AsType ColeVote Source #
SerialiseAsRawBytes ColeVote Source #
Instance details Defined in Bcc.Api.SpecialCole Methods serialiseToRawBytes ∷ ColeVote → ByteString Source # deserialiseFromRawBytes ∷ AsType ColeVote → ByteString → Maybe ColeVote Source #
data AsType ColeVote Source #
Instance details Defined in Bcc.Api.SpecialCole data AsType ColeVote = AsColeVote

makeColeUpdateProposal ∷ NetworkId → ProtocolVersion → SoftwareVersion → SystemTag → InstallerHash → SomeColeSigningKey → ColeProtocolParametersUpdate → ColeUpdateProposal Source #

makeColeVote ∷ NetworkId → SomeColeSigningKey → ColeUpdateProposal → Bool → ColeVote Source #

toColeLedgertoColeVote ∷ ColeVote → GenTx ColeBlock Source #