cardano-web3-js / CML / Address

Class: Address

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

Methods

free()

free(): void

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

Returns

void

---

header()

header(): number

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

header has 4 bits addr type discrim then 4 bits network discrim. Copied from shelley.cddl:

base address bits 7-6: 00 bit 5: stake cred is keyhash/scripthash bit 4: payment cred is keyhash/scripthash bits 3-0: network id

pointer address bits 7-5: 010 bit 4: payment cred is keyhash/scripthash bits 3-0: network id

enterprise address bits 7-5: 010 bit 4: payment cred is keyhash/scripthash bits 3-0: network id

reward addresses: bits 7-5: 111 bit 4: credential is keyhash/scripthash bits 3-0: network id

byron addresses: bits 7-4: 1000 bits 3-0: unrelated data (recall: no network ID in Byron addresses)

Returns

number

---

kind()

kind(): AddressKind

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

Returns

AddressKind

---

network_id()

network_id(): number

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

Returns

number

---

payment_cred()

payment_cred(): Credential

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

Note: by convention, the key inside reward addresses are considered payment credentials

Returns

Credential

---

staking_cred()

staking_cred(): Credential

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

Note: by convention, the key inside reward addresses are NOT considered staking credentials Note: None is returned pointer addresses as the chain history is required to resolve its associated cred

Returns

Credential

---

to_bech32()

to_bech32(prefix?): string

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

Parameters

prefix?

string

Returns

string

---

to_hex()

to_hex(): string

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

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

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

Returns

string

---

to_raw_bytes()

to_raw_bytes(): Uint8Array

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

Returns

Uint8Array

---

from_bech32()

static from_bech32(bech_str): Address

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

Parameters

bech_str

string

Returns

Address

---

from_hex()

static from_hex(hex): Address

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

Parameters

hex

string

Returns

Address

---

from_json()

static from_json(json): Address

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

Parameters

json

string

Returns

Address

---

from_raw_bytes()

static from_raw_bytes(data): Address

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

Parameters

data

Uint8Array

Returns

Address

---

header_matches_kind()

static header_matches_kind(header, kind): boolean

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

Parameters

header

number

kind

AddressHeaderKind

Returns

boolean

---

is_valid()

static is_valid(bech_str): boolean

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

Parameters

bech_str

string

Returns

boolean

---

is_valid_bech32()

static is_valid_bech32(bech_str): boolean

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

• Note: bech32-encoded Byron addresses will also pass validation here

Parameters

bech_str

string

Returns

boolean