Evolution SDK
Modules

OperationalCert.ts

OperationalCert overview

Table of contents

arbitrary

arbitrary

FastCheck arbitrary for generating random OperationalCert instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<OperationalCert>

Added in v2.0.0

encoding

toCBORBytes

Encode OperationalCert to CBOR bytes.

Signature

export declare const toCBORBytes: (cert: OperationalCert, options?: CBOR.CodecOptions) => Uint8Array

Added in v2.0.0

toCBORHex

Encode OperationalCert to CBOR hex string.

Signature

export declare const toCBORHex: (cert: OperationalCert, options?: CBOR.CodecOptions) => string

Added in v2.0.0

model

OperationalCert (class)

OperationalCert class based on Conway CDDL specification

CDDL:

operational_cert = [
  hot_vkey : kes_vkey,
  sequence_number : uint64,
  kes_period : uint64,
  sigma : ed25519_signature
]

Signature

export declare class OperationalCert

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

fromCBORBytes

Parse OperationalCert from CBOR bytes.

Signature

export declare const fromCBORBytes: (bytes: Uint8Array, options?: CBOR.CodecOptions) => OperationalCert

Added in v2.0.0

fromCBORHex

Parse OperationalCert from CBOR hex string.

Signature

export declare const fromCBORHex: (hex: string, options?: CBOR.CodecOptions) => OperationalCert

Added in v2.0.0

predicates

isOperationalCert

Check if the given value is a valid OperationalCert

Signature

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

Added in v2.0.0

schemas

FromCBORBytes

CBOR bytes transformation schema for OperationalCert.

Signature

export declare const FromCBORBytes: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.transformOrFail<
    typeof Schema.Uint8ArrayFromSelf,
    Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
    never
  >,
  Schema.transformOrFail<
    Schema.Tuple<
      [
        typeof Schema.Uint8ArrayFromSelf,
        typeof Schema.BigIntFromSelf,
        typeof Schema.BigIntFromSelf,
        typeof Schema.Uint8ArrayFromSelf
      ]
    >,
    Schema.SchemaClass<OperationalCert, OperationalCert, never>,
    never
  >
>

Added in v2.0.0

FromCBORHex

CBOR hex transformation schema for OperationalCert.

Signature

export declare const FromCBORHex: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.Schema<Uint8Array, string, never>,
  Schema.transform<
    Schema.transformOrFail<
      typeof Schema.Uint8ArrayFromSelf,
      Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
      never
    >,
    Schema.transformOrFail<
      Schema.Tuple<
        [
          typeof Schema.Uint8ArrayFromSelf,
          typeof Schema.BigIntFromSelf,
          typeof Schema.BigIntFromSelf,
          typeof Schema.Uint8ArrayFromSelf
        ]
      >,
      Schema.SchemaClass<OperationalCert, OperationalCert, never>,
      never
    >
  >
>

Added in v2.0.0

FromCDDL

CDDL schema for OperationalCert. operational_cert = [ hot_vkey : kes_vkey, sequence_number : uint64, kes_period : uint64, sigma : ed25519_signature ]

Signature

export declare const FromCDDL: Schema.transformOrFail<
  Schema.Tuple<
    [
      typeof Schema.Uint8ArrayFromSelf,
      typeof Schema.BigIntFromSelf,
      typeof Schema.BigIntFromSelf,
      typeof Schema.Uint8ArrayFromSelf
    ]
  >,
  Schema.SchemaClass<OperationalCert, OperationalCert, never>,
  never
>

Added in v2.0.0

utils

CDDLSchema

Signature

export declare const CDDLSchema: Schema.Tuple<
  [
    typeof Schema.Uint8ArrayFromSelf,
    typeof Schema.BigIntFromSelf,
    typeof Schema.BigIntFromSelf,
    typeof Schema.Uint8ArrayFromSelf
  ]
>

Numeric.ts

Previous Page

PaymentAddress.ts

Next Page

On this page

OperationalCert overviewarbitraryarbitraryencodingtoCBORBytestoCBORHexmodelOperationalCert (class)toJSON (method)toString (method)[Inspectable.NodeInspectSymbol] (method)[Equal.symbol] (method)[Hash.symbol] (method)parsingfromCBORBytesfromCBORHexpredicatesisOperationalCertschemasFromCBORBytesFromCBORHexFromCDDLutilsCDDLSchema