Class PublicKey`Abstract`

An abstract representation of a public key.

Provides a common interface for verifying any signature.

Hierarchy (view full)

Serializable
- PublicKey
  - AccountPublicKey
  - Secp256k1PublicKey

Index

Constructors

Methods

bcsToBytes bcsToHex serialize toString toUint8Array verifySignature

Constructors

constructor

new PublicKey(): PublicKey
Returns PublicKey
Inherited from Serializable.constructor

Methods

bcsToBytes

bcsToBytes(): Uint8Array
Serializes a Serializable value to its BCS representation. This function is the Typescript SDK equivalent of bcs::to_bytes in Move.

Returns Uint8Array
the BCS representation of the Serializable instance as a byte buffer
Inherited from Serializable.bcsToBytes
- Defined in src/bcs/serializer.ts:27

bcsToHex

bcsToHex(): Hex
Helper function to get a value's BCS-serialized bytes as a Hex instance.

Returns Hex
a Hex instance with the BCS-serialized bytes loaded into its underlying Uint8Array
Inherited from Serializable.bcsToHex
- Defined in src/bcs/serializer.ts:37

`Abstract` serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Inherited from Serializable.serialize
- Defined in src/bcs/serializer.ts:20

toString

toString(): string
Get the public key as a hex string with a 0x prefix e.g. 0x123456...

Returns string
- Defined in src/core/crypto/publicKey.ts:36

`Abstract` toUint8Array

toUint8Array(): Uint8Array
Get the raw public key bytes

Returns Uint8Array
- Defined in src/core/crypto/publicKey.ts:31

`Abstract` verifySignature

verifySignature(args): boolean
Verifies that the private key associated with this public key signed the message with the given signature.
Parameters
- args: VerifySignatureArgs
Returns boolean
- Defined in src/core/crypto/publicKey.ts:26

Generated using TypeDoc