Evolution SDK

KeyHash.ts

KeyHash overview


Table of contents


arbitrary

arbitrary

FastCheck arbitrary for generating random KeyHash instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<KeyHash>

Added in v2.0.0

constructors

fromPrivateKey

Create a KeyHash from a PrivateKey

Signature

export declare const fromPrivateKey: (privateKey: PrivateKey) => KeyHash

Added in v2.0.0

fromVKey

Create a KeyHash from a VKey

Signature

export declare const fromVKey: (vkey: VKey.VKey) => KeyHash

Added in v2.0.0

encoding/decoding

fromBytes

Decode a KeyHash from raw bytes.

Signature

export declare const fromBytes: (i: Uint8Array, overrideOptions?: ParseOptions) => KeyHash

Added in v2.0.0

fromHex

Decode a KeyHash from a hex string.

Signature

export declare const fromHex: (i: string, overrideOptions?: ParseOptions) => KeyHash

Added in v2.0.0

toBytes

Convert a KeyHash to raw bytes.

Signature

export declare const toBytes: (a: KeyHash, overrideOptions?: ParseOptions) => Uint8Array

Added in v2.0.0

toHex

Convert a KeyHash to a hex string.

Signature

export declare const toHex: (a: KeyHash, overrideOptions?: ParseOptions) => string

Added in v2.0.0

model

KeyHash (class)

KeyHash

CDDL:

addr_keyhash = hash28

Signature

export declare class KeyHash

Added in v2.0.0

toJSON (method)

Signature

toJSON()

toString (method)

Signature

toString(): string

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

transformer

FromBytes

Schema transformer from bytes to KeyHash.

Signature

export declare const FromBytes: Schema.transform<
  Schema.SchemaClass<Uint8Array, Uint8Array, never>,
  Schema.SchemaClass<KeyHash, KeyHash, never>
>

Added in v2.0.0

FromHex

Schema transformer from hex string to KeyHash.

Signature

export declare const FromHex: Schema.transform<
  Schema.filter<Schema.Schema<Uint8Array, string, never>>,
  Schema.transform<Schema.SchemaClass<Uint8Array, Uint8Array, never>, Schema.SchemaClass<KeyHash, KeyHash, never>>
>

Added in v2.0.0