Skip to content

FrameSignature.toTuple

Converts a FrameSignature.FrameSignature to its RLP-ready FrameSignature.Tuple.

Encodes numeric scheme identifiers and packs protocol signatures without mutating the entry. Omitted protocol signatures become empty bytes.

Imports

Named
import { FrameSignature } from 'ox'

Examples

Basic Usage

Encode arbitrary witness bytes with the default scheme and payload.

import { FrameSignature } from 'ox'
 
const entry = FrameSignature.from('0xaabb')
const tuple = FrameSignature.toTuple(entry)
['0x', '0x', '0x', '0xaabb']

Definition

function toTuple(
  entry: FrameSignature,
): Tuple

Source: src/core/FrameSignature.ts

Parameters

entry

  • Type: FrameSignature

The signature entry to convert.

entry.payload

  • Type: 0x${string}
  • Optional

Explicit nonzero digest. Omit or use empty bytes for the transaction signing hash.

entry.publicKey

  • Type: { prefix: number; x: bigint; y: bigint; }
  • Optional

Public key, if already known. Empty wire signatures do not retain it.

entry.scheme

  • Type: 2 | "p256"

P-256 verification scheme.

entry.signature

  • Type: 0x${string} | { r: bigint; s: bigint; yParity?: number; }

P-256 signature or Signature.toHex bytes.

entry.signer

  • Type: Address.Address | undefined
  • Optional

Signer address. Omit to use the transaction sender.

Return Type

The encoded signature tuple.

Tuple