Skip to content

cardano-web3-js / CML / PoolRetirement

Class: PoolRetirement

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

Methods

epoch()

epoch(): bigint

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

Returns

bigint


free()

free(): void

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

Returns

void


pool()

pool(): Ed25519KeyHash

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

Returns

Ed25519KeyHash


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

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

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

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

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

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

Returns

string


from_cbor_bytes()

static from_cbor_bytes(cbor_bytes): PoolRetirement

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

  • Create this type from CBOR bytes

Parameters

cbor_bytes

Uint8Array

Returns

PoolRetirement


from_cbor_hex()

static from_cbor_hex(cbor_bytes): PoolRetirement

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

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

Parameters

cbor_bytes

string

Returns

PoolRetirement


from_json()

static from_json(json): PoolRetirement

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

Parameters

json

string

Returns

PoolRetirement


new()

static new(pool, epoch): PoolRetirement

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

Parameters

pool

Ed25519KeyHash

epoch

bigint

Returns

PoolRetirement

Released under the MIT License