cardano-web3-js / CML / PoolParams

Class: PoolParams

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

Methods

cost()

cost(): bigint

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

Returns

bigint

---

free()

free(): void

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

Returns

void

---

margin()

margin(): UnitInterval

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

Returns

UnitInterval

---

operator()

operator(): Ed25519KeyHash

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

Returns

Ed25519KeyHash

---

pledge()

pledge(): bigint

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

Returns

bigint

---

pool_metadata()

pool_metadata(): PoolMetadata

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

Returns

PoolMetadata

---

pool_owners()

pool_owners(): Ed25519KeyHashList

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

Returns

Ed25519KeyHashList

---

relays()

relays(): RelayList

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

Returns

RelayList

---

reward_account()

reward_account(): RewardAddress

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

Returns

RewardAddress

---

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

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

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

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

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

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

Returns

string

---

vrf_keyhash()

vrf_keyhash(): VRFKeyHash

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

Returns

VRFKeyHash

---

from_cbor_bytes()

static from_cbor_bytes(cbor_bytes): PoolParams

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

• Create this type from CBOR bytes

Parameters

cbor_bytes

Uint8Array

Returns

PoolParams

---

from_cbor_hex()

static from_cbor_hex(cbor_bytes): PoolParams

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

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

Parameters

cbor_bytes

string

Returns

PoolParams

---

from_json()

static from_json(json): PoolParams

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

Parameters

json

string

Returns

PoolParams

---

new()

static new(operator, vrf_keyhash, pledge, cost, margin, reward_account, pool_owners, relays, pool_metadata?): PoolParams

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

Parameters

operator

Ed25519KeyHash

vrf_keyhash

VRFKeyHash

pledge

bigint

cost

bigint

margin

UnitInterval

reward_account

RewardAddress

pool_owners

Ed25519KeyHashList

relays

RelayList

pool_metadata?

PoolMetadata

Returns

PoolParams