TransactionEnvelopeEip2930.from
Converts an arbitrary transaction object into an EIP-2930 Transaction Envelope.
Imports
Named
import { TransactionEnvelopeEip2930 } from 'ox'
Examples
import { TransactionEnvelopeEip2930, Value } from 'ox'
const envelope = TransactionEnvelopeEip2930.from({
chainId: 1,
accessList: [...],
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, TransactionEnvelopeEip2930, Value } from 'ox'
const envelope = TransactionEnvelopeEip2930.from({
chainId: 1,
gasPrice: Value.fromGwei('10'),
to: '0x0000000000000000000000000000000000000000',
value: Value.fromEther('1'),
})
const signature = Secp256k1.sign({
payload: TransactionEnvelopeEip2930.getSignPayload(envelope),
privateKey: '0x...',
})
const envelope_signed = TransactionEnvelopeEip2930.from(envelope, {
signature,
})
{ chainId: 1, gasPrice: 10000000000n, to: '0x0000000000000000000000000000000000000000', type: 'eip2930', value: 1000000000000000000n, r: 125...n, s: 642...n, yParity: 0, }
From Serialized
It is possible to instantiate an EIP-2930 Transaction Envelope from a TransactionEnvelopeEip2930.Serialized
value.
import { TransactionEnvelopeEip2930 } from 'ox'
const envelope = TransactionEnvelopeEip2930.from('0x01f858018203118502540be4008504a817c800809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c08477359400e1a001627c687261b0e7f8638af1112efa8a77e23656f6e7945275b19e9deed80261')
{ chainId: 1, gasPrice: 10000000000n, to: '0x0000000000000000000000000000000000000000', type: 'eip2930', value: 1000000000000000000n, }
Definition
function from<envelope, signature>(
envelope: envelope | UnionPartialBy<TransactionEnvelopeEip2930, 'type'> | Serialized,
options?: from.Options<signature>,
): from.ReturnType<envelope, signature>
Source: src/core/TransactionEnvelopeEip2930.ts
Parameters
envelope
- Type:
envelope | UnionPartialBy<TransactionEnvelopeEip2930, 'type'> | Serialized
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 TransactionEnvelopeEip2930.TransactionEnvelopeEip2930
from.ReturnType<envelope, signature>