TX package cleanup (#3890)

* tx: cleanup: get rid of access/authority JSONs inside the tx

* vm: fix build

* tx: ensure jsons do not get auto-generated in constructors

* tx: add util docs

* tx: fix access list related tests

* tx: rename imports .js back to .ts

* tx: move capability-specific utilities to capabilities

* remove duplicate code

* tx: minor readability improvements

* tx: remove any

* tx: eip7702 refactor

* tx: eip2930 refactor

* tx: undo eip2930 refactor

* tx: simplify 2930

* tx: update TODO comment to include issue

* tx: cleanup 7702 logic

* tx: fix 2930 test cases

* tx: 7702 add length check for auth list

* tx: eip2930 move back methods to util and use correct capability sig

* tx: eip2930 also use `EIP2930CompatibleTx` as function arg for capability method

* tx: ensure 7702 is also compliant to capability method sigs + move back utility methods from 7702 to util

* tx: split and move util methods

* tx: only export util/general

* tx: split up util more (authorization+access dedicated)

* tx: checkMaxInitCodeSize moved into internal util

* tx: also move txTypeBytse and validateNotArray to internal util methods

* tx: fix test imports

---------

Co-authored-by: ScottyPoi <[email protected]>
Co-authored-by: Gabriel Rocheleau <[email protected]>

Author: 3 people

packages/tx/src/1559/constructors.ts

@@ -8,7 +8,7 @@ import {
 } from '@ethereumjs/util'
 
 import { TransactionType } from '../types.ts'
-import { txTypeBytes, validateNotArray } from '../util.ts'
+import { txTypeBytes, validateNotArray } from '../util/internal.ts'
 
 import { FeeMarket1559Tx } from './tx.ts'
 

packages/tx/src/1559/tx.ts

@@ -13,16 +13,14 @@ import * as EIP1559 from '../capabilities/eip1559.ts'
 import * as EIP2718 from '../capabilities/eip2718.ts'
 import * as EIP2930 from '../capabilities/eip2930.ts'
 import * as Legacy from '../capabilities/legacy.ts'
-import { getBaseJSON, sharedConstructor, valueBoundaryCheck } from '../features/util.ts'
-import { TransactionType } from '../types.ts'
-import { AccessLists } from '../util.ts'
+import { TransactionType, isAccessList } from '../types.ts'
+import { getBaseJSON, sharedConstructor, valueBoundaryCheck } from '../util/internal.ts'
 
 import { createFeeMarket1559Tx } from './constructors.ts'
 
 import type { Common } from '@ethereumjs/common'
 import type { Address } from '@ethereumjs/util'
 import type {
-  AccessList,
   AccessListBytes,
   TxData as AllTypesTxData,
   TxValuesArray as AllTypesTxValuesArray,
@@ -32,6 +30,7 @@ import type {
   TransactionInterface,
   TxOptions,
 } from '../types.ts'
+import { accessListBytesToJSON, accessListJSONToBytes } from '../util/access.ts'
 
 export type TxData = AllTypesTxData[typeof TransactionType.FeeMarketEIP1559]
 export type TxValuesArray = AllTypesTxValuesArray[typeof TransactionType.FeeMarketEIP1559]
@@ -66,8 +65,6 @@ export class FeeMarket1559Tx
 
   // End of Tx data part
 
-  public readonly AccessListJSON: AccessList
-
   public readonly common!: Common
 
   readonly txOptions!: TxOptions
@@ -90,7 +87,8 @@ export class FeeMarket1559Tx
    */
   public constructor(txData: TxData, opts: TxOptions = {}) {
     sharedConstructor(this, { ...txData, type: TransactionType.FeeMarketEIP1559 }, opts)
-    const { chainId, accessList, maxFeePerGas, maxPriorityFeePerGas } = txData
+    const { chainId, accessList: rawAccessList, maxFeePerGas, maxPriorityFeePerGas } = txData
+    const accessList = rawAccessList ?? []
 
     if (chainId !== undefined && bytesToBigInt(toBytes(chainId)) !== this.common.chainId()) {
       throw EthereumJSErrorWithoutCode(
@@ -105,12 +103,10 @@ export class FeeMarket1559Tx
     this.activeCapabilities = this.activeCapabilities.concat([1559, 2718, 2930])
 
     // Populate the access list fields
-    const accessListData = AccessLists.getAccessListData(accessList ?? [])
-    this.accessList = accessListData.accessList
-    this.AccessListJSON = accessListData.AccessListJSON
-    // Verify the access list format.
-    AccessLists.verifyAccessList(this.accessList)
+    this.accessList = isAccessList(accessList) ? accessListJSONToBytes(accessList) : accessList
 
+    // Verify the access list format.
+    EIP2930.verifyAccessList(this)
     this.maxFeePerGas = bytesToBigInt(toBytes(maxFeePerGas))
     this.maxPriorityFeePerGas = bytesToBigInt(toBytes(maxPriorityFeePerGas))
 
@@ -332,7 +328,7 @@ export class FeeMarket1559Tx
    * Returns an object with the JSON representation of the transaction
    */
   toJSON(): JSONTx {
-    const accessListJSON = AccessLists.getAccessListJSON(this.accessList)
+    const accessListJSON = accessListBytesToJSON(this.accessList)
     const baseJSON = getBaseJSON(this)
 
     return {

packages/tx/src/2930/constructors.ts

@@ -8,7 +8,7 @@ import {
 } from '@ethereumjs/util'
 
 import { TransactionType } from '../types.ts'
-import { txTypeBytes, validateNotArray } from '../util.ts'
+import { txTypeBytes, validateNotArray } from '../util/internal.ts'
 
 import { AccessList2930Tx } from './tx.ts'
 

packages/tx/src/2930/tx.ts

@@ -11,16 +11,14 @@ import {
 import * as EIP2718 from '../capabilities/eip2718.ts'
 import * as EIP2930 from '../capabilities/eip2930.ts'
 import * as Legacy from '../capabilities/legacy.ts'
-import { getBaseJSON, sharedConstructor, valueBoundaryCheck } from '../features/util.ts'
-import { TransactionType } from '../types.ts'
-import { AccessLists } from '../util.ts'
+import { TransactionType, isAccessList } from '../types.ts'
+import { getBaseJSON, sharedConstructor, valueBoundaryCheck } from '../util/internal.ts'
 
 import { createAccessList2930Tx } from './constructors.ts'
 
 import type { Common } from '@ethereumjs/common'
 import type { Address } from '@ethereumjs/util'
 import type {
-  AccessList,
   AccessListBytes,
   TxData as AllTypesTxData,
   TxValuesArray as AllTypesTxValuesArray,
@@ -30,6 +28,7 @@ import type {
   TransactionInterface,
   TxOptions,
 } from '../types.ts'
+import { accessListBytesToJSON, accessListJSONToBytes } from '../util/access.ts'
 
 export type TxData = AllTypesTxData[typeof TransactionType.AccessListEIP2930]
 export type TxValuesArray = AllTypesTxValuesArray[typeof TransactionType.AccessListEIP2930]
@@ -62,8 +61,6 @@ export class AccessList2930Tx
 
   // End of Tx data part
 
-  public readonly AccessListJSON: AccessList
-
   public readonly common!: Common
 
   readonly txOptions!: TxOptions
@@ -86,7 +83,8 @@ export class AccessList2930Tx
    */
   public constructor(txData: TxData, opts: TxOptions = {}) {
     sharedConstructor(this, { ...txData, type: TransactionType.AccessListEIP2930 }, opts)
-    const { chainId, accessList, gasPrice } = txData
+    const { chainId, accessList: rawAccessList, gasPrice } = txData
+    const accessList = rawAccessList ?? []
 
     if (chainId !== undefined && bytesToBigInt(toBytes(chainId)) !== this.common.chainId()) {
       throw EthereumJSErrorWithoutCode(
@@ -102,11 +100,9 @@ export class AccessList2930Tx
     this.activeCapabilities = this.activeCapabilities.concat([2718, 2930])
 
     // Populate the access list fields
-    const accessListData = AccessLists.getAccessListData(accessList ?? [])
-    this.accessList = accessListData.accessList
-    this.AccessListJSON = accessListData.AccessListJSON
+    this.accessList = isAccessList(accessList) ? accessListJSONToBytes(accessList) : accessList
     // Verify the access list format.
-    AccessLists.verifyAccessList(this.accessList)
+    EIP2930.verifyAccessList(this)
 
     this.gasPrice = bytesToBigInt(toBytes(gasPrice))
 
@@ -307,7 +303,7 @@ export class AccessList2930Tx
    * Returns an object with the JSON representation of the transaction
    */
   toJSON(): JSONTx {
-    const accessListJSON = AccessLists.getAccessListJSON(this.accessList)
+    const accessListJSON = accessListBytesToJSON(this.accessList)
     const baseJSON = getBaseJSON(this)
 
     return {

packages/tx/src/4844/constructors.ts

@@ -15,7 +15,7 @@ import {
 
 import { paramsTx } from '../params.ts'
 import { TransactionType } from '../types.ts'
-import { AccessLists, txTypeBytes, validateNotArray } from '../util.ts'
+import { accessListBytesToJSON } from '../util/access.ts'
 
 import { Blob4844Tx } from './tx.ts'
 
@@ -25,6 +25,7 @@ import type {
   JSONBlobTxNetworkWrapper,
   TxOptions,
 } from '../types.ts'
+import { txTypeBytes, validateNotArray } from '../util/internal.ts'
 import type { TxData, TxValuesArray } from './tx.ts'
 
 const validateBlobTransactionNetworkWrapper = (
@@ -331,7 +332,7 @@ export function blobTxNetworkWrapperToJSON(
 ): JSONBlobTxNetworkWrapper {
   const tx = createBlob4844TxFromSerializedNetworkWrapper(serialized, opts)
 
-  const accessListJSON = AccessLists.getAccessListJSON(tx.accessList)
+  const accessListJSON = accessListBytesToJSON(tx.accessList)
   const baseJSON = tx.toJSON()
 
   return {

packages/tx/src/4844/tx.ts

@@ -16,16 +16,20 @@ import * as EIP1559 from '../capabilities/eip1559.ts'
 import * as EIP2718 from '../capabilities/eip2718.ts'
 import * as EIP2930 from '../capabilities/eip2930.ts'
 import * as Legacy from '../capabilities/legacy.ts'
-import { getBaseJSON, sharedConstructor, valueBoundaryCheck } from '../features/util.ts'
-import { TransactionType } from '../types.ts'
-import { AccessLists, validateNotArray } from '../util.ts'
+import { TransactionType, isAccessList } from '../types.ts'
+import { accessListBytesToJSON, accessListJSONToBytes } from '../util/access.ts'
+import {
+  getBaseJSON,
+  sharedConstructor,
+  validateNotArray,
+  valueBoundaryCheck,
+} from '../util/internal.ts'
 
 import { createBlob4844Tx } from './constructors.ts'
 
 import type { Common } from '@ethereumjs/common'
 import type { Address, PrefixedHexString } from '@ethereumjs/util'
 import type {
-  AccessList,
   AccessListBytes,
   TxData as AllTypesTxData,
   TxValuesArray as AllTypesTxValuesArray,
@@ -72,8 +76,6 @@ export class Blob4844Tx implements TransactionInterface<typeof TransactionType.B
   kzgCommitments?: PrefixedHexString[] // This property should only be populated when the transaction is in the "Network Wrapper" format
   kzgProofs?: PrefixedHexString[] // This property should only be populated when the transaction is in the "Network Wrapper" format
 
-  public readonly AccessListJSON: AccessList
-
   public readonly common!: Common
 
   readonly txOptions!: TxOptions
@@ -96,7 +98,14 @@ export class Blob4844Tx implements TransactionInterface<typeof TransactionType.B
    */
   constructor(txData: TxData, opts: TxOptions = {}) {
     sharedConstructor(this, { ...txData, type: TransactionType.BlobEIP4844 }, opts)
-    const { chainId, accessList, maxFeePerGas, maxPriorityFeePerGas, maxFeePerBlobGas } = txData
+    const {
+      chainId,
+      accessList: rawAccessList,
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+      maxFeePerBlobGas,
+    } = txData
+    const accessList = rawAccessList ?? []
 
     if (chainId !== undefined && bytesToBigInt(toBytes(chainId)) !== this.common.chainId()) {
       throw EthereumJSErrorWithoutCode(
@@ -115,11 +124,9 @@ export class Blob4844Tx implements TransactionInterface<typeof TransactionType.B
     this.activeCapabilities = this.activeCapabilities.concat([1559, 2718, 2930])
 
     // Populate the access list fields
-    const accessListData = AccessLists.getAccessListData(accessList ?? [])
-    this.accessList = accessListData.accessList
-    this.AccessListJSON = accessListData.AccessListJSON
+    this.accessList = isAccessList(accessList) ? accessListJSONToBytes(accessList) : accessList
     // Verify the access list format.
-    AccessLists.verifyAccessList(this.accessList)
+    EIP2930.verifyAccessList(this)
 
     this.maxFeePerGas = bytesToBigInt(toBytes(maxFeePerGas))
     this.maxPriorityFeePerGas = bytesToBigInt(toBytes(maxPriorityFeePerGas))
@@ -375,7 +382,7 @@ export class Blob4844Tx implements TransactionInterface<typeof TransactionType.B
   }
 
   toJSON(): JSONTx {
-    const accessListJSON = AccessLists.getAccessListJSON(this.accessList)
+    const accessListJSON = accessListBytesToJSON(this.accessList)
     const baseJSON = getBaseJSON(this)
 
     return {

packages/tx/src/7702/constructors.ts

@@ -8,7 +8,7 @@ import {
 } from '@ethereumjs/util'
 
 import { TransactionType } from '../types.ts'
-import { txTypeBytes, validateNotArray } from '../util.ts'
+import { txTypeBytes, validateNotArray } from '../util/internal.ts'
 
 import { EOACode7702Tx } from './tx.ts'
 

packages/tx/src/7702/tx.ts

@@ -11,29 +11,37 @@ import {
 
 import * as EIP1559 from '../capabilities/eip1559.ts'
 import * as EIP2718 from '../capabilities/eip2718.ts'
+import * as EIP2930 from '../capabilities/eip2930.ts'
 import * as EIP7702 from '../capabilities/eip7702.ts'
 import * as Legacy from '../capabilities/legacy.ts'
-import { getBaseJSON, sharedConstructor, valueBoundaryCheck } from '../features/util.ts'
-import { TransactionType } from '../types.ts'
-import { AccessLists, AuthorizationLists, validateNotArray } from '../util.ts'
+import { TransactionType, isAccessList, isAuthorizationList } from '../types.ts'
+import {
+  getBaseJSON,
+  sharedConstructor,
+  validateNotArray,
+  valueBoundaryCheck,
+} from '../util/internal.ts'
 
 import { createEOACode7702Tx } from './constructors.ts'
 
 import type { Common } from '@ethereumjs/common'
 import type { Address } from '@ethereumjs/util'
 import type {
-  AccessList,
   AccessListBytes,
   TxData as AllTypesTxData,
   TxValuesArray as AllTypesTxValuesArray,
-  AuthorizationList,
   AuthorizationListBytes,
   Capability,
   JSONTx,
   TransactionCache,
   TransactionInterface,
   TxOptions,
 } from '../types.ts'
+import { accessListBytesToJSON, accessListJSONToBytes } from '../util/access.ts'
+import {
+  authorizationListBytesToJSON,
+  authorizationListJSONToBytes,
+} from '../util/authorization.ts'
 
 export type TxData = AllTypesTxData[typeof TransactionType.EOACodeEIP7702]
 export type TxValuesArray = AllTypesTxValuesArray[typeof TransactionType.EOACodeEIP7702]
@@ -66,9 +74,6 @@ export class EOACode7702Tx implements TransactionInterface<typeof TransactionTyp
 
   // End of Tx data part
 
-  public readonly AccessListJSON: AccessList
-  public readonly AuthorizationListJSON: AuthorizationList
-
   public readonly common!: Common
 
   readonly txOptions!: TxOptions
@@ -91,7 +96,15 @@ export class EOACode7702Tx implements TransactionInterface<typeof TransactionTyp
    */
   public constructor(txData: TxData, opts: TxOptions = {}) {
     sharedConstructor(this, { ...txData, type: TransactionType.EOACodeEIP7702 }, opts)
-    const { chainId, accessList, authorizationList, maxFeePerGas, maxPriorityFeePerGas } = txData
+    const {
+      chainId,
+      accessList: rawAccessList,
+      authorizationList: rawAuthorizationList,
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+    } = txData
+    const accessList = rawAccessList ?? []
+    const authorizationList = rawAuthorizationList ?? []
 
     if (chainId !== undefined && bytesToBigInt(toBytes(chainId)) !== this.common.chainId()) {
       throw EthereumJSErrorWithoutCode(
@@ -106,20 +119,16 @@ export class EOACode7702Tx implements TransactionInterface<typeof TransactionTyp
     this.activeCapabilities = this.activeCapabilities.concat([1559, 2718, 2930, 7702])
 
     // Populate the access list fields
-    const accessListData = AccessLists.getAccessListData(accessList ?? [])
-    this.accessList = accessListData.accessList
-    this.AccessListJSON = accessListData.AccessListJSON
+    this.accessList = isAccessList(accessList) ? accessListJSONToBytes(accessList) : accessList
     // Verify the access list format.
-    AccessLists.verifyAccessList(this.accessList)
+    EIP2930.verifyAccessList(this)
 
     // Populate the authority list fields
-    const authorizationListData = AuthorizationLists.getAuthorizationListData(
-      authorizationList ?? [],
-    )
-    this.authorizationList = authorizationListData.authorizationList
-    this.AuthorizationListJSON = authorizationListData.AuthorizationListJSON
+    this.authorizationList = isAuthorizationList(authorizationList)
+      ? authorizationListJSONToBytes(authorizationList)
+      : authorizationList
     // Verify the authority list format.
-    AuthorizationLists.verifyAuthorizationList(this.authorizationList)
+    EIP7702.verifyAuthorizationList(this)
 
     this.maxFeePerGas = bytesToBigInt(toBytes(maxFeePerGas))
     this.maxPriorityFeePerGas = bytesToBigInt(toBytes(maxPriorityFeePerGas))
@@ -354,7 +363,9 @@ export class EOACode7702Tx implements TransactionInterface<typeof TransactionTyp
    * Returns an object with the JSON representation of the transaction
    */
   toJSON(): JSONTx {
-    const accessListJSON = AccessLists.getAccessListJSON(this.accessList)
+    const accessListJSON = accessListBytesToJSON(this.accessList)
+    const authorizationList = authorizationListBytesToJSON(this.authorizationList)
+
     const baseJSON = getBaseJSON(this)
 
     return {
@@ -363,7 +374,7 @@ export class EOACode7702Tx implements TransactionInterface<typeof TransactionTyp
       maxPriorityFeePerGas: bigIntToHex(this.maxPriorityFeePerGas),
       maxFeePerGas: bigIntToHex(this.maxFeePerGas),
       accessList: accessListJSON,
-      authorizationList: this.AuthorizationListJSON,
+      authorizationList,
     }
   }
 

packages/tx/src/capabilities/eip2718.ts

@@ -2,7 +2,7 @@ import { RLP } from '@ethereumjs/rlp'
 import { BIGINT_0, BIGINT_1, EthereumJSErrorWithoutCode, concatBytes } from '@ethereumjs/util'
 import { keccak256 } from 'ethereum-cryptography/keccak.js'
 
-import { txTypeBytes } from '../util.ts'
+import { txTypeBytes } from '../util/internal.ts'
 
 import { errorMsg } from './legacy.ts'