FrameSignature

Utilities for constructing, validating, and encoding EIP-8141 signature entries.

Supports FrameSignature.Arbitrary, FrameSignature.Secp256k1, and FrameSignature.P256 entries. An empty payload selects the canonical transaction signing hash.

Examples

Use FrameSignature.from to wrap arbitrary witness bytes.

import { FrameSignature } from 'ox'
 
const entry = FrameSignature.from('0xaabb')
{ payload: '0x', scheme: 'arbitrary', signature: '0xaabb' }

Name	Description
`FrameSignature.assert`	Asserts that a `FrameSignature.FrameSignature` is structurally valid.
`FrameSignature.from`	Coerces a value into a `FrameSignature.FrameSignature`.
`FrameSignature.fromRpc`	Converts an RPC signature entry to a structured frame signature.
`FrameSignature.fromTuple`	Converts a `FrameSignature.Tuple` to a structured `FrameSignature.FrameSignature`.
`FrameSignature.toRpc`	Converts a structured frame signature to its RPC representation.
`FrameSignature.toTuple`	Converts a `FrameSignature.FrameSignature` to its RLP-ready `FrameSignature.Tuple`.
`FrameSignature.validate`	Returns whether a `FrameSignature.FrameSignature` is structurally valid.

Name	Description
`FrameSignature.InvalidError`	Thrown when frame signature metadata or encoding is invalid.

Name	Description
`FrameSignature.Arbitrary`	Contract-defined signature bytes.
`FrameSignature.FrameSignature`	An EIP-8141 signature entry. Empty payload selects the transaction signing hash.
`FrameSignature.P256`	A P-256 signature entry.
`FrameSignature.Rpc`	JSON-RPC representation of a frame signature.
`FrameSignature.Scheme`	A supported numeric or named frame signature scheme.
`FrameSignature.Secp256k1`	A secp256k1 signature entry.
`FrameSignature.Tuple`	RLP-ready signature entry. The payload occupies the specification's `msg` field.