Skip to content

PublicKey.toHex

Serializes a PublicKey.PublicKey to Hex.Hex.

Imports

Named
import { PublicKey } from 'ox'

Examples

import { PublicKey } from 'ox'
 
const publicKey = PublicKey.from({
  prefix: 4,
  x: 59295962801117472859457908919941473389380284132224861839820747729565200149877n,
  y: 24099691209996290925259367678540227198235484593389470330605641003500238088869n,
})
 
const hex = PublicKey.toHex(publicKey)
'0x048318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed753547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5'

Definition

function toHex(
  publicKey: PublicKey<boolean>,
  options?: toHex.Options,
): Hex.Hex

Source: src/PublicKey.ts

Parameters

publicKey

  • Type: PublicKey<boolean>

The public key to serialize.

publicKey.prefix

  • Type: numberType

publicKey.x

  • Type: bigintType

publicKey.y

  • Type: bigintType

options

  • Type: toHex.Options
  • Optional

options.includePrefix

  • Type: boolean
  • Optional

Whether to include the prefix in the serialized public key.

Return Type

The serialized public key.

Hex.Hex

Error Type

PublicKey.toHex.ErrorType