Class EphemeralKeyPair

A class which contains a key pair that is used in signing transactions via the Keyless authentication scheme. This key pair is ephemeral and has an expiration time. For more details on how this class is used - https://aptos.dev/guides/keyless-accounts/#1-present-the-user-with-a-sign-in-with-idp-button-on-the-ui

Hierarchy (view full)

Serializable
- EphemeralKeyPair

Index

Constructors

constructor

new EphemeralKeyPair(args): EphemeralKeyPair
Parameters
- args: {
      blinder?: HexInput;
      expiryDateSecs?: number;
      privateKey: PrivateKey;
  }
  - Optional blinder?: HexInput
  - Optional expiryDateSecs?: number
  - privateKey: PrivateKey
Returns EphemeralKeyPair
Overrides Serializable.constructor
- Defined in src/account/EphemeralKeyPair.ts:60

Properties

`Readonly` blinder

blinder: Uint8Array

A byte array of length BLINDER_LENGTH used to obfuscate the public key from the IdP. Used in calculating the nonce passed to the IdP and as a secret witness in proof generation.

`Readonly` expiryDateSecs

expiryDateSecs: number

A timestamp in seconds indicating when the ephemeral key pair is expired. After expiry, a new EphemeralKeyPair must be generated and a new JWT needs to be created.

`Readonly` nonce

nonce: string

The value passed to the IdP when the user authenticates. It comprises of a hash of the ephermeral public key, expiry date, and blinder.

`Private` privateKey

privateKey: PrivateKey

A private key used to sign transactions. This private key is not tied to any account on the chain as it is ephemeral (not permanent) in nature.

`Private` publicKey

publicKey: EphemeralPublicKey

A public key used to verify transactions. This public key is not tied to any account on the chain as it is ephemeral (not permanent) in nature.

`Static` `Readonly` BLINDER_LENGTH

BLINDER_LENGTH: number = 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 Serializable.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 Serializable.bcsToHex
- Defined in src/bcs/serializer.ts:37

getPublicKey

getPublicKey(): EphemeralPublicKey
Returns the public key of the key pair.

Returns EphemeralPublicKey
EphemeralPublicKey
- Defined in src/account/EphemeralKeyPair.ts:81

isExpired

isExpired(): boolean
Returns the public key of the key pair.

Returns boolean
boolean
- Defined in src/account/EphemeralKeyPair.ts:89

serialize

serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Overrides Serializable.serialize
- Defined in src/account/EphemeralKeyPair.ts:94

sign

sign(data): EphemeralSignature
Sign the given message with the private key.
Parameters
- data: HexInput
  in HexInput format
Returns EphemeralSignature
EphemeralSignature
- Defined in src/account/EphemeralKeyPair.ts:143

`Static` deserialize

deserialize(deserializer): EphemeralKeyPair
Parameters
- deserializer: Deserializer
Returns EphemeralKeyPair
- Defined in src/account/EphemeralKeyPair.ts:101

`Static` fromBytes

fromBytes(bytes): EphemeralKeyPair
Parameters
- bytes: Uint8Array
Returns EphemeralKeyPair
- Defined in src/account/EphemeralKeyPair.ts:116

`Static` generate

generate(args?): EphemeralKeyPair
Returns the public key of the key pair.
Parameters
- Optional args: {
  expiryDateSecs?: number;
  scheme?: Ed25519;
  }
  - Optional expiryDateSecs?: number
  - Optional scheme?: Ed25519
Returns EphemeralKeyPair
boolean
- Defined in src/account/EphemeralKeyPair.ts:126

Class EphemeralKeyPair

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional blinder?: HexInput

Optional expiryDateSecs?: number

privateKey: PrivateKey

Returns EphemeralKeyPair

Properties

Readonly blinder

Readonly expiryDateSecs

Readonly nonce

Private privateKey

Private publicKey

Static Readonly BLINDER_LENGTH

Methods

bcsToBytes

Returns Uint8Array

bcsToHex

Returns Hex

getPublicKey

Returns EphemeralPublicKey

isExpired

Returns boolean

serialize

Parameters

Returns void

sign

Parameters

Returns EphemeralSignature

Static deserialize

Parameters

Returns EphemeralKeyPair

Static fromBytes

Parameters

Returns EphemeralKeyPair

Static generate

Parameters

Optional expiryDateSecs?: number

Optional scheme?: Ed25519

Returns EphemeralKeyPair

Settings

Member Visibility

Theme

On This Page

`Optional` blinder?: HexInput

`Optional` expiryDateSecs?: number

`Readonly` blinder

`Readonly` expiryDateSecs

`Readonly` nonce

`Private` privateKey

`Private` publicKey

`Static` `Readonly` BLINDER_LENGTH

`Static` deserialize

`Static` fromBytes

`Static` generate

`Optional` expiryDateSecs?: number

`Optional` scheme?: Ed25519