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

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'

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).

Construct an KeyHash from raw ByteString (28 bytes).

Since: 3.0.0

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

• addr_shared_vkh
• stake_shared_vkh
• addr_vkh
• stake_vkh
• policy_vkh
• drep
• cc_cold
• cc_hot
• drep_vkh
• cc_cold_vkh
• cc_hot_vkh
• addr_shared_vk
• stake_shared_vk
• addr_vk
• stake_vk
• policy_vk
• cc_cold_vk
• cc_hot_vk
• addr_shared_xvk
• stake_shared_xvk
• addr_xvk
• stake_xvk
• policy_xvk
• drep_xvk
• cc_cold_xvk
• cc_hot_xvk

Raw keys will be hashed on the fly, whereas hash that are directly provided will remain as such. If if hex is encountered Unknown policy key is assumed.

Since: 3.1.0

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

Possible errors when deserializing a key hash from text.

Since: 3.0.0

Possible errors when deserializing a key hash from text.

Since: 3.0.0