Skip to content

cardano-web3-js / CML / AuxiliaryData

Class: AuxiliaryData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:813

Methods

add()

add(other): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:843

Adds everything present in other to self May change the era the aux data is in if necessary Warning: overwrites any metadatum labels present also does not check for duplicates in scripts

Parameters

other

AuxiliaryData

Returns

void


add_metadata()

add_metadata(other): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:824

Warning: overwrites any conflicting metadatum labels present

Parameters

other

Metadata

Returns

void


add_native_scripts()

add_native_scripts(scripts): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:828

Warning: does not check for duplicates and may migrate eras

Parameters

scripts

NativeScriptList

Returns

void


add_plutus_v1_scripts()

add_plutus_v1_scripts(scripts): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:832

Warning: does not check for duplicates and may migrate eras

Parameters

scripts

PlutusV1ScriptList

Returns

void


add_plutus_v2_scripts()

add_plutus_v2_scripts(scripts): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:836

Warning: does not check for duplicates and may migrate eras

Parameters

scripts

PlutusV2ScriptList

Returns

void


as_conway()

as_conway(): ConwayFormatAuxData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:894

Returns

ConwayFormatAuxData


as_shelley()

as_shelley(): Metadata

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:892

Returns

Metadata


as_shelley_ma()

as_shelley_ma(): ShelleyMAFormatAuxData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:893

Returns

ShelleyMAFormatAuxData


free()

free(): void

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:815

Returns

void


kind()

kind(): AuxiliaryDataKind

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:891

Returns

AuxiliaryDataKind


metadata()

metadata(): Metadata

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:817

Returns

Metadata


native_scripts()

native_scripts(): NativeScriptList

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:818

Returns

NativeScriptList


plutus_v1_scripts()

plutus_v1_scripts(): PlutusV1ScriptList

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:819

Returns

PlutusV1ScriptList


plutus_v2_scripts()

plutus_v2_scripts(): PlutusV2ScriptList

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:820

Returns

PlutusV2ScriptList


to_canonical_cbor_bytes()

to_canonical_cbor_bytes(): Uint8Array

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:857

  • Serialize this type to CBOR bytes using canonical CBOR encodings

Returns

Uint8Array


to_canonical_cbor_hex()

to_canonical_cbor_hex(): string

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:877

  • Serialize this type to CBOR bytes using canonical CBOR encodings as hex bytes

Returns

string


to_cbor_bytes()

to_cbor_bytes(): Uint8Array

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:851

  • Serialize this type to CBOR bytes * This type type supports encoding preservation so this will preserve round-trip CBOR formats. * If created from scratch the CBOR will be canonical.

Returns

Uint8Array


to_cbor_hex()

to_cbor_hex(): string

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:871

  • Serialize this type to CBOR bytes encoded as a hex string (useful for working with CIP30). * This type type supports encoding preservation so this will preserve round-trip CBOR formats. * If created from scratch the CBOR will be canonical.

Returns

string


to_js_value()

to_js_value(): any

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:886

Returns

any


to_json()

to_json(): string

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:885

Returns

string


from_cbor_bytes()

static from_cbor_bytes(cbor_bytes): AuxiliaryData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:863

  • Create this type from CBOR bytes

Parameters

cbor_bytes

Uint8Array

Returns

AuxiliaryData


from_cbor_hex()

static from_cbor_hex(cbor_bytes): AuxiliaryData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:884

  • Create this type from the CBOR bytes encoded as a hex string. * This is useful for interfacing with CIP30

Parameters

cbor_bytes

string

Returns

AuxiliaryData


from_json()

static from_json(json): AuxiliaryData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:887

Parameters

json

string

Returns

AuxiliaryData


new()

static new(): AuxiliaryData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:816

Returns

AuxiliaryData


new_conway()

static new_conway(conway): AuxiliaryData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:890

Parameters

conway

ConwayFormatAuxData

Returns

AuxiliaryData


new_shelley()

static new_shelley(shelley): AuxiliaryData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:888

Parameters

shelley

Metadata

Returns

AuxiliaryData


new_shelley_ma()

static new_shelley_ma(shelley_ma): AuxiliaryData

Defined in: node_modules/cardano-wasm-libs/src/libs/cardano-multiplatform-lib/nodejs/cardano_multiplatform_lib.d.ts:889

Parameters

shelley_ma

ShelleyMAFormatAuxData

Returns

AuxiliaryData

Released under the MIT License