Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Credential

Synopsis

data Credential (kr ∷ KeyRole)
- = ScriptHashObj !ScriptHash
- | KeyHashObj !(KeyHash kr)
type PaymentCredential = Credential 'Payment
credKeyHash ∷ Credential r → Maybe (KeyHash r)
credKeyHashWitness ∷ Credential r → Maybe (KeyHash 'Witness)
credScriptHash ∷ Credential kr → Maybe ScriptHash
credToText ∷ Credential kr → Text
parseCredential ∷ MonadFail m ⇒ Text → m (Credential kr)
data Ptr = Ptr !SlotNo32 !TxIx !CertIx
mkPtrNormalized ∷ Word64 → Word64 → Word64 → Ptr
ptrSlotNo ∷ Ptr → SlotNo
ptrTxIx ∷ Ptr → TxIx
ptrCertIx ∷ Ptr → CertIx
newtype SlotNo32 = SlotNo32 Word32
type StakeCredential = Credential 'Staking
data StakeReference
- = StakeRefBase !StakeCredential
- | StakeRefPtr !Ptr
- | StakeRefNull
normalizePtr ∷ Ptr → Ptr

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 # Methods from ∷ Credential kr → Rep (Credential kr) x # to ∷ Rep (Credential kr) x → Credential kr #
Show (Credential kr) Source #
Instance details Defined in Cardano.Ledger.Credential Methods showsPrec ∷ Int → Credential kr → ShowS # show ∷ Credential kr → String # showList ∷ [Credential kr] → ShowS #
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 r) Source #
Instance details Defined in Cardano.Ledger.Credential Methods rnf ∷ Credential r → () #
Eq (Credential kr) Source #
Instance details Defined in Cardano.Ledger.Credential Methods (==) ∷ Credential kr → Credential kr → Bool # (/=) ∷ Credential kr → Credential kr → Bool #
Ord (Credential kr) Source #
Instance details Defined in Cardano.Ledger.Credential Methods compare ∷ Credential kr → Credential kr → Ordering # (<) ∷ Credential kr → Credential kr → Bool # (<=) ∷ Credential kr → Credential kr → Bool # (>) ∷ Credential kr → Credential kr → Bool # (>=) ∷ Credential kr → Credential kr → Bool # max ∷ Credential kr → Credential kr → Credential kr # min ∷ Credential kr → Credential kr → Credential kr #
Typeable kr ⇒ MemPack (Credential kr) Source #
Instance details Defined in Cardano.Ledger.Credential Methods typeName ∷ String Source # packedByteCount ∷ Credential kr → Int Source # packM ∷ Credential kr → Pack s () Source # unpackM ∷ Buffer b ⇒ Unpack b (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 !SlotNo32 !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 # Methods from ∷ Ptr → Rep Ptr x # to ∷ Rep Ptr x → Ptr #
Show Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods showsPrec ∷ Int → Ptr → ShowS # show ∷ Ptr → String # showList ∷ [Ptr] → ShowS #
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 → () #
Eq Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods (==) ∷ Ptr → Ptr → Bool # (/=) ∷ Ptr → Ptr → Bool #
Ord Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods compare ∷ Ptr → Ptr → Ordering # (<) ∷ Ptr → Ptr → Bool # (<=) ∷ Ptr → Ptr → Bool # (>) ∷ Ptr → Ptr → Bool # (>=) ∷ Ptr → Ptr → Bool # max ∷ Ptr → Ptr → Ptr # min ∷ Ptr → Ptr → Ptr #
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) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 SlotNo32) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 TxIx) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CertIx))))

mkPtrNormalized ∷ Word64 → Word64 → Word64 → Ptr Source #

Construct a valid Ptr, while protecting against overflow. Constructs a Ptr with all zeros for its fields, whenever either one of them doesn't fit in without overflowing. 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 and result in all values to be clamped to zero. In case of all valid arguments the Ptrs will be constructed with values unmodified.

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

ptrSlotNo ∷ Ptr → SlotNo Source #

ptrTxIx ∷ Ptr → TxIx Source #

ptrCertIx ∷ Ptr → CertIx Source #

newtype SlotNo32 Source #

Pointers have been deprecated and aren't used anymore. For this reason we can safely use Word32 for slots in pointers

Constructors

SlotNo32 Word32

Instances

Instances details

FromJSON SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods parseJSON ∷ Value → Parser SlotNo32 Source # parseJSONList ∷ Value → Parser [SlotNo32] Source # omittedField ∷ Maybe SlotNo32 Source #
ToJSON SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods toJSON ∷ SlotNo32 → Value Source # toEncoding ∷ SlotNo32 → Encoding Source # toJSONList ∷ [SlotNo32] → Value Source # toEncodingList ∷ [SlotNo32] → Encoding Source # omitField ∷ SlotNo32 → Bool Source #
Bounded SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods minBound ∷ SlotNo32 # maxBound ∷ SlotNo32 #
Generic SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Associated Types type Rep SlotNo32 ∷ Type → Type # Methods from ∷ SlotNo32 → Rep SlotNo32 x # to ∷ Rep SlotNo32 x → SlotNo32 #
Num SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods (+) ∷ SlotNo32 → SlotNo32 → SlotNo32 # (-) ∷ SlotNo32 → SlotNo32 → SlotNo32 # (*) ∷ SlotNo32 → SlotNo32 → SlotNo32 # negate ∷ SlotNo32 → SlotNo32 # abs ∷ SlotNo32 → SlotNo32 # signum ∷ SlotNo32 → SlotNo32 # fromInteger ∷ Integer → SlotNo32 #
Show SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods showsPrec ∷ Int → SlotNo32 → ShowS # show ∷ SlotNo32 → String # showList ∷ [SlotNo32] → ShowS #
FromCBOR SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods fromCBOR ∷ Decoder s SlotNo32 Source # label ∷ Proxy SlotNo32 → Text Source #
ToCBOR SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods toCBOR ∷ SlotNo32 → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SlotNo32 → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SlotNo32] → Size Source #
DecCBOR SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods decCBOR ∷ Decoder s SlotNo32 Source # dropCBOR ∷ Proxy SlotNo32 → Decoder s () Source # label ∷ Proxy SlotNo32 → Text Source #
EncCBOR SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods encCBOR ∷ SlotNo32 → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy SlotNo32 → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [SlotNo32] → Size Source #
NFData SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods rnf ∷ SlotNo32 → () #
Eq SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods (==) ∷ SlotNo32 → SlotNo32 → Bool # (/=) ∷ SlotNo32 → SlotNo32 → Bool #
Ord SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods compare ∷ SlotNo32 → SlotNo32 → Ordering # (<) ∷ SlotNo32 → SlotNo32 → Bool # (<=) ∷ SlotNo32 → SlotNo32 → Bool # (>) ∷ SlotNo32 → SlotNo32 → Bool # (>=) ∷ SlotNo32 → SlotNo32 → Bool # max ∷ SlotNo32 → SlotNo32 → SlotNo32 # min ∷ SlotNo32 → SlotNo32 → SlotNo32 #
NoThunks SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential Methods noThunks ∷ Context → SlotNo32 → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → SlotNo32 → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy SlotNo32 → String Source #
type Rep SlotNo32 Source #
Instance details Defined in Cardano.Ledger.Credential type Rep SlotNo32 = D1 ('MetaData "SlotNo32" "Cardano.Ledger.Credential" "cardano-ledger-core-1.17.0.0-inplace" 'True) (C1 ('MetaCons "SlotNo32" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

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 # Methods from ∷ StakeReference → Rep StakeReference x # to ∷ Rep StakeReference x → StakeReference #
Show StakeReference Source #
Instance details Defined in Cardano.Ledger.Credential Methods showsPrec ∷ Int → StakeReference → ShowS # show ∷ StakeReference → String # showList ∷ [StakeReference] → ShowS #
NFData StakeReference Source #
Instance details Defined in Cardano.Ledger.Credential Methods rnf ∷ StakeReference → () #
Eq StakeReference Source #
Instance details Defined in Cardano.Ledger.Credential Methods (==) ∷ StakeReference → StakeReference → Bool # (/=) ∷ StakeReference → StakeReference → Bool #
Ord StakeReference Source #
Instance details Defined in Cardano.Ledger.Credential Methods compare ∷ StakeReference → StakeReference → Ordering # (<) ∷ StakeReference → StakeReference → Bool # (<=) ∷ StakeReference → StakeReference → Bool # (>) ∷ StakeReference → StakeReference → Bool # (>=) ∷ StakeReference → StakeReference → Bool # max ∷ StakeReference → StakeReference → StakeReference # min ∷ StakeReference → StakeReference → StakeReference #
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 #

Deprecated: Starting with Conway era all Pointers are now normalized and this logic has been moved into the decoder

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.