cardano-web3-js / CML / PlutusMap

Class: PlutusMap

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

Methods

free()

free(): void

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

Returns

void

---

get()

get(key): PlutusData

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

Gets the plutus datum corresponding to a given key, if it exists. Note: In the case of duplicate keys this only returns the first datum. This is an extremely rare occurence on-chain but can happen.

Parameters

key

PlutusData

Returns

PlutusData

---

get_all()

get_all(key): PlutusDataList

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

In the extremely unlikely situation there are duplicate keys, this gets all of a single key

Parameters

key

PlutusData

Returns

PlutusDataList

---

is_empty()

is_empty(): boolean

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

Returns

boolean

---

keys()

keys(): PlutusDataList

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

Returns

PlutusDataList

---

len()

len(): number

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

Returns

number

---

set()

set(key, value): void

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

Replaces all datums of a given key, if any exist.

Parameters

key

PlutusData

value

PlutusData

Returns

void

---

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

• 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:4481

• 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:4455

• 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:4475

• 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

---

from_cbor_bytes()

static from_cbor_bytes(cbor_bytes): PlutusMap

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

• Create this type from CBOR bytes

Parameters

cbor_bytes

Uint8Array

Returns

PlutusMap

---

from_cbor_hex()

static from_cbor_hex(cbor_bytes): PlutusMap

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

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

Parameters

cbor_bytes

string

Returns

PlutusMap

---

new()

static new(): PlutusMap

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

Returns

PlutusMap