cardano-web3-js / CML / Relay

Class: Relay

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

Methods

as_multi_host_name()

as_multi_host_name(): MultiHostName

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

Returns

MultiHostName

---

as_single_host_addr()

as_single_host_addr(): SingleHostAddr

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

Returns

SingleHostAddr

---

as_single_host_name()

as_single_host_name(): SingleHostName

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

Returns

SingleHostName

---

free()

free(): void

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

Returns

void

---

kind()

kind(): RelayKind

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

Returns

RelayKind

---

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

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

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

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

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

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

Returns

string

---

from_cbor_bytes()

static from_cbor_bytes(cbor_bytes): Relay

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

• Create this type from CBOR bytes

Parameters

cbor_bytes

Uint8Array

Returns

Relay

---

from_cbor_hex()

static from_cbor_hex(cbor_bytes): Relay

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

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

Parameters

cbor_bytes

string

Returns

Relay

---

from_json()

static from_json(json): Relay

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

Parameters

json

string

Returns

Relay

---

new_multi_host_name()

static new_multi_host_name(dns_name): Relay

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

Parameters

dns_name

DNSName

Returns

Relay

---

new_single_host_addr()

static new_single_host_addr(port?, ipv4?, ipv6?): Relay

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

Parameters

port?

number

ipv4?

Ipv4

ipv6?

Ipv6

Returns

Relay

---

new_single_host_name()

static new_single_host_name(port, dns_name): Relay

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

Parameters

port

number

dns_name

DNSName

Returns

Relay