Safe Haskell	None
Language	Haskell2010

Cardano.Api.Governance.Actions.ProposalProcedure

Synopsis

data AnyGovernanceAction = AnyGovernanceAction (GovAction era)
data GovernanceAction era
- = MotionOfNoConfidence (StrictMaybe (GovPurposeId 'CommitteePurpose (ShelleyLedgerEra era)))
- | ProposeNewConstitution (StrictMaybe (GovPurposeId 'ConstitutionPurpose (ShelleyLedgerEra era))) (Anchor StandardCrypto) (StrictMaybe (ScriptHash StandardCrypto))
- | ProposeNewCommittee (StrictMaybe (GovPurposeId 'CommitteePurpose (ShelleyLedgerEra era))) [Credential 'ColdCommitteeRole StandardCrypto] (Map (Credential 'ColdCommitteeRole StandardCrypto) EpochNo) Rational
- | InfoAct
- | TreasuryWithdrawal [(Network, StakeCredential, Coin)] !(StrictMaybe (ScriptHash StandardCrypto))
- | InitiateHardfork (StrictMaybe (GovPurposeId 'HardForkPurpose (ShelleyLedgerEra era))) ProtVer
- | UpdatePParams (StrictMaybe (GovPurposeId 'PParamUpdatePurpose (ShelleyLedgerEra era))) (PParamsUpdate (ShelleyLedgerEra era)) !(StrictMaybe (ScriptHash StandardCrypto))
toGovernanceAction :: ShelleyBasedEra era -> GovernanceAction era -> GovAction (ShelleyLedgerEra era)
fromGovernanceAction :: EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto => GovAction (ShelleyLedgerEra era) -> GovernanceAction era
newtype Proposal era = Proposal {
- unProposal :: ProposalProcedure (ShelleyLedgerEra era)
}
createProposalProcedure :: ShelleyBasedEra era -> Network -> Coin -> StakeCredential -> GovernanceAction era -> Anchor StandardCrypto -> Proposal era
fromProposalProcedure :: ShelleyBasedEra era -> Proposal era -> (Coin, StakeCredential, GovernanceAction era)
createPreviousGovernanceActionId :: forall era (r :: GovActionPurpose). EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto => TxId -> Word16 -> GovPurposeId r (ShelleyLedgerEra era)
createGovernanceActionId :: TxId -> Word16 -> GovActionId StandardCrypto
createAnchor :: Url -> ByteString -> Anchor StandardCrypto
getAnchorDataFromGovernanceAction :: EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto => GovAction (ShelleyLedgerEra era) -> Maybe (Anchor StandardCrypto)

Documentation

data AnyGovernanceAction Source #

Constructors

AnyGovernanceAction (GovAction era)

data GovernanceAction era Source #

Constructors

MotionOfNoConfidence (StrictMaybe (GovPurposeId 'CommitteePurpose (ShelleyLedgerEra era)))
ProposeNewConstitution (StrictMaybe (GovPurposeId 'ConstitutionPurpose (ShelleyLedgerEra era))) (Anchor StandardCrypto) (StrictMaybe (ScriptHash StandardCrypto))
ProposeNewCommittee
Fields (StrictMaybe (GovPurposeId 'CommitteePurpose (ShelleyLedgerEra era))) [Credential 'ColdCommitteeRole StandardCrypto] Old constitutional committee (Map (Credential 'ColdCommitteeRole StandardCrypto) EpochNo) New committee members with epoch number when each of them expires Rational Quorum of the committee that is necessary for a successful vote
InfoAct
TreasuryWithdrawal [(Network, StakeCredential, Coin)] !(StrictMaybe (ScriptHash StandardCrypto))	Governance policy
InitiateHardfork (StrictMaybe (GovPurposeId 'HardForkPurpose (ShelleyLedgerEra era))) ProtVer
UpdatePParams (StrictMaybe (GovPurposeId 'PParamUpdatePurpose (ShelleyLedgerEra era))) (PParamsUpdate (ShelleyLedgerEra era)) !(StrictMaybe (ScriptHash StandardCrypto))	Governance policy

toGovernanceAction :: ShelleyBasedEra era -> GovernanceAction era -> GovAction (ShelleyLedgerEra era) Source #

fromGovernanceAction :: EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto => GovAction (ShelleyLedgerEra era) -> GovernanceAction era Source #

newtype Proposal era Source #

Constructors

Proposal
Fields unProposal :: ProposalProcedure (ShelleyLedgerEra era)

Instances

Instances details

IsShelleyBasedEra era => Show (Proposal era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.ProposalProcedure

Methods

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

show :: Proposal era -> String Source #

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

HasTypeProxy era => HasTypeProxy (Proposal era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.ProposalProcedure

Associated Types

data AsType (Proposal era)
Instance details Defined in Cardano.Api.Governance.Actions.ProposalProcedure data AsType (Proposal era) = AsProposal

Methods

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

IsShelleyBasedEra era => SerialiseAsCBOR (Proposal era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.ProposalProcedure

Methods

serialiseToCBOR :: Proposal era -> ByteString Source #

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

IsShelleyBasedEra era => HasTextEnvelope (Proposal era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.ProposalProcedure

Methods

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

textEnvelopeDefaultDescr :: Proposal era -> TextEnvelopeDescr Source #

IsShelleyBasedEra era => FromCBOR (Proposal era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.ProposalProcedure

Methods

fromCBOR :: Decoder s (Proposal era) Source #

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

IsShelleyBasedEra era => ToCBOR (Proposal era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.ProposalProcedure

Methods

toCBOR :: Proposal era -> Encoding Source #

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

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

IsShelleyBasedEra era => Eq (Proposal era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.ProposalProcedure

Methods

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

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

data AsType (Proposal era) Source #

Instance details

Defined in Cardano.Api.Governance.Actions.ProposalProcedure

data AsType (Proposal era) = AsProposal

createProposalProcedure Source #

Arguments

:: ShelleyBasedEra era
-> Network
-> Coin	Deposit
-> StakeCredential	Credential to return the deposit to.
-> GovernanceAction era
-> Anchor StandardCrypto
-> Proposal era

fromProposalProcedure :: ShelleyBasedEra era -> Proposal era -> (Coin, StakeCredential, GovernanceAction era) Source #

createPreviousGovernanceActionId Source #

Arguments

:: forall era (r :: GovActionPurpose). EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto
=> TxId
-> Word16	Governance action transation index
-> GovPurposeId r (ShelleyLedgerEra era)

createGovernanceActionId :: TxId -> Word16 -> GovActionId StandardCrypto Source #

createAnchor :: Url -> ByteString -> Anchor StandardCrypto Source #

getAnchorDataFromGovernanceAction :: EraCrypto (ShelleyLedgerEra era) ~ StandardCrypto => GovAction (ShelleyLedgerEra era) -> Maybe (Anchor StandardCrypto) Source #

Get anchor data url and hash from a governance action. A return value of Nothing means that the governance action does not contain anchor data.