Merge pull request #941 from ethereumjs/block-tx-freeze-optionality

New freeze option to deactivate block, tx freeze / Fix block options passing

Author: holgerd77

packages/block/CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 (modification: no type change headlines) and this project adheres to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 3.0.0-beta.2 - UNRELEASED
+
+- Added `freeze` option to allow for block freeze deactivation (e.g. to allow for subclassing block and adding additional parameters), see PR [#941](https://github.com/ethereumjs/ethereumjs-vm/pull/941)
+- Fixed bug where block options have not been passed on to the main constructor from the static factory methods, see PR [#941](https://github.com/ethereumjs/ethereumjs-vm/pull/941)
+
 ## 3.0.0-beta.1 - 2020-10-22
 
 ### New Package Name

packages/block/src/block.ts

@@ -36,7 +36,7 @@ export class Block {
       uncleHeaders.push(uh)
     }
 
-    return new Block(header, transactions, uncleHeaders)
+    return new Block(header, transactions, uncleHeaders, opts)
   }
 
   public static fromRLPSerializedBlock(serialized: Buffer, opts?: BlockOptions) {
@@ -70,7 +70,7 @@ export class Block {
       uncleHeaders.push(BlockHeader.fromValuesArray(uncleHeaderData, opts))
     }
 
-    return new Block(header, transactions, uncleHeaders)
+    return new Block(header, transactions, uncleHeaders, opts)
   }
 
   /**
@@ -96,7 +96,10 @@ export class Block {
     this.uncleHeaders = uncleHeaders
     this._common = this.header._common
 
-    Object.freeze(this)
+    const freeze = opts?.freeze ?? true
+    if (freeze) {
+      Object.freeze(this)
+    }
   }
 
   /**

packages/block/src/header.ts

@@ -230,7 +230,10 @@ export class BlockHeader {
       this.difficulty = this.canonicalDifficulty(options.calcDifficultyFromHeader)
     }
 
-    Object.freeze(this)
+    const freeze = options?.freeze ?? true
+    if (freeze) {
+      Object.freeze(this)
+    }
   }
 
   /**

packages/block/src/types.ts

@@ -43,6 +43,17 @@ export interface BlockOptions {
    * difficulty takes precedence over a provided static `difficulty` value.
    */
   calcDifficultyFromHeader?: BlockHeader
+  /**
+   * A block object by default gets frozen along initialization. This gives you
+   * strong additional security guarantees on the consistency of the block parameters.
+   *
+   * If you need to deactivate the block freeze - e.g. because you want to subclass block and
+   * add aditional properties - it is strongly encouraged that you do the freeze yourself
+   * within your code instead.
+   *
+   * Default: true
+   */
+  freeze?: boolean
 }
 
 /**

packages/block/test/block.spec.ts

@@ -1,13 +1,52 @@
 import tape from 'tape'
-import { rlp } from 'ethereumjs-util'
+import { rlp, zeros } from 'ethereumjs-util'
 import Common from '@ethereumjs/common'
-import { Block } from '../src'
+import { Block, BlockBuffer } from '../src'
 
 tape('[Block]: block functions', function (t) {
   t.test('should test block initialization', function (st) {
     const common = new Common({ chain: 'ropsten', hardfork: 'chainstart' })
     const genesis = Block.genesis({}, { common })
     st.ok(genesis.hash().toString('hex'), 'block should initialize')
+
+    // test default freeze values
+    // also test if the options are carried over to the constructor
+    let block = Block.fromBlockData({})
+    st.ok(Object.isFrozen(block), 'block should be frozen by default')
+
+    block = Block.fromBlockData({}, { freeze: false })
+    st.ok(!Object.isFrozen(block), 'block should not be frozen when freeze deactivated in options')
+
+    const rlpBlock = block.serialize()
+    block = Block.fromRLPSerializedBlock(rlpBlock)
+    st.ok(Object.isFrozen(block), 'block should be frozen by default')
+
+    block = Block.fromRLPSerializedBlock(rlpBlock, { freeze: false })
+    st.ok(!Object.isFrozen(block), 'block should not be frozen when freeze deactivated in options')
+
+    const zero = Buffer.alloc(0)
+    const headerArray = []
+    for (let item = 0; item < 15; item++) {
+      headerArray.push(zero)
+    }
+
+    // mock header data (if set to zeros(0) header throws)
+    headerArray[0] = zeros(32) //parentHash
+    headerArray[2] = zeros(20) //coinbase
+    headerArray[3] = zeros(32) //stateRoot
+    headerArray[4] = zeros(32) //transactionsTrie
+    headerArray[5] = zeros(32) //receiptTrie
+    headerArray[13] = zeros(32) // mixHash
+    headerArray[14] = zeros(8) // nonce
+
+    const valuesArray = <BlockBuffer>[headerArray, [], []]
+
+    block = Block.fromValuesArray(valuesArray)
+    st.ok(Object.isFrozen(block), 'block should be frozen by default')
+
+    block = Block.fromValuesArray(valuesArray, { freeze: false })
+    st.ok(!Object.isFrozen(block), 'block should not be frozen when freeze deactivated in options')
+
     st.end()
   })
 

packages/block/test/header.spec.ts

@@ -35,8 +35,45 @@ tape('[Block]: Header functions', function (t) {
 
   t.test('should test header initialization', function (st) {
     const common = new Common({ chain: 'ropsten', hardfork: 'chainstart' })
-    const header = BlockHeader.genesis(undefined, { common })
+    let header = BlockHeader.genesis(undefined, { common })
     st.ok(header.hash().toString('hex'), 'block should initialize')
+
+    // test default freeze values
+    // also test if the options are carried over to the constructor
+    header = BlockHeader.fromHeaderData({})
+    st.ok(Object.isFrozen(header), 'block should be frozen by default')
+
+    header = BlockHeader.fromHeaderData({}, { freeze: false })
+    st.ok(!Object.isFrozen(header), 'block should not be frozen when freeze deactivated in options')
+
+    const rlpHeader = header.serialize()
+    header = BlockHeader.fromRLPSerializedHeader(rlpHeader)
+    st.ok(Object.isFrozen(header), 'block should be frozen by default')
+
+    header = BlockHeader.fromRLPSerializedHeader(rlpHeader, { freeze: false })
+    st.ok(!Object.isFrozen(header), 'block should not be frozen when freeze deactivated in options')
+
+    const zero = Buffer.alloc(0)
+    const headerArray = []
+    for (let item = 0; item < 15; item++) {
+      headerArray.push(zero)
+    }
+
+    // mock header data (if set to zeros(0) header throws)
+    headerArray[0] = zeros(32) //parentHash
+    headerArray[2] = zeros(20) //coinbase
+    headerArray[3] = zeros(32) //stateRoot
+    headerArray[4] = zeros(32) //transactionsTrie
+    headerArray[5] = zeros(32) //receiptTrie
+    headerArray[13] = zeros(32) // mixHash
+    headerArray[14] = zeros(8) // nonce
+
+    header = BlockHeader.fromValuesArray(headerArray)
+    st.ok(Object.isFrozen(header), 'block should be frozen by default')
+
+    header = BlockHeader.fromValuesArray(headerArray, { freeze: false })
+    st.ok(!Object.isFrozen(header), 'block should not be frozen when freeze deactivated in options')
+
     st.end()
   })
 

packages/tx/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 (modification: no type change headlines) and this project adheres to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 3.0.0-beta.2 - UNRELEASED
+
+- Added `freeze` option to allow for transaction freeze deactivation (e.g. to allow for subclassing tx and adding additional parameters), see PR [#941](https://github.com/ethereumjs/ethereumjs-vm/pull/941)
+
 ## 3.0.0-beta.1 - 2020-10-22
 
 ### New Package Name

packages/tx/src/transaction.ts

@@ -136,7 +136,10 @@ export default class Transaction {
     this.r = r
     this.s = s
 
-    Object.freeze(this)
+    const freeze = opts?.freeze ?? true
+    if (freeze) {
+      Object.freeze(this)
+    }
   }
 
   /**

packages/tx/src/types.ts

@@ -13,6 +13,17 @@ export interface TxOptions {
    * Current default hardfork: `istanbul`
    */
   common?: Common
+  /**
+   * A transaction object by default gets frozen along initialization. This gives you
+   * strong additional security guarantees on the consistency of the tx parameters.
+   *
+   * If you need to deactivate the tx freeze - e.g. because you want to subclass tx and
+   * add aditional properties - it is strongly encouraged that you do the freeze yourself
+   * within your code instead.
+   *
+   * Default: true
+   */
+  freeze?: boolean
 }
 
 /**

packages/tx/test/api.ts

@@ -20,8 +20,32 @@ tape('[Transaction]: Basic functions', function (t) {
   const transactions: Transaction[] = []
 
   t.test('should initialize correctly', function (st) {
-    const tx = Transaction.fromTxData({})
+    let tx = Transaction.fromTxData({})
     st.equal(tx.common.hardfork(), 'istanbul', 'should initialize with correct default HF')
+    st.ok(Object.isFrozen(tx), 'tx should be frozen by default')
+
+    tx = Transaction.fromTxData({}, { freeze: false })
+    st.ok(!Object.isFrozen(tx), 'tx should not be frozen when freeze deactivated in options')
+
+    // Perform the same test as above, but now using a different construction method. This also implies that passing on the
+    // options object works as expected.
+    const rlpData = tx.serialize()
+
+    const zero = Buffer.alloc(0)
+    const valuesArray = [zero, zero, zero, zero, zero, zero]
+
+    tx = Transaction.fromRlpSerializedTx(rlpData)
+    st.ok(Object.isFrozen(tx), 'tx should be frozen by default')
+
+    tx = Transaction.fromRlpSerializedTx(rlpData, { freeze: false })
+    st.ok(!Object.isFrozen(tx), 'tx should not be frozen when freeze deactivated in options')
+
+    tx = Transaction.fromValuesArray(valuesArray)
+    st.ok(Object.isFrozen(tx), 'tx should be frozen by default')
+
+    tx = Transaction.fromValuesArray(valuesArray, { freeze: false })
+    st.ok(!Object.isFrozen(tx), 'tx should not be frozen when freeze deactivated in options')
+
     st.end()
   })