Copyright	(c) 2025 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.Types.Governance

Description

Synopsis

data GYVote
- = Yes
- | No
- | Abstain
voteFromLedger ∷ Vote → GYVote
voteToLedger ∷ GYVote → Vote
data GYVoter
- = CommitteeVoter !(GYCredential 'GYKeyRoleHotCommittee)
- | DRepVoter !(GYCredential 'GYKeyRoleDRep)
- | StakePoolVoter !(GYKeyHash 'GYKeyRoleStakePool)
voterFromLedger ∷ Voter (EraCrypto StandardConway) → GYVoter
voterToLedger ∷ GYVoter → Voter Era
data GYGovActionId = GYGovActionId {
- gaidTxId ∷ !GYTxId
- gaidIx ∷ !Word16
}
govActionIdFromLedger ∷ GovActionId Era → GYGovActionId
govActionIdToLedger ∷ GYGovActionId → GovActionId Era
data GYVotingProcedure = GYVotingProcedure {
- vpVote ∷ !GYVote
- vpAnchor ∷ !(Maybe GYAnchor)
}
votingProcedureFromLedger ∷ VotingProcedure StandardConway → GYVotingProcedure
votingProcedureToLedger ∷ GYVotingProcedure → VotingProcedure StandardConway
type GYVotingProcedures = Map GYVoter (Map GYGovActionId GYVotingProcedure)
votingProceduresFromLedger ∷ VotingProcedures StandardConway → GYVotingProcedures
votingProceduresToLedger ∷ GYVotingProcedures → VotingProcedures StandardConway
combineVotingProcedures ∷ GYVotingProcedures → GYVotingProcedures → GYVotingProcedures
type GYTxVotingProcedures v = Map GYVoter (GYTxBuildWitness v, Map GYGovActionId GYVotingProcedure)
combineTxVotingProcedures ∷ GYTxVotingProcedures v → GYTxVotingProcedures v → GYTxVotingProcedures v
data GYProposalProcedurePB = GYProposalProcedurePB {
- propProcPBReturnAddr ∷ !GYStakeAddress
- propProcPBGovAction ∷ !GYGovAction
- propProcPBAnchor ∷ !GYAnchor
}
data GYProposalProcedure = GYProposalProcedure {
- propProcDeposit ∷ !Natural
- propProcReturnAddr ∷ !GYStakeAddress
- propProcGovAction ∷ !GYGovAction
- propProcAnchor ∷ !GYAnchor
}
completeProposalProcedure ∷ GYProposalProcedurePB → Natural → GYProposalProcedure
propProcToLedger ∷ GYProposalProcedure → ProposalProcedure StandardConway
data GYConstitution = GYConstitution {
- constitutionAnchor ∷ !GYAnchor
- constitutionScript ∷ !(Maybe GYScriptHash)
}
constitutionToLedger ∷ GYConstitution → Constitution StandardConway
data GYGovAction
- = ParameterChange !(Maybe GYGovActionId) !(PParamsUpdate StandardConway) !(Maybe GYScriptHash)
- | HardForkInitiation !(Maybe GYGovActionId) !ProtVer
- | TreasuryWithdrawals !(Map GYStakeAddress Natural) !(Maybe GYScriptHash)
- | NoConfidence !(Maybe GYGovActionId)
- | UpdateCommittee !(Maybe GYGovActionId) !(Set (GYCredential 'GYKeyRoleColdCommittee)) !(Map (GYCredential 'GYKeyRoleColdCommittee) GYEpochNo) !UnitInterval
- | NewConstitution !(Maybe GYGovActionId) !GYConstitution
- | InfoAction
govActionToLedger ∷ GYGovAction → GovAction StandardConway

Documentation

data GYVote #

Vote on a governance proposal.

Constructors

Yes
No
Abstain

Instances

Instances details

Bounded GYVote #
Instance details Defined in GeniusYield.Types.Governance Methods minBound ∷ GYVote # maxBound ∷ GYVote #
Enum GYVote #
Instance details Defined in GeniusYield.Types.Governance Methods succ ∷ GYVote → GYVote # pred ∷ GYVote → GYVote # toEnum ∷ Int → GYVote # fromEnum ∷ GYVote → Int # enumFrom ∷ GYVote → [GYVote] # enumFromThen ∷ GYVote → GYVote → [GYVote] # enumFromTo ∷ GYVote → GYVote → [GYVote] # enumFromThenTo ∷ GYVote → GYVote → GYVote → [GYVote] #
Show GYVote #
Instance details Defined in GeniusYield.Types.Governance Methods showsPrec ∷ Int → GYVote → ShowS # show ∷ GYVote → String # showList ∷ [GYVote] → ShowS #
Eq GYVote #
Instance details Defined in GeniusYield.Types.Governance Methods (==) ∷ GYVote → GYVote → Bool # (/=) ∷ GYVote → GYVote → Bool #
Ord GYVote #
Instance details Defined in GeniusYield.Types.Governance Methods compare ∷ GYVote → GYVote → Ordering # (<) ∷ GYVote → GYVote → Bool # (<=) ∷ GYVote → GYVote → Bool # (>) ∷ GYVote → GYVote → Bool # (>=) ∷ GYVote → GYVote → Bool # max ∷ GYVote → GYVote → GYVote # min ∷ GYVote → GYVote → GYVote #

voteFromLedger ∷ Vote → GYVote #

voteToLedger ∷ GYVote → Vote #

data GYVoter #

Voter.

Constructors

CommitteeVoter !(GYCredential 'GYKeyRoleHotCommittee)
DRepVoter !(GYCredential 'GYKeyRoleDRep)
StakePoolVoter !(GYKeyHash 'GYKeyRoleStakePool)

Instances

Instances details

Show GYVoter #
Instance details Defined in GeniusYield.Types.Governance Methods showsPrec ∷ Int → GYVoter → ShowS # show ∷ GYVoter → String # showList ∷ [GYVoter] → ShowS #
Eq GYVoter #
Instance details Defined in GeniusYield.Types.Governance Methods (==) ∷ GYVoter → GYVoter → Bool # (/=) ∷ GYVoter → GYVoter → Bool #
Ord GYVoter #
Instance details Defined in GeniusYield.Types.Governance Methods compare ∷ GYVoter → GYVoter → Ordering # (<) ∷ GYVoter → GYVoter → Bool # (<=) ∷ GYVoter → GYVoter → Bool # (>) ∷ GYVoter → GYVoter → Bool # (>=) ∷ GYVoter → GYVoter → Bool # max ∷ GYVoter → GYVoter → GYVoter # min ∷ GYVoter → GYVoter → GYVoter #

voterFromLedger ∷ Voter (EraCrypto StandardConway) → GYVoter #

voterToLedger ∷ GYVoter → Voter Era #

data GYGovActionId #

Constructors

GYGovActionId
Fields gaidTxId ∷ !GYTxId gaidIx ∷ !Word16

Instances

Instances details

Show GYGovActionId #
Instance details Defined in GeniusYield.Types.Governance Methods showsPrec ∷ Int → GYGovActionId → ShowS # show ∷ GYGovActionId → String # showList ∷ [GYGovActionId] → ShowS #
Eq GYGovActionId #
Instance details Defined in GeniusYield.Types.Governance Methods (==) ∷ GYGovActionId → GYGovActionId → Bool # (/=) ∷ GYGovActionId → GYGovActionId → Bool #
Ord GYGovActionId #
Instance details Defined in GeniusYield.Types.Governance Methods compare ∷ GYGovActionId → GYGovActionId → Ordering # (<) ∷ GYGovActionId → GYGovActionId → Bool # (<=) ∷ GYGovActionId → GYGovActionId → Bool # (>) ∷ GYGovActionId → GYGovActionId → Bool # (>=) ∷ GYGovActionId → GYGovActionId → Bool # max ∷ GYGovActionId → GYGovActionId → GYGovActionId # min ∷ GYGovActionId → GYGovActionId → GYGovActionId #

govActionIdFromLedger ∷ GovActionId Era → GYGovActionId #

govActionIdToLedger ∷ GYGovActionId → GovActionId Era #

data GYVotingProcedure #

Voting procedure.

Constructors

GYVotingProcedure
Fields vpVote ∷ !GYVote vpAnchor ∷ !(Maybe GYAnchor)

Instances

Instances details

Show GYVotingProcedure #
Instance details Defined in GeniusYield.Types.Governance Methods showsPrec ∷ Int → GYVotingProcedure → ShowS # show ∷ GYVotingProcedure → String # showList ∷ [GYVotingProcedure] → ShowS #
Eq GYVotingProcedure #
Instance details Defined in GeniusYield.Types.Governance Methods (==) ∷ GYVotingProcedure → GYVotingProcedure → Bool # (/=) ∷ GYVotingProcedure → GYVotingProcedure → Bool #
Ord GYVotingProcedure #
Instance details Defined in GeniusYield.Types.Governance Methods compare ∷ GYVotingProcedure → GYVotingProcedure → Ordering # (<) ∷ GYVotingProcedure → GYVotingProcedure → Bool # (<=) ∷ GYVotingProcedure → GYVotingProcedure → Bool # (>) ∷ GYVotingProcedure → GYVotingProcedure → Bool # (>=) ∷ GYVotingProcedure → GYVotingProcedure → Bool # max ∷ GYVotingProcedure → GYVotingProcedure → GYVotingProcedure # min ∷ GYVotingProcedure → GYVotingProcedure → GYVotingProcedure #

votingProcedureFromLedger ∷ VotingProcedure StandardConway → GYVotingProcedure #

votingProcedureToLedger ∷ GYVotingProcedure → VotingProcedure StandardConway #

type GYVotingProcedures = Map GYVoter (Map GYGovActionId GYVotingProcedure) #

votingProceduresFromLedger ∷ VotingProcedures StandardConway → GYVotingProcedures #

votingProceduresToLedger ∷ GYVotingProcedures → VotingProcedures StandardConway #

combineVotingProcedures ∷ GYVotingProcedures → GYVotingProcedures → GYVotingProcedures #

Combine two voting procedures. Here if a voter has voted on the same proposal in both procedures, the vote from the second procedure is taken.

type GYTxVotingProcedures v = Map GYVoter (GYTxBuildWitness v, Map GYGovActionId GYVotingProcedure) #

combineTxVotingProcedures ∷ GYTxVotingProcedures v → GYTxVotingProcedures v → GYTxVotingProcedures v #

Combine two voting procedures. Here if a voter has voted on the same proposal in both procedures, the vote from the second procedure is taken. Likewise, witness from the second map is taken in case of conflicts.

data GYProposalProcedurePB #

Constructors

GYProposalProcedurePB
Fields propProcPBReturnAddr ∷ !GYStakeAddress propProcPBGovAction ∷ !GYGovAction propProcPBAnchor ∷ !GYAnchor

Instances

Instances details

Show GYProposalProcedurePB #
Instance details Defined in GeniusYield.Types.Governance Methods showsPrec ∷ Int → GYProposalProcedurePB → ShowS # show ∷ GYProposalProcedurePB → String # showList ∷ [GYProposalProcedurePB] → ShowS #
Eq GYProposalProcedurePB #
Instance details Defined in GeniusYield.Types.Governance Methods (==) ∷ GYProposalProcedurePB → GYProposalProcedurePB → Bool # (/=) ∷ GYProposalProcedurePB → GYProposalProcedurePB → Bool #
Ord GYProposalProcedurePB #
Instance details Defined in GeniusYield.Types.Governance Methods compare ∷ GYProposalProcedurePB → GYProposalProcedurePB → Ordering # (<) ∷ GYProposalProcedurePB → GYProposalProcedurePB → Bool # (<=) ∷ GYProposalProcedurePB → GYProposalProcedurePB → Bool # (>) ∷ GYProposalProcedurePB → GYProposalProcedurePB → Bool # (>=) ∷ GYProposalProcedurePB → GYProposalProcedurePB → Bool # max ∷ GYProposalProcedurePB → GYProposalProcedurePB → GYProposalProcedurePB # min ∷ GYProposalProcedurePB → GYProposalProcedurePB → GYProposalProcedurePB #

data GYProposalProcedure #

Constructors

GYProposalProcedure
Fields propProcDeposit ∷ !Natural propProcReturnAddr ∷ !GYStakeAddress propProcGovAction ∷ !GYGovAction propProcAnchor ∷ !GYAnchor

Instances

Instances details

Show GYProposalProcedure #
Instance details Defined in GeniusYield.Types.Governance Methods showsPrec ∷ Int → GYProposalProcedure → ShowS # show ∷ GYProposalProcedure → String # showList ∷ [GYProposalProcedure] → ShowS #
Eq GYProposalProcedure #
Instance details Defined in GeniusYield.Types.Governance Methods (==) ∷ GYProposalProcedure → GYProposalProcedure → Bool # (/=) ∷ GYProposalProcedure → GYProposalProcedure → Bool #
Ord GYProposalProcedure #
Instance details Defined in GeniusYield.Types.Governance Methods compare ∷ GYProposalProcedure → GYProposalProcedure → Ordering # (<) ∷ GYProposalProcedure → GYProposalProcedure → Bool # (<=) ∷ GYProposalProcedure → GYProposalProcedure → Bool # (>) ∷ GYProposalProcedure → GYProposalProcedure → Bool # (>=) ∷ GYProposalProcedure → GYProposalProcedure → Bool # max ∷ GYProposalProcedure → GYProposalProcedure → GYProposalProcedure # min ∷ GYProposalProcedure → GYProposalProcedure → GYProposalProcedure #

completeProposalProcedure ∷ GYProposalProcedurePB → Natural → GYProposalProcedure #

propProcToLedger ∷ GYProposalProcedure → ProposalProcedure StandardConway #

data GYConstitution #

Constructors

GYConstitution
Fields constitutionAnchor ∷ !GYAnchor constitutionScript ∷ !(Maybe GYScriptHash)

Instances

Instances details

Show GYConstitution #
Instance details Defined in GeniusYield.Types.Governance Methods showsPrec ∷ Int → GYConstitution → ShowS # show ∷ GYConstitution → String # showList ∷ [GYConstitution] → ShowS #
Eq GYConstitution #
Instance details Defined in GeniusYield.Types.Governance Methods (==) ∷ GYConstitution → GYConstitution → Bool # (/=) ∷ GYConstitution → GYConstitution → Bool #
Ord GYConstitution #
Instance details Defined in GeniusYield.Types.Governance Methods compare ∷ GYConstitution → GYConstitution → Ordering # (<) ∷ GYConstitution → GYConstitution → Bool # (<=) ∷ GYConstitution → GYConstitution → Bool # (>) ∷ GYConstitution → GYConstitution → Bool # (>=) ∷ GYConstitution → GYConstitution → Bool # max ∷ GYConstitution → GYConstitution → GYConstitution # min ∷ GYConstitution → GYConstitution → GYConstitution #

constitutionToLedger ∷ GYConstitution → Constitution StandardConway #

data GYGovAction #

Constructors

ParameterChange
Fields !(Maybe GYGovActionId) Previous governance action id of `ParameterChange` type. !(PParamsUpdate StandardConway) Proposed changes to PParams !(Maybe GYScriptHash) Policy hash protection
HardForkInitiation
Fields !(Maybe GYGovActionId) Previous governance action id of `HardForkInitiation` type !ProtVer Proposed new protocol version
TreasuryWithdrawals
Fields !(Map GYStakeAddress Natural) Proposed treasury withdrawals !(Maybe GYScriptHash) Policy hash protection
NoConfidence
Fields !(Maybe GYGovActionId) Previous governance action id of `NoConfidence` or `UpdateCommittee` type
UpdateCommittee
Fields !(Maybe GYGovActionId) Previous governance action id of `UpdateCommittee` or `NoConfidence` type !(Set (GYCredential 'GYKeyRoleColdCommittee)) Constitutional Committe members to be removed !(Map (GYCredential 'GYKeyRoleColdCommittee) GYEpochNo) Constitutional committee members to be added !UnitInterval New Threshold
NewConstitution
Fields !(Maybe GYGovActionId) Previous governance action id of `NewConstitution` type !GYConstitution
InfoAction

Instances

Instances details

Show GYGovAction #
Instance details Defined in GeniusYield.Types.Governance Methods showsPrec ∷ Int → GYGovAction → ShowS # show ∷ GYGovAction → String # showList ∷ [GYGovAction] → ShowS #
Eq GYGovAction #
Instance details Defined in GeniusYield.Types.Governance Methods (==) ∷ GYGovAction → GYGovAction → Bool # (/=) ∷ GYGovAction → GYGovAction → Bool #
Ord GYGovAction #
Instance details Defined in GeniusYield.Types.Governance Methods compare ∷ GYGovAction → GYGovAction → Ordering # (<) ∷ GYGovAction → GYGovAction → Bool # (<=) ∷ GYGovAction → GYGovAction → Bool # (>) ∷ GYGovAction → GYGovAction → Bool # (>=) ∷ GYGovAction → GYGovAction → Bool # max ∷ GYGovAction → GYGovAction → GYGovAction # min ∷ GYGovAction → GYGovAction → GYGovAction #

govActionToLedger ∷ GYGovAction → GovAction StandardConway #