ox
Version:
433 lines • 14.4 kB
JavaScript
import * as AccessList from './AccessList.js';
import * as Address from './Address.js';
import * as Hash from './Hash.js';
import * as Hex from './Hex.js';
import * as Rlp from './Rlp.js';
import * as Signature from './Signature.js';
import * as TransactionEnvelope from './TransactionEnvelope.js';
export const serializedType = '0x02';
export const type = 'eip1559';
/**
* Asserts a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559} is valid.
*
* @example
* ```ts twoslash
* import { TransactionEnvelopeEip1559, Value } from 'ox'
*
* TransactionEnvelopeEip1559.assert({
* maxFeePerGas: 2n ** 256n - 1n + 1n,
* chainId: 1,
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1'),
* })
* // @error: FeeCapTooHighError:
* // @error: The fee cap (`masFeePerGas` = 115792089237316195423570985008687907853269984665640564039457584007913 gwei) cannot be
* // @error: higher than the maximum allowed value (2^256-1).
* ```
*
* @param envelope - The transaction envelope to assert.
*/
export function assert(envelope) {
const { chainId, maxPriorityFeePerGas, maxFeePerGas, to } = envelope;
if (chainId <= 0)
throw new TransactionEnvelope.InvalidChainIdError({ chainId });
if (to)
Address.assert(to, { strict: false });
if (maxFeePerGas && BigInt(maxFeePerGas) > 2n ** 256n - 1n)
throw new TransactionEnvelope.FeeCapTooHighError({ feeCap: maxFeePerGas });
if (maxPriorityFeePerGas &&
maxFeePerGas &&
maxPriorityFeePerGas > maxFeePerGas)
throw new TransactionEnvelope.TipAboveFeeCapError({
maxFeePerGas,
maxPriorityFeePerGas,
});
}
/**
* Deserializes a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559} from its serialized form.
*
* @example
* ```ts twoslash
* import { TransactionEnvelopeEip1559 } from 'ox'
*
* const envelope = TransactionEnvelopeEip1559.deserialize('0x02ef0182031184773594008477359400809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c0')
* // @log: {
* // @log: type: 'eip1559',
* // @log: nonce: 785n,
* // @log: maxFeePerGas: 2000000000n,
* // @log: gas: 1000000n,
* // @log: to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
* // @log: value: 1000000000000000000n,
* // @log: }
* ```
*
* @param serialized - The serialized transaction.
* @returns Deserialized Transaction Envelope.
*/
export function deserialize(serialized) {
const transactionArray = Rlp.toHex(Hex.slice(serialized, 1));
const [chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gas, to, value, data, accessList, yParity, r, s,] = transactionArray;
if (!(transactionArray.length === 9 || transactionArray.length === 12))
throw new TransactionEnvelope.InvalidSerializedError({
attributes: {
chainId,
nonce,
maxPriorityFeePerGas,
maxFeePerGas,
gas,
to,
value,
data,
accessList,
...(transactionArray.length > 9
? {
yParity,
r,
s,
}
: {}),
},
serialized,
type,
});
let transaction = {
chainId: Number(chainId),
type,
};
if (Hex.validate(to) && to !== '0x')
transaction.to = to;
if (Hex.validate(gas) && gas !== '0x')
transaction.gas = BigInt(gas);
if (Hex.validate(data) && data !== '0x')
transaction.data = data;
if (Hex.validate(nonce))
transaction.nonce = nonce === '0x' ? 0n : BigInt(nonce);
if (Hex.validate(value) && value !== '0x')
transaction.value = BigInt(value);
if (Hex.validate(maxFeePerGas) && maxFeePerGas !== '0x')
transaction.maxFeePerGas = BigInt(maxFeePerGas);
if (Hex.validate(maxPriorityFeePerGas) && maxPriorityFeePerGas !== '0x')
transaction.maxPriorityFeePerGas = BigInt(maxPriorityFeePerGas);
if (accessList.length !== 0 && accessList !== '0x')
transaction.accessList = AccessList.fromTupleList(accessList);
const signature = r && s && yParity ? Signature.fromTuple([yParity, r, s]) : undefined;
if (signature)
transaction = {
...transaction,
...signature,
};
assert(transaction);
return transaction;
}
/**
* Converts an arbitrary transaction object into an EIP-1559 Transaction Envelope.
*
* @example
* ```ts twoslash
* import { TransactionEnvelopeEip1559, Value } from 'ox'
*
* const envelope = TransactionEnvelopeEip1559.from({
* chainId: 1,
* maxFeePerGas: Value.fromGwei('10'),
* maxPriorityFeePerGas: Value.fromGwei('1'),
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1'),
* })
* ```
*
* @example
* ### Attaching Signatures
*
* It is possible to attach a `signature` to the transaction envelope.
*
* ```ts twoslash
* import { Secp256k1, TransactionEnvelopeEip1559, Value } from 'ox'
*
* const envelope = TransactionEnvelopeEip1559.from({
* chainId: 1,
* maxFeePerGas: Value.fromGwei('10'),
* maxPriorityFeePerGas: Value.fromGwei('1'),
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1'),
* })
*
* const signature = Secp256k1.sign({
* payload: TransactionEnvelopeEip1559.getSignPayload(envelope),
* privateKey: '0x...',
* })
*
* const envelope_signed = TransactionEnvelopeEip1559.from(envelope, { // [!code focus]
* signature, // [!code focus]
* }) // [!code focus]
* // @log: {
* // @log: chainId: 1,
* // @log: maxFeePerGas: 10000000000n,
* // @log: maxPriorityFeePerGas: 1000000000n,
* // @log: to: '0x0000000000000000000000000000000000000000',
* // @log: type: 'eip1559',
* // @log: value: 1000000000000000000n,
* // @log: r: 125...n,
* // @log: s: 642...n,
* // @log: yParity: 0,
* // @log: }
* ```
*
* @example
* ### From Serialized
*
* It is possible to instantiate an EIP-1559 Transaction Envelope from a {@link ox#TransactionEnvelopeEip1559.Serialized} value.
*
* ```ts twoslash
* import { TransactionEnvelopeEip1559 } from 'ox'
*
* const envelope = TransactionEnvelopeEip1559.from('0x02f858018203118502540be4008504a817c800809470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c08477359400e1a001627c687261b0e7f8638af1112efa8a77e23656f6e7945275b19e9deed80261')
* // @log: {
* // @log: chainId: 1,
* // @log: maxFeePerGas: 10000000000n,
* // @log: maxPriorityFeePerGas: 1000000000n,
* // @log: to: '0x0000000000000000000000000000000000000000',
* // @log: type: 'eip1559',
* // @log: value: 1000000000000000000n,
* // @log: }
* ```
*
* @param envelope - The transaction object to convert.
* @param options - Options.
* @returns An EIP-1559 Transaction Envelope.
*/
export function from(envelope, options = {}) {
const { signature } = options;
const envelope_ = (typeof envelope === 'string' ? deserialize(envelope) : envelope);
assert(envelope_);
return {
...envelope_,
...(signature ? Signature.from(signature) : {}),
type: 'eip1559',
};
}
/**
* Returns the payload to sign for a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}.
*
* @example
* The example below demonstrates how to compute the sign payload which can be used
* with ECDSA signing utilities like {@link ox#Secp256k1.(sign:function)}.
*
* ```ts twoslash
* import { Secp256k1, TransactionEnvelopeEip1559 } from 'ox'
*
* const envelope = TransactionEnvelopeEip1559.from({
* chainId: 1,
* nonce: 0n,
* maxFeePerGas: 1000000000n,
* gas: 21000n,
* to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
* value: 1000000000000000000n,
* })
*
* const payload = TransactionEnvelopeEip1559.getSignPayload(envelope) // [!code focus]
* // @log: '0x...'
*
* const signature = Secp256k1.sign({ payload, privateKey: '0x...' })
* ```
*
* @param envelope - The transaction envelope to get the sign payload for.
* @returns The sign payload.
*/
export function getSignPayload(envelope) {
return hash(envelope, { presign: true });
}
/**
* Hashes a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}. This is the "transaction hash".
*
* @example
* ```ts twoslash
* import { Secp256k1, TransactionEnvelopeEip1559 } from 'ox'
*
* const envelope = TransactionEnvelopeEip1559.from({
* chainId: 1,
* nonce: 0n,
* maxFeePerGas: 1000000000n,
* gas: 21000n,
* to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
* value: 1000000000000000000n,
* })
*
* const signature = Secp256k1.sign({
* payload: TransactionEnvelopeEip1559.getSignPayload(envelope),
* privateKey: '0x...'
* })
*
* const envelope_signed = TransactionEnvelopeEip1559.from(envelope, { signature })
*
* const hash = TransactionEnvelopeEip1559.hash(envelope_signed) // [!code focus]
* ```
*
* @param envelope - The EIP-1559 Transaction Envelope to hash.
* @param options - Options.
* @returns The hash of the transaction envelope.
*/
export function hash(envelope, options = {}) {
const { presign } = options;
return Hash.keccak256(serialize({
...envelope,
...(presign
? {
r: undefined,
s: undefined,
yParity: undefined,
v: undefined,
}
: {}),
}));
}
/**
* Serializes a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}.
*
* @example
* ```ts twoslash
* import { TransactionEnvelopeEip1559, Value } from 'ox'
*
* const envelope = TransactionEnvelopeEip1559.from({
* chainId: 1,
* maxFeePerGas: Value.fromGwei('10'),
* maxPriorityFeePerGas: Value.fromGwei('1'),
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1'),
* })
*
* const serialized = TransactionEnvelopeEip1559.serialize(envelope) // [!code focus]
* ```
*
* @example
* ### Attaching Signatures
*
* It is possible to attach a `signature` to the serialized Transaction Envelope.
*
* ```ts twoslash
* import { Secp256k1, TransactionEnvelopeEip1559, Value } from 'ox'
*
* const envelope = TransactionEnvelopeEip1559.from({
* chainId: 1,
* maxFeePerGas: Value.fromGwei('10'),
* maxPriorityFeePerGas: Value.fromGwei('1'),
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1'),
* })
*
* const signature = Secp256k1.sign({
* payload: TransactionEnvelopeEip1559.getSignPayload(envelope),
* privateKey: '0x...',
* })
*
* const serialized = TransactionEnvelopeEip1559.serialize(envelope, { // [!code focus]
* signature, // [!code focus]
* }) // [!code focus]
*
* // ... send `serialized` transaction to JSON-RPC `eth_sendRawTransaction`
* ```
*
* @param envelope - The Transaction Envelope to serialize.
* @param options - Options.
* @returns The serialized Transaction Envelope.
*/
export function serialize(envelope, options = {}) {
const { chainId, gas, nonce, to, value, maxFeePerGas, maxPriorityFeePerGas, accessList, data, input, } = envelope;
assert(envelope);
const accessTupleList = AccessList.toTupleList(accessList);
const signature = Signature.extract(options.signature || envelope);
const serialized = [
Hex.fromNumber(chainId),
nonce ? Hex.fromNumber(nonce) : '0x',
maxPriorityFeePerGas ? Hex.fromNumber(maxPriorityFeePerGas) : '0x',
maxFeePerGas ? Hex.fromNumber(maxFeePerGas) : '0x',
gas ? Hex.fromNumber(gas) : '0x',
to ?? '0x',
value ? Hex.fromNumber(value) : '0x',
data ?? input ?? '0x',
accessTupleList,
...(signature ? Signature.toTuple(signature) : []),
];
return Hex.concat(serializedType, Rlp.fromHex(serialized));
}
/**
* Converts an {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559} to an {@link ox#TransactionEnvelopeEip1559.Rpc}.
*
* @example
* ```ts twoslash
* import { RpcRequest, TransactionEnvelopeEip1559, Value } from 'ox'
*
* const envelope = TransactionEnvelopeEip1559.from({
* chainId: 1,
* nonce: 0n,
* gas: 21000n,
* to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
* value: Value.fromEther('1'),
* })
*
* const envelope_rpc = TransactionEnvelopeEip1559.toRpc(envelope) // [!code focus]
*
* const request = RpcRequest.from({
* id: 0,
* method: 'eth_sendTransaction',
* params: [envelope_rpc],
* })
* ```
*
* @param envelope - The EIP-1559 transaction envelope to convert.
* @returns An RPC-formatted EIP-1559 transaction envelope.
*/
export function toRpc(envelope) {
const signature = Signature.extract(envelope);
return {
...envelope,
chainId: Hex.fromNumber(envelope.chainId),
data: envelope.data ?? envelope.input,
type: '0x2',
...(typeof envelope.gas === 'bigint'
? { gas: Hex.fromNumber(envelope.gas) }
: {}),
...(typeof envelope.nonce === 'bigint'
? { nonce: Hex.fromNumber(envelope.nonce) }
: {}),
...(typeof envelope.value === 'bigint'
? { value: Hex.fromNumber(envelope.value) }
: {}),
...(typeof envelope.maxFeePerGas === 'bigint'
? { maxFeePerGas: Hex.fromNumber(envelope.maxFeePerGas) }
: {}),
...(typeof envelope.maxPriorityFeePerGas === 'bigint'
? {
maxPriorityFeePerGas: Hex.fromNumber(envelope.maxPriorityFeePerGas),
}
: {}),
...(signature ? Signature.toRpc(signature) : {}),
};
}
/**
* Validates a {@link ox#TransactionEnvelopeEip1559.TransactionEnvelopeEip1559}. Returns `true` if the envelope is valid, `false` otherwise.
*
* @example
* ```ts twoslash
* import { TransactionEnvelopeEip1559, Value } from 'ox'
*
* const valid = TransactionEnvelopeEip1559.assert({
* maxFeePerGas: 2n ** 256n - 1n + 1n,
* chainId: 1,
* to: '0x0000000000000000000000000000000000000000',
* value: Value.fromEther('1'),
* })
* // @log: false
* ```
*
* @param envelope - The transaction envelope to validate.
*/
export function validate(envelope) {
try {
assert(envelope);
return true;
}
catch {
return false;
}
}
//# sourceMappingURL=TransactionEnvelopeEip1559.js.map