Class AccountPublicKey`Abstract`

An abstract representation of an account public key.

Provides a common interface for deriving an authentication key.

Hierarchy (view full)

PublicKey
- AccountPublicKey

Index

Implementation - BCS

bcsToBytes bcsToHex

Implementation - Serialization

authKey toString toUint8Array verifySignature verifySignatureAsync

Constructors

Methods

serialize toStringWithoutPrefix

Implementation - BCS

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 PublicKey.bcsToBytes
- Defined in src/bcs/serializer.ts:45

bcsToHex

bcsToHex(): Hex
Converts the BCS-serialized bytes of a value into a Hex instance. This function provides a Hex representation of the BCS-serialized data for easier handling and manipulation.

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

Implementation - Serialization

`Abstract`authKey

authKey(): AuthenticationKey
Get the authentication key associated with this public key

Returns AuthenticationKey
- Defined in src/core/crypto/publicKey.ts:105

toString

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

Returns string
The public key in hex format.
Inherited from PublicKey.toString
- Defined in src/core/crypto/publicKey.ts:84

toUint8Array

toUint8Array(): Uint8Array
Get the raw public key bytes

Returns Uint8Array
Inherited from PublicKey.toUint8Array
- Defined in src/core/crypto/publicKey.ts:73

`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
Inherited from PublicKey.verifySignature
- Defined in src/core/crypto/publicKey.ts:54

verifySignatureAsync

verifySignatureAsync(args): Promise<boolean>
Verifies signature with the public key and makes any network calls required to get state required to verify the signature.
Parameters
- args: VerifySignatureAsyncArgs
Returns Promise<boolean>
Inherited from PublicKey.verifySignatureAsync
- Defined in src/core/crypto/publicKey.ts:64

Constructors

constructor

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

Methods

`Abstract`serialize

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

toStringWithoutPrefix

toStringWithoutPrefix(): string
Returns the hex string representation of the Serializable value without the 0x prefix.

Returns string
the hex format as a string without 0x prefix.
Inherited from PublicKey.toStringWithoutPrefix
- Defined in src/bcs/serializer.ts:67