Class EphemeralPublicKey

Represents ephemeral public keys for Aptos Keyless accounts.

These are not public keys used as a public key on an account. They are only used ephemerally on Keyless accounts.

Hierarchy (view full)

PublicKey
- EphemeralPublicKey

Index

Constructors

Properties

publicKey variant

Methods

bcsToBytes bcsToHex serialize toString toUint8Array verifySignature deserialize isPublicKey

Constructors

constructor

new EphemeralPublicKey(publicKey): EphemeralPublicKey
Parameters
- publicKey: PublicKey
Returns EphemeralPublicKey
Overrides PublicKey.constructor
- Defined in src/core/crypto/ephemeral.ts:24

Properties

`Readonly` publicKey

publicKey: PublicKey

The public key itself

`Readonly` variant

variant: Ed25519

An enum indicating the scheme of the ephemeral public key

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

serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides PublicKey.serialize
- Defined in src/core/crypto/ephemeral.ts:58

toString

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

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

toUint8Array

toUint8Array(): Uint8Array
Get the public key in bytes (Uint8Array).

Returns Uint8Array
Uint8Array representation of the public key
Overrides PublicKey.toUint8Array
- Defined in src/core/crypto/ephemeral.ts:42

verifySignature

verifySignature(args): boolean
Verifies a signed data with a the ephemeral public key
Parameters
- args: {
  message: HexInput;
  signature: EphemeralSignature;
  }
  - message: HexInput
    message
  - signature: EphemeralSignature
    The signature that was signed by the private key of the ephemeral public key
Returns boolean
true if the signature is valid
Overrides PublicKey.verifySignature
- Defined in src/core/crypto/ephemeral.ts:53

`Static` deserialize

deserialize(deserializer): EphemeralPublicKey
Parameters
- deserializer: Deserializer
Returns EphemeralPublicKey
- Defined in src/core/crypto/ephemeral.ts:67

`Static` isPublicKey

isPublicKey(publicKey): publicKey is EphemeralPublicKey
Parameters
- publicKey: PublicKey
Returns publicKey is EphemeralPublicKey
- Defined in src/core/crypto/ephemeral.ts:77