Interface: PublicKey

Defined in: public.ts:33

General PublicKey Interface used by CompressedSecp256k1PublicKey. PublicKey

Properties

compressed

readonly compressed: Bytes

Defined in: public.ts:38

Compressed public key getter.

---

hex

readonly hex: Hex

Defined in: public.ts:86

CompressedSecp256k1PublicKey hex string getter.

---

isEven

readonly isEven: boolean

Defined in: public.ts:62

CompressedSecp256k1PublicKey isEven getter.

---

multibase

readonly multibase: MultibaseObject

Defined in: public.ts:80

CompressedSecp256k1PublicKey multibase getter.

Returns

The public key as MultibaseObject as a address string, key and prefix bytes.

---

parity

readonly parity: number

Defined in: public.ts:56

CompressedSecp256k1PublicKey parity getter.

---

point

readonly point: Point

Defined in: public.ts:92

CompressedSecp256k1PublicKey point getter.

---

uncompressed

readonly uncompressed: Bytes

Defined in: public.ts:44

Uncompressed public key getter.

---

x

readonly x: Bytes

Defined in: public.ts:68

CompressedSecp256k1PublicKey x-coordinate getter.

---

xOnly

readonly xOnly: Bytes

Defined in: public.ts:50

X-only public key getter.

---

y

readonly y: Bytes

Defined in: public.ts:74

CompressedSecp256k1PublicKey y-coordinate getter.

Methods

decode()

decode(): Bytes

Defined in: public.ts:98

Decode the base58btc multibase string to the compressed public key prefixed with 0x02.

Returns

Bytes

The public key as a 33-byte compressed public key with header.

---

encode()

encode(): string

Defined in: public.ts:104

Encode the CompressedSecp256k1PublicKey as an x-only base58btc multibase public key.

Returns

string

The public key formatted a base58btc multibase string.

---

equals()

equals(other): boolean

Defined in: public.ts:111

CompressedSecp256k1PublicKey key equality check. Checks if this public key is equal to other public key.

Parameters

other

CompressedSecp256k1PublicKey

The public key to compare.

Returns

boolean

True if the public keys are equal.

---

json()

json(): PublicKeyObject

Defined in: public.ts:117

JSON representation of a CompressedSecp256k1PublicKey object.

Returns

PublicKeyObject

The CompressedSecp256k1PublicKey as a JSON object.