# TxEnvelopeEip2930

Utility functions for working with [EIP-2930 Typed Transaction Envelopes](https://eips.ethereum.org/EIPS/eip-2930)

## Examples

Below are some examples demonstrating common usages of the `TxEnvelopeEip2930` module:

* [Instantiating](#instantiating)

* [Signing](#signing)

* [Serializing](#serializing)

* [Sending](#sending)

* [Computing Hashes](#computing-hashes)

### Instantiating

Transaction Envelopes can be instantiated using [`TxEnvelopeEip2930.from`](/api/TxEnvelopeEip2930/from):

```ts twoslash
// @noErrors
import { TxEnvelopeEip2930, Value } from 'ox'

const envelope = TxEnvelopeEip2930.from({
  chainId: 1,
  accessList: [...],
  gasPrice: Value.fromGwei('10'),
  to: '0x0000000000000000000000000000000000000000',
  value: Value.fromEther('1'),
})
```

### Signing

Transaction Envelopes can be signed using [`TxEnvelopeEip2930.getSignPayload`](/api/TxEnvelopeEip2930/getSignPayload) and a signing function such as [`Secp256k1.sign`](/api/Secp256k1/sign) or [`P256.sign`](/api/P256/sign):

```ts twoslash
import { Secp256k1, TxEnvelopeEip2930 } from 'ox'

const envelope = TxEnvelopeEip2930.from({
  chainId: 1,
  nonce: 0n,
  gasPrice: 1000000000n,
  gas: 21000n,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: 1000000000000000000n
})

const payload = TxEnvelopeEip2930.getSignPayload(envelope) // [!code focus]
// @log: '0x...'

const signature = Secp256k1.sign({
  payload,
  privateKey: '0x...'
})
```

### Serializing

Transaction Envelopes can be serialized using [`TxEnvelopeEip2930.serialize`](/api/TxEnvelopeEip2930/serialize):

```ts twoslash
import { Secp256k1, TxEnvelopeEip2930, Value } from 'ox'

const envelope = TxEnvelopeEip2930.from({
  chainId: 1,
  nonce: 0n,
  gasPrice: 1000000000n,
  gas: 21000n,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: 1000000000000000000n
})

const serialized = TxEnvelopeEip2930.serialize(envelope) // [!code focus]
```

### 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`](/api/RpcTransport/fromHttp) to broadcast a `eth_sendRawTransaction` request over HTTP JSON-RPC.

```ts twoslash
import {
  RpcTransport,
  TxEnvelopeEip2930,
  Secp256k1,
  Value
} from 'ox'

// Construct the Envelope.
const envelope = TxEnvelopeEip2930.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: TxEnvelopeEip2930.getSignPayload(envelope),
  privateKey: '0x...'
})

// Serialize the Envelope with the Signature. // [!code focus]
const serialized = TxEnvelopeEip2930.serialize(envelope, {
  // [!code focus]
  signature // [!code focus]
}) // [!code focus]

// Broadcast the Envelope with `eth_sendRawTransaction`. // [!code focus]
const transport = RpcTransport.fromHttp(
  'https://1.rpc.thirdweb.com'
) // [!code focus]
const hash = await transport.request({
  // [!code focus]
  method: 'eth_sendRawTransaction', // [!code focus]
  params: [serialized] // [!code focus]
}) // [!code focus]
```

If you are interfacing with an RPC that supports `eth_sendTransaction`, you can also use
[`TxEnvelopeEip2930.toRpc`](/api/TxEnvelopeEip2930/toRpc) to convert an Envelope to an RPC-compatible format.
This means you can skip the ceremony of manually filling & signing the Transaction.

```ts twoslash
import 'ox/window'
import { Provider, TxEnvelopeEip2930, Value } from 'ox'

const envelope = TxEnvelopeEip2930.from({
  accessList: [],
  chainId: 1,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: Value.fromEther('1.5')
})

const envelope_rpc = TxEnvelopeEip2930.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 [`TxEnvelopeEip2930.hash`](/api/TxEnvelopeEip2930/hash):

```ts twoslash
import { Secp256k1, TxEnvelopeEip2930 } from 'ox'

const envelope = TxEnvelopeEip2930.from({
  chainId: 1,
  nonce: 0n,
  gasPrice: 1000000000n,
  gas: 21000n,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: 1000000000000000000n,
  data: '0x'
})

const signature = Secp256k1.sign({
  payload: TxEnvelopeEip2930.getSignPayload(envelope),
  privateKey: '0x...'
})

const envelope_signed = TxEnvelopeEip2930.from(envelope, {
  signature
})

const hash = TxEnvelopeEip2930.hash(envelope_signed) // [!code focus]
```

## Functions

| Name                | Description                         |
| ------------------- | ----------------------------------- |
| [`TxEnvelopeEip2930.assert`](/api/TxEnvelopeEip2930/assert) | Asserts a [`TxEnvelopeEip2930.TxEnvelopeEip2930`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930) is valid. |
| [`TxEnvelopeEip2930.deserialize`](/api/TxEnvelopeEip2930/deserialize) | Deserializes a [`TxEnvelopeEip2930.TxEnvelopeEip2930`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930) from its serialized form. |
| [`TxEnvelopeEip2930.from`](/api/TxEnvelopeEip2930/from) | Converts an arbitrary transaction object into an EIP-2930 Transaction Envelope. |
| [`TxEnvelopeEip2930.getSignPayload`](/api/TxEnvelopeEip2930/getSignPayload) | Returns the payload to sign for a [`TxEnvelopeEip2930.TxEnvelopeEip2930`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930). |
| [`TxEnvelopeEip2930.hash`](/api/TxEnvelopeEip2930/hash) | Hashes a [`TxEnvelopeEip2930.TxEnvelopeEip2930`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930). This is the "transaction hash". |
| [`TxEnvelopeEip2930.serialize`](/api/TxEnvelopeEip2930/serialize) | Serializes a [`TxEnvelopeEip2930.TxEnvelopeEip2930`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930). |
| [`TxEnvelopeEip2930.toRpc`](/api/TxEnvelopeEip2930/toRpc) | Converts an [`TxEnvelopeEip2930.TxEnvelopeEip2930`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930) to an [`TxEnvelopeEip2930.Rpc`](/api/TxEnvelopeEip2930/types#rpc). |
| [`TxEnvelopeEip2930.validate`](/api/TxEnvelopeEip2930/validate) | Validates a [`TxEnvelopeEip2930.TxEnvelopeEip2930`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930). Returns `true` if the envelope is valid, `false` otherwise. |

## Types

| Name                | Description                         |
| ------------------- | ----------------------------------- |
| [`TxEnvelopeEip2930.Rpc`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930rpc) |  |
| [`TxEnvelopeEip2930.Serialized`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930serialized) |  |
| [`TxEnvelopeEip2930.SerializedType`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930serializedtype) |  |
| [`TxEnvelopeEip2930.Signed`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930signed) |  |
| [`TxEnvelopeEip2930.TxEnvelopeEip2930`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930txenvelopeeip2930) |  |
| [`TxEnvelopeEip2930.Type`](/api/TxEnvelopeEip2930/types#txenvelopeeip2930type) |  |