Evolution SDK

KESVkey.ts

KESVkey overview


Table of contents


arbitrary

arbitrary

FastCheck arbitrary for generating random KESVkey instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<KESVkey>

Added in v2.0.0

encoding

toBytes

Encode KESVkey to bytes.

Signature

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

Added in v2.0.0

toHex

Encode KESVkey to hex string.

Signature

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

Added in v2.0.0

model

KESVkey (class)

Schema for KESVkey representing a KES verification key. kes_vkey = bytes .size 32 Follows the Conway-era CDDL specification.

Signature

export declare class KESVkey

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

parsing

fromBytes

Parse KESVkey from bytes.

Signature

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

Added in v2.0.0

fromHex

Parse KESVkey from hex string.

Signature

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

Added in v2.0.0

predicates

isKESVkey

Check if the given value is a valid KESVkey

Signature

export declare const isKESVkey: (u: unknown, overrideOptions?: ParseOptions | number) => u is KESVkey

Added in v2.0.0

schemas

FromBytes

Schema for transforming between Uint8Array and KESVkey.

Signature

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

Added in v2.0.0

FromHex

Schema for transforming between hex string and KESVkey.

Signature

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

Added in v2.0.0