Skip to content

cardano-web3-js / CML / CIP25ChunkableString

Class: CIP25ChunkableString

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

A String that may or may not be chunked into 64-byte chunks to be able to conform to Cardano TX Metadata limitations. Most users should simply use CIP25ChunkableString::from_string() and CIP25ChunkableString::to_string() and avoid the explicit single/chunk interface:

javascript
let chunkableString = CIP25.CIP25ChunkableString.from_string("this can be any length and will automatically be chunked if needed");

Methods

as_chunked()

as_chunked(): CIP25String64List

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

Returns

CIP25String64List


as_single()

as_single(): CIP25String64

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

Returns

CIP25String64


free()

free(): void

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

Returns

void


kind()

kind(): ChunkableStringKind

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

Returns

ChunkableStringKind


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

  • Serialize this type to CBOR bytes. * This type does NOT support fine-tuned encoding options so this may or may not be * canonical CBOR and may or may not preserve round-trip encodings.

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

  • Serialize this type to CBOR bytes encoded as a hex string (useful for working with CIP30). * This type does NOT support fine-tuned encoding options so this may or may not be * canonical CBOR and may or may not preserve round-trip encodings.

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

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

Returns

string


to_string()

to_string(): string

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

Returns

string


from_cbor_bytes()

static from_cbor_bytes(cbor_bytes): CIP25ChunkableString

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

  • Create this type from CBOR bytes

Parameters

cbor_bytes

Uint8Array

Returns

CIP25ChunkableString


from_cbor_hex()

static from_cbor_hex(cbor_bytes): CIP25ChunkableString

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

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

Parameters

cbor_bytes

string

Returns

CIP25ChunkableString


from_json()

static from_json(json): CIP25ChunkableString

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

Parameters

json

string

Returns

CIP25ChunkableString


from_string()

static from_string(str): CIP25ChunkableString

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

Parameters

str

string

Returns

CIP25ChunkableString


new_chunked()

static new_chunked(chunked): CIP25ChunkableString

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

Parameters

chunked

CIP25String64List

Returns

CIP25ChunkableString


new_single()

static new_single(single): CIP25ChunkableString

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

Parameters

single

CIP25String64

Returns

CIP25ChunkableString

Released under the MIT License