Class AnyPublicKey

Represents any public key supported by Aptos.

Since AIP-55 Aptos supports Legacy and Unified authentication keys.

Any unified authentication key is represented in the SDK as AnyPublicKey.

Hierarchy (view full)

AccountPublicKey
- AnyPublicKey

Index

Constructors

Properties

publicKey variant

Methods

authKey bcsToBytes bcsToHex isEd25519 isSecp256k1PublicKey serialize toString toUint8Array verifySignature deserialize isPublicKey

Constructors

constructor

new AnyPublicKey(publicKey): AnyPublicKey
Parameters
- publicKey: PublicKey
Returns AnyPublicKey
Overrides AccountPublicKey.constructor
- Defined in src/core/crypto/singleKey.ts:30

Properties

`Readonly` publicKey

publicKey: PublicKey

Reference to the inner public key

`Readonly` variant

variant: AnyPublicKeyVariant

Index of the underlying enum variant

Methods

authKey

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

Returns AuthenticationKey
Overrides AccountPublicKey.authKey
- Defined in src/core/crypto/singleKey.ts:58

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 AccountPublicKey.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 AccountPublicKey.bcsToHex
- Defined in src/bcs/serializer.ts:37

isEd25519

isEd25519(): boolean
Returns boolean
Deprecated
use publicKey instanceof Ed25519PublicKey instead.
- Defined in src/core/crypto/singleKey.ts:106

isSecp256k1PublicKey

isSecp256k1PublicKey(): boolean
Returns boolean
Deprecated
use publicKey instanceof Secp256k1PublicKey instead.
- Defined in src/core/crypto/singleKey.ts:113

serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides AccountPublicKey.serialize
- Defined in src/core/crypto/singleKey.ts:73

toString

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

Returns string
Inherited from AccountPublicKey.toString
- Defined in src/core/crypto/publicKey.ts:36

toUint8Array

toUint8Array(): Uint8Array
Get the raw public key bytes

Returns Uint8Array
Overrides AccountPublicKey.toUint8Array
- Defined in src/core/crypto/singleKey.ts:65

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
Overrides AccountPublicKey.verifySignature
- Defined in src/core/crypto/singleKey.ts:46

`Static` deserialize

deserialize(deserializer): AnyPublicKey
Parameters
- deserializer: Deserializer
Returns AnyPublicKey
- Defined in src/core/crypto/singleKey.ts:78

`Static` isPublicKey

isPublicKey(publicKey): publicKey is AnyPublicKey
Parameters
- publicKey: AccountPublicKey
Returns publicKey is AnyPublicKey
Deprecated
use instanceof AnyPublicKey instead.
- Defined in src/core/crypto/singleKey.ts:99