Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Credential

Synopsis

data Credential (kr ∷ KeyRole) c
- = ScriptHashObj !(ScriptHash c)
- | KeyHashObj !(KeyHash kr c)
newtype GenesisCredential c = GenesisCredential {
- unGenesisCredential ∷ KeyHash 'Genesis c
}
type PaymentCredential c = Credential 'Payment c
credKeyHashWitness ∷ Credential r c → Maybe (KeyHash 'Witness c)
credScriptHash ∷ Credential kr c → Maybe (ScriptHash c)
credToText ∷ Credential kr c → Text
parseCredential ∷ (MonadFail m, Crypto c) ⇒ Text → m (Credential kr c)
data Ptr = Ptr !SlotNo !TxIx !CertIx
ptrSlotNo ∷ Ptr → SlotNo
ptrTxIx ∷ Ptr → TxIx
ptrCertIx ∷ Ptr → CertIx
type StakeCredential c = Credential 'Staking c
data StakeReference c
- = StakeRefBase !(StakeCredential c)
- | StakeRefPtr !Ptr
- | StakeRefNull
normalizePtr ∷ Ptr → Ptr

Documentation

data Credential (kr ∷ KeyRole) c Source #

Script hash or key hash for a payment or a staking object.

Note that credentials (unlike raw key hashes) do appear to vary from era to era, since they reference the hash of a script, which can change. This parameter is a phantom, however, so in actuality the instances will remain the same.

Constructors

ScriptHashObj !(ScriptHash c)
KeyHashObj !(KeyHash kr c)

Instances

Instances details

HasKeyRole Credential Source #
Instance details Defined in Cardano.Ledger.Credential Methods coerceKeyRole ∷ ∀ (r ∷ KeyRole) c (r' ∷ KeyRole). Credential r c → Credential r' c Source #
Crypto c ⇒ FromJSON (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods parseJSON ∷ Value → Parser (Credential kr c) Source # parseJSONList ∷ Value → Parser [Credential kr c] Source # omittedField ∷ Maybe (Credential kr c) Source #
Crypto c ⇒ FromJSONKey (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods fromJSONKey ∷ FromJSONKeyFunction (Credential kr c) Source # fromJSONKeyList ∷ FromJSONKeyFunction [Credential kr c] Source #
Crypto c ⇒ ToJSON (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods toJSON ∷ Credential kr c → Value Source # toEncoding ∷ Credential kr c → Encoding Source # toJSONList ∷ [Credential kr c] → Value Source # toEncodingList ∷ [Credential kr c] → Encoding Source # omitField ∷ Credential kr c → Bool Source #
Crypto c ⇒ ToJSONKey (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods toJSONKey ∷ ToJSONKeyFunction (Credential kr c) Source # toJSONKeyList ∷ ToJSONKeyFunction [Credential kr c] Source #
Generic (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Associated Types type Rep (Credential kr c) ∷ Type → Type Source # Methods from ∷ Credential kr c → Rep (Credential kr c) x Source # to ∷ Rep (Credential kr c) x → Credential kr c Source #
Show (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods showsPrec ∷ Int → Credential kr c → ShowS Source # show ∷ Credential kr c → String Source # showList ∷ [Credential kr c] → ShowS Source #
(Typeable kr, Crypto c) ⇒ FromCBOR (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods fromCBOR ∷ Decoder s (Credential kr c) Source # label ∷ Proxy (Credential kr c) → Text Source #
(Typeable kr, Crypto c) ⇒ ToCBOR (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods toCBOR ∷ Credential kr c → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Credential kr c) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Credential kr c] → Size Source #
(Typeable kr, Crypto c) ⇒ DecCBOR (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods decCBOR ∷ Decoder s (Credential kr c) Source # dropCBOR ∷ Proxy (Credential kr c) → Decoder s () Source # label ∷ Proxy (Credential kr c) → Text Source #
(Typeable kr, Crypto c) ⇒ EncCBOR (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods encCBOR ∷ Credential kr c → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Credential kr c) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Credential kr c] → Size Source #
Crypto e ⇒ Default (Credential r e) Source #
Instance details Defined in Cardano.Ledger.Credential Methods def ∷ Credential r e Source #
NFData (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods rnf ∷ Credential kr c → () Source #
Eq (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods (==) ∷ Credential kr c → Credential kr c → Bool Source # (/=) ∷ Credential kr c → Credential kr c → Bool Source #
Ord (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods compare ∷ Credential kr c → Credential kr c → Ordering Source # (<) ∷ Credential kr c → Credential kr c → Bool Source # (<=) ∷ Credential kr c → Credential kr c → Bool Source # (>) ∷ Credential kr c → Credential kr c → Bool Source # (>=) ∷ Credential kr c → Credential kr c → Bool Source # max ∷ Credential kr c → Credential kr c → Credential kr c Source # min ∷ Credential kr c → Credential kr c → Credential kr c Source #
NoThunks (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods noThunks ∷ Context → Credential kr c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Credential kr c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Credential kr c) → String Source #
type Rep (Credential kr c) Source #
Instance details Defined in Cardano.Ledger.Credential type Rep (Credential kr c) = D1 ('MetaData "Credential" "Cardano.Ledger.Credential" "cardano-ledger-core-1.12.0.0-inplace" 'False) (C1 ('MetaCons "ScriptHashObj" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ScriptHash c))) :+: C1 ('MetaCons "KeyHashObj" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash kr c))))

newtype GenesisCredential c Source #

Constructors

GenesisCredential
Fields unGenesisCredential ∷ KeyHash 'Genesis c

Instances

Instances details

Generic (GenesisCredential c) Source #
Instance details Defined in Cardano.Ledger.Credential Associated Types type Rep (GenesisCredential c) ∷ Type → Type Source # Methods from ∷ GenesisCredential c → Rep (GenesisCredential c) x Source # to ∷ Rep (GenesisCredential c) x → GenesisCredential c Source #
Show (GenesisCredential c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods showsPrec ∷ Int → GenesisCredential c → ShowS Source # show ∷ GenesisCredential c → String Source # showList ∷ [GenesisCredential c] → ShowS Source #
Crypto c ⇒ ToCBOR (GenesisCredential c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods toCBOR ∷ GenesisCredential c → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (GenesisCredential c) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [GenesisCredential c] → Size Source #
Crypto c ⇒ EncCBOR (GenesisCredential c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods encCBOR ∷ GenesisCredential c → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (GenesisCredential c) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [GenesisCredential c] → Size Source #
Eq (GenesisCredential c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods (==) ∷ GenesisCredential c → GenesisCredential c → Bool Source # (/=) ∷ GenesisCredential c → GenesisCredential c → Bool Source #
Ord (GenesisCredential c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods compare ∷ GenesisCredential c → GenesisCredential c → Ordering Source # (<) ∷ GenesisCredential c → GenesisCredential c → Bool Source # (<=) ∷ GenesisCredential c → GenesisCredential c → Bool Source # (>) ∷ GenesisCredential c → GenesisCredential c → Bool Source # (>=) ∷ GenesisCredential c → GenesisCredential c → Bool Source # max ∷ GenesisCredential c → GenesisCredential c → GenesisCredential c Source # min ∷ GenesisCredential c → GenesisCredential c → GenesisCredential c Source #
type Rep (GenesisCredential c) Source #
Instance details Defined in Cardano.Ledger.Credential type Rep (GenesisCredential c) = D1 ('MetaData "GenesisCredential" "Cardano.Ledger.Credential" "cardano-ledger-core-1.12.0.0-inplace" 'True) (C1 ('MetaCons "GenesisCredential" 'PrefixI 'True) (S1 ('MetaSel ('Just "unGenesisCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (KeyHash 'Genesis c))))

type PaymentCredential c = Credential 'Payment c Source #

credKeyHashWitness ∷ Credential r c → Maybe (KeyHash 'Witness c) Source #

Convert a KeyHash into a Witness KeyHash. Does nothing for Script credentials.

credScriptHash ∷ Credential kr c → Maybe (ScriptHash c) Source #

Extract ScriptHash from a Credential. Returns Nothing for KeyHashes

credToText ∷ Credential kr c → Text Source #

parseCredential ∷ (MonadFail m, Crypto c) ⇒ Text → m (Credential kr c) Source #

data Ptr Source #

Pointer to a slot number, transaction index and an index in certificate list.

Constructors

Ptr !SlotNo !TxIx !CertIx

Instances

Instances details

ToJSON Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods toJSON ∷ Ptr → Value Source # toEncoding ∷ Ptr → Encoding Source # toJSONList ∷ [Ptr] → Value Source # toEncodingList ∷ [Ptr] → Encoding Source # omitField ∷ Ptr → Bool Source #
ToJSONKey Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods toJSONKey ∷ ToJSONKeyFunction Ptr Source # toJSONKeyList ∷ ToJSONKeyFunction [Ptr] Source #
Generic Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Associated Types type Rep Ptr ∷ Type → Type Source # Methods from ∷ Ptr → Rep Ptr x Source # to ∷ Rep Ptr x → Ptr Source #
Show Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods showsPrec ∷ Int → Ptr → ShowS Source # show ∷ Ptr → String Source # showList ∷ [Ptr] → ShowS Source #
FromCBOR Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods fromCBOR ∷ Decoder s Ptr Source # label ∷ Proxy Ptr → Text Source #
ToCBOR Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods toCBOR ∷ Ptr → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Ptr → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Ptr] → Size Source #
DecCBOR Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods decCBOR ∷ Decoder s Ptr Source # dropCBOR ∷ Proxy Ptr → Decoder s () Source # label ∷ Proxy Ptr → Text Source #
EncCBOR Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods encCBOR ∷ Ptr → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy Ptr → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Ptr] → Size Source #
DecCBORGroup Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods decCBORGroup ∷ Decoder s Ptr Source #
EncCBORGroup Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods encCBORGroup ∷ Ptr → Encoding Source # encodedGroupSizeExpr ∷ (∀ x. EncCBOR x ⇒ Proxy x → Size) → Proxy Ptr → Size Source # listLen ∷ Ptr → Word Source # listLenBound ∷ Proxy Ptr → Word Source #
NFData Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods rnf ∷ Ptr → () Source #
Eq Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods (==) ∷ Ptr → Ptr → Bool Source # (/=) ∷ Ptr → Ptr → Bool Source #
Ord Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods compare ∷ Ptr → Ptr → Ordering Source # (<) ∷ Ptr → Ptr → Bool Source # (<=) ∷ Ptr → Ptr → Bool Source # (>) ∷ Ptr → Ptr → Bool Source # (>=) ∷ Ptr → Ptr → Bool Source # max ∷ Ptr → Ptr → Ptr Source # min ∷ Ptr → Ptr → Ptr Source #
NoThunks Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods noThunks ∷ Context → Ptr → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Ptr → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy Ptr → String Source #
type Rep Ptr Source #
Instance details Defined in Cardano.Ledger.Credential type Rep Ptr = D1 ('MetaData "Ptr" "Cardano.Ledger.Credential" "cardano-ledger-core-1.12.0.0-inplace" 'False) (C1 ('MetaCons "Ptr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNo) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TxIx) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CertIx))))

ptrSlotNo ∷ Ptr → SlotNo Source #

ptrTxIx ∷ Ptr → TxIx Source #

ptrCertIx ∷ Ptr → CertIx Source #

type StakeCredential c = Credential 'Staking c Source #

data StakeReference c Source #

Constructors

StakeRefBase !(StakeCredential c)
StakeRefPtr !Ptr
StakeRefNull

Instances

Instances details

Crypto c ⇒ ToJSON (StakeReference c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods toJSON ∷ StakeReference c → Value Source # toEncoding ∷ StakeReference c → Encoding Source # toJSONList ∷ [StakeReference c] → Value Source # toEncodingList ∷ [StakeReference c] → Encoding Source # omitField ∷ StakeReference c → Bool Source #
Generic (StakeReference c) Source #
Instance details Defined in Cardano.Ledger.Credential Associated Types type Rep (StakeReference c) ∷ Type → Type Source # Methods from ∷ StakeReference c → Rep (StakeReference c) x Source # to ∷ Rep (StakeReference c) x → StakeReference c Source #
Show (StakeReference c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods showsPrec ∷ Int → StakeReference c → ShowS Source # show ∷ StakeReference c → String Source # showList ∷ [StakeReference c] → ShowS Source #
NFData (StakeReference c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods rnf ∷ StakeReference c → () Source #
Eq (StakeReference c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods (==) ∷ StakeReference c → StakeReference c → Bool Source # (/=) ∷ StakeReference c → StakeReference c → Bool Source #
Ord (StakeReference c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods compare ∷ StakeReference c → StakeReference c → Ordering Source # (<) ∷ StakeReference c → StakeReference c → Bool Source # (<=) ∷ StakeReference c → StakeReference c → Bool Source # (>) ∷ StakeReference c → StakeReference c → Bool Source # (>=) ∷ StakeReference c → StakeReference c → Bool Source # max ∷ StakeReference c → StakeReference c → StakeReference c Source # min ∷ StakeReference c → StakeReference c → StakeReference c Source #
NoThunks (StakeReference c) Source #
Instance details Defined in Cardano.Ledger.Credential Methods noThunks ∷ Context → StakeReference c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → StakeReference c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (StakeReference c) → String Source #
type Rep (StakeReference c) Source #
Instance details Defined in Cardano.Ledger.Credential type Rep (StakeReference c) = D1 ('MetaData "StakeReference" "Cardano.Ledger.Credential" "cardano-ledger-core-1.12.0.0-inplace" 'False) (C1 ('MetaCons "StakeRefBase" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StakeCredential c))) :+: (C1 ('MetaCons "StakeRefPtr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Ptr)) :+: C1 ('MetaCons "StakeRefNull" 'PrefixI 'False) (U1 ∷ Type → Type)))

normalizePtr ∷ Ptr → Ptr Source #

Convert any invalid Ptr to a Ptr that contains all zeros for its fields. Any pointer that contains a SlotNo, TxIx or CertIx that is too large to fit into Word32, Word16 and Word16 respectively is considered to be an invalid Ptr. Valid Ptrs will be returned unmodified.

Note - This is in no way related to dangling pointers, with an exception that any invalid Ptr is guarateed to be a dangling Ptr.