Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Cardano.Ledger.Api.Governance
Synopsis
- class (EraPParams era, Eq (GovState era), Show (GovState era), NoThunks (GovState era), NFData (GovState era), EncCBOR (GovState era), DecCBOR (GovState era), DecShareCBOR (GovState era), ToCBOR (GovState era), FromCBOR (GovState era), Default (GovState era), ToJSON (GovState era)) => EraGov era where
- emptyGovState :: EraGov era => GovState era
- getProposedPPUpdates :: EraGov era => GovState era -> Maybe (ProposedPPUpdates era)
- data ShelleyGovState era = ShelleyGovState {
- proposals :: !(ProposedPPUpdates era)
- futureProposals :: !(ProposedPPUpdates era)
- sgovPp :: !(PParams era)
- sgovPrevPp :: !(PParams era)
- newtype ProposedPPUpdates era = ProposedPPUpdates (Map (KeyHash 'Genesis (EraCrypto era)) (PParamsUpdate era))
- emptyPPPUpdates :: ProposedPPUpdates era
- data VotingProcedure era = VotingProcedure {
- vProcVote :: !Vote
- vProcAnchor :: !(StrictMaybe (Anchor (EraCrypto era)))
- newtype VotingProcedures era = VotingProcedures {
- unVotingProcedures :: Map (Voter (EraCrypto era)) (Map (GovActionId (EraCrypto era)) (VotingProcedure era))
- data ProposalProcedure era = ProposalProcedure {
- pProcDeposit :: !Coin
- pProcReturnAddr :: !(RewardAcnt (EraCrypto era))
- pProcGovAction :: !(GovAction era)
- pProcAnchor :: !(Anchor (EraCrypto era))
- data Constitution era = Constitution {
- constitutionAnchor :: !(Anchor (EraCrypto era))
- constitutionScript :: !(StrictMaybe (ScriptHash (EraCrypto era)))
- constitutionAnchorL :: forall era f. Functor f => (Anchor (EraCrypto era) -> f (Anchor (EraCrypto era))) -> Constitution era -> f (Constitution era)
- constitutionScriptL :: forall era f. Functor f => (StrictMaybe (ScriptHash (EraCrypto era)) -> f (StrictMaybe (ScriptHash (EraCrypto era)))) -> Constitution era -> f (Constitution era)
- data ConwayGovState era = ConwayGovState {
- cgProposals :: !(Proposals era)
- cgEnactState :: !(EnactState era)
- cgDRepPulsingState :: !(DRepPulsingState era)
- cgEnactStateL :: forall era f. Functor f => (EnactState era -> f (EnactState era)) -> ConwayGovState era -> f (ConwayGovState era)
- cgProposalsL :: forall era f. Functor f => (Proposals era -> f (Proposals era)) -> ConwayGovState era -> f (ConwayGovState era)
- data RatifyState era = RatifyState {
- rsEnactState :: !(EnactState era)
- rsRemoved :: !(Set (GovActionId (EraCrypto era)))
- rsDelayed :: !Bool
- data EnactState era = EnactState {
- ensCommittee :: !(StrictMaybe (Committee era))
- ensConstitution :: !(Constitution era)
- ensCurPParams :: !(PParams era)
- ensPrevPParams :: !(PParams era)
- ensTreasury :: !Coin
- ensWithdrawals :: !(Map (Credential 'Staking (EraCrypto era)) Coin)
- ensPrevGovActionIds :: !(PrevGovActionIds era)
- data Voter c
- = CommitteeVoter !(Credential 'HotCommitteeRole c)
- | DRepVoter !(Credential 'DRepRole c)
- | StakePoolVoter !(KeyHash 'StakePool c)
- data Vote
- data GovAction era
- = ParameterChange !(StrictMaybe (PrevGovActionId 'PParamUpdatePurpose (EraCrypto era))) !(PParamsUpdate era)
- | HardForkInitiation !(StrictMaybe (PrevGovActionId 'HardForkPurpose (EraCrypto era))) !ProtVer
- | TreasuryWithdrawals !(Map (RewardAcnt (EraCrypto era)) Coin)
- | NoConfidence !(StrictMaybe (PrevGovActionId 'CommitteePurpose (EraCrypto era)))
- | UpdateCommittee !(StrictMaybe (PrevGovActionId 'CommitteePurpose (EraCrypto era))) !(Set (Credential 'ColdCommitteeRole (EraCrypto era))) !(Map (Credential 'ColdCommitteeRole (EraCrypto era)) EpochNo) !UnitInterval
- | NewConstitution !(StrictMaybe (PrevGovActionId 'ConstitutionPurpose (EraCrypto era))) !(Constitution era)
- | InfoAction
- data GovActionId c = GovActionId {
- gaidTxId :: !(TxId c)
- gaidGovActionIx :: !GovActionIx
- newtype GovActionIx = GovActionIx Word32
- data GovActionState era = GovActionState {
- gasId :: !(GovActionId (EraCrypto era))
- gasCommitteeVotes :: !(Map (Credential 'HotCommitteeRole (EraCrypto era)) Vote)
- gasDRepVotes :: !(Map (Credential 'DRepRole (EraCrypto era)) Vote)
- gasStakePoolVotes :: !(Map (KeyHash 'StakePool (EraCrypto era)) Vote)
- gasDeposit :: !Coin
- gasReturnAddr :: !(RewardAcnt (EraCrypto era))
- gasAction :: !(GovAction era)
- gasProposedIn :: !EpochNo
- gasExpiresAfter :: !EpochNo
- data GovActionPurpose
- newtype PrevGovActionId (r :: GovActionPurpose) c = PrevGovActionId {}
- govActionIdToText :: GovActionId c -> Text
- data Anchor c = Anchor {
- anchorUrl :: !Url
- anchorDataHash :: !(SafeHash c AnchorData)
- newtype AnchorData = AnchorData ByteString
- hashAnchorData :: Crypto c => AnchorData -> SafeHash c AnchorData
Documentation
class (EraPParams era, Eq (GovState era), Show (GovState era), NoThunks (GovState era), NFData (GovState era), EncCBOR (GovState era), DecCBOR (GovState era), DecShareCBOR (GovState era), ToCBOR (GovState era), FromCBOR (GovState era), Default (GovState era), ToJSON (GovState era)) => EraGov era #
Minimal complete definition
curPParamsGovStateL, prevPParamsGovStateL, obligationGovState, getDRepDistr
Instances
Crypto c => EraGov (ShelleyEra c) | |
Defined in Cardano.Ledger.Shelley.Governance Associated Types type GovState (ShelleyEra c) = (r :: Type) # Methods emptyGovState :: GovState (ShelleyEra c) # getProposedPPUpdates :: GovState (ShelleyEra c) -> Maybe (ProposedPPUpdates (ShelleyEra c)) # getConstitution :: GovState (ShelleyEra c) -> Maybe (Constitution (ShelleyEra c)) getCommitteeMembers :: GovState (ShelleyEra c) -> Maybe (Map (Credential 'ColdCommitteeRole (EraCrypto (ShelleyEra c))) EpochNo, UnitInterval) curPParamsGovStateL :: Lens' (GovState (ShelleyEra c)) (PParams (ShelleyEra c)) prevPParamsGovStateL :: Lens' (GovState (ShelleyEra c)) (PParams (ShelleyEra c)) obligationGovState :: GovState (ShelleyEra c) -> Obligations getDRepDistr :: GovState (ShelleyEra c) -> Map (DRep (EraCrypto (ShelleyEra c))) (CompactForm Coin) |
emptyGovState :: EraGov era => GovState era #
getProposedPPUpdates :: EraGov era => GovState era -> Maybe (ProposedPPUpdates era) #
Shelley
data ShelleyGovState era #
Constructors
ShelleyGovState | |
Fields
|
Instances
newtype ProposedPPUpdates era #
Constructors
ProposedPPUpdates (Map (KeyHash 'Genesis (EraCrypto era)) (PParamsUpdate era)) |
Instances
emptyPPPUpdates :: ProposedPPUpdates era #
Conway
Governance Procedures
data VotingProcedure era #
Constructors
VotingProcedure | |
Fields
|
Instances
newtype VotingProcedures era #
Constructors
VotingProcedures | |
Fields
|
Instances
data ProposalProcedure era #
Constructors
ProposalProcedure | |
Fields
|
Instances
Constitution
data Constitution era #
Constructors
Constitution | |
Fields
|
Instances
constitutionAnchorL :: forall era f. Functor f => (Anchor (EraCrypto era) -> f (Anchor (EraCrypto era))) -> Constitution era -> f (Constitution era) #
constitutionScriptL :: forall era f. Functor f => (StrictMaybe (ScriptHash (EraCrypto era)) -> f (StrictMaybe (ScriptHash (EraCrypto era)))) -> Constitution era -> f (Constitution era) #
Governance State
data ConwayGovState era #
Constructors
ConwayGovState | |
Fields
|
Instances
cgEnactStateL :: forall era f. Functor f => (EnactState era -> f (EnactState era)) -> ConwayGovState era -> f (ConwayGovState era) #
cgProposalsL :: forall era f. Functor f => (Proposals era -> f (Proposals era)) -> ConwayGovState era -> f (ConwayGovState era) #
data RatifyState era #
Constructors
RatifyState | |
Fields
|
Instances
data EnactState era #
Constructors
EnactState | |
Fields
|
Instances
Constructors
CommitteeVoter !(Credential 'HotCommitteeRole c) | |
DRepVoter !(Credential 'DRepRole c) | |
StakePoolVoter !(KeyHash 'StakePool c) |
Instances
Instances
Governance Action
Constructors
ParameterChange !(StrictMaybe (PrevGovActionId 'PParamUpdatePurpose (EraCrypto era))) !(PParamsUpdate era) | |
HardForkInitiation !(StrictMaybe (PrevGovActionId 'HardForkPurpose (EraCrypto era))) !ProtVer | |
TreasuryWithdrawals !(Map (RewardAcnt (EraCrypto era)) Coin) | |
NoConfidence !(StrictMaybe (PrevGovActionId 'CommitteePurpose (EraCrypto era))) | |
UpdateCommittee !(StrictMaybe (PrevGovActionId 'CommitteePurpose (EraCrypto era))) !(Set (Credential 'ColdCommitteeRole (EraCrypto era))) !(Map (Credential 'ColdCommitteeRole (EraCrypto era)) EpochNo) !UnitInterval | |
NewConstitution !(StrictMaybe (PrevGovActionId 'ConstitutionPurpose (EraCrypto era))) !(Constitution era) | |
InfoAction |
Instances
data GovActionId c #
Constructors
GovActionId | |
Fields
|
Instances
newtype GovActionIx #
Constructors
GovActionIx Word32 |
Instances
data GovActionState era #
Constructors
GovActionState | |
Fields
|
Instances
data GovActionPurpose #
Instances
Show GovActionPurpose | |
Defined in Cardano.Ledger.Conway.Governance.Procedures | |
Eq GovActionPurpose | |
Defined in Cardano.Ledger.Conway.Governance.Procedures Methods (==) :: GovActionPurpose -> GovActionPurpose -> Bool Source # (/=) :: GovActionPurpose -> GovActionPurpose -> Bool Source # |
newtype PrevGovActionId (r :: GovActionPurpose) c #
Constructors
PrevGovActionId | |
Fields |
Instances
govActionIdToText :: GovActionId c -> Text #
Anchor
Constructors
Anchor | |
Fields
|
Instances
Crypto c => FromJSON (Anchor c) | |
Defined in Cardano.Ledger.BaseTypes Methods parseJSON :: Value -> Parser (Anchor c) parseJSONList :: Value -> Parser [Anchor c] omittedField :: Maybe (Anchor c) | |
Crypto c => ToJSON (Anchor c) | |
Defined in Cardano.Ledger.BaseTypes Methods toEncoding :: Anchor c -> Encoding toJSONList :: [Anchor c] -> Value toEncodingList :: [Anchor c] -> Encoding | |
Generic (Anchor c) | |
Show (Anchor c) | |
Crypto c => DecCBOR (Anchor c) | |
Crypto c => EncCBOR (Anchor c) | |
Defined in Cardano.Ledger.BaseTypes Methods encCBOR :: Anchor c -> Encoding encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy (Anchor c) -> Size encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [Anchor c] -> Size | |
Crypto c => Default (Anchor c) | |
Defined in Cardano.Ledger.BaseTypes | |
Crypto c => NFData (Anchor c) | |
Defined in Cardano.Ledger.BaseTypes | |
Eq (Anchor c) | |
Ord (Anchor c) | |
Defined in Cardano.Ledger.BaseTypes | |
NoThunks (Anchor c) | |
ToExpr (Anchor c) | |
Defined in Cardano.Ledger.BaseTypes | |
type Rep (Anchor c) | |
Defined in Cardano.Ledger.BaseTypes type Rep (Anchor c) = D1 ('MetaData "Anchor" "Cardano.Ledger.BaseTypes" "cardano-ledger-core-1.9.0.0-1dQ7WLDbkZc8aXLEpNIvOr" 'False) (C1 ('MetaCons "Anchor" 'PrefixI 'True) (S1 ('MetaSel ('Just "anchorUrl") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Url) :*: S1 ('MetaSel ('Just "anchorDataHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SafeHash c AnchorData)))) |
newtype AnchorData #
Constructors
AnchorData ByteString |
Instances
SafeToHash AnchorData | |
Defined in Cardano.Ledger.BaseTypes Methods originalBytes :: AnchorData -> ByteString makeHashWithExplicitProxys :: HashAlgorithm (HASH c) => Proxy c -> Proxy index -> AnchorData -> SafeHash c index | |
Eq AnchorData | |
Defined in Cardano.Ledger.BaseTypes Methods (==) :: AnchorData -> AnchorData -> Bool Source # (/=) :: AnchorData -> AnchorData -> Bool Source # | |
HashWithCrypto AnchorData AnchorData | |
Defined in Cardano.Ledger.BaseTypes Methods hashWithCrypto :: HashAlgorithm (HASH c) => Proxy c -> AnchorData -> SafeHash c AnchorData |
hashAnchorData :: Crypto c => AnchorData -> SafeHash c AnchorData #