cardano-ledger-core-1.17.0.0: Core components of Cardano ledgers from the Shelley release on.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Ledger.Credential

Synopsis

Documentation

data Credential (kr ∷ KeyRole) 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 
KeyHashObj !(KeyHash kr) 

Instances

Instances details
HasKeyRole Credential Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

coerceKeyRole ∷ ∀ (r ∷ KeyRole) (r' ∷ KeyRole). Credential r → Credential r' Source #

FromJSON (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

parseJSON ∷ Value → Parser (Credential kr) Source #

parseJSONList ∷ Value → Parser [Credential kr] Source #

omittedField ∷ Maybe (Credential kr) Source #

FromJSONKey (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

fromJSONKey ∷ FromJSONKeyFunction (Credential kr) Source #

fromJSONKeyList ∷ FromJSONKeyFunction [Credential kr] Source #

ToJSON (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

toJSON ∷ Credential kr → Value Source #

toEncoding ∷ Credential kr → Encoding Source #

toJSONList ∷ [Credential kr] → Value Source #

toEncodingList ∷ [Credential kr] → Encoding Source #

omitField ∷ Credential kr → Bool Source #

ToJSONKey (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

toJSONKey ∷ ToJSONKeyFunction (Credential kr) Source #

toJSONKeyList ∷ ToJSONKeyFunction [Credential kr] Source #

Generic (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Associated Types

type Rep (Credential kr) ∷ Type → Type Source #

Methods

from ∷ Credential kr → Rep (Credential kr) x Source #

to ∷ Rep (Credential kr) x → Credential kr Source #

Show (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

showsPrec ∷ Int → Credential kr → ShowS Source #

show ∷ Credential kr → String Source #

showList ∷ [Credential kr] → ShowS Source #

Typeable kr ⇒ FromCBOR (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

fromCBOR ∷ Decoder s (Credential kr) Source #

label ∷ Proxy (Credential kr) → Text Source #

Typeable kr ⇒ ToCBOR (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

toCBOR ∷ Credential kr → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Credential kr) → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Credential kr] → Size Source #

Typeable kr ⇒ DecCBOR (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

decCBOR ∷ Decoder s (Credential kr) Source #

dropCBOR ∷ Proxy (Credential kr) → Decoder s () Source #

label ∷ Proxy (Credential kr) → Text Source #

Typeable kr ⇒ EncCBOR (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

encCBOR ∷ Credential kr → Encoding Source #

encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Credential kr) → Size Source #

encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Credential kr] → Size Source #

Default (Credential r) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

def ∷ Credential r Source #

NFData (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

rnf ∷ Credential kr → () Source #

Eq (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

(==) ∷ Credential kr → Credential kr → Bool Source #

(/=) ∷ Credential kr → Credential kr → Bool Source #

Ord (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

compare ∷ Credential kr → Credential kr → Ordering Source #

(<) ∷ Credential kr → Credential kr → Bool Source #

(<=) ∷ Credential kr → Credential kr → Bool Source #

(>) ∷ Credential kr → Credential kr → Bool Source #

(>=) ∷ Credential kr → Credential kr → Bool Source #

max ∷ Credential kr → Credential kr → Credential kr Source #

min ∷ Credential kr → Credential kr → Credential kr Source #

NoThunks (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

noThunks ∷ Context → Credential kr → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Credential kr → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Credential kr) → String Source #

type Rep (Credential kr) Source # 
Instance details

Defined in Cardano.Ledger.Credential

type Rep (Credential kr) = D1 ('MetaData "Credential" "Cardano.Ledger.Credential" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "ScriptHashObj" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ScriptHash)) :+: C1 ('MetaCons "KeyHashObj" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash kr))))

type PaymentCredential = Credential 'Payment Source #

credKeyHash ∷ Credential r → Maybe (KeyHash r) Source #

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

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

credScriptHash ∷ Credential kr → Maybe ScriptHash Source #

Extract ScriptHash from a Credential. Returns Nothing for KeyHashes

credToText ∷ Credential kr → Text Source #

parseCredential ∷ MonadFail m ⇒ Text → m (Credential kr) 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.17.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 = Credential 'Staking Source #

data StakeReference Source #

Constructors

StakeRefBase !StakeCredential 
StakeRefPtr !Ptr 
StakeRefNull 

Instances

Instances details
ToJSON StakeReference Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

toJSON ∷ StakeReference → Value Source #

toEncoding ∷ StakeReference → Encoding Source #

toJSONList ∷ [StakeReference] → Value Source #

toEncodingList ∷ [StakeReference] → Encoding Source #

omitField ∷ StakeReference → Bool Source #

Generic StakeReference Source # 
Instance details

Defined in Cardano.Ledger.Credential

Associated Types

type Rep StakeReference ∷ Type → Type Source #

Methods

from ∷ StakeReference → Rep StakeReference x Source #

to ∷ Rep StakeReference x → StakeReference Source #

Show StakeReference Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

showsPrec ∷ Int → StakeReference → ShowS Source #

show ∷ StakeReference → String Source #

showList ∷ [StakeReference] → ShowS Source #

NFData StakeReference Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

rnf ∷ StakeReference → () Source #

Eq StakeReference Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

(==) ∷ StakeReference → StakeReference → Bool Source #

(/=) ∷ StakeReference → StakeReference → Bool Source #

Ord StakeReference Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

compare ∷ StakeReference → StakeReference → Ordering Source #

(<) ∷ StakeReference → StakeReference → Bool Source #

(<=) ∷ StakeReference → StakeReference → Bool Source #

(>) ∷ StakeReference → StakeReference → Bool Source #

(>=) ∷ StakeReference → StakeReference → Bool Source #

max ∷ StakeReference → StakeReference → StakeReference Source #

min ∷ StakeReference → StakeReference → StakeReference Source #

NoThunks StakeReference Source # 
Instance details

Defined in Cardano.Ledger.Credential

Methods

noThunks ∷ Context → StakeReference → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → StakeReference → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy StakeReference → String Source #

type Rep StakeReference Source # 
Instance details

Defined in Cardano.Ledger.Credential

type Rep StakeReference = D1 ('MetaData "StakeReference" "Cardano.Ledger.Credential" "cardano-ledger-core-1.17.0.0-inplace" 'False) (C1 ('MetaCons "StakeRefBase" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StakeCredential)) :+: (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.