Evolution SDK
Modules

CBOR.ts

CBOR overview

Table of contents

constants

AIKEN_DEFAULT_OPTIONS

Aiken-compatible CBOR encoding options

Matches the encoding used by Aiken's cbor.serialise():

  • Indefinite-length arrays (9f...ff)
  • Maps encoded as arrays of pairs (not CBOR maps)
  • Strings as bytearrays (major type 2, not 3)
  • Constructor tags: 121-127 for indices 0-6, then 1280+ for 7+

Signature

export declare const AIKEN_DEFAULT_OPTIONS: CodecOptions

Added in v2.0.0

CANONICAL_OPTIONS

Canonical CBOR encoding options (RFC 8949 Section 4.2.1)

Signature

export declare const CANONICAL_OPTIONS: CodecOptions

Added in v1.0.0

CARDANO_NODE_DATA_OPTIONS

Cardano Node compatible CBOR encoding options for PlutusData

Uses definite-length encoding for arrays and maps, matching the format produced by CML's to_cardano_node_format().to_cbor_hex().

Note: The on-chain format uses indefinite-length (AIKEN_DEFAULT_OPTIONS), but this option is useful for testing compatibility with tools that expect definite-length encoding.

Signature

export declare const CARDANO_NODE_DATA_OPTIONS: CodecOptions

Added in v2.0.0

CBOR_ADDITIONAL_INFO

CBOR additional information constants

Signature

export declare const CBOR_ADDITIONAL_INFO: {
  readonly DIRECT: 24
  readonly UINT16: 25
  readonly UINT32: 26
  readonly UINT64: 27
  readonly INDEFINITE: 31
}

Added in v1.0.0

CBOR_MAJOR_TYPE

CBOR major types as constants

Signature

export declare const CBOR_MAJOR_TYPE: {
  readonly UNSIGNED_INTEGER: 0
  readonly NEGATIVE_INTEGER: 1
  readonly BYTE_STRING: 2
  readonly TEXT_STRING: 3
  readonly ARRAY: 4
  readonly MAP: 5
  readonly TAG: 6
  readonly SIMPLE_FLOAT: 7
}

Added in v1.0.0

CBOR_SIMPLE

Simple value constants for CBOR

Signature

export declare const CBOR_SIMPLE: { readonly FALSE: 20; readonly TRUE: 21; readonly NULL: 22; readonly UNDEFINED: 23 }

Added in v1.0.0

CML_DATA_DEFAULT_OPTIONS

Default CBOR encoding option for Data

Signature

export declare const CML_DATA_DEFAULT_OPTIONS: CodecOptions

Added in v1.0.0

CML_DEFAULT_OPTIONS

Default CBOR encoding options

Signature

export declare const CML_DEFAULT_OPTIONS: CodecOptions

Added in v1.0.0

STRUCT_FRIENDLY_OPTIONS

CBOR encoding options that return objects instead of Maps for Schema.Struct compatibility

Signature

export declare const STRUCT_FRIENDLY_OPTIONS: CodecOptions

Added in v2.0.0

encoding

toCBORBytes

Convert a CBOR value to CBOR bytes.

Signature

export declare const toCBORBytes: (value: CBOR, options?: CodecOptions) => Uint8Array

Added in v1.0.0

toCBORHex

Convert a CBOR value to CBOR hex string.

Signature

export declare const toCBORHex: (value: CBOR, options?: CodecOptions) => string

Added in v1.0.0

errors

CBORError (class)

Error class for CBOR value operations

Signature

export declare class CBORError

Added in v1.0.0

model

CBOR (type alias)

Type representing a CBOR value with simplified, non-tagged structure

Signature

export type CBOR =
  | bigint // integers (both positive and negative)
  | Uint8Array // byte strings
  | string // text strings
  | ReadonlyArray<CBOR> // arrays
  | ReadonlyMap<CBOR, CBOR> // maps
  | { readonly [key: string | number]: CBOR } // record alternative to maps
  | { _tag: "Tag"; tag: number; value: CBOR } // tagged values
  | boolean // boolean values
  | null // null value
  | undefined // undefined value
  | number

Added in v1.0.0

CodecOptions (type alias)

CBOR codec configuration options

Signature

export type CodecOptions =
  | {
      readonly mode: "canonical"
      readonly mapsAsObjects?: boolean
      readonly encodeMapAsPairs?: boolean
    }
  | {
      readonly mode: "custom"
      readonly useIndefiniteArrays: boolean
      readonly useIndefiniteMaps: boolean
      readonly useDefiniteForEmpty: boolean
      readonly sortMapKeys: boolean
      readonly useMinimalEncoding: boolean
      readonly mapsAsObjects?: boolean
      readonly encodeMapAsPairs?: boolean
    }

Added in v1.0.0

parsing

fromCBORBytes

Parse a CBOR value from CBOR bytes.

Signature

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

Added in v1.0.0

fromCBORHex

Parse a CBOR value from CBOR hex string.

Signature

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

Added in v1.0.0

schemas

CBORSchema

CBOR Value discriminated union schema representing all possible CBOR data types Inspired by OCaml and Rust CBOR implementations

Signature

export declare const CBORSchema: Schema.Schema<CBOR, CBOR, never>

Added in v1.0.0

FromBytes

Create a CBOR bytes schema with custom codec options

Signature

export declare const FromBytes: (
  options: CodecOptions
) => Schema.transformOrFail<typeof Schema.Uint8ArrayFromSelf, Schema.declare<CBOR, CBOR, readonly [], never>, never>

Added in v1.0.0

Integer

CBOR Value schema definitions for each major type

Signature

export declare const Integer: typeof Schema.BigIntFromSelf

Added in v1.0.0

transformation

match

Pattern matching utility for CBOR values

Signature

export declare const match: <R>(
  value: CBOR,
  patterns: {
    integer: (value: bigint) => R
    bytes: (value: Uint8Array) => R
    text: (value: string) => R
    array: (value: ReadonlyArray<CBOR>) => R
    map: (value: ReadonlyMap<CBOR, CBOR>) => R
    record: (value: { readonly [key: string]: CBOR }) => R
    tag: (tag: number, value: CBOR) => R
    boolean: (value: boolean) => R
    null: () => R
    undefined: () => R
    float: (value: number) => R
  }
) => R

Added in v1.0.0

utils

ArraySchema

Signature

export declare const ArraySchema: Schema.Array$<Schema.suspend<CBOR, CBOR, never>>

ByteArray

Signature

export declare const ByteArray: typeof Schema.Uint8ArrayFromSelf

Either (namespace)

Float

Signature

export declare const Float: typeof Schema.Number

FromHex

Signature

export declare const FromHex: (
  options: CodecOptions
) => Schema.transform<
  Schema.Schema<Uint8Array, string, never>,
  Schema.transformOrFail<typeof Schema.Uint8ArrayFromSelf, Schema.declare<CBOR, CBOR, readonly [], never>, never>
>

MapSchema

Signature

export declare const MapSchema: Schema.ReadonlyMapFromSelf<
  Schema.suspend<CBOR, CBOR, never>,
  Schema.suspend<CBOR, CBOR, never>
>

RecordSchema

Signature

export declare const RecordSchema: Schema.Record$<typeof Schema.String, Schema.suspend<CBOR, CBOR, never>>

Simple

Signature

export declare const Simple: Schema.Union<[typeof Schema.Boolean, typeof Schema.Null, typeof Schema.Undefined]>

Tag

Signature

export declare const Tag: Schema.TaggedStruct<
  "Tag",
  { tag: typeof Schema.Number; value: Schema.suspend<CBOR, CBOR, never> }
>

Text

Signature

export declare const Text: typeof Schema.String

encodeArrayAsDefinite

Encode a CBOR definite-length array from already-encoded item bytes. This is a low-level function that constructs: definite_array_header + items.

Signature

export declare const encodeArrayAsDefinite: (items: ReadonlyArray<Uint8Array>) => Uint8Array

encodeArrayAsIndefinite

Encode a CBOR indefinite-length array from already-encoded item bytes. This is a low-level function that constructs: 0x9f + items + 0xff.

Signature

export declare const encodeArrayAsIndefinite: (items: ReadonlyArray<Uint8Array>) => Uint8Array

encodeTaggedValue

Encode a CBOR tagged value from already-encoded value bytes. This is a low-level function that constructs: tag_header + value_bytes.

Signature

export declare const encodeTaggedValue: (tag: number, valueBytes: Uint8Array) => Uint8Array

internalDecodeSync

Signature

export declare const internalDecodeSync: (data: Uint8Array, options?: CodecOptions) => CBOR

internalEncodeSync

Signature

export declare const internalEncodeSync: (value: CBOR, options?: CodecOptions) => Uint8Array

isArray

Signature

export declare const isArray: (u: unknown, overrideOptions?: ParseOptions | number) => u is readonly CBOR[]

isByteArray

Signature

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

isInteger

Signature

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

isMap

Signature

export declare const isMap: (u: unknown, overrideOptions?: ParseOptions | number) => u is ReadonlyMap<CBOR, CBOR>

isRecord

Signature

export declare const isRecord: (
  u: unknown,
  overrideOptions?: ParseOptions | number
) => u is { readonly [x: string]: CBOR }

isTag

Signature

export declare const isTag: (
  u: unknown,
  overrideOptions?: ParseOptions | number
) => u is { readonly _tag: "Tag"; readonly tag: number; readonly value: CBOR }

map

Signature

export declare const map: <K extends CBOR, V extends CBOR>(
  key: Schema.Schema<K>,
  value: Schema.Schema<V>
) => Schema.ReadonlyMapFromSelf<Schema.Schema<K, K, never>, Schema.Schema<V, V, never>>

tag

Signature

export declare const tag: <T extends number, C extends Schema.Schema<any, any>>(
  tag: T,
  value: C
) => Schema.TaggedStruct<"Tag", { tag: Schema.Literal<[T]>; value: C }>

Bytes96.ts

Previous Page

Certificate.ts

Next Page

On this page

CBOR overviewconstantsAIKEN_DEFAULT_OPTIONSCANONICAL_OPTIONSCARDANO_NODE_DATA_OPTIONSCBOR_ADDITIONAL_INFOCBOR_MAJOR_TYPECBOR_SIMPLECML_DATA_DEFAULT_OPTIONSCML_DEFAULT_OPTIONSSTRUCT_FRIENDLY_OPTIONSencodingtoCBORBytestoCBORHexerrorsCBORError (class)modelCBOR (type alias)CodecOptions (type alias)parsingfromCBORBytesfromCBORHexschemasCBORSchemaFromBytesIntegertransformationmatchutilsArraySchemaByteArrayEither (namespace)FloatFromHexMapSchemaRecordSchemaSimpleTagTextencodeArrayAsDefiniteencodeArrayAsIndefiniteencodeTaggedValueinternalDecodeSyncinternalEncodeSyncisArrayisByteArrayisIntegerisMapisRecordisTagmaptag