Implement EIP1559 Fee Market + EIP3198 BaseFee

packages/block/src/block.ts

@@ -3,7 +3,13 @@
 import { BaseTrie as Trie } from 'merkle-patricia-tree'
 import { BN, rlp, keccak256, KECCAK256_RLP } from 'ethereumjs-util'
 import Common from '@ethereumjs/common'
-import { TransactionFactory, TypedTransaction, TxOptions } from '@ethereumjs/tx'
+import {
+  TransactionFactory,
+  TypedTransaction,
+  TxOptions,
+  FeeMarketEIP1559Transaction,
+  Transaction,
+} from '@ethereumjs/tx'
 import { BlockHeader } from './header'
 import { BlockData, BlockOptions, JsonBlock, BlockBuffer, Blockchain } from './types'
 
@@ -63,7 +69,7 @@ export class Block {
    * @param opts
    */
   public static fromRLPSerializedBlock(serialized: Buffer, opts?: BlockOptions) {
-    const values = (rlp.decode(serialized) as any) as BlockBuffer
+    const values = rlp.decode(serialized) as any as BlockBuffer
 
     if (!Array.isArray(values)) {
       throw new Error('Invalid serialized block input. Must be array')
@@ -223,9 +229,21 @@ export class Block {
   validateTransactions(stringError: true): string[]
   validateTransactions(stringError = false) {
     const errors: string[] = []
-
-    this.transactions.forEach(function (tx, i) {
+    this.transactions.forEach((tx, i) => {
       const errs = <string[]>tx.validate(true)
+      if (this._common.isActivatedEIP(1559)) {
+        if (tx.transactionType === 2) {
+          tx = tx as FeeMarketEIP1559Transaction
+          if (tx.maxFeePerGas.lt(this.header.baseFeePerGas!)) {
+            errs.push('tx unable to pay base fee (EIP-1559 tx)')
+          }
+        } else {
+          tx = tx as Transaction
+          if (tx.gasPrice.lt(this.header.baseFeePerGas!)) {
+            errs.push('tx unable to pay base fee (non EIP-1559 tx)')
+          }
+        }
+      }
       if (errs.length > 0) {
         errors.push(`errors at tx ${i}: ${errs.join(', ')}`)
       }

packages/block/src/header.ts

@@ -43,6 +43,7 @@ export class BlockHeader {
   public readonly extraData: Buffer
   public readonly mixHash: Buffer
   public readonly nonce: Buffer
+  public readonly baseFeePerGas?: BN
 
   public readonly _common: Common
   public _errorPostfix = ''
@@ -53,7 +54,7 @@ export class BlockHeader {
    * @param headerData
    * @param opts
    */
-  public static fromHeaderData(headerData: HeaderData = {}, opts?: BlockOptions) {
+  public static fromHeaderData(headerData: HeaderData = {}, opts: BlockOptions = {}) {
     const {
       parentHash,
       uncleHash,
@@ -70,6 +71,7 @@ export class BlockHeader {
       extraData,
       mixHash,
       nonce,
+      baseFeePerGas,
     } = headerData
 
     return new BlockHeader(
@@ -88,7 +90,8 @@ export class BlockHeader {
       extraData ? toBuffer(extraData) : Buffer.from([]),
       mixHash ? toBuffer(mixHash) : zeros(32),
       nonce ? toBuffer(nonce) : zeros(8),
-      opts
+      opts,
+      baseFeePerGas !== undefined ? new BN(toBuffer(baseFeePerGas)) : undefined
     )
   }
 
@@ -98,7 +101,7 @@ export class BlockHeader {
    * @param headerData
    * @param opts
    */
-  public static fromRLPSerializedHeader(serialized: Buffer, opts?: BlockOptions) {
+  public static fromRLPSerializedHeader(serialized: Buffer, opts: BlockOptions = {}) {
     const values = rlp.decode(serialized)
 
     if (!Array.isArray(values)) {
@@ -114,11 +117,7 @@ export class BlockHeader {
    * @param headerData
    * @param opts
    */
-  public static fromValuesArray(values: BlockHeaderBuffer, opts?: BlockOptions) {
-    if (values.length > 15) {
-      throw new Error('invalid header. More values than expected were received')
-    }
-
+  public static fromValuesArray(values: BlockHeaderBuffer, opts: BlockOptions = {}) {
     const [
       parentHash,
       uncleHash,
@@ -135,8 +134,16 @@ export class BlockHeader {
       extraData,
       mixHash,
       nonce,
+      baseFeePerGas,
     ] = values
 
+    if (values.length > 16) {
+      throw new Error('invalid header. More values than expected were received')
+    }
+    if (values.length < 15) {
+      throw new Error('invalid header. Less values than expected were received')
+    }
+
     return new BlockHeader(
       toBuffer(parentHash),
       toBuffer(uncleHash),
@@ -153,7 +160,8 @@ export class BlockHeader {
       toBuffer(extraData),
       toBuffer(mixHash),
       toBuffer(nonce),
-      opts
+      opts,
+      baseFeePerGas !== undefined ? new BN(toBuffer(baseFeePerGas)) : undefined
     )
   }
 
@@ -167,9 +175,10 @@ export class BlockHeader {
 
   /**
    * This constructor takes the values, validates them, assigns them and freezes the object.
-   * Use the public static factory methods to assist in creating a Header object from
-   * varying data types.
-   * For a default empty header, use `BlockHeader.fromHeaderData()`.
+   *
+   * @deprecated - Use the public static factory methods to assist in creating a Header object from
+   * varying data types. For a default empty header, use `BlockHeader.fromHeaderData()`.
+   *
    */
   constructor(
     parentHash: Buffer,
@@ -187,7 +196,8 @@ export class BlockHeader {
     extraData: Buffer,
     mixHash: Buffer,
     nonce: Buffer,
-    options: BlockOptions = {}
+    options: BlockOptions = {},
+    baseFeePerGas?: BN
   ) {
     if (options.common) {
       this._common = Object.assign(
@@ -208,6 +218,16 @@ export class BlockHeader {
       this._common.setHardforkByBlockNumber(number.toNumber())
     }
 
+    if (this._common.isActivatedEIP(1559)) {
+      if (baseFeePerGas === undefined) {
+        baseFeePerGas = new BN(7)
+      }
+    } else {
+      if (baseFeePerGas) {
+        throw new Error('A base fee for a block can only be set with EIP1559 being activated')
+      }
+    }
+
     if (options.initWithGenesisHeader) {
       number = new BN(0)
       if (gasLimit.eq(DEFAULT_GAS_LIMIT)) {
@@ -245,6 +265,7 @@ export class BlockHeader {
     this.extraData = extraData
     this.mixHash = mixHash
     this.nonce = nonce
+    this.baseFeePerGas = baseFeePerGas
 
     this._validateHeaderFields()
     this._checkDAOExtraData()
@@ -430,7 +451,13 @@ export class BlockHeader {
    * @param parentBlockHeader - the header from the parent `Block` of this header
    */
   validateGasLimit(parentBlockHeader: BlockHeader): boolean {
-    const parentGasLimit = parentBlockHeader.gasLimit
+    let parentGasLimit = parentBlockHeader.gasLimit
+    // EIP-1559: assume double the parent gas limit on fork block
+    // to adopt to the new gas target centered logic
+    if (this.number.eq(this._common.hardforkBlockBN('london'))) {
+      const elasticity = new BN(this._common.param('gasConfig', 'elasticityMultiplier'))
+      parentGasLimit = parentGasLimit.mul(elasticity)
+    }
     const gasLimit = this.gasLimit
     const hardfork = this._getHardfork()
 
@@ -440,11 +467,12 @@ export class BlockHeader {
     const maxGasLimit = parentGasLimit.add(a)
     const minGasLimit = parentGasLimit.sub(a)
 
-    return (
+    const result =
       gasLimit.lt(maxGasLimit) &&
       gasLimit.gt(minGasLimit) &&
       gasLimit.gte(this._common.paramByHardfork('gasConfig', 'minGasLimit', hardfork))
-    )
+
+    return result
   }
 
   /**
@@ -469,14 +497,17 @@ export class BlockHeader {
       return
     }
     const hardfork = this._getHardfork()
+    // Consensus type dependent checks
     if (this._common.consensusAlgorithm() !== 'clique') {
+      // PoW/Ethash
       if (
         this.extraData.length > this._common.paramByHardfork('vm', 'maxExtraDataSize', hardfork)
       ) {
         const msg = 'invalid amount of extra data'
         throw this._error(msg)
       }
     } else {
+      // PoA/Clique
       const minLength = CLIQUE_EXTRA_VANITY + CLIQUE_EXTRA_SEAL
       if (!this.cliqueIsEpochTransition()) {
         // ExtraData length on epoch transition
@@ -546,13 +577,73 @@ export class BlockHeader {
         throw new Error('uncle block has a parent that is too old or too young')
       }
     }
+
+    // check if the block used too much gas
+    if (this.gasUsed.gt(this.gasLimit)) {
+      throw new Error('Invalid block: too much gas used')
+    }
+
+    if (this._common.isActivatedEIP(1559)) {
+      if (!this.baseFeePerGas) {
+        throw new Error('EIP1559 block has no base fee field')
+      }
+      const isInitialEIP1559Block = this.number.eq(this._common.hardforkBlockBN('london'))
+      if (isInitialEIP1559Block) {
+        const initialBaseFee = new BN(this._common.param('gasConfig', 'initialBaseFee'))
+        if (!this.baseFeePerGas!.eq(initialBaseFee)) {
+          throw new Error('Initial EIP1559 block does not have initial base fee')
+        }
+      } else {
+        // check if the base fee is correct
+        const expectedBaseFee = parentHeader.calcNextBaseFee()
+
+        if (!this.baseFeePerGas!.eq(expectedBaseFee)) {
+          throw new Error('Invalid block: base fee not correct')
+        }
+      }
+    }
+  }
+
+  /**
+   * Calculates the base fee for a potential next block
+   */
+  public calcNextBaseFee(): BN {
+    if (!this._common.isActivatedEIP(1559)) {
+      throw new Error('calcNextBaseFee() can only be called with EIP1559 being activated')
+    }
+    let nextBaseFee: BN
+    const elasticity = new BN(this._common.param('gasConfig', 'elasticityMultiplier'))
+    const parentGasTarget = this.gasLimit.div(elasticity)
+
+    if (parentGasTarget.eq(this.gasUsed)) {
+      nextBaseFee = this.baseFeePerGas!
+    } else if (this.gasUsed.gt(parentGasTarget)) {
+      const gasUsedDelta = this.gasUsed.sub(parentGasTarget)
+      const baseFeeMaxChangeDenominator = new BN(
+        this._common.param('gasConfig', 'baseFeeMaxChangeDenominator')
+      )
+      const calculatedDelta = this.baseFeePerGas!.mul(gasUsedDelta)
+        .div(parentGasTarget)
+        .div(baseFeeMaxChangeDenominator)
+      nextBaseFee = BN.max(calculatedDelta, new BN(1)).add(this.baseFeePerGas!)
+    } else {
+      const gasUsedDelta = parentGasTarget.sub(this.gasUsed)
+      const baseFeeMaxChangeDenominator = new BN(
+        this._common.param('gasConfig', 'baseFeeMaxChangeDenominator')
+      )
+      const calculatedDelta = this.baseFeePerGas!.mul(gasUsedDelta)
+        .div(parentGasTarget)
+        .div(baseFeeMaxChangeDenominator)
+      nextBaseFee = BN.max(this.baseFeePerGas!.sub(calculatedDelta), new BN(0))
+    }
+    return nextBaseFee
   }
 
   /**
    * Returns a Buffer Array of the raw Buffers in this header, in order.
    */
   raw(): BlockHeaderBuffer {
-    return [
+    const rawItems = [
       this.parentHash,
       this.uncleHash,
       this.coinbase.buf,
@@ -569,6 +660,12 @@ export class BlockHeader {
       this.mixHash,
       this.nonce,
     ]
+
+    if (this._common.isActivatedEIP(1559)) {
+      rawItems.push(unpadBuffer(toBuffer(this.baseFeePerGas)))
+    }
+
+    return rawItems
   }
 
   /**
@@ -716,7 +813,7 @@ export class BlockHeader {
    * Returns the block header in JSON format.
    */
   toJSON(): JsonHeader {
-    return {
+    const jsonDict: JsonHeader = {
       parentHash: '0x' + this.parentHash.toString('hex'),
       uncleHash: '0x' + this.uncleHash.toString('hex'),
       coinbase: this.coinbase.toString(),
@@ -733,6 +830,11 @@ export class BlockHeader {
       mixHash: '0x' + this.mixHash.toString('hex'),
       nonce: '0x' + this.nonce.toString('hex'),
     }
+    if (this._common.isActivatedEIP(1559)) {
+      jsonDict['baseFee'] = '0x' + this.baseFeePerGas!.toString('hex')
+    }
+
+    return jsonDict
   }
 
   /**

packages/block/src/types.ts

@@ -1,6 +1,6 @@
 import { AddressLike, BNLike, BufferLike } from 'ethereumjs-util'
 import Common from '@ethereumjs/common'
-import { AccessListEIP2930TxData, TxData, JsonTx } from '@ethereumjs/tx'
+import { TxData, JsonTx, AccessListEIP2930TxData, FeeMarketEIP1559TxData } from '@ethereumjs/tx'
 import { Block } from './block'
 import { BlockHeader } from './header'
 
@@ -83,6 +83,7 @@ export interface HeaderData {
   extraData?: BufferLike
   mixHash?: BufferLike
   nonce?: BufferLike
+  baseFeePerGas?: BNLike
 }
 
 /**
@@ -93,7 +94,7 @@ export interface BlockData {
    * Header data for the block
    */
   header?: HeaderData
-  transactions?: Array<TxData | AccessListEIP2930TxData>
+  transactions?: Array<TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData>
   uncleHeaders?: Array<HeaderData>
 }
 
@@ -137,6 +138,7 @@ export interface JsonHeader {
   extraData?: string
   mixHash?: string
   nonce?: string
+  baseFee?: string
 }
 
 export interface Blockchain {