Skip to content

X25519.createKeyPair

Creates a new X25519 key pair consisting of a private key and its corresponding public key.

Imports

Named
import { X25519 } from 'ox'

Examples

import { X25519 } from 'ox'
 
const { privateKey, publicKey } = X25519.createKeyPair()

Definition

function createKeyPair<as>(
  options?: createKeyPair.Options<as>,
): createKeyPair.ReturnType<as>

Source: src/core/X25519.ts

Parameters

options

  • Type: createKeyPair.Options<as>
  • Optional

The options to generate the key pair.

options.as

  • Type: "Bytes" | "Hex" | as
  • Optional

Format of the returned private and public keys.

Return Type

The generated key pair containing both private and public keys.

createKeyPair.ReturnType<as>