Evolution SDK
Modules

Redeemers.ts

Redeemers overview

Table of contents

arbitrary

arbitrary

FastCheck arbitrary for Redeemers.

Signature

export declare const arbitrary: FastCheck.Arbitrary<Redeemers>

Added in v2.0.0

encoding

toCBORBytes

Encode Redeemers to CBOR bytes (array format).

Signature

export declare const toCBORBytes: (data: Redeemers, options?: CBOR.CodecOptions) => any

Added in v2.0.0

toCBORBytesMap

Encode Redeemers to CBOR bytes (map format).

Signature

export declare const toCBORBytesMap: (data: Redeemers, options?: CBOR.CodecOptions) => any

Added in v2.0.0

toCBORHex

Encode Redeemers to CBOR hex string (array format).

Signature

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

Added in v2.0.0

toCBORHexMap

Encode Redeemers to CBOR hex string (map format).

Signature

export declare const toCBORHexMap: (data: Redeemers, options?: CBOR.CodecOptions) => string

Added in v2.0.0

model

Format (type alias)

Encoding format for redeemers collection.

Conway CDDL supports two formats:

; Flat Array support is included for backwards compatibility and
; will be removed in the next era. It is recommended for tools to
; adopt using a Map instead of Array going forward.
redeemers =
  [ + redeemer ]
  / { + [tag : redeemer_tag, index : uint .size 4] => [ data : plutus_data, ex_units : ex_units ] }
  • "array": Legacy flat array format - backwards compatible, will be deprecated
  • "map": New map format - recommended for Conway+

Signature

export type Format = "array" | "map"

Added in v2.0.0

Redeemers (class)

Redeemers collection based on Conway CDDL specification.

Represents a collection of redeemers that can be encoded in either array or map format.

Signature

export declare class Redeemers

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

fromCBORBytes

Parse Redeemers from CBOR bytes (array format).

Signature

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

Added in v2.0.0

fromCBORBytesMap

Parse Redeemers from CBOR bytes (map format).

Signature

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

Added in v2.0.0

fromCBORHex

Parse Redeemers from CBOR hex string (array format).

Signature

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

Added in v2.0.0

fromCBORHexMap

Parse Redeemers from CBOR hex string (map format).

Signature

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

Added in v2.0.0

schemas

ArrayCDDLSchema

CDDL schema for Redeemers in array format.

redeemers = [ + redeemer ]

Signature

export declare const ArrayCDDLSchema: Schema.Array$<
  Schema.Tuple<
    [
      Schema.SchemaClass<bigint, bigint, never>,
      Schema.SchemaClass<bigint, bigint, never>,
      Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
      Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
    ]
  >
>

Added in v2.0.0

CDDLSchema

Default CDDL schema for Redeemers (array format).

Signature

export declare const CDDLSchema: Schema.Array$<
  Schema.Tuple<
    [
      Schema.SchemaClass<bigint, bigint, never>,
      Schema.SchemaClass<bigint, bigint, never>,
      Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
      Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
    ]
  >
>

Added in v2.0.0

FromArrayCDDL

CDDL transformation schema for Redeemers array format.

Signature

export declare const FromArrayCDDL: Schema.transformOrFail<
  Schema.Array$<
    Schema.Tuple<
      [
        Schema.SchemaClass<bigint, bigint, never>,
        Schema.SchemaClass<bigint, bigint, never>,
        Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
        Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
      ]
    >
  >,
  Schema.SchemaClass<Redeemers, Redeemers, never>,
  never
>

Added in v2.0.0

FromCBORBytes

CBOR bytes transformation schema for Redeemers (array format).

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.Array$<
      Schema.Tuple<
        [
          Schema.SchemaClass<bigint, bigint, never>,
          Schema.SchemaClass<bigint, bigint, never>,
          Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
          Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
        ]
      >
    >,
    Schema.SchemaClass<Redeemers, Redeemers, never>,
    never
  >
>

Added in v2.0.0

FromCBORBytesMap

CBOR bytes transformation schema for Redeemers (map format).

Signature

export declare const FromCBORBytesMap: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.transformOrFail<
    typeof Schema.Uint8ArrayFromSelf,
    Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
    never
  >,
  Schema.transformOrFail<
    Schema.Map$<
      Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>,
      Schema.Tuple2<
        Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
        Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
      >
    >,
    Schema.SchemaClass<Redeemers, Redeemers, never>,
    never
  >
>

Added in v2.0.0

FromCBORHex

CBOR hex transformation schema for Redeemers (array format).

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.Array$<
        Schema.Tuple<
          [
            Schema.SchemaClass<bigint, bigint, never>,
            Schema.SchemaClass<bigint, bigint, never>,
            Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
            Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
          ]
        >
      >,
      Schema.SchemaClass<Redeemers, Redeemers, never>,
      never
    >
  >
>

Added in v2.0.0

FromCBORHexMap

CBOR hex transformation schema for Redeemers (map format).

Signature

export declare const FromCBORHexMap: (
  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.Map$<
        Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>,
        Schema.Tuple2<
          Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
          Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
        >
      >,
      Schema.SchemaClass<Redeemers, Redeemers, never>,
      never
    >
  >
>

Added in v2.0.0

FromCDDL

Default CDDL transformation (array format).

Signature

export declare const FromCDDL: Schema.transformOrFail<
  Schema.Array$<
    Schema.Tuple<
      [
        Schema.SchemaClass<bigint, bigint, never>,
        Schema.SchemaClass<bigint, bigint, never>,
        Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
        Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
      ]
    >
  >,
  Schema.SchemaClass<Redeemers, Redeemers, never>,
  never
>

Added in v2.0.0

FromMapCDDL

CDDL transformation schema for Redeemers map format.

Signature

export declare const FromMapCDDL: Schema.transformOrFail<
  Schema.Map$<
    Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>,
    Schema.Tuple2<
      Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
      Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
    >
  >,
  Schema.SchemaClass<Redeemers, Redeemers, never>,
  never
>

Added in v2.0.0

MapCDDLSchema

CDDL schema for Redeemers in map format.

{ + [tag, index] => [data, ex_units] }

Signature

export declare const MapCDDLSchema: Schema.Map$<
  Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>,
  Schema.Tuple2<
    Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>,
    Schema.Tuple2<typeof Schema.BigIntFromSelf, typeof Schema.BigIntFromSelf>
  >
>

Added in v2.0.0

Redeemer.ts

Previous Page

Relay.ts

Next Page

On this page

Redeemers overviewarbitraryarbitraryencodingtoCBORBytestoCBORBytesMaptoCBORHextoCBORHexMapmodelFormat (type alias)Redeemers (class)toJSON (method)toString (method)[Inspectable.NodeInspectSymbol] (method)[Equal.symbol] (method)[Hash.symbol] (method)parsingfromCBORBytesfromCBORBytesMapfromCBORHexfromCBORHexMapschemasArrayCDDLSchemaCDDLSchemaFromArrayCDDLFromCBORBytesFromCBORBytesMapFromCBORHexFromCBORHexMapFromCDDLFromMapCDDLMapCDDLSchema