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)

Constructors

constructor

Properties

publicKey variant

Methods

authKey bcsToBytes bcsToHex isEd25519 isSecp256k1PublicKey serialize toString toUint8Array verifySignature deserialize isInstance isPublicKey

Constructors

constructor

Properties

ReadonlypublicKey

publicKey: PublicKey

Reference to the inner public key

Readonlyvariant

variant: AnyPublicKeyVariant

Index of the underlying enum variant

Methods

authKey

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

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

isEd25519

  • isEd25519(): boolean

  • Returns boolean

    Deprecated

    use publicKey instanceof Ed25519PublicKey instead.

isSecp256k1PublicKey

  • isSecp256k1PublicKey(): boolean

  • Returns boolean

    Deprecated

    use publicKey instanceof Secp256k1PublicKey instead.

serialize

  • serialize(serializer): void

  • Parameters

    Returns void

toString

  • toString(): string

  • Get the public key as a hex string with a 0x prefix e.g. 0x123456...

    Returns string

toUint8Array

  • toUint8Array(): Uint8Array

  • Get the raw public key bytes

    Returns Uint8Array

verifySignature

  • verifySignature(args): boolean

  • Verifies that the private key associated with this public key signed the message with the given signature.

    Parameters

    Returns boolean

Staticdeserialize

  • deserialize(deserializer): AnyPublicKey

  • Parameters

    Returns AnyPublicKey

StaticisInstance

  • isInstance(publicKey): publicKey is AnyPublicKey

  • Parameters

    Returns publicKey is AnyPublicKey

StaticisPublicKey

  • isPublicKey(publicKey): publicKey is AnyPublicKey

  • Parameters

    Returns publicKey is AnyPublicKey

    Deprecated

    use instanceof AnyPublicKey instead.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods