Evolution SDK
Modules

Function.ts

Function overview

Table of contents

constructors

makeCBORDecodeSync

Creates a synchronous function that decodes CBOR bytes into a value using a schema. This pairs with makeCBOREncodeSync and avoids extra FromCBOR* transformers by using FromCDDL directly.

Signature

export declare const makeCBORDecodeSync: <A, T extends CBOR.CBOR, E extends Error>(
  schemaTransformer: Schema.Schema<A, T>,
  ErrorClass: ErrorCtor<E>,
  functionName: string,
  defaultOptions?: CBOR.CodecOptions
) => (bytes: Uint8Array, options?: CBOR.CodecOptions) => A

Added in v2.0.0

makeCBOREncodeSync

Creates a synchronous function that encodes a value to CBOR bytes. Combines schema encoding with CBOR serialization in one step.

Signature

export declare const makeCBOREncodeSync: <A, T extends CBOR.CBOR, E extends Error>(
  schemaTransformer: Schema.Schema<A, T>,
  ErrorClass: ErrorCtor<E>,
  functionName: string,
  defaultOptions?: CBOR.CodecOptions
) => (input: A, options?: CBOR.CodecOptions) => Uint8Array

Added in v2.0.0

utils

makeCBORDecodeEither

Creates a function that decodes CBOR bytes into a value using a schema, returning Either.

Signature

export declare const makeCBORDecodeEither: <A, T extends CBOR.CBOR, E extends Error>(
  schemaTransformer: Schema.Schema<A, T>,
  ErrorClass: ErrorCtor<E>,
  defaultOptions?: CBOR.CodecOptions
) => (bytes: Uint8Array, options?: CBOR.CodecOptions) => Either.Either<A, E>

makeCBORDecodeHexEither

Creates a function that decodes CBOR hex string into a value using a schema, returning Either.

Signature

export declare const makeCBORDecodeHexEither: <A, T extends CBOR.CBOR, E extends Error>(
  schemaTransformer: Schema.Schema<A, T>,
  ErrorClass: ErrorCtor<E>,
  defaultOptions?: CBOR.CodecOptions
) => (hex: string, options?: CBOR.CodecOptions) => Either.Either<A, E>

makeCBORDecodeHexSync

Creates a synchronous function that decodes a CBOR hex string into a value using a schema.

Signature

export declare const makeCBORDecodeHexSync: <A, T extends CBOR.CBOR, E extends Error>(
  schemaTransformer: Schema.Schema<A, T>,
  ErrorClass: ErrorCtor<E>,
  functionName: string,
  defaultOptions?: CBOR.CodecOptions
) => (hex: string, options?: CBOR.CodecOptions) => A

makeCBOREncodeEither

Creates a function that encodes a value to CBOR bytes using a schema, returning Either.

Signature

export declare const makeCBOREncodeEither: <A, T extends CBOR.CBOR, E extends Error>(
  schemaTransformer: Schema.Schema<A, T>,
  ErrorClass: ErrorCtor<E>,
  defaultOptions?: CBOR.CodecOptions
) => (value: A, options?: CBOR.CodecOptions) => Either.Either<Uint8Array, E>

makeCBOREncodeHexEither

Creates a function that encodes a value to CBOR hex string using a schema, returning Either.

Signature

export declare const makeCBOREncodeHexEither: <A, T extends CBOR.CBOR, E extends Error>(
  schemaTransformer: Schema.Schema<A, T>,
  ErrorClass: ErrorCtor<E>,
  defaultOptions?: CBOR.CodecOptions
) => (input: A, options?: CBOR.CodecOptions) => Either.Either<string, E>

makeCBOREncodeHexSync

Creates a synchronous function that encodes a value to CBOR hex string. Uses a schema to encode T -> A then serializes to hex.

Signature

export declare const makeCBOREncodeHexSync: <A, T extends CBOR.CBOR, E extends Error>(
  schemaTransformer: Schema.Schema<A, T>,
  ErrorClass: ErrorCtor<E>,
  functionName: string,
  defaultOptions?: CBOR.CodecOptions
) => (input: A, options?: CBOR.CodecOptions) => string

makeDecodeEither

Signature

export declare const makeDecodeEither: <T, A, E extends Error>(
  schema: Schema.Schema<T, A>,
  ErrorClass: ErrorCtor<E>
) => (input: A) => Either.Either<T, E>

makeDecodeSync

Creates a named function with proper stack traces using dynamic object property

Signature

export declare const makeDecodeSync: <T, A, E extends Error>(
  schemaTransformer: Schema.Schema<T, A>,
  ErrorClass: ErrorCtor<E>,
  functionName: string
) => (input: A) => T

makeEncodeEither

Signature

export declare const makeEncodeEither: <T, A, E extends Error>(
  schema: Schema.Schema<T, A>,
  ErrorClass: ErrorCtor<E>
) => (input: T) => Either.Either<A, E>

makeEncodeSync

Signature

export declare const makeEncodeSync: <T, A, E extends Error>(
  schemaTransformer: Schema.Schema<T, A>,
  ErrorClass: ErrorCtor<E>,
  functionName: string
) => (input: T) => A

FormatError.ts

Previous Page

GovernanceAction.ts

Next Page

On this page

Function overviewconstructorsmakeCBORDecodeSyncmakeCBOREncodeSyncutilsmakeCBORDecodeEithermakeCBORDecodeHexEithermakeCBORDecodeHexSyncmakeCBOREncodeEithermakeCBOREncodeHexEithermakeCBOREncodeHexSyncmakeDecodeEithermakeDecodeSyncmakeEncodeEithermakeEncodeSync