cardano-web3-js / CML / CIP25Metadata

Class: CIP25Metadata

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

This is the entire metadata schema for CIP-25 It can be parsed by passing in the CBOR bytes of the entire transaction metadata or by passing in an existing Metadata struct. Parsing from CBOR bytes should be marginally faster.

Methods

add_to_metadata()

add_to_metadata(metadata): void

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

Add to an existing metadata (could be empty) the full CIP25 metadata

Parameters

metadata

Metadata

Returns

void

---

free()

free(): void

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

Returns

void

---

key_721()

key_721(): CIP25LabelMetadata

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

The core details of the CIP25 spec

Returns

CIP25LabelMetadata

---

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:1534

Serialize to CBOR bytes compatible with tx metadata Does not guarantee any specific type of CBOR format and should NOT be used with round-tripping. It will ignore all non-CIP25 keys. Use cml_cip25::metadate crate for round-tripping metadata.

Returns

Uint8Array

---

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:1526

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:1525

Returns

string

---

to_metadata()

to_metadata(): Metadata

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

Create a Metadata containing only the CIP25 schema

Returns

Metadata

---

from_cbor_bytes()

static from_cbor_bytes(data): CIP25Metadata

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

Deserialize from CBOR bytes compatible with tx metadata Does not guarantee any specific type of CBOR format and should NOT be used with round-tripping. It will ignore all non-CIP25 keys. Use cml_cip25::metadate crate for round-tripping metadata.

Parameters

data

Uint8Array

Returns

CIP25Metadata

---

from_json()

static from_json(json): CIP25Metadata

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

Parameters

json

string

Returns

CIP25Metadata

---

from_metadata()

static from_metadata(metadata): CIP25Metadata

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

Read the CIP25 schema from a Metadata. Ignores all other data besides CIP25 Can fail if the Metadata does not conform to CIP25

Parameters

metadata

Metadata

Returns

CIP25Metadata

---

new()

static new(key_721): CIP25Metadata

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

Parameters

key_721

CIP25LabelMetadata

Returns

CIP25Metadata