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)

Constructors

constructor

Properties

blinder expiryDateSecs nonce BLINDER_LENGTH

Methods

bcsToBytes bcsToHex getPublicKey isExpired serialize sign deserialize fromBytes generate

Constructors

constructor

Properties

Readonlyblinder

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.

ReadonlyexpiryDateSecs

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.

Readonlynonce

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.

Static ReadonlyBLINDER_LENGTH

BLINDER_LENGTH: number

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

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

getPublicKey

  • getPublicKey(): EphemeralPublicKey

  • Returns the public key of the key pair.

    Returns EphemeralPublicKey

    EphemeralPublicKey

isExpired

  • isExpired(): boolean

  • Returns the public key of the key pair.

    Returns boolean

    boolean

serialize

  • serialize(serializer): void

  • Parameters

    Returns void

sign

  • sign(data): EphemeralSignature

  • Sign the given message with the private key.

    Parameters

    Returns EphemeralSignature

    EphemeralSignature

Staticdeserialize

StaticfromBytes

  • fromBytes(bytes): EphemeralKeyPair

  • Parameters

    • bytes: Uint8Array

    Returns EphemeralKeyPair

Staticgenerate

  • generate(args?): EphemeralKeyPair

  • Returns the public key of the key pair.

    Parameters

    • Optionalargs: {
          expiryDateSecs?: number;
          scheme?: Ed25519;
      }
      • OptionalexpiryDateSecs?: number
      • Optionalscheme?: Ed25519

    Returns EphemeralKeyPair

    boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods