# TxEnvelopeLegacy

Utility functions for working
with **Legacy Transaction Envelopes**.

## Examples

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

* [Instantiating](#instantiating)

* [Signing](#signing)

* [Serializing](#serializing)

* [Sending](#sending)

* [Computing Hashes](#computing-hashes)

### Instantiating

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

```ts twoslash
import { TxEnvelopeLegacy, Value } from 'ox'

const envelope = TxEnvelopeLegacy.from({
  gasPrice: Value.fromGwei('10'),
  to: '0x0000000000000000000000000000000000000000',
  value: Value.fromEther('1')
})
```

*

### Signing

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

```ts twoslash
// @noErrors
import { Secp256k1, TxEnvelopeLegacy } from 'ox'

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

const signature = Secp256k1.sign({
  // [!code focus]
  payload: TxEnvelopeLegacy.getSignPayload(envelope), // [!code focus]
  privateKey: '0x...' // [!code focus]
}) // [!code focus]

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

### Serializing

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

```ts twoslash
import { TxEnvelopeLegacy, Value } from 'ox'

const envelope = TxEnvelopeLegacy.from({
  chainId: 1,
  gasPrice: Value.fromGwei('10'),
  to: '0x0000000000000000000000000000000000000000',
  value: Value.fromEther('1')
})

const serialized = TxEnvelopeLegacy.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,
  TxEnvelopeLegacy,
  Secp256k1,
  Value
} from 'ox'

// Construct the Envelope.
const envelope = TxEnvelopeLegacy.from({
  chainId: 1,
  gasPrice: Value.fromGwei('10'),
  nonce: 69n,
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: Value.fromEther('1.5')
})

// Sign over the Envelope.
const signature = Secp256k1.sign({
  payload: TxEnvelopeLegacy.getSignPayload(envelope),
  privateKey: '0x...'
})

// Serialize the Envelope with the Signature. // [!code focus]
const serialized = TxEnvelopeLegacy.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
[`TxEnvelopeLegacy.toRpc`](/api/TxEnvelopeLegacy/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, TxEnvelopeLegacy, Value } from 'ox'

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

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

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

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

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

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

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

## Functions

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

## Types

| Name                | Description                         |
| ------------------- | ----------------------------------- |
| [`TxEnvelopeLegacy.Rpc`](/api/TxEnvelopeLegacy/types#txenvelopelegacyrpc) |  |
| [`TxEnvelopeLegacy.Serialized`](/api/TxEnvelopeLegacy/types#txenvelopelegacyserialized) |  |
| [`TxEnvelopeLegacy.Signed`](/api/TxEnvelopeLegacy/types#txenvelopelegacysigned) |  |
| [`TxEnvelopeLegacy.TxEnvelopeLegacy`](/api/TxEnvelopeLegacy/types#txenvelopelegacytxenvelopelegacy) |  |
| [`TxEnvelopeLegacy.Type`](/api/TxEnvelopeLegacy/types#txenvelopelegacytype) |  |