Copyright	2020 Input Output (Hong Kong) Ltd. 2021-2022 Input Output Global Inc. (IOG) 2023-2025 Intersect
License	Apache-2.0
Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Address.KeyHash

Description

Synopsis

data KeyHash = KeyHash {
- role :: KeyRole
- digest :: ByteString
}
data KeyRole
- = PaymentShared
- | DelegationShared
- | Payment
- | Delegation
- | Policy
- | Representative
- | CommitteeCold
- | CommitteeHot
- | Unknown
data GovernanceType
- = NoGovernance
- | CIP0129
- | CIP0105
keyHashFromBytes :: (KeyRole, ByteString) -> Maybe KeyHash
keyHashFromText :: Text -> Either ErrKeyHashFromText KeyHash
keyHashToText :: KeyHash -> GovernanceType -> Text

Documentation

data KeyHash Source #

A KeyHash type represents verification key hash that participate in building multi-signature script. The hash is expected to have size of 28-byte.

Since: 3.0.0

Constructors

KeyHash
Fields role :: KeyRole digest :: ByteString

Instances

Instances details

ToJSON KeyHash Source #
Instance details Defined in Cardano.Address.KeyHash Methods toJSON :: KeyHash -> Value # toEncoding :: KeyHash -> Encoding # toJSONList :: [KeyHash] -> Value # toEncodingList :: [KeyHash] -> Encoding # omitField :: KeyHash -> Bool #
Generic KeyHash Source #
Instance details Defined in Cardano.Address.KeyHash Associated Types type Rep KeyHash :: Type -> Type # Methods from :: KeyHash -> Rep KeyHash x # to :: Rep KeyHash x -> KeyHash #
Show KeyHash Source #
Instance details Defined in Cardano.Address.KeyHash Methods showsPrec :: Int -> KeyHash -> ShowS # show :: KeyHash -> String # showList :: [KeyHash] -> ShowS #
NFData KeyHash Source #
Instance details Defined in Cardano.Address.KeyHash Methods rnf :: KeyHash -> () #
Eq KeyHash Source #
Instance details Defined in Cardano.Address.KeyHash Methods (==) :: KeyHash -> KeyHash -> Bool # (/=) :: KeyHash -> KeyHash -> Bool #
Ord KeyHash Source #
Instance details Defined in Cardano.Address.KeyHash Methods compare :: KeyHash -> KeyHash -> Ordering # (<) :: KeyHash -> KeyHash -> Bool # (<=) :: KeyHash -> KeyHash -> Bool # (>) :: KeyHash -> KeyHash -> Bool # (>=) :: KeyHash -> KeyHash -> Bool # max :: KeyHash -> KeyHash -> KeyHash # min :: KeyHash -> KeyHash -> KeyHash #
FromJSON (Script KeyHash) Source #
Instance details Defined in Cardano.Address.Script Methods parseJSON :: Value -> Parser (Script KeyHash) # parseJSONList :: Value -> Parser [Script KeyHash] # omittedField :: Maybe (Script KeyHash) #
type Rep KeyHash Source #
Instance details Defined in Cardano.Address.KeyHash type Rep KeyHash = D1 ('MetaData "KeyHash" "Cardano.Address.KeyHash" "cardano-addresses-4.0.0-IcyHUatmop45H7Iv1rHNhW" 'False) (C1 ('MetaCons "KeyHash" 'PrefixI 'True) (S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KeyRole) :*: S1 ('MetaSel ('Just "digest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data KeyRole Source #

Determines the role a given key plays. The role basically can be mapped into derivation path which was used to derive it from the parent. Also it has a dedicated user facing HRP when presented in bech32 format - see keyHashToText for more details. Take notice that purpose/role (except Policy) are as defined below in derivation path: m purpose' coin_type' account_ix' role / index Policy has a dedicated derivation path as follows: m purpose' coin_type' / policy_ix'

| KeyRole | purpose | role | CIP | ------------------------------------------------------------------------------------------------------------------------| | PaymentShared | 1854H | 0,1 | CIP-1854 | | DelegationShared | 1854H | 2 | CIP-1854 | | Payment | 1852H | 0,1 | CIP-1852 | | Delegation | 1852H | 2 | CIP-0011 | | Representative | 1852H | 3 | CIP-0105 | | CommitteeCold | 1852H | 4 | CIP-0105 | | CommitteeHot | 1852H | 5 | CIP-0105 | | Policy | 1855H | - | CIP-1855 |

Constructors

PaymentShared
DelegationShared
Payment
Delegation
Policy
Representative
CommitteeCold
CommitteeHot
Unknown

Instances

Instances details

Generic KeyRole Source #
Instance details Defined in Cardano.Address.KeyHash Associated Types type Rep KeyRole :: Type -> Type # Methods from :: KeyRole -> Rep KeyRole x # to :: Rep KeyRole x -> KeyRole #
Show KeyRole Source #
Instance details Defined in Cardano.Address.KeyHash Methods showsPrec :: Int -> KeyRole -> ShowS # show :: KeyRole -> String # showList :: [KeyRole] -> ShowS #
NFData KeyRole Source #
Instance details Defined in Cardano.Address.KeyHash Methods rnf :: KeyRole -> () #
Eq KeyRole Source #
Instance details Defined in Cardano.Address.KeyHash Methods (==) :: KeyRole -> KeyRole -> Bool # (/=) :: KeyRole -> KeyRole -> Bool #
Ord KeyRole Source #
Instance details Defined in Cardano.Address.KeyHash Methods compare :: KeyRole -> KeyRole -> Ordering # (<) :: KeyRole -> KeyRole -> Bool # (<=) :: KeyRole -> KeyRole -> Bool # (>) :: KeyRole -> KeyRole -> Bool # (>=) :: KeyRole -> KeyRole -> Bool # max :: KeyRole -> KeyRole -> KeyRole # min :: KeyRole -> KeyRole -> KeyRole #
type Rep KeyRole Source #
Instance details Defined in Cardano.Address.KeyHash type Rep KeyRole = D1 ('MetaData "KeyRole" "Cardano.Address.KeyHash" "cardano-addresses-4.0.0-IcyHUatmop45H7Iv1rHNhW" 'False) (((C1 ('MetaCons "PaymentShared" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DelegationShared" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Payment" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Delegation" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Policy" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Representative" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CommitteeCold" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CommitteeHot" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unknown" 'PrefixI 'False) (U1 :: Type -> Type)))))

data GovernanceType Source #

Determines if one asks for deprecated HRP prefixes, '*_vkh' and '*_script' in accordance to CIP-0105 (on demand when flag 'cip-0105' is used) or uses default format specified in CIP-0129 (where additional byte is prepended to 28-byte hash).

Constructors

NoGovernance
CIP0129
CIP0105

Instances

Instances details

Show GovernanceType Source #
Instance details Defined in Cardano.Address.KeyHash Methods showsPrec :: Int -> GovernanceType -> ShowS # show :: GovernanceType -> String # showList :: [GovernanceType] -> ShowS #
Eq GovernanceType Source #
Instance details Defined in Cardano.Address.KeyHash Methods (==) :: GovernanceType -> GovernanceType -> Bool # (/=) :: GovernanceType -> GovernanceType -> Bool #

keyHashFromBytes :: (KeyRole, ByteString) -> Maybe KeyHash Source #

Construct an KeyHash from raw ByteString (28 bytes).

Since: 3.0.0

keyHashFromText :: Text -> Either ErrKeyHashFromText KeyHash Source #

Construct a KeyHash from Text. It should be Bech32 encoded text with one of following hrp:

keyHashToText :: KeyHash -> GovernanceType -> Text Source #

Encode a KeyHash to bech32 Text or hex is key role unknown. If one wants to include, valid in governance roles only, additional byte as specified in CIP-0129, the function needs to be called with withByte=true.

Since: 3.0.0