Safe Haskell	None
Language	Haskell2010

Cardano.Api.Governance.Actions.VotingProcedure

Synopsis

newtype GovernanceActionId era = GovernanceActionId {
- unGovernanceActionId :: GovActionId (EraCrypto (ShelleyLedgerEra era))
}
newtype Voter era = Voter (Voter (EraCrypto (ShelleyLedgerEra era)))
data Vote
- = No
- | Yes
- | Abstain
toVote :: Vote -> Vote
createVotingProcedure :: ConwayEraOnwards era -> Vote -> Maybe (Url, Text) -> VotingProcedure era
newtype VotingProcedure era = VotingProcedure {
- unVotingProcedure :: VotingProcedure (ShelleyLedgerEra era)
}
newtype VotingProcedures era = VotingProcedures {
- unVotingProcedures :: VotingProcedures (ShelleyLedgerEra era)
}
emptyVotingProcedures :: VotingProcedures era
singletonVotingProcedures :: ConwayEraOnwards era -> Voter (EraCrypto (ShelleyLedgerEra era)) -> GovActionId (EraCrypto (ShelleyLedgerEra era)) -> VotingProcedure (ShelleyLedgerEra era) -> VotingProcedures era
newtype VotesMergingConflict era = VotesMergingConflict (Voter (EraCrypto (ShelleyLedgerEra era)), [GovActionId (EraCrypto (ShelleyLedgerEra era))])
mergeVotingProcedures :: VotingProcedures era -> VotingProcedures era -> Either (VotesMergingConflict era) (VotingProcedures era)

Documentation

newtype GovernanceActionId era Source #

Constructors

GovernanceActionId
Fields unGovernanceActionId :: GovActionId (EraCrypto (ShelleyLedgerEra era))

Instances

Instances details

Show (GovernanceActionId era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods showsPrec :: Int -> GovernanceActionId era -> ShowS Source # show :: GovernanceActionId era -> String Source # showList :: [GovernanceActionId era] -> ShowS Source #
IsShelleyBasedEra era => FromCBOR (GovernanceActionId era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods fromCBOR :: Decoder s (GovernanceActionId era) Source # label :: Proxy (GovernanceActionId era) -> Text Source #
IsShelleyBasedEra era => ToCBOR (GovernanceActionId era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods toCBOR :: GovernanceActionId era -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (GovernanceActionId era) -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [GovernanceActionId era] -> Size Source #
Eq (GovernanceActionId era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods (==) :: GovernanceActionId era -> GovernanceActionId era -> Bool Source # (/=) :: GovernanceActionId era -> GovernanceActionId era -> Bool Source #
Ord (GovernanceActionId era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods compare :: GovernanceActionId era -> GovernanceActionId era -> Ordering Source # (<) :: GovernanceActionId era -> GovernanceActionId era -> Bool Source # (<=) :: GovernanceActionId era -> GovernanceActionId era -> Bool Source # (>) :: GovernanceActionId era -> GovernanceActionId era -> Bool Source # (>=) :: GovernanceActionId era -> GovernanceActionId era -> Bool Source # max :: GovernanceActionId era -> GovernanceActionId era -> GovernanceActionId era Source # min :: GovernanceActionId era -> GovernanceActionId era -> GovernanceActionId era Source #

newtype Voter era Source #

Constructors

Voter (Voter (EraCrypto (ShelleyLedgerEra era)))

Instances

Instances details

Show (Voter era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods showsPrec :: Int -> Voter era -> ShowS Source # show :: Voter era -> String Source # showList :: [Voter era] -> ShowS Source #
IsShelleyBasedEra era => FromCBOR (Voter era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods fromCBOR :: Decoder s (Voter era) Source # label :: Proxy (Voter era) -> Text Source #
IsShelleyBasedEra era => ToCBOR (Voter era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods toCBOR :: Voter era -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (Voter era) -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [Voter era] -> Size Source #
Eq (Voter era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods (==) :: Voter era -> Voter era -> Bool Source # (/=) :: Voter era -> Voter era -> Bool Source #
Ord (Voter era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods compare :: Voter era -> Voter era -> Ordering Source # (<) :: Voter era -> Voter era -> Bool Source # (<=) :: Voter era -> Voter era -> Bool Source # (>) :: Voter era -> Voter era -> Bool Source # (>=) :: Voter era -> Voter era -> Bool Source # max :: Voter era -> Voter era -> Voter era Source # min :: Voter era -> Voter era -> Voter era Source #

data Vote Source #

Constructors

No
Yes
Abstain

Instances

Instances details

Show Vote Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods showsPrec :: Int -> Vote -> ShowS Source # show :: Vote -> String Source # showList :: [Vote] -> ShowS Source #
Eq Vote Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure Methods (==) :: Vote -> Vote -> Bool Source # (/=) :: Vote -> Vote -> Bool Source #

toVote :: Vote -> Vote Source #

createVotingProcedure Source #

Arguments

:: ConwayEraOnwards era
-> Vote
-> Maybe (Url, Text)	Anchor
-> VotingProcedure era

newtype VotingProcedure era Source #

Constructors

VotingProcedure
Fields unVotingProcedure :: VotingProcedure (ShelleyLedgerEra era)

Instances

Instances details

Show (VotingProcedure era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

showsPrec :: Int -> VotingProcedure era -> ShowS Source #

show :: VotingProcedure era -> String Source #

showList :: [VotingProcedure era] -> ShowS Source #

HasTypeProxy era => HasTypeProxy (VotingProcedure era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Associated Types

data AsType (VotingProcedure era)
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedure era) = AsVote

Methods

proxyToAsType :: Proxy (VotingProcedure era) -> AsType (VotingProcedure era) Source #

IsShelleyBasedEra era => SerialiseAsCBOR (VotingProcedure era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

serialiseToCBOR :: VotingProcedure era -> ByteString Source #

deserialiseFromCBOR :: AsType (VotingProcedure era) -> ByteString -> Either DecoderError (VotingProcedure era) Source #

IsShelleyBasedEra era => HasTextEnvelope (VotingProcedure era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

textEnvelopeType :: AsType (VotingProcedure era) -> TextEnvelopeType Source #

textEnvelopeDefaultDescr :: VotingProcedure era -> TextEnvelopeDescr Source #

IsShelleyBasedEra era => FromCBOR (VotingProcedure era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

fromCBOR :: Decoder s (VotingProcedure era) Source #

label :: Proxy (VotingProcedure era) -> Text Source #

IsShelleyBasedEra era => ToCBOR (VotingProcedure era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

toCBOR :: VotingProcedure era -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (VotingProcedure era) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [VotingProcedure era] -> Size Source #

Eq (VotingProcedure era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

(==) :: VotingProcedure era -> VotingProcedure era -> Bool Source #

(/=) :: VotingProcedure era -> VotingProcedure era -> Bool Source #

data AsType (VotingProcedure era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

data AsType (VotingProcedure era) = AsVote

newtype VotingProcedures era Source #

Constructors

VotingProcedures
Fields unVotingProcedures :: VotingProcedures (ShelleyLedgerEra era)

Instances

Instances details

Generic (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Associated Types

type Rep (VotingProcedures era)

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

type Rep (VotingProcedures era) = D1 ('MetaData "VotingProcedures" "Cardano.Api.Governance.Actions.VotingProcedure" "cardano-api-9.3.0.0-inplace-internal" 'True) (C1 ('MetaCons "VotingProcedures" 'PrefixI 'True) (S1 ('MetaSel ('Just "unVotingProcedures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VotingProcedures (ShelleyLedgerEra era)))))

Methods

from :: VotingProcedures era -> Rep (VotingProcedures era) x Source #

to :: Rep (VotingProcedures era) x -> VotingProcedures era Source #

Show (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

showsPrec :: Int -> VotingProcedures era -> ShowS Source #

show :: VotingProcedures era -> String Source #

showList :: [VotingProcedures era] -> ShowS Source #

HasTypeProxy era => HasTypeProxy (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Associated Types

data AsType (VotingProcedures era)
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedures era) = AsVotingProcedures

Methods

proxyToAsType :: Proxy (VotingProcedures era) -> AsType (VotingProcedures era) Source #

IsShelleyBasedEra era => SerialiseAsCBOR (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

serialiseToCBOR :: VotingProcedures era -> ByteString Source #

deserialiseFromCBOR :: AsType (VotingProcedures era) -> ByteString -> Either DecoderError (VotingProcedures era) Source #

IsShelleyBasedEra era => HasTextEnvelope (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

textEnvelopeType :: AsType (VotingProcedures era) -> TextEnvelopeType Source #

textEnvelopeDefaultDescr :: VotingProcedures era -> TextEnvelopeDescr Source #

IsShelleyBasedEra era => FromCBOR (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

fromCBOR :: Decoder s (VotingProcedures era) Source #

label :: Proxy (VotingProcedures era) -> Text Source #

IsShelleyBasedEra era => ToCBOR (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

toCBOR :: VotingProcedures era -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (VotingProcedures era) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [VotingProcedures era] -> Size Source #

Eq (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

Methods

(==) :: VotingProcedures era -> VotingProcedures era -> Bool Source #

(/=) :: VotingProcedures era -> VotingProcedures era -> Bool Source #

type Rep (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

type Rep (VotingProcedures era) = D1 ('MetaData "VotingProcedures" "Cardano.Api.Governance.Actions.VotingProcedure" "cardano-api-9.3.0.0-inplace-internal" 'True) (C1 ('MetaCons "VotingProcedures" 'PrefixI 'True) (S1 ('MetaSel ('Just "unVotingProcedures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VotingProcedures (ShelleyLedgerEra era)))))

data AsType (VotingProcedures era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.VotingProcedure

data AsType (VotingProcedures era) = AsVotingProcedures

emptyVotingProcedures :: VotingProcedures era Source #

singletonVotingProcedures :: ConwayEraOnwards era -> Voter (EraCrypto (ShelleyLedgerEra era)) -> GovActionId (EraCrypto (ShelleyLedgerEra era)) -> VotingProcedure (ShelleyLedgerEra era) -> VotingProcedures era Source #

newtype VotesMergingConflict era Source #

A voter, and the conflicting votes of this voter (i.e. votes with the same governance action identifier)

Constructors

VotesMergingConflict (Voter (EraCrypto (ShelleyLedgerEra era)), [GovActionId (EraCrypto (ShelleyLedgerEra era))])

mergeVotingProcedures Source #

Arguments

:: VotingProcedures era	Votes to merge
-> VotingProcedures era	Votes to merge
-> Either (VotesMergingConflict era) (VotingProcedures era)	Either the conflict found, or the merged votes

mergeVotingProcedures vote1 vote2 merges vote1 and vote2 into a single vote, or fails if the votes are incompatible.