Evolution SDK
Modules

AuxiliaryData.ts

AuxiliaryData overview

Table of contents

arbitrary

arbitrary

FastCheck arbitrary for generating random AuxiliaryData instances. Generates all three era formats with equal probability.

Signature

export declare const arbitrary: FastCheck.Arbitrary<ConwayAuxiliaryData | ShelleyMAAuxiliaryData | ShelleyAuxiliaryData>

Added in v2.0.0

conwayArbitrary

FastCheck arbitrary for generating Conway-era AuxiliaryData instances. Conway era supports all features: metadata, native scripts, and all Plutus script versions.

Signature

export declare const conwayArbitrary: FastCheck.Arbitrary<ConwayAuxiliaryData>

Added in v2.0.0

constructors

conway

Create a Conway-era AuxiliaryData instance.

Signature

export declare const conway: (input: {
  metadata?: Metadata.Metadata
  nativeScripts?: Array<NativeScripts.NativeScript>
  plutusV1Scripts?: Array<PlutusV1.PlutusV1>
  plutusV2Scripts?: Array<PlutusV2.PlutusV2>
  plutusV3Scripts?: Array<PlutusV3.PlutusV3>
}) => AuxiliaryData

Added in v2.0.0

emptyConwayAuxiliaryData

Create an empty Conway AuxiliaryData instance.

Signature

export declare const emptyConwayAuxiliaryData: () => AuxiliaryData

Added in v2.0.0

shelley

Create a Shelley-era AuxiliaryData instance.

Signature

export declare const shelley: (input: { metadata: Metadata.Metadata }) => AuxiliaryData

Added in v2.0.0

shelleyMA

Create a ShelleyMA-era AuxiliaryData instance.

Signature

export declare const shelleyMA: (input: {
  metadata?: Metadata.Metadata
  nativeScripts?: Array<NativeScripts.NativeScript>
}) => AuxiliaryData

Added in v2.0.0

encoding

toCBORBytes

Encode AuxiliaryData to CBOR bytes.

Signature

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

Added in v2.0.0

toCBORHex

Encode AuxiliaryData to CBOR hex string.

Signature

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

Added in v2.0.0

hashing

toHash

Compute hash of auxiliary data (tag 259) per ledger rules.

Pass the same codec options used to serialize the transaction's auxiliary data. Set the resulting body commitment before signing; changing encoding afterward can invalidate the commitment and existing signatures.

Signature

export declare const toHash: (aux: AuxiliaryData, options?: CBOR.CodecOptions) => AuxiliaryDataHash.AuxiliaryDataHash

Added in v2.0.0

model

AuxiliaryData

Union of all AuxiliaryData era formats.

Signature

export declare const AuxiliaryData: Schema.Union<
  [typeof ConwayAuxiliaryData, typeof ShelleyMAAuxiliaryData, typeof ShelleyAuxiliaryData]
>

Added in v2.0.0

AuxiliaryData (type alias)

Type representing any AuxiliaryData format.

Signature

export type AuxiliaryData = Schema.Schema.Type<typeof AuxiliaryData>

Added in v2.0.0

ConwayAuxiliaryData (class)

AuxiliaryData based on Conway CDDL specification.

CDDL (Conway era):

auxiliary_data = {
  ? 0 => metadata           ; transaction_metadata
  ? 1 => [* native_script]  ; native_scripts
  ? 2 => [* plutus_v1_script] ; plutus_v1_scripts
  ? 3 => [* plutus_v2_script] ; plutus_v2_scripts
  ? 4 => [* plutus_v3_script] ; plutus_v3_scripts
}

Uses map format with numeric keys as per Conway specification.

Signature

export declare class ConwayAuxiliaryData

Added in v2.0.0

toJSON (method)

Signature

toJSON()

Added in v2.0.0

toString (method)

Signature

toString(): string

Added in v2.0.0

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

Added in v2.0.0

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

Added in v2.0.0

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

Added in v2.0.0

ShelleyAuxiliaryData (class)

AuxiliaryData for Shelley era (direct metadata).

CDDL (Shelley era):

auxiliary_data = metadata

Signature

export declare class ShelleyAuxiliaryData

Added in v2.0.0

toJSON (method)

Signature

toJSON()

Added in v2.0.0

toString (method)

Signature

toString(): string

Added in v2.0.0

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

Added in v2.0.0

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

Added in v2.0.0

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

Added in v2.0.0

ShelleyMAAuxiliaryData (class)

AuxiliaryData for ShelleyMA era (array format).

CDDL (ShelleyMA era):

auxiliary_data = [ metadata?, [* native_script]? ]

Signature

export declare class ShelleyMAAuxiliaryData

Added in v2.0.0

toJSON (method)

Signature

toJSON()

Added in v2.0.0

toString (method)

Signature

toString(): string

Added in v2.0.0

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

Added in v2.0.0

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

Added in v2.0.0

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

Added in v2.0.0

parsing

fromCBORBytes

Decode AuxiliaryData from CBOR bytes.

Signature

export declare const fromCBORBytes: (
  bytes: Uint8Array,
  options?: CBOR.CodecOptions
) => ConwayAuxiliaryData | ShelleyMAAuxiliaryData | ShelleyAuxiliaryData

Added in v2.0.0

fromCBORHex

Decode AuxiliaryData from CBOR hex string.

Signature

export declare const fromCBORHex: (
  hex: string,
  options?: CBOR.CodecOptions
) => ConwayAuxiliaryData | ShelleyMAAuxiliaryData | ShelleyAuxiliaryData

Added in v2.0.0

schemas

CDDLSchema

Tagged CDDL schema for AuxiliaryData (#6.259 wrapping the struct).

Signature

export declare const CDDLSchema: Schema.TaggedStruct<
  "Tag",
  {
    tag: Schema.Literal<[259]>
    value: Schema.MapFromSelf<typeof Schema.BigIntFromSelf, Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>>
  }
>

Added in v2.0.0

FromCBORBytes

CBOR bytes transformation schema for AuxiliaryData. Transforms between CBOR bytes and AuxiliaryData using CDDL 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.Union<
      [
        Schema.TaggedStruct<
          "Tag",
          {
            tag: Schema.Literal<[259]>
            value: Schema.MapFromSelf<typeof Schema.BigIntFromSelf, Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>>
          }
        >,
        Schema.Array$<Schema.suspend<CBOR.CBOR, CBOR.CBOR, never>>,
        Schema.MapFromSelf<
          typeof Schema.BigIntFromSelf,
          Schema.suspend<
            | string
            | bigint
            | Uint8Array
            | Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
            | readonly TransactionMetadatum.TransactionMetadatum[],
            | string
            | bigint
            | Uint8Array
            | Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
            | readonly TransactionMetadatum.TransactionMetadatum[],
            never
          >
        >
      ]
    >,
    Schema.SchemaClass<
      ConwayAuxiliaryData | ShelleyMAAuxiliaryData | ShelleyAuxiliaryData,
      ConwayAuxiliaryData | ShelleyMAAuxiliaryData | ShelleyAuxiliaryData,
      never
    >,
    never
  >
>

Added in v2.0.0

FromCBORHex

CBOR hex transformation schema for AuxiliaryData. Transforms between CBOR hex string and AuxiliaryData using CDDL 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.Union<
        [
          Schema.TaggedStruct<
            "Tag",
            {
              tag: Schema.Literal<[259]>
              value: Schema.MapFromSelf<typeof Schema.BigIntFromSelf, Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>>
            }
          >,
          Schema.Array$<Schema.suspend<CBOR.CBOR, CBOR.CBOR, never>>,
          Schema.MapFromSelf<
            typeof Schema.BigIntFromSelf,
            Schema.suspend<
              | string
              | bigint
              | Uint8Array
              | Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
              | readonly TransactionMetadatum.TransactionMetadatum[],
              | string
              | bigint
              | Uint8Array
              | Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
              | readonly TransactionMetadatum.TransactionMetadatum[],
              never
            >
          >
        ]
      >,
      Schema.SchemaClass<
        ConwayAuxiliaryData | ShelleyMAAuxiliaryData | ShelleyAuxiliaryData,
        ConwayAuxiliaryData | ShelleyMAAuxiliaryData | ShelleyAuxiliaryData,
        never
      >,
      never
    >
  >
>

Added in v2.0.0

utils

FromCDDL

Signature

export declare const FromCDDL: Schema.transformOrFail<
  Schema.Union<
    [
      Schema.TaggedStruct<
        "Tag",
        {
          tag: Schema.Literal<[259]>
          value: Schema.MapFromSelf<typeof Schema.BigIntFromSelf, Schema.Schema<CBOR.CBOR, CBOR.CBOR, never>>
        }
      >,
      Schema.Array$<Schema.suspend<CBOR.CBOR, CBOR.CBOR, never>>,
      Schema.MapFromSelf<
        typeof Schema.BigIntFromSelf,
        Schema.suspend<
          | string
          | bigint
          | Uint8Array
          | Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
          | readonly TransactionMetadatum.TransactionMetadatum[],
          | string
          | bigint
          | Uint8Array
          | Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
          | readonly TransactionMetadatum.TransactionMetadatum[],
          never
        >
      >
    ]
  >,
  Schema.SchemaClass<
    ConwayAuxiliaryData | ShelleyMAAuxiliaryData | ShelleyAuxiliaryData,
    ConwayAuxiliaryData | ShelleyMAAuxiliaryData | ShelleyAuxiliaryData,
    never
  >,
  never
>

empty

Backwards-friendly helper returning empty Conway-format auxiliary data. Alias kept for ergonomics and CML-compat tests.

Signature

export declare const empty: () => AuxiliaryData

shelleyArbitrary

Signature

export declare const shelleyArbitrary: FastCheck.Arbitrary<ShelleyAuxiliaryData>

shelleyMAArbitrary

Signature

export declare const shelleyMAArbitrary: FastCheck.Arbitrary<ShelleyMAAuxiliaryData>

Assets.ts

Previous Page

AuxiliaryDataHash.ts

Next Page

On this page

AuxiliaryData overviewarbitraryarbitraryconwayArbitraryconstructorsconwayemptyConwayAuxiliaryDatashelleyshelleyMAencodingtoCBORBytestoCBORHexhashingtoHashmodelAuxiliaryDataAuxiliaryData (type alias)ConwayAuxiliaryData (class)toJSON (method)toString (method)[Inspectable.NodeInspectSymbol] (method)[Equal.symbol] (method)[Hash.symbol] (method)ShelleyAuxiliaryData (class)toJSON (method)toString (method)[Inspectable.NodeInspectSymbol] (method)[Equal.symbol] (method)[Hash.symbol] (method)ShelleyMAAuxiliaryData (class)toJSON (method)toString (method)[Inspectable.NodeInspectSymbol] (method)[Equal.symbol] (method)[Hash.symbol] (method)parsingfromCBORBytesfromCBORHexschemasCDDLSchemaFromCBORBytesFromCBORHexutilsFromCDDLemptyshelleyArbitraryshelleyMAArbitrary