New release v4.1.0

CHANGELOG.md

@@ -6,6 +6,71 @@ 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).
 
+## [4.1.0] - 2019-09-12
+
+This is the first feature-complete `Istanbul` release, containing implementations
+for all 6 EIPs, see the HF meta EIP [EIP-1679](https://eips.ethereum.org/EIPS/eip-1679)
+for an overview. Beside this release contains further unrelated features as
+well as bug fixes.
+
+Note that `Istanbul` support is still labeled as `beta`. All implementations
+have only basic test coverage since the official Ethereum consensus tests are
+not yet merged. There might be also last minute changes to EIPs during the
+testing period.
+
+**Istanbul Summary**
+
+See the VM `Istanbul` hardfork meta issue
+[#501](https://github.com/ethereumjs/ethereumjs-vm/issues/501) for a summary
+on all the changes.
+
+Added EIPs:
+
+- [EIP-152](https://github.com/ethereum/EIPs/pull/2129): Blake 2b `F` precompile,
+  PR [#584](https://github.com/ethereumjs/ethereumjs-vm/pull/584)
+- [EIP-1108](https://eips.ethereum.org/EIPS/eip-1108): Reduce `alt_bn128`
+  precompile gas costs,  
+  PR [#540](https://github.com/ethereumjs/ethereumjs-vm/pull/540)
+  (already released in `v4.0.0`)
+- [EIP-1344](https://eips.ethereum.org/EIPS/eip-1344): Add ChainID Opcode,
+  PR [#572](https://github.com/ethereumjs/ethereumjs-vm/pull/572)
+- [EIP-1884](https://eips.ethereum.org/EIPS/eip-1884): Trie-size-dependent
+  Opcode Repricing,
+  PR [#581](https://github.com/ethereumjs/ethereumjs-vm/pull/581)
+- [EIP-2200](https://github.com/ethereum/EIPs/pull/2200): Rebalance net-metered
+  SSTORE gas costs,
+  PR [#590](https://github.com/ethereumjs/ethereumjs-vm/pull/590)
+
+**Other Features**
+
+- Two new event types `beforeMessage` and `afterMessage`, emitting a `Message`
+  before and an `EVMResult` after running a `Message`, see also the
+  [updated section](https://github.com/ethereumjs/ethereumjs-vm#vms-tracing-events)
+  in the `README` on this,
+  PR [#577](https://github.com/ethereumjs/ethereumjs-vm/pull/577)
+
+**Bug Fixes**
+
+- Transaction error strings should not contain multiple consecutive whitespace
+  characters, this has been fixed,
+  PR [#578](https://github.com/ethereumjs/ethereumjs-vm/pull/578)
+- Fixed `vm.stateManager.generateCanonicalGenesis()` to produce a correct
+  genesis block state root (in particular for the `Goerli` testnet),
+  PR [#589](https://github.com/ethereumjs/ethereumjs-vm/pull/589)
+
+**Refactoring / Docs**
+
+- Preparation for separate lists of opcodes for the different HFs,
+  PR [#582](https://github.com/ethereumjs/ethereumjs-vm/pull/582),
+  see also follow-up
+  PR [#592](https://github.com/ethereumjs/ethereumjs-vm/pull/592) making this
+  list a property of the VM instance
+- Clarification in the docs for the behavior of the `activatePrecompiles`
+  VM option,
+  PR [#595](https://github.com/ethereumjs/ethereumjs-vm/pull/595)
+
+[4.1.0]: https://github.com/ethereumjs/ethereumjs-vm/compare/v4.0.0...v4.1.0
+
 ## [4.0.0] - 2019-08-06
 
 First `TypeScript` based VM release, other highlights:

README.md

@@ -16,30 +16,37 @@ The VM currently supports the following hardfork rules:
 - `Byzantium`
 - `Constantinople`
 - `Petersburg` (default)
-- `Istanbul` (`DRAFT`)
+- `Istanbul` (`beta`)
 
 If you are still looking for a [Spurious Dragon](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-607.md) compatible version of this library install the latest of the `2.2.x` series (see [Changelog](./CHANGELOG.md)).
 
 ##### Istanbul Harfork Support
 
-With the `v4.0.0` release we are starting to add implementations of EIPs being
-candidates or accepted for inclusion within the `Istanbul` hardfork. You can
-activate a preliminary `Istanbul` VM by using the `istanbul` `hardfork` option
-flag.
-
-Currently supported `Istanbul` EIPs:
-
-- [EIP-1108](https://eips.ethereum.org/EIPS/eip-1803) (Candidate): `alt_bn128` Gas Cost Reductions, see PR [#540](https://github.com/ethereumjs/ethereumjs-vm/pull/540)
-
-Note that this is highly experimental and solely meant for experimental purposes,
-since `Istanbul` scope is not yet finalized and most EIPs are still in a `DRAFT`
-state and likely subject to updates and changes.
-
-A final `Istanbul` VM will be released along a major version bump to likely
-`v5.0.0` or `v6.0.0`.
-
-Have a look at the corresponding issue to follow the discussion and current state on
-[Istanbul planning](https://github.com/ethereumjs/ethereumjs-vm/issues/501).
+A feature-complete `Istanbul` HF implementation is available since the `v4.1.0`
+VM release. You can activate an `Istanbul` VM by using the `istanbul`
+`hardfork` option flag.
+
+Supported `Istanbul` EIPs:
+
+- [EIP-152](https://github.com/ethereum/EIPs/pull/2129): Blake 2b `F` precompile,
+  PR [#584](https://github.com/ethereumjs/ethereumjs-vm/pull/584)
+- [EIP-1108](https://eips.ethereum.org/EIPS/eip-1108): Reduce `alt_bn128`
+  precompile gas costs,  
+  PR [#540](https://github.com/ethereumjs/ethereumjs-vm/pull/540)
+  (already released in `v4.0.0`)
+- [EIP-1344](https://eips.ethereum.org/EIPS/eip-1344): Add ChainID Opcode,
+  PR [#572](https://github.com/ethereumjs/ethereumjs-vm/pull/572)
+- [EIP-1884](https://eips.ethereum.org/EIPS/eip-1884): Trie-size-dependent
+  Opcode Repricing,
+  PR [#581](https://github.com/ethereumjs/ethereumjs-vm/pull/581)
+- [EIP-2200](https://github.com/ethereum/EIPs/pull/2200): Rebalance net-metered
+  SSTORE gas costs,
+  PR [#590](https://github.com/ethereumjs/ethereumjs-vm/pull/590)
+
+Note that `Istanbul` support is still labeled as `beta`. All implementations
+have only basic test coverage since the official Ethereum consensus tests are
+not yet merged. There might be also last minute changes to EIPs during the
+testing period.
 
 # INSTALL
 

docs/README.md

@@ -17,6 +17,7 @@
 
 * [EVMResult](interfaces/evmresult.md)
 * [ExecResult](interfaces/execresult.md)
+* [NewContractEvent](interfaces/newcontractevent.md)
 * [RunBlockOpts](interfaces/runblockopts.md)
 * [RunBlockResult](interfaces/runblockresult.md)
 * [RunCallOpts](interfaces/runcallopts.md)
@@ -28,5 +29,29 @@
 * [TxReceipt](interfaces/txreceipt.md)
 * [VMOpts](interfaces/vmopts.md)
 
+### Functions
+
+* [OOGResult](#oogresult)
+
 ---
 
+## Functions
+
+<a id="oogresult"></a>
+
+###  OOGResult
+
+▸ **OOGResult**(gasLimit: *`BN`*): [ExecResult](interfaces/execresult.md)
+
+*Defined in [evm/evm.ts:80](https://github.com/ethereumjs/ethereumjs-vm/blob/439570a/lib/evm/evm.ts#L80)*
+
+**Parameters:**
+
+| Name | Type |
+| ------ | ------ |
+| gasLimit | `BN` |
+
+**Returns:** [ExecResult](interfaces/execresult.md)
+
+___
+