Util: treeshaking tasks (#3589)

* util: extract static withdrawal constructor functions * util: rename withdrawal constructor functions * update downstream * util: rename requests.ts > request.ts * util: extract static DepositRequest constructors * update downstream * util: extract static constructors from WithdrawalRequest * util: extract static constructors for ConsolidationRequest * fix request constructor test * util: rename fromValuesArray to fromBytesArray * util: rename request "fromBytes" to "fromRLP" * spellcheck * remove lint exception * remove lint exception * Add docstrings --------- Co-authored-by: acolytec3 <[email protected]>
ethereumjs · Aug 29, 2024 · dc906d0 · dc906d0
1 parent 7df96ff
commit dc906d0
Show file tree

Hide file tree

Showing 19 changed files with 233 additions and 198 deletions.
diff --git a/packages/block/src/block/constructors.ts b/packages/block/src/block/constructors.ts
@@ -9,13 +9,13 @@ import {
 } from '@ethereumjs/tx'
 import {
   CLRequestFactory,
-  ConsolidationRequest,
-  DepositRequest,
-  Withdrawal,
-  WithdrawalRequest,
   bigIntToHex,
   bytesToHex,
   bytesToUtf8,
+  createConsolidationRequestFromJSON,
+  createDepositRequestFromJSON,
+  createWithdrawal,
+  createWithdrawalRequestFromJSON,
   equalsBytes,
   fetchFromProvider,
   getProvider,
@@ -103,7 +103,7 @@ export function createBlock(blockData: BlockData = {}, opts?: BlockOptions) {
     uncleHeaders.push(uh)
   }
 
-  const withdrawals = withdrawalsData?.map(Withdrawal.fromWithdrawalData)
+  const withdrawals = withdrawalsData?.map(createWithdrawal)
   // The witness data is planned to come in rlp serialized bytes so leave this
   // stub till that time
   const executionWitness = executionWitnessData
@@ -220,7 +220,7 @@ export function createBlockFromBytesArray(values: BlockBytes, opts?: BlockOption
       address,
       amount,
     }))
-    ?.map(Withdrawal.fromWithdrawalData)
+    ?.map(createWithdrawal)
 
   let requests
   if (header.common.isActivatedEIP(7685)) {
@@ -402,7 +402,7 @@ export async function createBlockFromExecutionPayload(
   }
 
   const transactionsTrie = await genTransactionsTrieRoot(txs, new Trie({ common: opts?.common }))
-  const withdrawals = withdrawalsData?.map((wData) => Withdrawal.fromWithdrawalData(wData))
+  const withdrawals = withdrawalsData?.map((wData) => createWithdrawal(wData))
   const withdrawalsRoot = withdrawals
     ? await genWithdrawalsTrieRoot(withdrawals, new Trie({ common: opts?.common }))
     : undefined
@@ -419,17 +419,17 @@ export async function createBlockFromExecutionPayload(
 
   if (depositRequests !== undefined && depositRequests !== null) {
     for (const dJson of depositRequests) {
-      requests!.push(DepositRequest.fromJSON(dJson))
+      requests!.push(createDepositRequestFromJSON(dJson))
     }
   }
   if (withdrawalRequests !== undefined && withdrawalRequests !== null) {
     for (const wJson of withdrawalRequests) {
-      requests!.push(WithdrawalRequest.fromJSON(wJson))
+      requests!.push(createWithdrawalRequestFromJSON(wJson))
     }
   }
   if (consolidationRequests !== undefined && consolidationRequests !== null) {
     for (const cJson of consolidationRequests) {
-      requests!.push(ConsolidationRequest.fromJSON(cJson))
+      requests!.push(createConsolidationRequestFromJSON(cJson))
     }
   }
 

diff --git a/packages/block/test/eip4895block.spec.ts b/packages/block/test/eip4895block.spec.ts
@@ -3,7 +3,7 @@ import { RLP } from '@ethereumjs/rlp'
 import {
   Address,
   KECCAK256_RLP,
-  Withdrawal,
+  createWithdrawalFromBytesArray,
   hexToBytes,
   randomBytes,
   zeros,
@@ -40,7 +40,7 @@ describe('EIP4895 tests', () => {
     // get withdrawalsArray
     const gethBlockBytesArray = RLP.decode(hexToBytes(`0x${gethWithdrawals8BlockRlp}`))
     const withdrawals = (gethBlockBytesArray[3] as WithdrawalBytes[]).map((wa) =>
-      Withdrawal.fromValuesArray(wa),
+      createWithdrawalFromBytesArray(wa),
     )
     assert.equal(withdrawals.length, 8, '8 withdrawals should have been found')
     const gethWithdrawalsRoot = (gethBlockBytesArray[0] as Uint8Array[])[16] as Uint8Array

diff --git a/packages/block/test/eip7685block.spec.ts b/packages/block/test/eip7685block.spec.ts
@@ -1,9 +1,9 @@
 import { Common, Hardfork, Mainnet } from '@ethereumjs/common'
 import {
-  DepositRequest,
   KECCAK256_RLP,
-  WithdrawalRequest,
   bytesToBigInt,
+  createDepositRequest,
+  createWithdrawalRequest,
   randomBytes,
 } from '@ethereumjs/util'
 import { assert, describe, expect, it } from 'vitest'
@@ -27,7 +27,7 @@ function getRandomDepositRequest(): CLRequest<CLRequestType> {
     signature: randomBytes(96),
     index: bytesToBigInt(randomBytes(8)),
   }
-  return DepositRequest.fromRequestData(depositRequestData) as CLRequest<CLRequestType>
+  return createDepositRequest(depositRequestData) as CLRequest<CLRequestType>
 }
 
 function getRandomWithdrawalRequest(): CLRequest<CLRequestType> {
@@ -36,7 +36,7 @@ function getRandomWithdrawalRequest(): CLRequest<CLRequestType> {
     validatorPubkey: randomBytes(48),
     amount: bytesToBigInt(randomBytes(8)),
   }
-  return WithdrawalRequest.fromRequestData(withdrawalRequestData) as CLRequest<CLRequestType>
+  return createWithdrawalRequest(withdrawalRequestData) as CLRequest<CLRequestType>
 }
 
 const common = new Common({
@@ -109,7 +109,7 @@ describe('7685 tests', () => {
   })
 })
 
-describe('fromValuesArray tests', () => {
+describe('createWithdrawalFromBytesArray tests', () => {
   it('should construct a block with empty requests root', () => {
     const block = createBlockFromBytesArray(
       [createBlockHeader({}, { common }).raw(), [], [], [], []],

diff --git a/packages/block/test/header.spec.ts b/packages/block/test/header.spec.ts
@@ -129,7 +129,7 @@ describe('[Block]: Header functions', () => {
     }
   })
 
-  it('Initialization -> fromValuesArray()', () => {
+  it('Initialization -> createWithdrawalFromBytesArray()', () => {
     const common = new Common({ chain: Mainnet, hardfork: Hardfork.London })
     const zero = new Uint8Array(0)
     const headerArray = []
@@ -156,7 +156,7 @@ describe('[Block]: Header functions', () => {
     )
   })
 
-  it('Initialization -> fromValuesArray() -> error cases', () => {
+  it('Initialization -> createWithdrawalFromBytesArray() -> error cases', () => {
     const headerArray = Array(22).fill(new Uint8Array(0))
 
     // mock header data (if set to zeros(0) header throws)

diff --git a/packages/client/test/rpc/engine/preimages.spec.ts b/packages/client/test/rpc/engine/preimages.spec.ts
@@ -6,8 +6,8 @@ import {
 } from '@ethereumjs/block'
 import { createTxFromSerializedData } from '@ethereumjs/tx'
 import {
-  Withdrawal,
   bytesToHex,
+  createWithdrawal,
   equalsBytes,
   hexToBytes,
   intToBytes,
@@ -50,7 +50,7 @@ async function genBlockWithdrawals(blockNumber: number) {
           }
         })
   const withdrawalsRoot = bytesToHex(
-    await genWithdrawalsTrieRoot(withdrawals.map(Withdrawal.fromWithdrawalData)),
+    await genWithdrawalsTrieRoot(withdrawals.map(createWithdrawal)),
   )
 
   return { withdrawals, withdrawalsRoot }

diff --git a/packages/client/test/rpc/engine/withdrawals.spec.ts b/packages/client/test/rpc/engine/withdrawals.spec.ts
@@ -1,6 +1,6 @@
 import { genWithdrawalsTrieRoot } from '@ethereumjs/block'
 import { Trie } from '@ethereumjs/trie'
-import { Withdrawal, bigIntToHex, bytesToHex, intToHex } from '@ethereumjs/util'
+import { bigIntToHex, bytesToHex, createWithdrawal, intToHex } from '@ethereumjs/util'
 import { assert, it } from 'vitest'
 
 import { INVALID_PARAMS } from '../../../src/rpc/error-code.js'
@@ -105,7 +105,7 @@ for (const { name, withdrawals, withdrawalsRoot, gethBlockRlp } of testCases) {
   it(name, async () => {
     // check withdrawals root computation
     const computedWithdrawalsRoot = bytesToHex(
-      await genWithdrawalsTrieRoot(withdrawals.map(Withdrawal.fromWithdrawalData), new Trie()),
+      await genWithdrawalsTrieRoot(withdrawals.map(createWithdrawal), new Trie()),
     )
     assert.equal(
       withdrawalsRoot,

diff --git a/packages/tx/test/base.spec.ts b/packages/tx/test/base.spec.ts
@@ -184,7 +184,7 @@ describe('[BaseTransaction]', () => {
     }
   })
 
-  it('fromValuesArray()', () => {
+  it('createWithdrawalFromBytesArray()', () => {
     let rlpData: any = legacyTxs[0].raw()
     rlpData[0] = toBytes('0x0')
     try {
@@ -270,7 +270,7 @@ describe('[BaseTransaction]', () => {
       for (const tx of txType.txs) {
         assert.ok(
           txType.create.bytesArray(tx.raw() as any, { common }),
-          `${txType.name}: should do roundtrip raw() -> fromValuesArray()`,
+          `${txType.name}: should do roundtrip raw() -> createWithdrawalFromBytesArray()`,
         )
       }
     }

diff --git a/packages/tx/test/legacy.spec.ts b/packages/tx/test/legacy.spec.ts
@@ -99,7 +99,7 @@ describe('[Transaction]', () => {
     )
   })
 
-  it('Initialization -> decode with fromValuesArray()', () => {
+  it('Initialization -> decode with createWithdrawalFromBytesArray()', () => {
     for (const tx of txFixtures.slice(0, 4)) {
       const txData = tx.raw.map((rawTxData) => hexToBytes(rawTxData as PrefixedHexString))
       const pt = createLegacyTxFromBytesArray(txData)

diff --git a/packages/util/examples/withdrawal.ts b/packages/util/examples/withdrawal.ts
@@ -1,6 +1,6 @@
-import { Withdrawal } from '@ethereumjs/util'
+import { createWithdrawal } from '@ethereumjs/util'
 
-const withdrawal = Withdrawal.fromWithdrawalData({
+const withdrawal = createWithdrawal({
   index: 0n,
   validatorIndex: 65535n,
   address: '0x0000000000000000000000000000000000000000',

diff --git a/packages/util/src/index.ts b/packages/util/src/index.ts
@@ -64,6 +64,6 @@ export * from './kzg.js'
 export * from './lock.js'
 export * from './mapDB.js'
 export * from './provider.js'
-export * from './requests.js'
+export * from './request.js'
 export * from './tasks.js'
 export * from './verkle.js'