Evolution SDK

AuxiliaryDataHash.ts

AuxiliaryDataHash overview

Auxiliary Data Hash module - provides an alias for Bytes32 specialized for auxiliary data hashing.

In Cardano, auxiliary_data_hash = Bytes32, representing a 32-byte hash used for auxiliary data (metadata) attached to transactions.

Added in v2.0.0


Table of contents


arbitrary

arbitrary

FastCheck arbitrary for generating random AuxiliaryDataHash instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<AuxiliaryDataHash>

Added in v2.0.0

encoding

toBytes

Encode AuxiliaryDataHash to bytes.

Signature

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

Added in v2.0.0

toHex

Encode AuxiliaryDataHash to hex string.

Signature

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

Added in v2.0.0

model

AuxiliaryDataHash (class)

Schema for AuxiliaryDataHash representing auxiliary data hashes. auxiliary_data_hash = Bytes32

Signature

export declare class AuxiliaryDataHash

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 AuxiliaryDataHash from bytes.

Signature

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

Added in v2.0.0

fromHex

Parse AuxiliaryDataHash from hex string.

Signature

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

Added in v2.0.0

predicates

isAuxiliaryDataHash

Check if the given value is a valid AuxiliaryDataHash

Signature

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

Added in v2.0.0

utils

BytesSchema

Signature

export declare const BytesSchema: Schema.transform<
  Schema.SchemaClass<Uint8Array, Uint8Array, never>,
  Schema.SchemaClass<AuxiliaryDataHash, AuxiliaryDataHash, never>
>

FromBytes

Signature

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

FromHex

Signature

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

HexSchema

Signature

export declare const HexSchema: Schema.transform<
  Schema.filter<Schema.Schema<Uint8Array, string, never>>,
  Schema.transform<
    Schema.SchemaClass<Uint8Array, Uint8Array, never>,
    Schema.SchemaClass<AuxiliaryDataHash, AuxiliaryDataHash, never>
  >
>