TransactionEnvelopeLegacy.from
Converts an arbitrary transaction object into a legacy Transaction Envelope.
Imports
Named
import { TransactionEnvelopeLegacy } from 'ox'
Examples
import { TransactionEnvelopeLegacy, Value } from 'ox'
const envelope = TransactionEnvelopeLegacy.from({
gasPrice: Value.fromGwei('10'),
to: '0x0000000000000000000000000000000000000000',
value: Value.fromEther('1'),
})
Attaching Signatures
It is possible to attach a signature
to the transaction envelope.
import { Secp256k1, TransactionEnvelopeLegacy, Value } from 'ox'
const envelope = TransactionEnvelopeLegacy.from({
chainId: 1,
gasPrice: Value.fromGwei('10'),
to: '0x0000000000000000000000000000000000000000',
value: Value.fromEther('1'),
})
const signature = Secp256k1.sign({
payload: TransactionEnvelopeLegacy.getSignPayload(envelope),
privateKey: '0x...',
})
const envelope_signed = TransactionEnvelopeLegacy.from(envelope, {
signature,
})
{ authorizationList: [...], chainId: 1, gasPrice: 10000000000n, to: '0x0000000000000000000000000000000000000000', type: 'eip7702', value: 1000000000000000000n, r: 125...n, s: 642...n, yParity: 0, }
From Serialized
It is possible to instantiate an legacy Transaction Envelope from a TransactionEnvelopeLegacy.Serialized
value.
import { TransactionEnvelopeLegacy } from 'ox'
const envelope = TransactionEnvelopeLegacy.from('0xf858018203118502540be4008504a817c800809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c08477359400e1a001627c687261b0e7f8638af1112efa8a77e23656f6e7945275b19e9deed80261')
{ chainId: 1, gasPrice: 10000000000n, to: '0x0000000000000000000000000000000000000000', type: 'legacy', value: 1000000000000000000n, }
Definition
function from<envelope, signature>(
envelope: envelope | UnionPartialBy<TransactionEnvelopeLegacy, 'type'> | Hex.Hex,
options?: from.Options<signature>,
): from.ReturnType<envelope, signature>
Source: src/TransactionEnvelopeLegacy.ts
Parameters
envelope
- Type:
envelope | UnionPartialBy<TransactionEnvelopeLegacy, 'type'> | Hex.Hex
The transaction object to convert.
options
- Type:
from.Options<signature>
- Optional
Options.
options.signature
- Type:
{ r: bigint; s: bigint; yParity: number; } | signature
- Optional
Return Type
A legacy Transaction Envelope.
from.ReturnType<envelope, signature>