Evolution SDK

DataJson.ts

DataJson overview


Table of contents


utils

ByteArray

Signature

export declare const ByteArray: Schema.Struct<{ bytes: Schema.filter<Schema.Schema<string, string, never>> }>

ByteArray (interface)

Signature

export interface ByteArray {
  readonly bytes: string
}

Constr

Signature

export declare const Constr: Schema.Struct<{
  constructor: typeof Schema.Number
  fields: Schema.Array$<Schema.suspend<Data, Data, never>>
}>

Constr (interface)

Signature

export interface Constr {
  readonly constructor: number
  readonly fields: ReadonlyArray<Data>
}

Data

Signature

export declare const Data: Schema.Schema<Data, Data, never>

Data (type alias)

Plutus data types and schemas for serialization/deserialization between TypeScript types and Cardano's Plutus data format

Signature

export type Data = Integer | ByteArray | List | Map | Constr

Added in v1.0.0

Integer

Signature

export declare const Integer: Schema.Struct<{ int: typeof Schema.Number }>

Integer (interface)

Signature

export interface Integer {
  readonly int: number
}

List

Signature

export declare const List: Schema.Array$<Schema.suspend<Data, Data, never>>

List (interface)

Signature

export interface List extends ReadonlyArray<Data> {}

Map

Signature

export declare const Map: Schema.Record$<typeof Schema.String, Schema.suspend<Data, Data, never>>

Map (type alias)

Signature

export type Map = {
  readonly [key: string]: Data
}

isByteArray

Signature

export declare const isByteArray: (
  u: unknown,
  overrideOptions?: ParseOptions | number
) => u is { readonly bytes: string }

isConstr

Signature

export declare const isConstr: (
  u: unknown,
  overrideOptions?: ParseOptions | number
) => u is { readonly fields: readonly Data[]; readonly constructor: number }

isInteger

Signature

export declare const isInteger: (u: unknown, overrideOptions?: ParseOptions | number) => u is { readonly int: number }

isList

Signature

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

isMap

Signature

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

mkConstr (interface)

Signature

export interface mkConstr<T extends Data> {
  readonly constructor: number
  readonly fields: ReadonlyArray<T>
}