cardano-web3-js / CML / PlutusData

Class: PlutusData

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

Methods

as_bytes()

as_bytes(): Uint8Array

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

Returns

Uint8Array

---

as_constr_plutus_data()

as_constr_plutus_data(): ConstrPlutusData

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

Returns

ConstrPlutusData

---

as_integer()

as_integer(): BigInteger

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

Returns

BigInteger

---

as_list()

as_list(): PlutusDataList

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

Returns

PlutusDataList

---

as_map()

as_map(): PlutusMap

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

Returns

PlutusMap

---

free()

free(): void

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

Returns

void

---

kind()

kind(): PlutusDataKind

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

Returns

PlutusDataKind

---

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

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

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

Returns

string

---

to_cardano_node_format()

to_cardano_node_format(): PlutusData

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

• Convert to a Datum that will serialize equivalent to cardano-node's format *
  • Please VERY STRONGLY consider using PlutusData::from_cbor_bytes() instead wherever possible.
  • You should try to never rely on a tool encoding CBOR a certain way as there are many possible,
  • and just because it matches with a specific datum, doesn't mean that a different datum won't differ.
  • This is critical as that means the datum hash won't match.
  • After creation a datum (or other hashable CBOR object) should only be treated as raw CBOR bytes,
  • or through a type that respects its specific CBOR format e.g. CML's PlutusData::from_cbor_bytes()
  • This function is just here in case there's no possible way at all to create from CBOR bytes and
  • thus cold only be constructed manually and then had this function called on it.
  • This is also the format that CSL and Lucid use

Returns

PlutusData

---

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

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

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

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

Returns

string

---

from_cbor_bytes()

static from_cbor_bytes(cbor_bytes): PlutusData

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

• Create this type from CBOR bytes

Parameters

cbor_bytes

Uint8Array

Returns

PlutusData

---

from_cbor_hex()

static from_cbor_hex(cbor_bytes): PlutusData

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

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

Parameters

cbor_bytes

string

Returns

PlutusData

---

from_json()

static from_json(json): PlutusData

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

Parameters

json

string

Returns

PlutusData

---

new_bytes()

static new_bytes(bytes): PlutusData

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

Parameters

bytes

Uint8Array

Returns

PlutusData

---

new_constr_plutus_data()

static new_constr_plutus_data(constr_plutus_data): PlutusData

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

Parameters

constr_plutus_data

ConstrPlutusData

Returns

PlutusData

---

new_integer()

static new_integer(big_int): PlutusData

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

Parameters

big_int

BigInteger

Returns

PlutusData

---

new_list()

static new_list(list): PlutusData

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

Parameters

list

PlutusDataList

Returns

PlutusData

---

new_map()

static new_map(map): PlutusData

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

Parameters

map

PlutusMap

Returns

PlutusData