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

Methods

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

Properties

publicKey variant

Constructors

constructor

  • new AnyPublicKey(publicKey): AnyPublicKey

  • Creates an instance of the signature class based on the provided signature type. This allows for the handling of different signature variants such as Ed25519, Secp256k1, and Keyless.

    Parameters

    • publicKey: PublicKey

      The publicKey object which determines the variant to be used.

    Returns AnyPublicKey

    Throws

    Error if the provided signature type is unsupported.

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

  • 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.

isEd25519

  • isEd25519(): boolean

  • Determines if the current public key is an instance of Ed25519PublicKey.

    Returns boolean

    Deprecated

    use publicKey instanceof Ed25519PublicKey instead.

isSecp256k1PublicKey

  • isSecp256k1PublicKey(): boolean

  • Checks if the public key is an instance of Secp256k1PublicKey.

    Returns boolean

    Deprecated

    use publicKey instanceof Secp256k1PublicKey instead.

serialize

  • serialize(serializer): void

  • Serializes the current object using the provided serializer. This function helps in converting the object into a format suitable for transmission or storage.

    Parameters

    • serializer: Serializer

      The serializer instance used to perform the serialization.

    Returns void

toString

toStringWithoutPrefix

toUint8Array

  • toUint8Array(): Uint8Array

  • Get the signature in bytes (Uint8Array).

    This function is a warning that it will soon return the underlying signature bytes directly. Use AnySignature.bcsToBytes() instead.

    Returns Uint8Array

    Uint8Array representation of the signature.

verifySignature

  • verifySignature(args): boolean

  • Verifies the provided signature against the given message. This function helps ensure the integrity and authenticity of the message by confirming that the signature is valid.

    Parameters

    Returns boolean

    A boolean indicating whether the signature is valid for the given message.

Staticdeserialize

  • deserialize(deserializer): AnyPublicKey

  • Deserializes an AnySignature from the provided deserializer. This function helps in reconstructing the AnySignature object from its serialized form, allowing for further processing or validation.

    Parameters

    • deserializer: Deserializer

      The deserializer instance used to read the serialized data.

    Returns AnyPublicKey

StaticisInstance

  • isInstance(publicKey): publicKey is AnyPublicKey

  • Determines if the provided publicKey is an instance of a valid PublicKey object.

    Parameters

    • publicKey: PublicKey

      The publicKey to be checked for validity.

    Returns publicKey is AnyPublicKey

    True if the signature is a valid instance; otherwise, false.

StaticisPublicKey

Properties

ReadonlypublicKey

publicKey: PublicKey

Reference to the inner public key

Readonlyvariant

variant: AnyPublicKeyVariant

Index of the underlying enum variant

Settings

Member Visibility

On This Page

Constructors
Methods
Properties