tx: moved v,r,s to BaseTransaction, added type inheritance for TxData objects, separate AccessListEIP2930TxData type

Author: holgerd77

packages/tx/src/baseTransaction.ts

@@ -8,7 +8,7 @@ import {
   ecsign,
   publicToAddress,
 } from 'ethereumjs-util'
-import { BaseTransactionData, BaseTxOptions, JsonTx } from './types'
+import { TxData, TxOptions, JsonTx } from './types'
 
 export abstract class BaseTransaction<TransactionObject> {
   public readonly nonce: BN
@@ -23,8 +23,8 @@ export abstract class BaseTransaction<TransactionObject> {
   public readonly r?: BN
   public readonly s?: BN
 
-  constructor(txData: BaseTransactionData, txOptions: BaseTxOptions = {}) {
-    const { nonce, gasLimit, gasPrice, to, value, data } = txData
+  constructor(txData: TxData, txOptions: TxOptions = {}) {
+    const { nonce, gasLimit, gasPrice, to, value, data, v, r, s } = txData
 
     this.nonce = new BN(toBuffer(nonce))
     this.gasPrice = new BN(toBuffer(gasPrice))
@@ -33,6 +33,10 @@ export abstract class BaseTransaction<TransactionObject> {
     this.value = new BN(toBuffer(value))
     this.data = toBuffer(data)
 
+    this.v = v ? new BN(toBuffer(v)) : undefined
+    this.r = r ? new BN(toBuffer(r)) : undefined
+    this.s = s ? new BN(toBuffer(s)) : undefined
+
     const validateCannotExceedMaxInteger = {
       nonce: this.nonce,
       gasPrice: this.gasPrice,

packages/tx/src/eip2930Transaction.ts

@@ -14,10 +14,10 @@ import { BaseTransaction } from './baseTransaction'
 import {
   AccessList,
   AccessListBuffer,
+  AccessListEIP2930TxData,
   AccessListItem,
   isAccessList,
   JsonTx,
-  TxData,
   TxOptions,
 } from './types'
 
@@ -41,9 +41,6 @@ type EIP2930ValuesArray = [
 export default class AccessListEIP2930Transaction extends BaseTransaction<AccessListEIP2930Transaction> {
   public readonly chainId: BN
   public readonly accessList: AccessListBuffer
-  public readonly v?: BN
-  public readonly r?: BN
-  public readonly s?: BN
 
   get transactionType(): number {
     return 1
@@ -67,7 +64,7 @@ export default class AccessListEIP2930Transaction extends BaseTransaction<Access
     return this.v
   }
 
-  public static fromTxData(txData: TxData, opts: TxOptions = {}) {
+  public static fromTxData(txData: AccessListEIP2930TxData, opts: TxOptions = {}) {
     return new AccessListEIP2930Transaction(txData, opts)
   }
 
@@ -125,10 +122,10 @@ export default class AccessListEIP2930Transaction extends BaseTransaction<Access
     }
   }
 
-  public constructor(txData: TxData, opts: TxOptions = {}) {
-    const { chainId, nonce, gasPrice, gasLimit, to, value, data, accessList, v, r, s } = txData
+  public constructor(txData: AccessListEIP2930TxData, opts: TxOptions = {}) {
+    const { chainId, accessList } = txData
 
-    super({ nonce, gasPrice, gasLimit, to, value, data }, opts)
+    super(txData, opts)
 
     // EIP-2718 check is done in Common
     if (!this.common.isActivatedEIP(2930)) {
@@ -176,9 +173,6 @@ export default class AccessListEIP2930Transaction extends BaseTransaction<Access
 
     this.chainId = chainId ? new BN(toBuffer(chainId)) : new BN(this.common.chainId())
     this.accessList = usedAccessList
-    this.v = v ? new BN(toBuffer(v)) : undefined
-    this.r = r ? new BN(toBuffer(r)) : undefined
-    this.s = s ? new BN(toBuffer(s)) : undefined
 
     if (!this.chainId.eq(new BN(this.common.chainId().toString()))) {
       throw new Error('The chain ID does not match the chain ID of Common')

packages/tx/src/legacyTransaction.ts

@@ -22,9 +22,6 @@ const N_DIV_2 = new BN('7fffffffffffffffffffffffffffffff5d576e7357a4501ddfe92f46
  * An Ethereum transaction.
  */
 export default class Transaction extends BaseTransaction<Transaction> {
-  public readonly v?: BN
-  public readonly r?: BN
-  public readonly s?: BN
 
   get transactionType(): number {
     return 0
@@ -90,13 +87,7 @@ export default class Transaction extends BaseTransaction<Transaction> {
    * @note Transaction objects implement EIP155 by default. To disable it, pass in an `@ethereumjs/common` object set before EIP155 activation (i.e. before Spurious Dragon).
    */
   public constructor(txData: TxData, opts: TxOptions = {}) {
-    const { nonce, gasPrice, gasLimit, to, value, data, v, r, s } = txData
-
-    super({ nonce, gasPrice, gasLimit, to, value, data }, opts)
-
-    this.v = v ? new BN(toBuffer(v)) : undefined
-    this.r = r ? new BN(toBuffer(r)) : undefined
-    this.s = s ? new BN(toBuffer(s)) : undefined
+    super(txData, opts)
 
     const validateCannotExceedMaxInteger = {
       r: this.r ?? new BN(0),

packages/tx/src/transactionFactory.ts

@@ -1,7 +1,7 @@
 import Common from '@ethereumjs/common'
 import { default as Transaction } from './legacyTransaction'
 import { default as AccessListEIP2930Transaction } from './eip2930Transaction'
-import { TxOptions, TypedTransaction, TxData } from './types'
+import { TxOptions, TypedTransaction, TxData, AccessListEIP2930TxData } from './types'
 import { BN } from 'ethereumjs-util'
 
 const DEFAULT_COMMON = new Common({ chain: 'mainnet' })
@@ -15,14 +15,14 @@ export default class TransactionFactory {
    * @param txData - The transaction data. The `type` field will determine which transaction type is returned (if undefined, create a Transaction)
    * @param txOptions - Options to pass on to the constructor of the transaction
    */
-  public static fromTxData(txData: TxData, txOptions: TxOptions = {}): TypedTransaction {
+  public static fromTxData(txData: TxData | AccessListEIP2930TxData, txOptions: TxOptions = {}): TypedTransaction {
     const common = txOptions.common ?? DEFAULT_COMMON
-    if (txData.type === undefined) {
+    if (!('type' in txData) || txData.type === undefined) {
       // Assume Transaction
-      return Transaction.fromTxData(txData, txOptions)
+      return Transaction.fromTxData(<TxData>txData, txOptions)
     } else {
       const txType = new BN(txData.type).toNumber()
-      return TransactionFactory.getTransactionClass(txType, common).fromTxData(txData, txOptions)
+      return TransactionFactory.getTransactionClass(txType, common).fromTxData(<AccessListEIP2930TxData>txData, txOptions)
     }
   }
 

packages/tx/src/types.ts

@@ -31,13 +31,6 @@ export interface TxOptions {
   freeze?: boolean
 }
 
-/**
- * The options for initializing a Transaction.
- */
-export interface BaseTxOptions {
-  common?: Common
-}
-
 export type AccessListItem = {
   address: string
   storageKeys: string[]
@@ -65,15 +58,9 @@ export function isAccessList(input: AccessListBuffer | AccessList): input is Acc
   return !isAccessListBuffer(input) // This is exactly the same method, except the output is negated.
 }
 
-/**
- * An object with an optional field with each of the transaction's values.
- */
-export interface TxData {
-  /**
-   * The transaction's chain ID
-   */
-  chainId?: BNLike
+export type TypedTransaction = Transaction | AccessListEIP2930Transaction
 
+export type TxData = {
   /**
    * The transaction's nonce.
    */
@@ -107,17 +94,27 @@ export interface TxData {
   /**
    * EC recovery ID.
    */
-  v?: BNLike
-
-  /**
-   * EC signature parameter.
-   */
-  r?: BNLike
+   v?: BNLike
+
+   /**
+    * EC signature parameter.
+    */
+   r?: BNLike
+ 
+   /**
+    * EC signature parameter.
+    */
+   s?: BNLike
+}
 
+/**
+ * An object with an optional field with each of the transaction's values.
+ */
+export interface AccessListEIP2930TxData extends TxData {
   /**
-   * EC signature parameter.
+   * The transaction's chain ID
    */
-  s?: BNLike
+  chainId?: BNLike
 
   /**
    * The access list which contains the addresses/storage slots which the transaction wishes to access
@@ -131,40 +128,6 @@ export interface TxData {
   type?: BNLike
 }
 
-export type TypedTransaction = Transaction | AccessListEIP2930Transaction
-
-export type BaseTransactionData = {
-  /**
-   * The transaction's nonce.
-   */
-  nonce?: BNLike
-
-  /**
-   * The transaction's gas price.
-   */
-  gasPrice?: BNLike
-
-  /**
-   * The transaction's gas limit.
-   */
-  gasLimit?: BNLike
-
-  /**
-   * The transaction's the address is sent to.
-   */
-  to?: AddressLike
-
-  /**
-   * The amount of Ether sent.
-   */
-  value?: BNLike
-
-  /**
-   * This will contain the data of the message or the init of a contract.
-   */
-  data?: BufferLike
-}
-
 type JsonAccessListItem = { address: string; storageKeys: string[] }
 
 /**