@did-btc1/keypair / IPublicKey
Interface: IPublicKey
Defined in: public.ts:26
Interface for the PublicKey class. IPublicKey
Properties
compressed
> readonly compressed: Bytes
Defined in: public.ts:37
Compressed public key getter.
hex
> readonly hex: Hex
Defined in: public.ts:67
PublicKey hex string getter.
multibase
> readonly multibase: MultibaseObject
Defined in: public.ts:61
PublicKey multibase getter.
Returns
The public key as MultibaseObject as a address string, key and prefix bytes.
parity
> readonly parity: number
Defined in: public.ts:43
PublicKey parity getter.
uncompressed
> readonly uncompressed: Bytes
Defined in: public.ts:31
Uncompressed public key getter.
x
> readonly x: Bytes
Defined in: public.ts:49
PublicKey x-coordinate getter.
y
> readonly y: Bytes
Defined in: public.ts:55
PublicKey y-coordinate getter.
Methods
decode()
> decode(): Bytes
Defined in: public.ts:73
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:79
Encode the PublicKey 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:86
PublicKey key equality check. Checks if this public key is equal to other public key.
Parameters
other
The public key to compare.
Returns
boolean
True if the public keys are equal.
json()
> json(): PublicKeyObject
Defined in: public.ts:92
JSON representation of a PublicKey object.
Returns
PublicKeyObject
The PublicKey as a JSON object.