TransactionEnvelopeEip2930
Utility functions for working with EIP-2930 Typed Transaction Envelopes
Examples
Below are some examples demonstrating common usages of the TransactionEnvelopeEip2930
module:
Instantiating
Transaction Envelopes can be instantiated using TransactionEnvelopeEip2930.from
:
import { TransactionEnvelopeEip2930, Value } from 'ox'
const envelope = TransactionEnvelopeEip2930.from({
chainId: 1,
accessList: [...],
gasPrice: Value.fromGwei('10'),
to: '0x0000000000000000000000000000000000000000',
value: Value.fromEther('1'),
})
Signing
Transaction Envelopes can be signed using TransactionEnvelopeEip2930.getSignPayload
and a signing function such as Secp256k1.sign
or P256.sign
:
import { Secp256k1, TransactionEnvelopeEip2930 } from 'ox'
const envelope = TransactionEnvelopeEip2930.from({
chainId: 1,
nonce: 0n,
gasPrice: 1000000000n,
gas: 21000n,
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: 1000000000000000000n,
})
const payload = TransactionEnvelopeEip2930.getSignPayload(envelope)
'0x...' const signature = Secp256k1.sign({ payload, privateKey: '0x...' })
Serializing
Transaction Envelopes can be serialized using TransactionEnvelopeEip2930.serialize
:
import { Secp256k1, TransactionEnvelopeEip2930, Value } from 'ox'
const envelope = TransactionEnvelopeEip2930.from({
chainId: 1,
nonce: 0n,
gasPrice: 1000000000n,
gas: 21000n,
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: 1000000000000000000n,
})
const serialized = TransactionEnvelopeEip2930.serialize(envelope)
Sending
We can send a Transaction Envelope to the network by serializing the signed envelope with .serialize
, and then broadcasting it over JSON-RPC with eth_sendRawTransaction
.
In this example, we will use RpcTransport.fromHttp
to broadcast a eth_sendRawTransaction
request over HTTP JSON-RPC.
import { RpcTransport, TransactionEnvelopeEip2930, Secp256k1, Value } from 'ox'
// Construct the Envelope.
const envelope = TransactionEnvelopeEip2930.from({
accessList: [],
chainId: 1,
gasPrice: Value.fromGwei('10'),
nonce: 69n,
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: Value.fromEther('1.5'),
})
// Sign over the Envelope.
const signature = Secp256k1.sign({
payload: TransactionEnvelopeEip2930.getSignPayload(envelope),
privateKey: '0x...',
})
// Serialize the Envelope with the Signature.
const serialized = TransactionEnvelopeEip2930.serialize(envelope, {
signature
})
// Broadcast the Envelope with `eth_sendRawTransaction`.
const transport = RpcTransport.fromHttp('https://1.rpc.thirdweb.com')
const hash = await transport.request({
method: 'eth_sendRawTransaction',
params: [serialized],
})
If you are interfacing with an RPC that supports eth_sendTransaction
, you can also use
TransactionEnvelopeEip2930.toRpc
to convert an Envelope to an RPC-compatible format.
This means you can skip the ceremony of manually filling & signing the Transaction.
import 'ox/window'
import { Provider, TransactionEnvelopeEip2930, Value } from 'ox'
const envelope = TransactionEnvelopeEip2930.from({
accessList: [],
chainId: 1,
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: Value.fromEther('1.5'),
})
const envelope_rpc = TransactionEnvelopeEip2930.toRpc(envelope)
const provider = Provider.from(window.ethereum)
const hash = await provider.request({
method: 'eth_sendTransaction',
params: [envelope_rpc],
})
Computing Hashes
Transaction Hashes can be computed using TransactionEnvelopeEip2930.hash
:
import { Secp256k1, TransactionEnvelopeEip2930 } from 'ox'
const envelope = TransactionEnvelopeEip2930.from({
chainId: 1,
nonce: 0n,
gasPrice: 1000000000n,
gas: 21000n,
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: 1000000000000000000n,
data: '0x',
})
const signature = Secp256k1.sign({
payload: TransactionEnvelopeEip2930.getSignPayload(envelope),
privateKey: '0x...'
})
const envelope_signed = TransactionEnvelopeEip2930.from(envelope, { signature })
const hash = TransactionEnvelopeEip2930.hash(envelope_signed)