Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidate normalizeTxParams method usage #3588

Merged
merged 2 commits into from
Aug 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 1 addition & 25 deletions packages/block/src/block/constructors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ import {
createTxFromBlockBodyData,
createTxFromSerializedData,
createTxFromTxData,
normalizeTxParams,
} from '@ethereumjs/tx'
import {
CLRequestFactory,
ConsolidationRequest,
DepositRequest,
TypeOutput,
Withdrawal,
WithdrawalRequest,
bigIntToHex,
Expand All @@ -22,9 +22,6 @@ import {
hexToBytes,
intToHex,
isHexString,
setLengthLeft,
toBytes,
toType,
} from '@ethereumjs/util'

import { generateCliqueBlockExtraData } from '../consensus/clique.js'
Expand Down Expand Up @@ -59,27 +56,6 @@ import type {
WithdrawalBytes,
} from '@ethereumjs/util'

export function normalizeTxParams(_txParams: any) {
const txParams = Object.assign({}, _txParams)

txParams.gasLimit = toType(txParams.gasLimit ?? txParams.gas, TypeOutput.BigInt)
txParams.data = txParams.data === undefined ? txParams.input : txParams.data

// check and convert gasPrice and value params
txParams.gasPrice = txParams.gasPrice !== undefined ? BigInt(txParams.gasPrice) : undefined
txParams.value = txParams.value !== undefined ? BigInt(txParams.value) : undefined

// strict byte length checking
txParams.to =
txParams.to !== null && txParams.to !== undefined
? setLengthLeft(toBytes(txParams.to), 20)
: null

txParams.v = toType(txParams.v, TypeOutput.BigInt)

return txParams
}

/**
* Static constructor to create a block from a block data dictionary
*
Expand Down
36 changes: 0 additions & 36 deletions packages/tx/src/fromRpc.ts

This file was deleted.

3 changes: 3 additions & 0 deletions packages/tx/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@ export {

// Types
export * from './types.js'

// Utils
export * from './util.js'
2 changes: 1 addition & 1 deletion packages/tx/src/transactionFactory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import { create1559FeeMarketTx, create1559FeeMarketTxFromRLP } from './1559/cons
import { create2930AccessListTx, create2930AccessListTxFromRLP } from './2930/constructors.js'
import { create4844BlobTx, create4844BlobTxFromRLP } from './4844/constructors.js'
import { create7702EOACodeTx, create7702EOACodeTxFromRLP } from './7702/constructors.js'
import { normalizeTxParams } from './fromRpc.js'
import {
createLegacyTx,
createLegacyTxFromBytesArray,
Expand All @@ -18,6 +17,7 @@ import {
isFeeMarketEIP1559TxData,
isLegacyTxData,
} from './types.js'
import { normalizeTxParams } from './util.js'

import type { Transaction, TxData, TxOptions, TypedTxData } from './types.js'
import type { EthersProvider } from '@ethereumjs/util'
Expand Down
43 changes: 43 additions & 0 deletions packages/tx/src/util.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
import {
type PrefixedHexString,
TypeOutput,
bytesToHex,
hexToBytes,
setLengthLeft,
toBytes,
toType,
validateNoLeadingZeroes,
} from '@ethereumjs/util'

Expand All @@ -16,6 +19,7 @@ import type {
AuthorizationListBytes,
AuthorizationListItem,
TransactionType,
TypedTxData,
} from './types.js'
import type { Common } from '@ethereumjs/common'

Expand Down Expand Up @@ -249,3 +253,42 @@ export function validateNotArray(values: { [key: string]: any }) {
}
}
}

/**
* Normalizes values for transactions that are received from an RPC provider to be properly usable within
* the ethereumjs context
* @param txParamsFromRPC a transaction in the standard JSON-RPC format
* @returns a normalized {@link TypedTxData} object with valid values
*/
export const normalizeTxParams = (txParamsFromRPC: any): TypedTxData => {
const txParams = Object.assign({}, txParamsFromRPC)

txParams.gasLimit = toType(txParams.gasLimit ?? txParams.gas, TypeOutput.BigInt)
txParams.data = txParams.data === undefined ? txParams.input : txParams.data

// check and convert gasPrice and value params
txParams.gasPrice = txParams.gasPrice !== undefined ? BigInt(txParams.gasPrice) : undefined
txParams.value = txParams.value !== undefined ? BigInt(txParams.value) : undefined

// strict byte length checking
txParams.to =
txParams.to !== null && txParams.to !== undefined
? setLengthLeft(toBytes(txParams.to), 20)
: null

// Normalize the v/r/s values. If RPC returns '0x0', ensure v/r/s are set to `undefined` in the tx.
// If this is not done, then the transaction creation will throw, because `v` is `0`.
// Note: this still means that `isSigned` will return `false`.
// v/r/s values are `0x0` on networks like Optimism, where the tx is a system tx.
// For instance: https://optimistic.etherscan.io/tx/0xf4304cb09b3f58a8e5d20fec5f393c96ccffe0269aaf632cb2be7a8a0f0c91cc

txParams.v = txParams.v === '0x0' ? '0x' : txParams.v
txParams.r = txParams.r === '0x0' ? '0x' : txParams.r
txParams.s = txParams.s === '0x0' ? '0x' : txParams.s

if (txParams.v !== '0x' || txParams.r !== '0x' || txParams.s !== '0x') {
txParams.v = toType(txParams.v, TypeOutput.BigInt)
}

return txParams
}
2 changes: 1 addition & 1 deletion packages/tx/test/fromRpc.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ import { Common, Hardfork, Mainnet, createCustomCommon } from '@ethereumjs/commo
import { bytesToHex, randomBytes } from '@ethereumjs/util'
import { assert, describe, it } from 'vitest'

import { normalizeTxParams } from '../src/fromRpc.js'
import {
TransactionType,
createTxFromJsonRpcProvider,
createTxFromRPC,
createTxFromTxData,
} from '../src/index.js'
import { normalizeTxParams } from '../src/util.js'

import optimismTx from './json/optimismTx.json'
import rpcTx from './json/rpcTx.json'
Expand Down
Loading