Class EphemeralPublicKey

Represents ephemeral public keys for Aptos Keyless accounts.

These keys are used only temporarily within Keyless accounts and are not utilized as public keys for account identification.

Hierarchy (view full)

PublicKey
- EphemeralPublicKey

Index

Constructors

constructor

new EphemeralPublicKey(publicKey): EphemeralPublicKey
Creates an instance of EphemeralPublicKey using the provided public key. This constructor ensures that only supported signature types are accepted.
Parameters
- publicKey: PublicKey
  The public key to be used for the ephemeral public key.
Returns EphemeralPublicKey
Throws
Error if the signature type is unsupported.
Overrides PublicKey.constructor
- Defined in src/core/crypto/ephemeral.ts:31

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

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:40

serialize

serialize(serializer): void
Serializes the current instance, specifically handling the Ed25519 signature type. This function ensures that the signature is properly serialized using the provided serializer.
Parameters
- serializer: Serializer
  The serializer instance used to serialize the signature.
Returns void
Throws
Error if the signature type is unknown.
Overrides PublicKey.serialize
- Defined in src/core/crypto/ephemeral.ts:64

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:44

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:49

toUint8Array

toUint8Array(): Uint8Array
Get the raw public key bytes

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

verifySignature

verifySignature(args): boolean
Verifies a signed message using the ephemeral public key.
Parameters
- args: {
  message: HexInput;
  signature: EphemeralSignature;
  }
  The arguments for the verification.
  - message: HexInput
    The message that was signed.
  - signature: EphemeralSignature
    The signature that was signed by the private key of the ephemeral public key.
Returns boolean
true if the signature is valid, otherwise false.
Overrides PublicKey.verifySignature
- Defined in src/core/crypto/ephemeral.ts:52

`Static`deserialize

deserialize(deserializer): EphemeralPublicKey
Deserializes an EphemeralSignature from the provided deserializer. This function allows you to retrieve an EphemeralSignature based on the deserialized data.
Parameters
- deserializer: Deserializer
  The deserializer instance used to read the serialized data.
Returns EphemeralPublicKey
- Defined in src/core/crypto/ephemeral.ts:79

`Static`isPublicKey

isPublicKey(publicKey): publicKey is EphemeralPublicKey
Determines if the provided public key is an instance of EphemeralPublicKey.
Parameters
- publicKey: PublicKey
  The public key to check.
Returns publicKey is EphemeralPublicKey
A boolean indicating whether the public key is an ephemeral type.
- Defined in src/core/crypto/ephemeral.ts:95

Properties

`Readonly`publicKey

publicKey: PublicKey

The public key itself

`Readonly`variant

variant: Ed25519

An enum indicating the scheme of the ephemeral public key

Class EphemeralPublicKey

Hierarchy (view full)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns EphemeralPublicKey

Throws

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

serialize

Parameters

Returns void

Throws

toString

Returns string

toStringWithoutPrefix

Returns string

toUint8Array

Returns Uint8Array

verifySignature

Parameters

message: HexInput

signature: EphemeralSignature

Returns boolean

Staticdeserialize

Parameters

Returns EphemeralPublicKey

StaticisPublicKey

Parameters

Returns publicKey is EphemeralPublicKey

Properties

ReadonlypublicKey

Readonlyvariant

Settings

On This Page

`Static`deserialize

`Static`isPublicKey

`Readonly`publicKey

`Readonly`variant