Evolution SDK
Modules

Header.ts

Header overview

Header module based on Conway CDDL specification

CDDL: header = [header_body, body_signature : kes_signature]

Added in v2.0.0

Table of contents

encoding

toCBORBytes

Convert a Header to CBOR bytes.

Signature

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

Added in v2.0.0

toCBORHex

Convert a Header to CBOR hex string.

Signature

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

Added in v2.0.0

model

Header (class)

Header implementation using HeaderBody and KesSignature

CDDL: header = [header_body, body_signature : kes_signature]

Signature

export declare class Header

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 a Header from CBOR bytes.

Signature

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

Added in v2.0.0

fromCBORHex

Parse a Header from CBOR hex string.

Signature

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

Added in v2.0.0

predicates

isHeader

Predicate to check if a value is a Header instance.

Signature

export declare const isHeader: (value: unknown) => value is Header

Added in v2.0.0

schemas

FromBytes

CBOR bytes transformation schema for Header.

Signature

export declare const FromBytes: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.transformOrFail<
    typeof Schema.Uint8ArrayFromSelf,
    Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
    never
  >,
  Schema.transformOrFail<
    Schema.Tuple2<
      Schema.SchemaClass<
        readonly [
          bigint,
          bigint,
          any,
          any,
          any,
          readonly [any, any],
          bigint,
          any,
          readonly [any, bigint, bigint, any],
          readonly [bigint, bigint]
        ],
        readonly [
          bigint,
          bigint,
          any,
          any,
          any,
          readonly [any, any],
          bigint,
          any,
          readonly [any, bigint, bigint, any],
          readonly [bigint, bigint]
        ],
        never
      >,
      typeof Schema.Uint8ArrayFromSelf
    >,
    Schema.SchemaClass<Header, Header, never>,
    never
  >
>

Added in v2.0.0

FromCDDL

CDDL schema for Header. header = [header_body, body_signature : kes_signature]

Signature

export declare const FromCDDL: Schema.transformOrFail<
  Schema.Tuple2<
    Schema.SchemaClass<
      readonly [
        bigint,
        bigint,
        any,
        any,
        any,
        readonly [any, any],
        bigint,
        any,
        readonly [any, bigint, bigint, any],
        readonly [bigint, bigint]
      ],
      readonly [
        bigint,
        bigint,
        any,
        any,
        any,
        readonly [any, any],
        bigint,
        any,
        readonly [any, bigint, bigint, any],
        readonly [bigint, bigint]
      ],
      never
    >,
    typeof Schema.Uint8ArrayFromSelf
  >,
  Schema.SchemaClass<Header, Header, never>,
  never
>

Added in v2.0.0

FromHex

CBOR hex transformation schema for Header.

Signature

export declare const FromHex: (
  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.Tuple2<
        Schema.SchemaClass<
          readonly [
            bigint,
            bigint,
            any,
            any,
            any,
            readonly [any, any],
            bigint,
            any,
            readonly [any, bigint, bigint, any],
            readonly [bigint, bigint]
          ],
          readonly [
            bigint,
            bigint,
            any,
            any,
            any,
            readonly [any, any],
            bigint,
            any,
            readonly [any, bigint, bigint, any],
            readonly [bigint, bigint]
          ],
          never
        >,
        typeof Schema.Uint8ArrayFromSelf
      >,
      Schema.SchemaClass<Header, Header, never>,
      never
    >
  >
>

Added in v2.0.0

Hash28.ts

Previous Page

HeaderBody.ts

Next Page

On this page

Header overviewencodingtoCBORBytestoCBORHexmodelHeader (class)toJSON (method)toString (method)[Inspectable.NodeInspectSymbol] (method)[Equal.symbol] (method)[Hash.symbol] (method)parsingfromCBORBytesfromCBORHexpredicatesisHeaderschemasFromBytesFromCDDLFromHex