Evolution SDK

BootstrapWitness.ts

BootstrapWitness overview


Table of contents


encoding

toCBORBytes

Encode BootstrapWitness to CBOR bytes.

Signature

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

Added in v2.0.0

toCBORHex

Encode BootstrapWitness to CBOR hex string.

Signature

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

Added in v2.0.0

parsing

fromCBORBytes

Parse BootstrapWitness from CBOR bytes.

Signature

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

Added in v2.0.0

fromCBORHex

Parse BootstrapWitness from CBOR hex string.

Signature

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

Added in v2.0.0

schemas

FromCBORBytes

CBOR bytes transformation schema for BootstrapWitness. Transforms between Uint8Array and BootstrapWitness using CBOR encoding.

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.Uint8ArrayFromSelf,
        typeof Schema.Uint8ArrayFromSelf,
        typeof Schema.Uint8ArrayFromSelf
      ]
    >,
    Schema.SchemaClass<BootstrapWitness, BootstrapWitness, never>,
    never
  >
>

Added in v2.0.0

FromCBORHex

CBOR hex transformation schema for BootstrapWitness. Transforms between hex string and BootstrapWitness using CBOR encoding.

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.Uint8ArrayFromSelf,
          typeof Schema.Uint8ArrayFromSelf,
          typeof Schema.Uint8ArrayFromSelf
        ]
      >,
      Schema.SchemaClass<BootstrapWitness, BootstrapWitness, never>,
      never
    >
  >
>

Added in v2.0.0

utils

BootstrapWitness (class)

Bootstrap witness for Byron-era addresses.

CDDL:

bootstrap_witness = [
  public_key : vkey,
  signature : ed25519_signature,
  chain_code : bytes .size 32,
  attributes : bytes
]

Signature

export declare class BootstrapWitness

toJSON (method)

Convert to JSON representation.

Signature

toJSON()

Added in v2.0.0

toString (method)

Convert to string representation.

Signature

toString(): string

Added in v2.0.0

[Inspectable.NodeInspectSymbol] (method)

Custom inspect for Node.js REPL.

Signature

[Inspectable.NodeInspectSymbol](): unknown

Added in v2.0.0

[Equal.symbol] (method)

Structural equality check.

Signature

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

Added in v2.0.0

[Hash.symbol] (method)

Hash code generation. Only hashes publicKey for performance (minimal identifying field).

Signature

[Hash.symbol](): number

Added in v2.0.0

CDDLSchema

Signature

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

FromCDDL

Transform between tuple CDDL shape and class.

Signature

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

arbitrary

Arbitrary generator for BootstrapWitness instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<BootstrapWitness>