Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Hashes

Contents

Hashing algorithms
Era-independent hash type identifiers.
Hashes
SafeHash
Header Hash
- Creating SafeHash
- Other operations

Synopsis

data Hash h a
class (KnownNat (SizeHash h), Typeable h) ⇒ HashAlgorithm h
type HASH = Blake2b_256
type ADDRHASH = Blake2b_224
data EraIndependentTxBody
data EraIndependentBlockHeader
data EraIndependentBlockBody
data EraIndependentMetadata
data EraIndependentScript
data EraIndependentData
data EraIndependentScriptData
data EraIndependentTxAuxData
data EraIndependentPParamView
data EraIndependentScriptIntegrity
newtype KeyHash (r ∷ KeyRole) = KeyHash {
- unKeyHash ∷ Hash ADDRHASH (VerKeyDSIGN DSIGN)
}
data KeyRole
- = GenesisRole
- | GenesisDelegate
- | Payment
- | Staking
- | StakePool
- | BlockIssuer
- | Witness
- | DRepRole
- | HotCommitteeRole
- | ColdCommitteeRole
- | Guard
hashKey ∷ ∀ (kd ∷ KeyRole). VKey kd → KeyHash kd
hashTxBodySignature ∷ SignedDSIGN DSIGN (Hash HASH EraIndependentTxBody) → Hash HASH (SignedDSIGN DSIGN (Hash HASH EraIndependentTxBody))
newtype ScriptHash = ScriptHash (Hash ADDRHASH EraIndependentScript)
type DataHash = SafeHash EraIndependentData
newtype TxAuxDataHash = TxAuxDataHash {
- unTxAuxDataHash ∷ SafeHash EraIndependentTxAuxData
}
data KeyRoleVRF
- = StakePoolVRF
- | GenDelegVRF
- | BlockIssuerVRF
newtype VRFVerKeyHash (r ∷ KeyRoleVRF) = VRFVerKeyHash {
- unVRFVerKeyHash ∷ Hash HASH KeyRoleVRF
}
toVRFVerKeyHash ∷ ∀ v (r ∷ KeyRoleVRF). Hash HASH (VerKeyVRF v) → VRFVerKeyHash r
fromVRFVerKeyHash ∷ ∀ (r ∷ KeyRoleVRF) v. VRFVerKeyHash r → Hash HASH (VerKeyVRF v)
data GenDelegPair = GenDelegPair {
- genDelegKeyHash ∷ !(KeyHash 'GenesisDelegate)
- genDelegVrfHash ∷ !(VRFVerKeyHash 'GenDelegVRF)
}
newtype GenDelegs = GenDelegs {
- unGenDelegs ∷ Map (KeyHash 'GenesisRole) GenDelegPair
}
data SafeHash i
class SafeToHash t where
- originalBytes ∷ t → ByteString
- originalBytesSize ∷ t → Int
- makeHashWithExplicitProxys ∷ Proxy i → t → SafeHash i
newtype HashHeader = HashHeader {
- unHashHeader ∷ Hash HASH EraIndependentBlockHeader
}
class SafeToHash x ⇒ HashAnnotated x i | x → i
hashAnnotated ∷ HashAnnotated x i ⇒ x → SafeHash i
unsafeMakeSafeHash ∷ Hash HASH i → SafeHash i
castSafeHash ∷ SafeHash i → SafeHash j
extractHash ∷ SafeHash i → Hash HASH i
standardHashSize ∷ Int
standardAddrHashSize ∷ Int

Hashing algorithms

data Hash h a Source #

Instances

Instances details

HashAlgorithm h ⇒ IsString (Q (TExp (Hash h a)))

This instance is meant to be used with TemplateHaskell

>>> import Cardano.Crypto.Hash.Class (Hash)
>>> import Cardano.Crypto.Hash.Short (ShortHash)
>>> :set -XTemplateHaskell
>>> :set -XOverloadedStrings
>>>  let hash = $$("0xBADC0FFEE0DDF00D") :: Hash ShortHash ()
>>> print hash
"badc0ffee0ddf00d"
>>> let hash = $$("0123456789abcdef") :: Hash ShortHash ()
>>> print hash
"0123456789abcdef"
>>> let hash = $$("deadbeef") :: Hash ShortHash ()
<interactive>:5:15: error:
    • <Hash blake2b_prefix_8>: Expected in decoded form to be: 8 bytes, but got: 4
    • In the Template Haskell splice $$("deadbeef")
      In the expression: $$("deadbeef") :: Hash ShortHash ()
      In an equation for ‘hash’:
          hash = $$("deadbeef") :: Hash ShortHash ()
>>> let hash = $$("123") :: Hash ShortHash ()
<interactive>:6:15: error:
    • <Hash blake2b_prefix_8>: Malformed hex: invalid bytestring size
    • In the Template Haskell splice $$("123")
      In the expression: $$("123") :: Hash ShortHash ()
      In an equation for ‘hash’: hash = $$("123") :: Hash ShortHash ()

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

fromString ∷ String → Q (TExp (Hash h a)) #

HashAlgorithm h ⇒ FromJSON (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

parseJSON ∷ Value → Parser (Hash h a) Source #

parseJSONList ∷ Value → Parser [Hash h a] Source #

omittedField ∷ Maybe (Hash h a) Source #

HashAlgorithm h ⇒ FromJSONKey (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

fromJSONKey ∷ FromJSONKeyFunction (Hash h a) Source #

fromJSONKeyList ∷ FromJSONKeyFunction [Hash h a] Source #

HashAlgorithm h ⇒ ToJSON (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

toJSON ∷ Hash h a → Value Source #

toEncoding ∷ Hash h a → Encoding Source #

toJSONList ∷ [Hash h a] → Value Source #

toEncodingList ∷ [Hash h a] → Encoding Source #

omitField ∷ Hash h a → Bool Source #

HashAlgorithm h ⇒ ToJSONKey (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

toJSONKey ∷ ToJSONKeyFunction (Hash h a) Source #

toJSONKeyList ∷ ToJSONKeyFunction [Hash h a] Source #

(HashAlgorithm h, Typeable a) ⇒ FromCBOR (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

fromCBOR ∷ Decoder s (Hash h a) Source #

label ∷ Proxy (Hash h a) → Text Source #

(HashAlgorithm h, Typeable a) ⇒ ToCBOR (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

toCBOR ∷ Hash h a → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Hash h a) → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Hash h a] → Size Source #

SignableRepresentation (Hash a b) Source #

Instance details

Defined in Cardano.Ledger.Orphans

Methods

getSignableRepresentation ∷ Hash a b → ByteString Source #

(HashAlgorithm h, Typeable a) ⇒ DecCBOR (Hash h a)

Instance details

Defined in Cardano.Ledger.Binary.Decoding.DecCBOR

Methods

decCBOR ∷ Decoder s (Hash h a) Source #

dropCBOR ∷ Proxy (Hash h a) → Decoder s () Source #

label ∷ Proxy (Hash h a) → Text Source #

HashAlgorithm h ⇒ EncCBOR (Hash h a)

Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR ∷ Hash h a → Encoding Source #

HashAlgorithm h ⇒ SafeToHash (Hash h i) Source #

Hash of a hash. Hash is always safe to hash. Do you even hash?

Instance details

Defined in Cardano.Ledger.Hashes

Methods

originalBytes ∷ Hash h i → ByteString Source #

originalBytesSize ∷ Hash h i → Int Source #

makeHashWithExplicitProxys ∷ Proxy i0 → Hash h i → SafeHash i0 Source #

HashAlgorithm h ⇒ Default (Hash h b) Source #

Instance details

Defined in Cardano.Ledger.Orphans

Methods

def ∷ Hash h b Source #

NFData (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

rnf ∷ Hash h a → () #

HashAlgorithm h ⇒ IsString (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

fromString ∷ String → Hash h a #

Generic (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Associated Types

type Rep (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

type Rep (Hash h a) = D1 ('MetaData "Hash" "Cardano.Crypto.Hash.Class" "cardano-crypto-class-2.2.3.1-93e2c82f664404a263ce0cfe72acde6cccce29dd72e7a756ec140c9b1d091d59" 'True) (C1 ('MetaCons "UnsafeHashRep" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PackedBytes (SizeHash h)))))

Methods

from ∷ Hash h a → Rep (Hash h a) x #

to ∷ Rep (Hash h a) x → Hash h a #

HashAlgorithm h ⇒ Read (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

readsPrec ∷ Int → ReadS (Hash h a) #

readList ∷ ReadS [Hash h a] #

readPrec ∷ ReadPrec (Hash h a) #

readListPrec ∷ ReadPrec [Hash h a] #

Show (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

showsPrec ∷ Int → Hash h a → ShowS #

show ∷ Hash h a → String #

showList ∷ [Hash h a] → ShowS #

Eq (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

(==) ∷ Hash h a → Hash h a → Bool #

(/=) ∷ Hash h a → Hash h a → Bool #

Ord (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

compare ∷ Hash h a → Hash h a → Ordering #

(<) ∷ Hash h a → Hash h a → Bool #

(<=) ∷ Hash h a → Hash h a → Bool #

(>) ∷ Hash h a → Hash h a → Bool #

(>=) ∷ Hash h a → Hash h a → Bool #

max ∷ Hash h a → Hash h a → Hash h a #

min ∷ Hash h a → Hash h a → Hash h a #

HeapWords (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

heapWords ∷ Hash h a → Int Source #

HashAlgorithm h ⇒ MemPack (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

typeName ∷ String Source #

packedByteCount ∷ Hash h a → Int Source #

packM ∷ Hash h a → Pack s () Source #

unpackM ∷ Buffer b ⇒ Unpack s b (Hash h a) Source #

NoThunks (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

noThunks ∷ Context → Hash h a → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Hash h a → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Hash h a) → String Source #

HashAlgorithm h ⇒ IsString (Code Q (Hash h a))

Instance details

Defined in Cardano.Crypto.Hash.Class

Methods

fromString ∷ String → Code Q (Hash h a) #

type Rep (Hash h a)

Instance details

Defined in Cardano.Crypto.Hash.Class

type Rep (Hash h a) = D1 ('MetaData "Hash" "Cardano.Crypto.Hash.Class" "cardano-crypto-class-2.2.3.1-93e2c82f664404a263ce0cfe72acde6cccce29dd72e7a756ec140c9b1d091d59" 'True) (C1 ('MetaCons "UnsafeHashRep" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PackedBytes (SizeHash h)))))

class (KnownNat (SizeHash h), Typeable h) ⇒ HashAlgorithm h Source #

Minimal complete definition

hashAlgorithmName, digest

Instances

Instances details

HashAlgorithm Blake2b_224

Instance details

Defined in Cardano.Crypto.Hash.Blake2b

Associated Types

type SizeHash Blake2b_224
Instance details Defined in Cardano.Crypto.Hash.Blake2b type SizeHash Blake2b_224 = 28

Methods

hashAlgorithmName ∷ proxy Blake2b_224 → String Source #

digest ∷ proxy Blake2b_224 → ByteString → ByteString Source #

HashAlgorithm Blake2b_256

Instance details

Defined in Cardano.Crypto.Hash.Blake2b

Associated Types

type SizeHash Blake2b_256
Instance details Defined in Cardano.Crypto.Hash.Blake2b type SizeHash Blake2b_256 = 32

Methods

hashAlgorithmName ∷ proxy Blake2b_256 → String Source #

digest ∷ proxy Blake2b_256 → ByteString → ByteString Source #

HashAlgorithm Keccak256

Instance details

Defined in Cardano.Crypto.Hash.Keccak256

Associated Types

type SizeHash Keccak256
Instance details Defined in Cardano.Crypto.Hash.Keccak256 type SizeHash Keccak256 = 32

Methods

hashAlgorithmName ∷ proxy Keccak256 → String Source #

digest ∷ proxy Keccak256 → ByteString → ByteString Source #

HashAlgorithm NeverHash

Instance details

Defined in Cardano.Crypto.Hash.NeverUsed

Associated Types

type SizeHash NeverHash
Instance details Defined in Cardano.Crypto.Hash.NeverUsed type SizeHash NeverHash = 0

Methods

hashAlgorithmName ∷ proxy NeverHash → String Source #

digest ∷ proxy NeverHash → ByteString → ByteString Source #

HashAlgorithm RIPEMD160

Instance details

Defined in Cardano.Crypto.Hash.RIPEMD160

Associated Types

type SizeHash RIPEMD160
Instance details Defined in Cardano.Crypto.Hash.RIPEMD160 type SizeHash RIPEMD160 = 20

Methods

hashAlgorithmName ∷ proxy RIPEMD160 → String Source #

digest ∷ proxy RIPEMD160 → ByteString → ByteString Source #

HashAlgorithm SHA256

Instance details

Defined in Cardano.Crypto.Hash.SHA256

Associated Types

type SizeHash SHA256
Instance details Defined in Cardano.Crypto.Hash.SHA256 type SizeHash SHA256 = 32

Methods

hashAlgorithmName ∷ proxy SHA256 → String Source #

digest ∷ proxy SHA256 → ByteString → ByteString Source #

HashAlgorithm SHA3_256

Instance details

Defined in Cardano.Crypto.Hash.SHA3_256

Associated Types

type SizeHash SHA3_256
Instance details Defined in Cardano.Crypto.Hash.SHA3_256 type SizeHash SHA3_256 = 32

Methods

hashAlgorithmName ∷ proxy SHA3_256 → String Source #

digest ∷ proxy SHA3_256 → ByteString → ByteString Source #

HashAlgorithm SHA3_512

Instance details

Defined in Cardano.Crypto.Hash.SHA3_512

Associated Types

type SizeHash SHA3_512
Instance details Defined in Cardano.Crypto.Hash.SHA3_512 type SizeHash SHA3_512 = 64

Methods

hashAlgorithmName ∷ proxy SHA3_512 → String Source #

digest ∷ proxy SHA3_512 → ByteString → ByteString Source #

HashAlgorithm SHA512

Instance details

Defined in Cardano.Crypto.Hash.SHA512

Associated Types

type SizeHash SHA512
Instance details Defined in Cardano.Crypto.Hash.SHA512 type SizeHash SHA512 = 64

Methods

hashAlgorithmName ∷ proxy SHA512 → String Source #

digest ∷ proxy SHA512 → ByteString → ByteString Source #

(KnownNat n, CmpNat n 33 ~ 'LT) ⇒ HashAlgorithm (Blake2bPrefix n)

Instance details

Defined in Cardano.Crypto.Hash.Short

Associated Types

type SizeHash (Blake2bPrefix n)
Instance details Defined in Cardano.Crypto.Hash.Short type SizeHash (Blake2bPrefix n) = n

Methods

hashAlgorithmName ∷ proxy (Blake2bPrefix n) → String Source #

digest ∷ proxy (Blake2bPrefix n) → ByteString → ByteString Source #

type HASH = Blake2b_256 Source #

Hashing algorithm used for hashing everything, except addresses, for which ADDRHASH is used.

type ADDRHASH = Blake2b_224 Source #

Hashing algorithm used for hashing cryptographic keys and scripts. As the type synonym name alludes, this is the hashing algorithm used for addresses.

Era-independent hash type identifiers.

Various identifiers in the ledger are hashes of particular structures. While the structures may change from era to era, the hash will remain the same, and we can refer to the hash of, say, a transaction, without knowing the actual transaction type. As such, we define a number of these hashes here.

data EraIndependentTxBody Source #

data EraIndependentBlockHeader Source #

data EraIndependentBlockBody Source #

data EraIndependentMetadata Source #

data EraIndependentScript Source #

data EraIndependentData Source #

Instances

Instances details

HashAnnotated (BinaryData era) EraIndependentData Source #
Instance details Defined in Cardano.Ledger.Plutus.Data Methods hashAnnotated ∷ BinaryData era → SafeHash EraIndependentData Source #
HashAnnotated (Data era) EraIndependentData Source #
Instance details Defined in Cardano.Ledger.Plutus.Data Methods hashAnnotated ∷ Data era → SafeHash EraIndependentData Source #

data EraIndependentScriptData Source #

data EraIndependentTxAuxData Source #

data EraIndependentPParamView Source #

data EraIndependentScriptIntegrity Source #

Hashes

``DSIGN` Verification Key Hashes

newtype KeyHash (r ∷ KeyRole) Source #

Discriminated hash of public Key

Constructors

KeyHash
Fields unKeyHash ∷ Hash ADDRHASH (VerKeyDSIGN DSIGN)

Instances

Instances details

HasKeyRole KeyHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

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

FromJSON (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

parseJSON ∷ Value → Parser (KeyHash r) Source #

parseJSONList ∷ Value → Parser [KeyHash r] Source #

omittedField ∷ Maybe (KeyHash r) Source #

FromJSONKey (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

fromJSONKey ∷ FromJSONKeyFunction (KeyHash r) Source #

fromJSONKeyList ∷ FromJSONKeyFunction [KeyHash r] Source #

ToJSON (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toJSON ∷ KeyHash r → Value Source #

toEncoding ∷ KeyHash r → Encoding Source #

toJSONList ∷ [KeyHash r] → Value Source #

toEncodingList ∷ [KeyHash r] → Encoding Source #

omitField ∷ KeyHash r → Bool Source #

ToJSONKey (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toJSONKey ∷ ToJSONKeyFunction (KeyHash r) Source #

toJSONKeyList ∷ ToJSONKeyFunction [KeyHash r] Source #

Typeable r ⇒ FromCBOR (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

fromCBOR ∷ Decoder s (KeyHash r) Source #

label ∷ Proxy (KeyHash r) → Text Source #

Typeable r ⇒ ToCBOR (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toCBOR ∷ KeyHash r → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (KeyHash r) → Size Source #

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

Typeable r ⇒ DecCBOR (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

decCBOR ∷ Decoder s (KeyHash r) Source #

dropCBOR ∷ Proxy (KeyHash r) → Decoder s () Source #

label ∷ Proxy (KeyHash r) → Text Source #

EncCBOR (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

encCBOR ∷ KeyHash r → Encoding Source #

Default (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

def ∷ KeyHash r Source #

NFData (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

rnf ∷ KeyHash r → () #

Generic (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Associated Types

type Rep (KeyHash r)
Instance details Defined in Cardano.Ledger.Hashes type Rep (KeyHash r) = Rep (Hash ADDRHASH (VerKeyDSIGN DSIGN))

Methods

from ∷ KeyHash r → Rep (KeyHash r) x #

to ∷ Rep (KeyHash r) x → KeyHash r #

Show (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

showsPrec ∷ Int → KeyHash r → ShowS #

show ∷ KeyHash r → String #

showList ∷ [KeyHash r] → ShowS #

Eq (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

(==) ∷ KeyHash r → KeyHash r → Bool #

(/=) ∷ KeyHash r → KeyHash r → Bool #

Ord (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

compare ∷ KeyHash r → KeyHash r → Ordering #

(<) ∷ KeyHash r → KeyHash r → Bool #

(<=) ∷ KeyHash r → KeyHash r → Bool #

(>) ∷ KeyHash r → KeyHash r → Bool #

(>=) ∷ KeyHash r → KeyHash r → Bool #

max ∷ KeyHash r → KeyHash r → KeyHash r #

min ∷ KeyHash r → KeyHash r → KeyHash r #

MemPack (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

typeName ∷ String Source #

packedByteCount ∷ KeyHash r → Int Source #

packM ∷ KeyHash r → Pack s () Source #

unpackM ∷ Buffer b ⇒ Unpack s b (KeyHash r) Source #

NoThunks (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

noThunks ∷ Context → KeyHash r → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → KeyHash r → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (KeyHash r) → String Source #

type Rep (KeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

type Rep (KeyHash r) = Rep (Hash ADDRHASH (VerKeyDSIGN DSIGN))

data KeyRole Source #

The role of a key.

All key roles are fixed and unique, except for the Witness role. In particular, keys can be cast to a Witness role with the help of asWitness, because same witness can be valid for many roles.

In fact, it is perfectly allowable for a key to be used in many roles by the end user; there is nothing prohibiting somebody using the same underlying key or a script as their payment and staking credential, as well as the key for their stake pool. However, in the ledger code mixing up keys with different roles could be catastrophic, that is why we have this separation.

Constructors

GenesisRole
GenesisDelegate
Payment
Staking
StakePool
BlockIssuer
Witness
DRepRole
HotCommitteeRole
ColdCommitteeRole
Guard

hashKey ∷ ∀ (kd ∷ KeyRole). VKey kd → KeyHash kd Source #

Hash a given public key

hashTxBodySignature ∷ SignedDSIGN DSIGN (Hash HASH EraIndependentTxBody) → Hash HASH (SignedDSIGN DSIGN (Hash HASH EraIndependentTxBody)) Source #

Hash a given signature

Script Hashes

newtype ScriptHash Source #

Constructors

ScriptHash (Hash ADDRHASH EraIndependentScript)

Instances

Instances details

FromJSON ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

parseJSON ∷ Value → Parser ScriptHash Source #

parseJSONList ∷ Value → Parser [ScriptHash] Source #

omittedField ∷ Maybe ScriptHash Source #

FromJSONKey ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

fromJSONKey ∷ FromJSONKeyFunction ScriptHash Source #

fromJSONKeyList ∷ FromJSONKeyFunction [ScriptHash] Source #

ToJSON ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toJSON ∷ ScriptHash → Value Source #

toEncoding ∷ ScriptHash → Encoding Source #

toJSONList ∷ [ScriptHash] → Value Source #

toEncodingList ∷ [ScriptHash] → Encoding Source #

omitField ∷ ScriptHash → Bool Source #

ToJSONKey ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toJSONKey ∷ ToJSONKeyFunction ScriptHash Source #

toJSONKeyList ∷ ToJSONKeyFunction [ScriptHash] Source #

FromCBOR ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

fromCBOR ∷ Decoder s ScriptHash Source #

label ∷ Proxy ScriptHash → Text Source #

ToCBOR ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toCBOR ∷ ScriptHash → Encoding Source #

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

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

DecCBOR ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

decCBOR ∷ Decoder s ScriptHash Source #

dropCBOR ∷ Proxy ScriptHash → Decoder s () Source #

label ∷ Proxy ScriptHash → Text Source #

EncCBOR ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

encCBOR ∷ ScriptHash → Encoding Source #

NFData ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

rnf ∷ ScriptHash → () #

Generic ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Associated Types

type Rep ScriptHash
Instance details Defined in Cardano.Ledger.Hashes type Rep ScriptHash = D1 ('MetaData "ScriptHash" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "ScriptHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hash ADDRHASH EraIndependentScript))))

Methods

from ∷ ScriptHash → Rep ScriptHash x #

to ∷ Rep ScriptHash x → ScriptHash #

Show ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

showsPrec ∷ Int → ScriptHash → ShowS #

show ∷ ScriptHash → String #

showList ∷ [ScriptHash] → ShowS #

Eq ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

(==) ∷ ScriptHash → ScriptHash → Bool #

(/=) ∷ ScriptHash → ScriptHash → Bool #

Ord ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

compare ∷ ScriptHash → ScriptHash → Ordering #

(<) ∷ ScriptHash → ScriptHash → Bool #

(<=) ∷ ScriptHash → ScriptHash → Bool #

(>) ∷ ScriptHash → ScriptHash → Bool #

(>=) ∷ ScriptHash → ScriptHash → Bool #

max ∷ ScriptHash → ScriptHash → ScriptHash #

min ∷ ScriptHash → ScriptHash → ScriptHash #

MemPack ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

typeName ∷ String Source #

packedByteCount ∷ ScriptHash → Int Source #

packM ∷ ScriptHash → Pack s () Source #

unpackM ∷ Buffer b ⇒ Unpack s b ScriptHash Source #

NoThunks ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

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

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

showTypeOf ∷ Proxy ScriptHash → String Source #

type Rep ScriptHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

type Rep ScriptHash = D1 ('MetaData "ScriptHash" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "ScriptHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hash ADDRHASH EraIndependentScript))))

type DataHash = SafeHash EraIndependentData Source #

AuxiliaryData

newtype TxAuxDataHash Source #

Constructors

TxAuxDataHash
Fields unTxAuxDataHash ∷ SafeHash EraIndependentTxAuxData

Instances

Instances details

ToJSON TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toJSON ∷ TxAuxDataHash → Value Source #

toEncoding ∷ TxAuxDataHash → Encoding Source #

toJSONList ∷ [TxAuxDataHash] → Value Source #

toEncodingList ∷ [TxAuxDataHash] → Encoding Source #

omitField ∷ TxAuxDataHash → Bool Source #

DecCBOR TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

decCBOR ∷ Decoder s TxAuxDataHash Source #

dropCBOR ∷ Proxy TxAuxDataHash → Decoder s () Source #

label ∷ Proxy TxAuxDataHash → Text Source #

EncCBOR TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

encCBOR ∷ TxAuxDataHash → Encoding Source #

NFData TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

rnf ∷ TxAuxDataHash → () #

Generic TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Associated Types

type Rep TxAuxDataHash
Instance details Defined in Cardano.Ledger.Hashes type Rep TxAuxDataHash = D1 ('MetaData "TxAuxDataHash" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "TxAuxDataHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "unTxAuxDataHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SafeHash EraIndependentTxAuxData))))

Methods

from ∷ TxAuxDataHash → Rep TxAuxDataHash x #

to ∷ Rep TxAuxDataHash x → TxAuxDataHash #

Show TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

showsPrec ∷ Int → TxAuxDataHash → ShowS #

show ∷ TxAuxDataHash → String #

showList ∷ [TxAuxDataHash] → ShowS #

Eq TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

(==) ∷ TxAuxDataHash → TxAuxDataHash → Bool #

(/=) ∷ TxAuxDataHash → TxAuxDataHash → Bool #

Ord TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

compare ∷ TxAuxDataHash → TxAuxDataHash → Ordering #

(<) ∷ TxAuxDataHash → TxAuxDataHash → Bool #

(<=) ∷ TxAuxDataHash → TxAuxDataHash → Bool #

(>) ∷ TxAuxDataHash → TxAuxDataHash → Bool #

(>=) ∷ TxAuxDataHash → TxAuxDataHash → Bool #

max ∷ TxAuxDataHash → TxAuxDataHash → TxAuxDataHash #

min ∷ TxAuxDataHash → TxAuxDataHash → TxAuxDataHash #

NoThunks TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

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

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

showTypeOf ∷ Proxy TxAuxDataHash → String Source #

type Rep TxAuxDataHash Source #

Instance details

Defined in Cardano.Ledger.Hashes

type Rep TxAuxDataHash = D1 ('MetaData "TxAuxDataHash" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "TxAuxDataHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "unTxAuxDataHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SafeHash EraIndependentTxAuxData))))

`VRF` Verification Key Hashes

data KeyRoleVRF Source #

Constructors

StakePoolVRF
GenDelegVRF
BlockIssuerVRF

newtype VRFVerKeyHash (r ∷ KeyRoleVRF) Source #

Discriminated hash of VRF Verification Key

Constructors

VRFVerKeyHash
Fields unVRFVerKeyHash ∷ Hash HASH KeyRoleVRF

Instances

Instances details

FromJSON (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

parseJSON ∷ Value → Parser (VRFVerKeyHash r) Source #

parseJSONList ∷ Value → Parser [VRFVerKeyHash r] Source #

omittedField ∷ Maybe (VRFVerKeyHash r) Source #

FromJSONKey (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

fromJSONKey ∷ FromJSONKeyFunction (VRFVerKeyHash r) Source #

fromJSONKeyList ∷ FromJSONKeyFunction [VRFVerKeyHash r] Source #

ToJSON (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toJSON ∷ VRFVerKeyHash r → Value Source #

toEncoding ∷ VRFVerKeyHash r → Encoding Source #

toJSONList ∷ [VRFVerKeyHash r] → Value Source #

toEncodingList ∷ [VRFVerKeyHash r] → Encoding Source #

omitField ∷ VRFVerKeyHash r → Bool Source #

ToJSONKey (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toJSONKey ∷ ToJSONKeyFunction (VRFVerKeyHash r) Source #

toJSONKeyList ∷ ToJSONKeyFunction [VRFVerKeyHash r] Source #

Typeable r ⇒ FromCBOR (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

fromCBOR ∷ Decoder s (VRFVerKeyHash r) Source #

label ∷ Proxy (VRFVerKeyHash r) → Text Source #

Typeable r ⇒ ToCBOR (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toCBOR ∷ VRFVerKeyHash r → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (VRFVerKeyHash r) → Size Source #

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

Typeable r ⇒ DecCBOR (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

decCBOR ∷ Decoder s (VRFVerKeyHash r) Source #

dropCBOR ∷ Proxy (VRFVerKeyHash r) → Decoder s () Source #

label ∷ Proxy (VRFVerKeyHash r) → Text Source #

EncCBOR (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

encCBOR ∷ VRFVerKeyHash r → Encoding Source #

Default (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

def ∷ VRFVerKeyHash r Source #

NFData (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

rnf ∷ VRFVerKeyHash r → () #

Generic (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Associated Types

type Rep (VRFVerKeyHash r)
Instance details Defined in Cardano.Ledger.Hashes type Rep (VRFVerKeyHash r) = Rep (Hash HASH KeyRoleVRF)

Methods

from ∷ VRFVerKeyHash r → Rep (VRFVerKeyHash r) x #

to ∷ Rep (VRFVerKeyHash r) x → VRFVerKeyHash r #

Show (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

showsPrec ∷ Int → VRFVerKeyHash r → ShowS #

show ∷ VRFVerKeyHash r → String #

showList ∷ [VRFVerKeyHash r] → ShowS #

Eq (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

(==) ∷ VRFVerKeyHash r → VRFVerKeyHash r → Bool #

(/=) ∷ VRFVerKeyHash r → VRFVerKeyHash r → Bool #

Ord (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

compare ∷ VRFVerKeyHash r → VRFVerKeyHash r → Ordering #

(<) ∷ VRFVerKeyHash r → VRFVerKeyHash r → Bool #

(<=) ∷ VRFVerKeyHash r → VRFVerKeyHash r → Bool #

(>) ∷ VRFVerKeyHash r → VRFVerKeyHash r → Bool #

(>=) ∷ VRFVerKeyHash r → VRFVerKeyHash r → Bool #

max ∷ VRFVerKeyHash r → VRFVerKeyHash r → VRFVerKeyHash r #

min ∷ VRFVerKeyHash r → VRFVerKeyHash r → VRFVerKeyHash r #

NoThunks (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

noThunks ∷ Context → VRFVerKeyHash r → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → VRFVerKeyHash r → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (VRFVerKeyHash r) → String Source #

type Rep (VRFVerKeyHash r) Source #

Instance details

Defined in Cardano.Ledger.Hashes

type Rep (VRFVerKeyHash r) = Rep (Hash HASH KeyRoleVRF)

toVRFVerKeyHash ∷ ∀ v (r ∷ KeyRoleVRF). Hash HASH (VerKeyVRF v) → VRFVerKeyHash r Source #

fromVRFVerKeyHash ∷ ∀ (r ∷ KeyRoleVRF) v. VRFVerKeyHash r → Hash HASH (VerKeyVRF v) Source #

Genesis `DSIGN` and `VRF` Verification Key Hashes

data GenDelegPair Source #

Constructors

GenDelegPair
Fields genDelegKeyHash ∷ !(KeyHash 'GenesisDelegate) genDelegVrfHash ∷ !(VRFVerKeyHash 'GenDelegVRF)

Instances

Instances details

FromJSON GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

parseJSON ∷ Value → Parser GenDelegPair Source #

parseJSONList ∷ Value → Parser [GenDelegPair] Source #

omittedField ∷ Maybe GenDelegPair Source #

ToJSON GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toJSON ∷ GenDelegPair → Value Source #

toEncoding ∷ GenDelegPair → Encoding Source #

toJSONList ∷ [GenDelegPair] → Value Source #

toEncodingList ∷ [GenDelegPair] → Encoding Source #

omitField ∷ GenDelegPair → Bool Source #

DecCBOR GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

decCBOR ∷ Decoder s GenDelegPair Source #

dropCBOR ∷ Proxy GenDelegPair → Decoder s () Source #

label ∷ Proxy GenDelegPair → Text Source #

EncCBOR GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

encCBOR ∷ GenDelegPair → Encoding Source #

NFData GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

rnf ∷ GenDelegPair → () #

Generic GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Associated Types

type Rep GenDelegPair

Instance details

Defined in Cardano.Ledger.Hashes

type Rep GenDelegPair = D1 ('MetaData "GenDelegPair" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'False) (C1 ('MetaCons "GenDelegPair" 'PrefixI 'True) (S1 ('MetaSel ('Just "genDelegKeyHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'GenesisDelegate)) :*: S1 ('MetaSel ('Just "genDelegVrfHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (VRFVerKeyHash 'GenDelegVRF))))

Methods

from ∷ GenDelegPair → Rep GenDelegPair x #

to ∷ Rep GenDelegPair x → GenDelegPair #

Show GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

showsPrec ∷ Int → GenDelegPair → ShowS #

show ∷ GenDelegPair → String #

showList ∷ [GenDelegPair] → ShowS #

Eq GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

(==) ∷ GenDelegPair → GenDelegPair → Bool #

(/=) ∷ GenDelegPair → GenDelegPair → Bool #

Ord GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

compare ∷ GenDelegPair → GenDelegPair → Ordering #

(<) ∷ GenDelegPair → GenDelegPair → Bool #

(<=) ∷ GenDelegPair → GenDelegPair → Bool #

(>) ∷ GenDelegPair → GenDelegPair → Bool #

(>=) ∷ GenDelegPair → GenDelegPair → Bool #

max ∷ GenDelegPair → GenDelegPair → GenDelegPair #

min ∷ GenDelegPair → GenDelegPair → GenDelegPair #

NoThunks GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

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

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

showTypeOf ∷ Proxy GenDelegPair → String Source #

type Rep GenDelegPair Source #

Instance details

Defined in Cardano.Ledger.Hashes

type Rep GenDelegPair = D1 ('MetaData "GenDelegPair" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'False) (C1 ('MetaCons "GenDelegPair" 'PrefixI 'True) (S1 ('MetaSel ('Just "genDelegKeyHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'GenesisDelegate)) :*: S1 ('MetaSel ('Just "genDelegVrfHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (VRFVerKeyHash 'GenDelegVRF))))

newtype GenDelegs Source #

Constructors

GenDelegs
Fields unGenDelegs ∷ Map (KeyHash 'GenesisRole) GenDelegPair

Instances

Instances details

FromJSON GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

parseJSON ∷ Value → Parser GenDelegs Source #

parseJSONList ∷ Value → Parser [GenDelegs] Source #

omittedField ∷ Maybe GenDelegs Source #

ToJSON GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

toJSON ∷ GenDelegs → Value Source #

toEncoding ∷ GenDelegs → Encoding Source #

toJSONList ∷ [GenDelegs] → Value Source #

toEncodingList ∷ [GenDelegs] → Encoding Source #

omitField ∷ GenDelegs → Bool Source #

DecCBOR GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

decCBOR ∷ Decoder s GenDelegs Source #

dropCBOR ∷ Proxy GenDelegs → Decoder s () Source #

label ∷ Proxy GenDelegs → Text Source #

EncCBOR GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

encCBOR ∷ GenDelegs → Encoding Source #

NFData GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

rnf ∷ GenDelegs → () #

Generic GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

Associated Types

type Rep GenDelegs
Instance details Defined in Cardano.Ledger.Hashes type Rep GenDelegs = D1 ('MetaData "GenDelegs" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "GenDelegs" 'PrefixI 'True) (S1 ('MetaSel ('Just "unGenDelegs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (KeyHash 'GenesisRole) GenDelegPair))))

Methods

from ∷ GenDelegs → Rep GenDelegs x #

to ∷ Rep GenDelegs x → GenDelegs #

Show GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

showsPrec ∷ Int → GenDelegs → ShowS #

show ∷ GenDelegs → String #

showList ∷ [GenDelegs] → ShowS #

Eq GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

(==) ∷ GenDelegs → GenDelegs → Bool #

(/=) ∷ GenDelegs → GenDelegs → Bool #

NoThunks GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

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

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

showTypeOf ∷ Proxy GenDelegs → String Source #

type Rep GenDelegs Source #

Instance details

Defined in Cardano.Ledger.Hashes

type Rep GenDelegs = D1 ('MetaData "GenDelegs" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "GenDelegs" 'PrefixI 'True) (S1 ('MetaSel ('Just "unGenDelegs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (KeyHash 'GenesisRole) GenDelegPair))))

SafeHash

In cardano-ledger, hashing a type X is based upon the serialization of X. Serialization is based upon the EncCBOR and DecCBOR type classes, and the serialization that can be handled by DecCBOR instances for a particular type, are not necessarily unique. For this reason, when an X object comes over the network in serialized form, we must preserve the original bytes that arrived over the network, otherwise when the system hashes that object, the hash in the ledger, and the hash of that object from the other side of the network may not agree. In otherwords reserialization for the purpose of hash calculation is not an option. The SafeToHash type class ensures that types with a (SafeToHash X) instance store the original bytes that arrived over the network for the value of X. The recommended way to store the original bytes is to use the type MemoBytes, although there are a few types that store their original bytes in other ways. In order to encourage the use of newtype over MemoBytes newtype defined as a MemoBytes, which would get the functionality of retaining bytes and deriving of SafeToHash instance for free.

data SafeHash i Source #

A SafeHash is a hash of something that is safe to hash. Such types store their own serialisation bytes. The prime example is (MemoBytes t), but other examples are things that consist of only ByteStrings (i.e. they are their own serialization) or for some other reason store their original bytes.

We do NOT export the constructor SafeHash, but instead export other functions such as hashAnnotated and extractHash which have constraints that limit their application to types which preserve their original serialization bytes.

Instances

Instances details

FromJSON (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods parseJSON ∷ Value → Parser (SafeHash i) Source # parseJSONList ∷ Value → Parser [SafeHash i] Source # omittedField ∷ Maybe (SafeHash i) Source #
ToJSON (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods toJSON ∷ SafeHash i → Value Source # toEncoding ∷ SafeHash i → Encoding Source # toJSONList ∷ [SafeHash i] → Value Source # toEncodingList ∷ [SafeHash i] → Encoding Source # omitField ∷ SafeHash i → Bool Source #
Typeable i ⇒ FromCBOR (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods fromCBOR ∷ Decoder s (SafeHash i) Source # label ∷ Proxy (SafeHash i) → Text Source #
Typeable i ⇒ ToCBOR (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods toCBOR ∷ SafeHash i → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (SafeHash i) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SafeHash i] → Size Source #
Typeable i ⇒ DecCBOR (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods decCBOR ∷ Decoder s (SafeHash i) Source # dropCBOR ∷ Proxy (SafeHash i) → Decoder s () Source # label ∷ Proxy (SafeHash i) → Text Source #
EncCBOR (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods encCBOR ∷ SafeHash i → Encoding Source #
SafeToHash (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods originalBytes ∷ SafeHash i → ByteString Source # originalBytesSize ∷ SafeHash i → Int Source # makeHashWithExplicitProxys ∷ Proxy i0 → SafeHash i → SafeHash i0 Source #
Default (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods def ∷ SafeHash i Source #
NFData (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods rnf ∷ SafeHash i → () #
Show (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods showsPrec ∷ Int → SafeHash i → ShowS # show ∷ SafeHash i → String # showList ∷ [SafeHash i] → ShowS #
Eq (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods (==) ∷ SafeHash i → SafeHash i → Bool # (/=) ∷ SafeHash i → SafeHash i → Bool #
Ord (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods compare ∷ SafeHash i → SafeHash i → Ordering # (<) ∷ SafeHash i → SafeHash i → Bool # (<=) ∷ SafeHash i → SafeHash i → Bool # (>) ∷ SafeHash i → SafeHash i → Bool # (>=) ∷ SafeHash i → SafeHash i → Bool # max ∷ SafeHash i → SafeHash i → SafeHash i # min ∷ SafeHash i → SafeHash i → SafeHash i #
MemPack (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods typeName ∷ String Source # packedByteCount ∷ SafeHash i → Int Source # packM ∷ SafeHash i → Pack s () Source # unpackM ∷ Buffer b ⇒ Unpack s b (SafeHash i) Source #
NoThunks (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods noThunks ∷ Context → SafeHash i → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → SafeHash i → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (SafeHash i) → String Source #

class SafeToHash t where Source #

Only Types that preserve their serialisation bytes are members of the class SafeToHash. There are only a limited number of primitive direct instances of SafeToHash, all but two of them are present in this file. Instead of making explicit instances, we almost always use a newtype (around a type S) where their is already an instance (SafeToHash S). In that case the newtype has its SafeToHash instance derived using newtype deriving. The prime example of s is MemoBytes. The only exceptions are the legacy Shelley types: Metadata and ShelleyTx, that preserve their serialization bytes using a different mechanism than the use of MemoBytes. SafeToHash is a superclass requirement of the classes HashAnnotated which provide more convenient ways to construct SafeHashes than using makeHashWithExplicitProxys.

Minimal complete definition

originalBytes

Methods

originalBytes ∷ t → ByteString Source #

Extract the original bytes from t

originalBytesSize ∷ t → Int Source #

makeHashWithExplicitProxys ∷ Proxy i → t → SafeHash i Source #

Instances

Instances details

SafeToHash ByteString Source #
Instance details Defined in Cardano.Ledger.Hashes Methods originalBytes ∷ ByteString → ByteString Source # originalBytesSize ∷ ByteString → Int Source # makeHashWithExplicitProxys ∷ Proxy i → ByteString → SafeHash i Source #
SafeToHash ShortByteString Source #
Instance details Defined in Cardano.Ledger.Hashes Methods originalBytes ∷ ShortByteString → ByteString Source # originalBytesSize ∷ ShortByteString → Int Source # makeHashWithExplicitProxys ∷ Proxy i → ShortByteString → SafeHash i Source #
SafeToHash AnchorData Source #
Instance details Defined in Cardano.Ledger.BaseTypes Methods originalBytes ∷ AnchorData → ByteString Source # originalBytesSize ∷ AnchorData → Int Source # makeHashWithExplicitProxys ∷ Proxy i → AnchorData → SafeHash i Source #
SafeToHash PlutusBinary Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods originalBytes ∷ PlutusBinary → ByteString Source # originalBytesSize ∷ PlutusBinary → Int Source # makeHashWithExplicitProxys ∷ Proxy i → PlutusBinary → SafeHash i Source #
SafeToHash (SafeHash i) Source #
Instance details Defined in Cardano.Ledger.Hashes Methods originalBytes ∷ SafeHash i → ByteString Source # originalBytesSize ∷ SafeHash i → Int Source # makeHashWithExplicitProxys ∷ Proxy i0 → SafeHash i → SafeHash i0 Source #
SafeToHash (MemoBytes t) Source #
Instance details Defined in Cardano.Ledger.MemoBytes.Internal Methods originalBytes ∷ MemoBytes t → ByteString Source # originalBytesSize ∷ MemoBytes t → Int Source # makeHashWithExplicitProxys ∷ Proxy i → MemoBytes t → SafeHash i Source #
SafeToHash (BinaryData era) Source #
Instance details Defined in Cardano.Ledger.Plutus.Data Methods originalBytes ∷ BinaryData era → ByteString Source # originalBytesSize ∷ BinaryData era → Int Source # makeHashWithExplicitProxys ∷ Proxy i → BinaryData era → SafeHash i Source #
SafeToHash (Data era) Source #
Instance details Defined in Cardano.Ledger.Plutus.Data Methods originalBytes ∷ Data era → ByteString Source # originalBytesSize ∷ Data era → Int Source # makeHashWithExplicitProxys ∷ Proxy i → Data era → SafeHash i Source #
SafeToHash (Plutus l) Source #
Instance details Defined in Cardano.Ledger.Plutus.Language Methods originalBytes ∷ Plutus l → ByteString Source # originalBytesSize ∷ Plutus l → Int Source # makeHashWithExplicitProxys ∷ Proxy i → Plutus l → SafeHash i Source #
HashAlgorithm h ⇒ SafeToHash (Hash h i) Source #	Hash of a hash. Hash is always safe to hash. Do you even hash?
Instance details Defined in Cardano.Ledger.Hashes Methods originalBytes ∷ Hash h i → ByteString Source # originalBytesSize ∷ Hash h i → Int Source # makeHashWithExplicitProxys ∷ Proxy i0 → Hash h i → SafeHash i0 Source #

Header Hash

newtype HashHeader Source #

Constructors

HashHeader
Fields unHashHeader ∷ Hash HASH EraIndependentBlockHeader

Instances

Instances details

DecCBOR HashHeader Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

decCBOR ∷ Decoder s HashHeader Source #

dropCBOR ∷ Proxy HashHeader → Decoder s () Source #

label ∷ Proxy HashHeader → Text Source #

EncCBOR HashHeader Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

encCBOR ∷ HashHeader → Encoding Source #

NFData HashHeader Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

rnf ∷ HashHeader → () #

Generic HashHeader Source #

Instance details

Defined in Cardano.Ledger.Hashes

Associated Types

type Rep HashHeader
Instance details Defined in Cardano.Ledger.Hashes type Rep HashHeader = D1 ('MetaData "HashHeader" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "HashHeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "unHashHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hash HASH EraIndependentBlockHeader))))

Methods

from ∷ HashHeader → Rep HashHeader x #

to ∷ Rep HashHeader x → HashHeader #

Show HashHeader Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

showsPrec ∷ Int → HashHeader → ShowS #

show ∷ HashHeader → String #

showList ∷ [HashHeader] → ShowS #

Eq HashHeader Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

(==) ∷ HashHeader → HashHeader → Bool #

(/=) ∷ HashHeader → HashHeader → Bool #

Ord HashHeader Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

compare ∷ HashHeader → HashHeader → Ordering #

(<) ∷ HashHeader → HashHeader → Bool #

(<=) ∷ HashHeader → HashHeader → Bool #

(>) ∷ HashHeader → HashHeader → Bool #

(>=) ∷ HashHeader → HashHeader → Bool #

max ∷ HashHeader → HashHeader → HashHeader #

min ∷ HashHeader → HashHeader → HashHeader #

NoThunks HashHeader Source #

Instance details

Defined in Cardano.Ledger.Hashes

Methods

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

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

showTypeOf ∷ Proxy HashHeader → String Source #

type Rep HashHeader Source #

Instance details

Defined in Cardano.Ledger.Hashes

type Rep HashHeader = D1 ('MetaData "HashHeader" "Cardano.Ledger.Hashes" "cardano-ledger-core-1.19.0.0-inplace" 'True) (C1 ('MetaCons "HashHeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "unHashHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Hash HASH EraIndependentBlockHeader))))

Creating SafeHash

class SafeToHash x ⇒ HashAnnotated x i | x → i Source #

Types that are SafeToHash AND have the type uniquely determines the index type tag of SafeHash index

The SafeToHash and the HashAnnotated classes are designed so that their instances can be easily derived (because their methods have default methods when the type is a newtype around a type that is SafeToHash). For example,

Instances

Instances details

HashAnnotated AnchorData AnchorData Source #
Instance details Defined in Cardano.Ledger.BaseTypes Methods hashAnnotated ∷ AnchorData → SafeHash AnchorData Source #
HashAnnotated (BinaryData era) EraIndependentData Source #
Instance details Defined in Cardano.Ledger.Plutus.Data Methods hashAnnotated ∷ BinaryData era → SafeHash EraIndependentData Source #
HashAnnotated (Data era) EraIndependentData Source #
Instance details Defined in Cardano.Ledger.Plutus.Data Methods hashAnnotated ∷ Data era → SafeHash EraIndependentData Source #

hashAnnotated ∷ HashAnnotated x i ⇒ x → SafeHash i Source #

Create a (SafeHash i), given (HashAnnotated x i) instance.

unsafeMakeSafeHash ∷ Hash HASH i → SafeHash i Source #

Don't use this except in Testing to make Arbitrary instances, etc. or in cases when it can be guaranteed that original bytes were used for computing the hash.

Other operations

castSafeHash ∷ SafeHash i → SafeHash j Source #

To change the index parameter of SafeHash (which is a phantom type) use castSafeHash

extractHash ∷ SafeHash i → Hash HASH i Source #

Extract the hash out of a SafeHash

standardHashSize ∷ Int Source #

standardAddrHashSize ∷ Int Source #

Hashing algorithms

Instances

Instances

Era-independent hash type identifiers.

Instances

Hashes

`DSIGN Verification Key Hashes

Instances

Script Hashes

Instances

AuxiliaryData

Instances

VRF Verification Key Hashes

Instances

Genesis DSIGN and VRF Verification Key Hashes

Instances

Instances

SafeHash

Instances

Instances

Header Hash

Instances

Creating SafeHash

Instances

Other operations

``DSIGN` Verification Key Hashes

`VRF` Verification Key Hashes

Genesis `DSIGN` and `VRF` Verification Key Hashes