cardano-api
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.Serialise.Cip129

Synopsis

Documentation

class (SerialiseAsRawBytes a, HasTypeProxy a) => Cip129 a where Source #

Cip-129 is a typeclass that captures the serialisation requirements of https://cips.cardano.org/cip/CIP-0129 which pertain to governance credentials and governance action ids.

Minimal complete definition

cip129Bech32PrefixFor, cip129Header, cip129SerialiseRaw, cip129DeserialiseRaw

Associated Types

data Cip129Header a Source #

A sum type with all possible headers for CIP-129 identifier

Methods

cip129Bech32PrefixFor :: AsType a -> HumanReadablePart Source #

The human readable part of the Bech32 encoding for the credential.

cip129Bech32PrefixesPermitted :: AsType a -> [Text] Source #

Permitted bech32 prefixes according to CIP-129.

default cip129Bech32PrefixesPermitted :: AsType a -> [Text] Source #

cip129Header :: Cip129Header a -> Word8 Source #

A Word8 value of Cip129 header

cip129SerialiseRaw :: a -> ByteString Source #

Serialise a value to a binary representation used in CIP 129. It's usually distinct from CBOR serialisation. Internal conversion function. Use serialiseToBech32Cip129 instead of calling this function directly.

cip129DeserialiseRaw :: ByteString -> Either Cip129EncodingError a Source #

Deserialise a value from the bytes representation. Internal conversion function. Use deserialiseFromBech32Cip129 instead of calling this function directly.

Instances

Instances details
Cip129 GovActionId Source # 
Instance details

Defined in Cardano.Api.Serialise.Cip129

Associated Types

data Cip129Header GovActionId 
Instance details

Defined in Cardano.Api.Serialise.Cip129

data Cip129Header GovActionId

Methods

cip129Bech32PrefixFor :: AsType GovActionId -> HumanReadablePart Source #

cip129Bech32PrefixesPermitted :: AsType GovActionId -> [Text] Source #

cip129Header :: Cip129Header GovActionId -> Word8 Source #

cip129SerialiseRaw :: GovActionId -> ByteString Source #

cip129DeserialiseRaw :: ByteString -> Either Cip129EncodingError GovActionId Source #

Cip129 (Credential 'ColdCommitteeRole) Source # 
Instance details

Defined in Cardano.Api.Serialise.Cip129

Associated Types

data Cip129Header (Credential 'ColdCommitteeRole) 
Instance details

Defined in Cardano.Api.Serialise.Cip129

data Cip129Header (Credential 'ColdCommitteeRole)

Methods

cip129Bech32PrefixFor :: AsType (Credential 'ColdCommitteeRole) -> HumanReadablePart Source #

cip129Bech32PrefixesPermitted :: AsType (Credential 'ColdCommitteeRole) -> [Text] Source #

cip129Header :: Cip129Header (Credential 'ColdCommitteeRole) -> Word8 Source #

cip129SerialiseRaw :: Credential 'ColdCommitteeRole -> ByteString Source #

cip129DeserialiseRaw :: ByteString -> Either Cip129EncodingError (Credential 'ColdCommitteeRole) Source #

Cip129 (Credential 'DRepRole) Source # 
Instance details

Defined in Cardano.Api.Serialise.Cip129

Associated Types

data Cip129Header (Credential 'DRepRole) 
Instance details

Defined in Cardano.Api.Serialise.Cip129

data Cip129Header (Credential 'DRepRole)

Methods

cip129Bech32PrefixFor :: AsType (Credential 'DRepRole) -> HumanReadablePart Source #

cip129Bech32PrefixesPermitted :: AsType (Credential 'DRepRole) -> [Text] Source #

cip129Header :: Cip129Header (Credential 'DRepRole) -> Word8 Source #

cip129SerialiseRaw :: Credential 'DRepRole -> ByteString Source #

cip129DeserialiseRaw :: ByteString -> Either Cip129EncodingError (Credential 'DRepRole) Source #

Cip129 (Credential 'HotCommitteeRole) Source # 
Instance details

Defined in Cardano.Api.Serialise.Cip129

Associated Types

data Cip129Header (Credential 'HotCommitteeRole) 
Instance details

Defined in Cardano.Api.Serialise.Cip129

data Cip129Header (Credential 'HotCommitteeRole)

Methods

cip129Bech32PrefixFor :: AsType (Credential 'HotCommitteeRole) -> HumanReadablePart Source #

cip129Bech32PrefixesPermitted :: AsType (Credential 'HotCommitteeRole) -> [Text] Source #

cip129Header :: Cip129Header (Credential 'HotCommitteeRole) -> Word8 Source #

cip129SerialiseRaw :: Credential 'HotCommitteeRole -> ByteString Source #

cip129DeserialiseRaw :: ByteString -> Either Cip129EncodingError (Credential 'HotCommitteeRole) Source #

data Cip129EncodingError Source #

CIP-129 decoding errors

Instances

Instances details
Error Cip129EncodingError Source # 
Instance details

Defined in Cardano.Api.Serialise.Cip129

Methods

prettyError :: Cip129EncodingError -> Doc ann Source #

Show Cip129EncodingError Source # 
Instance details

Defined in Cardano.Api.Serialise.Cip129

Methods

showsPrec :: Int -> Cip129EncodingError -> ShowS Source #

show :: Cip129EncodingError -> String Source #

showList :: [Cip129EncodingError] -> ShowS Source #

Eq Cip129EncodingError Source # 
Instance details

Defined in Cardano.Api.Serialise.Cip129

Methods

(==) :: Cip129EncodingError -> Cip129EncodingError -> Bool Source #

(/=) :: Cip129EncodingError -> Cip129EncodingError -> Bool Source #

deserialiseFromBech32Cip129 Source #

Arguments

:: Cip129 a 
=> Text

A Bech32-encoded governance identifier

-> Either Cip129EncodingError a 

Deserialise a governance identifier from CIP-129 format.

serialiseToBech32Cip129 :: Cip129 a => a -> Text Source #

Serialise a accoding to the serialisation requirements of https://cips.cardano.org/cip/CIP-0129 which currently pertain to governance credentials.

serialiseGovActionIdToBech32Cip129 :: GovActionId -> Text Source #

Deprecated: Use serialiseToBech32Cip129 instead

Governance Action ID According to Cip129 there is no header byte for GovActionId. Instead they append the txid and index to form the payload.

deserialiseGovActionIdFromBech32Cip129 :: Text -> Either Cip129EncodingError GovActionId Source #

Deprecated: Use deserialiseFromBech32Cip129 instead

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 ByteString Source # 
Instance details

Defined in Cardano.Api.HasTypeProxy

data AsType ByteString = AsByteString
data AsType AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

data AsType AddressAny = AsAddressAny
data AsType ByronAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ByronAddr = AsByronAddr
data AsType ShelleyAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ShelleyAddr = AsShelleyAddr
data AsType StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

data AsType StakeAddress = AsStakeAddress
data AsType BlockHeader Source # 
Instance details

Defined in Cardano.Api.Block

data AsType BlockHeader = AsBlockHeader
data AsType ByronKey Source # 
Instance details

Defined in Cardano.Api.Byron.Internal.Key

data AsType ByronKey = AsByronKey
data AsType ByronKeyLegacy Source # 
Instance details

Defined in Cardano.Api.Byron.Internal.Key

data AsType ByronKeyLegacy = AsByronKeyLegacy
data AsType ByronUpdateProposal Source # 
Instance details

Defined in Cardano.Api.Byron.Internal.Proposal

data AsType ByronUpdateProposal = AsByronUpdateProposal
data AsType ByronVote Source # 
Instance details

Defined in Cardano.Api.Byron.Internal.Proposal

data AsType ByronVote = AsByronVote
data AsType DRepMetadata Source # 
Instance details

Defined in Cardano.Api.Certificate.Internal.DRepMetadata

data AsType DRepMetadata = AsDRepMetadata
data AsType OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Certificate.Internal.OperationalCertificate

data AsType OperationalCertificate = AsOperationalCertificate
data AsType OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Certificate.Internal.OperationalCertificate

data AsType OperationalCertificateIssueCounter = AsOperationalCertificateIssueCounter
data AsType StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.Certificate.Internal.StakePoolMetadata

data AsType StakePoolMetadata = AsStakePoolMetadata
data AsType AllegraEra Source # 
Instance details

Defined in Cardano.Api.Era.Internal.Core

data AsType AllegraEra = AsAllegraEra
data AsType AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Era.Internal.Core

data AsType AlonzoEra = AsAlonzoEra
data AsType BabbageEra Source # 
Instance details

Defined in Cardano.Api.Era.Internal.Core

data AsType BabbageEra = AsBabbageEra
data AsType ByronEra Source # 
Instance details

Defined in Cardano.Api.Era.Internal.Core

data AsType ByronEra = AsByronEra
data AsType ConwayEra Source # 
Instance details

Defined in Cardano.Api.Era.Internal.Core

data AsType ConwayEra = AsConwayEra
data AsType MaryEra Source # 
Instance details

Defined in Cardano.Api.Era.Internal.Core

data AsType MaryEra = AsMaryEra
data AsType ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Era.Internal.Core

data AsType ShelleyEra = AsShelleyEra
data AsType GovernancePoll Source # 
Instance details

Defined in Cardano.Api.Governance.Internal.Poll

data AsType GovernancePoll = AsGovernancePoll
data AsType GovernancePollAnswer Source # 
Instance details

Defined in Cardano.Api.Governance.Internal.Poll

data AsType GovernancePollAnswer = AsGovernancePollAnswer
data AsType CommitteeColdExtendedKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType CommitteeColdExtendedKey = AsCommitteeColdExtendedKey
data AsType CommitteeColdKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType CommitteeColdKey = AsCommitteeColdKey
data AsType CommitteeHotExtendedKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType CommitteeHotExtendedKey = AsCommitteeHotExtendedKey
data AsType CommitteeHotKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType CommitteeHotKey = AsCommitteeHotKey
data AsType DRepExtendedKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType DRepExtendedKey = AsDRepExtendedKey
data AsType DRepKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType DRepKey = AsDRepKey
data AsType GenesisDelegateExtendedKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType GenesisDelegateExtendedKey = AsGenesisDelegateExtendedKey
data AsType GenesisDelegateKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType GenesisDelegateKey = AsGenesisDelegateKey
data AsType GenesisExtendedKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType GenesisExtendedKey = AsGenesisExtendedKey
data AsType GenesisKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType GenesisKey = AsGenesisKey
data AsType GenesisUTxOKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType GenesisUTxOKey = AsGenesisUTxOKey
data AsType PaymentExtendedKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType PaymentExtendedKey = AsPaymentExtendedKey
data AsType PaymentKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType PaymentKey = AsPaymentKey
data AsType StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType StakeExtendedKey = AsStakeExtendedKey
data AsType StakeKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType StakeKey = AsStakeKey
data AsType StakePoolExtendedKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType StakePoolExtendedKey = AsStakePoolExtendedKey
data AsType StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal

data AsType StakePoolKey = AsStakePoolKey
data AsType KesKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal.Praos

data AsType KesKey = AsKesKey
data AsType VrfKey Source # 
Instance details

Defined in Cardano.Api.Key.Internal.Praos

data AsType VrfKey = AsVrfKey
data AsType PlutusScriptV1 Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType PlutusScriptV1 = AsPlutusScriptV1
data AsType PlutusScriptV2 Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType PlutusScriptV2 = AsPlutusScriptV2
data AsType PlutusScriptV3 Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType PlutusScriptV3 = AsPlutusScriptV3
data AsType ScriptHash Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType ScriptHash = AsScriptHash
data AsType ScriptInAnyLang Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType ScriptInAnyLang = AsScriptInAnyLang
data AsType SimpleScript' Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType SimpleScript' = AsSimpleScript
data AsType HashableScriptData Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.ScriptData

data AsType HashableScriptData = AsHashableScriptData
data AsType ScriptData Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.ScriptData

data AsType ScriptData = AsScriptData
data AsType PraosNonce Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType PraosNonce = AsPraosNonce
data AsType UpdateProposal Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType UpdateProposal = AsUpdateProposal
data AsType EraHistory Source # 
Instance details

Defined in Cardano.Api.Query.Internal.Type.QueryInMode

data AsType EraHistory = AsEraHistory
data AsType TextEnvelope Source # 
Instance details

Defined in Cardano.Api.Serialise.TextEnvelope.Internal

data AsType TextEnvelope = AsTextEnvelope
data AsType TxId Source # 
Instance details

Defined in Cardano.Api.Tx.Internal.TxIn

data AsType TxId = AsTxId
data AsType TxMetadata Source # 
Instance details

Defined in Cardano.Api.Tx.Internal.TxMetadata

data AsType TxMetadata = AsTxMetadata
data AsType AssetName Source # 
Instance details

Defined in Cardano.Api.Value.Internal

data AsType AssetName = AsAssetName
data AsType PolicyId Source # 
Instance details

Defined in Cardano.Api.Value.Internal

data AsType PolicyId = AsPolicyId
data AsType GovActionId Source # 
Instance details

Defined in Cardano.Api.Internal.Orphans.Serialisation

data AsType GovActionId = AsGovActionId
data AsType GovActionIx Source # 
Instance details

Defined in Cardano.Api.Internal.Orphans.Serialisation

data AsType GovActionIx = AsGovActionIx
data AsType Term Source # 
Instance details

Defined in Cardano.Api.Serialise.Cbor.Canonical

data AsType Term = AsTerm
data AsType Word16 Source # 
Instance details

Defined in Cardano.Api.HasTypeProxy

data AsType Word16 = AsWord16
data AsType Word8 Source # 
Instance details

Defined in Cardano.Api.HasTypeProxy

data AsType Word8 = AsWord8
data AsType (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (AddressInEra era) Source # 
Instance details

Defined in Cardano.Api.Address

data AsType (AddressInEra era) = AsAddressInEra (AsType era)
data AsType (Certificate era) Source # 
Instance details

Defined in Cardano.Api.Certificate.Internal

data AsType (Certificate era) = AsCertificate
data AsType (SignedTx era) Source # 
Instance details

Defined in Cardano.Api.Experimental.Tx

data AsType (SignedTx era) = AsSignedTx (AsType era)
data AsType (UnsignedTx era) Source # 
Instance details

Defined in Cardano.Api.Experimental.Tx

data AsType (UnsignedTx era) = AsUnsignedTx (AsType era)
data AsType (Proposal era) Source # 
Instance details

Defined in Cardano.Api.Governance.Internal.Action.ProposalProcedure

data AsType (Proposal era) = AsProposal
data AsType (VotingProcedure era) Source # 
Instance details

Defined in Cardano.Api.Governance.Internal.Action.VotingProcedure

data AsType (VotingProcedure era) = AsVote
data AsType (VotingProcedures era) Source # 
Instance details

Defined in Cardano.Api.Governance.Internal.Action.VotingProcedure

data AsType (VotingProcedures era) = AsVotingProcedures
data AsType (Hash a) Source # 
Instance details

Defined in Cardano.Api.Hash

data AsType (Hash a) = AsHash (AsType a)
data AsType (SigningKey a) Source # 
Instance details

Defined in Cardano.Api.Key.Internal.Class

data AsType (SigningKey a) = AsSigningKey (AsType a)
data AsType (VerificationKey a) Source # 
Instance details

Defined in Cardano.Api.Key.Internal.Class

data AsType (VerificationKey a) = AsVerificationKey (AsType a)
data AsType (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)
data AsType (Script lang) Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType (Script lang) = AsScript (AsType lang)
data AsType (ScriptInEra era) Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType (ScriptInEra era) = AsScriptInEra (AsType era)
data AsType (KeyWitness era) Source # 
Instance details

Defined in Cardano.Api.Tx.Internal.Sign

data AsType (KeyWitness era) = AsKeyWitness (AsType era)
data AsType (Tx era) Source # 
Instance details

Defined in Cardano.Api.Tx.Internal.Sign

data AsType (Tx era) = AsTx (AsType era)
data AsType (TxBody era) Source # 
Instance details

Defined in Cardano.Api.Tx.Internal.Sign

data AsType (TxBody era) = AsTxBody (AsType era)
data AsType (Credential 'ColdCommitteeRole) Source # 
Instance details

Defined in Cardano.Api.Internal.Orphans.Serialisation

data AsType (Credential 'ColdCommitteeRole) = AsColdCommitteeCredential
data AsType (Credential 'DRepRole) Source # 
Instance details

Defined in Cardano.Api.Internal.Orphans.Serialisation

data AsType (Credential 'DRepRole) = AsDrepCredential
data AsType (Credential 'HotCommitteeRole) Source # 
Instance details

Defined in Cardano.Api.Internal.Orphans.Serialisation

data AsType (Credential 'HotCommitteeRole) = AsHotCommitteeCredential
data AsType (PlutusScriptInEra era lang) Source # 
Instance details

Defined in Cardano.Api.Plutus.Internal.Script

data AsType (PlutusScriptInEra era lang) = AsPlutusScriptInEra (AsType lang)