All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog (modification: no type change headlines) and this project adheres to Semantic Versioning.
## [2.6.1] - [rp fork]
- Add constantinople support
2.6.0 - 2019-02-07
Petersburg Support
Support for the Petersburg
(aka constantinopleFix
) hardfork by integrating
Petersburg
ready versions of associated libraries, see also
PR #433:
ethereumjs-common
(chain and HF logic and helper functionality) v1.1.0ethereumjs-blockchain
v3.4.0ethereumjs-block
v2.2.0
To instantiate the VM with Petersburg
HF rules set the opts.hardfork
constructor parameter to petersburg
. This will run the VM on the new
Petersburg rules having removed the support for
EIP 1283.
Goerli Readiness
The VM is now also ready to execute on blocks from the final version of the
Goerli cross-client testnet and can
therefore be instantiated with opts.chain
set to goerli
.
Bug Fixes
- Fixed mixed
sync
/async
functions incache
, PR #422 - Fixed a bug in
setStateroot
and caching by clearing thestateManager
cache after setting the state root such that stale values are not returned, PR #420 - Fixed cache access on the hooked VM (deprecated), PR #434
Refactoring
Following changes might be relevant for you if you are hotfixing/monkey-patching on parts of the VM:
- Moved
bloom
to its own directory, PR #429 - Moved
opcodes
,opFns
andlogTable
tolib/vm
, PR #425 - Converted
Bloom
toES6
class, PR #428 - Converted
Cache
toES6
class, added unit tests, PR 427
2.5.1 - 2019-01-19
- Added
memoryWordCount
to thestep
event object, PR #405
- Fixed a bug which caused an overwrite of the passed state trie (
opts.state
) when instantiating the library with theopts.activatePrecompiles
option, PR #415 - Fixed error handling in
runCode
(in caseloadContract
fails), PR #408 - Fixed a bug in the
StateManager.generateGenesis()
function, PR #400
- Upgraded
ethereumjs-blockchain
andlevel
for test runs, PR #414 - Fixed issue when running code coverage on PRs from forks, PR #402
2.5.0 - 2018-11-21
This is the first release of the VM with full support for all Constantinople
EIPs. It further comes along with huge improvements on consensus conformity and introduces the Beta
version of a new StateManager
API.
For running the VM with Constantinople
hardfork rules, set the option in the VM
constructor opts.hardfork
to constantinople
. Supported hardforks are byzantium
and constantinople
, default
setting will stay on byzantium
for now but this will change in a future release.
Changes related to Constantinople:
- EIP 1283
SSTORE
, see PR #367 - EIP 1014
CREATE2
, see PR #329 - EIP 1052
EXTCODEHASH
, see PR #324 - Constantinople ready versions of ethereumjs-block and ethereumjs-blockchain dependencies (difficulty bomb delay), see PRs #371, #325
This release is making a huge leap forward regarding consensus conformity, and even if you are not interested in Constantinople
support at all, you should upgrade just for this reason. Some context: we couldn't run blockchain tests for a long time on a steady basis due to performance constraints and when we re-triggered a test run after quite some time with PR #341 the result was a bit depressing with over 300 failing tests. Thanks to joined efforts from the community and core team members we could bring this down far quicker than expected and this is the first release for a long time which practically comes with complete consensus conformity - with just three recently added tests failing (see skipBroken
list in tests/tester.js
) and otherwise passing all blockchain tests and all state tests for both Constantinople
and Byzantium
rules. 🏆 🏆 🏆
Consensus Conformity related changes:
- Reset
selfdestruct
onREVERT
, see PR #392 - Undo
Bloom
filter changes from PR #295, see PR #384 - Fixes broken
BLOCKHASH
opcode, see PR #381 - Fix failing blockchain test
GasLimitHigherThan2p63m1
, see PR #380 - Stop adding
account
tocache
when checking if it is empty, see PR #375
The StateManager
(lib/stateManager.js
) - providing a high-level interface to account and contract data from the underlying state trie structure - has been completely reworked and there is now a close-to-being finalized API (currently marked as Beta
) coming with its own documentation.
This comes along with larger refactoring work throughout more-or-less the whole code base and the StateManager
now completely encapsulates the trie structure and the cache backend used, see issue #268 and associated PRs for reference. This will make it much easier in the future to bring along an own state manager serving special needs (optimized for memory and performance, run on mobile,...) by e.g. using a different trie implementation, cache or underlying storage or database backend.
We plan to completely separate the currently still integrated state manager into its own repository in one of the next releases, this will then be a breaking v3.0.0
release. Discussion around a finalized interface (we might e.g. drop all genesis-releated methods respectively methods implemented in the DefaultStateManager
) is still ongoing and you are very much invited to jump in and articulate your needs, just take e.g. the issue mentioned above as an entry point.
Change related to the new StateManager
interface:
StateManager
interface simplification, see PR #388- Make
StateManager
cache and trie private, see PR #385 - Remove vm accesses to
StateManager
trie
andcache
, see PR #376 - Remove explicit direct cache interactions, see PR #366
- Remove contract specific commit, see PR #335
- Fixed incorrect references to
trie
in tests, see PR #345 - Added
StateManager
API documentation, see PR #393
- New
emitFreeLogs
option, allowing any contract to emit an unlimited quantity of events without modifying the block gas limit (default:false
) which can be used in debugging contexts, see PRs #378, #379
Beyond the reintegrated blockchain tests there is now a separate test suite to test the API of the library, see tests/api
. This should largely reduce the risk of introducing new bugs on the API level on future changes, generally ease the development process by being able to develop against the specific tests and also allows using the tests as a reference for examples on how to use the API.
On the documentation side the API documentation has also been consolidated and there is now a unified and auto-generated API documentation (previously being manually edited (and too often forgotten) in README
).
- Added API tests for
index.js
,StateManager
, see PR #364 - Added API Tests for
runJit
andfakeBlockchain
, see PR #331 - Added API tests for
runBlockchain
, see PR #336 - Added
runBlock
API tests, see PR #360 - Added
runTx
API tests, see PR #352 - Added API Tests for the
Bloom
module, see PR #330 - New consistent auto-generated API documentation, see PR #377
- Blockchain tests now run by default on CI, see PR #374
- Switched from
istanbul
tonyc
, see PR #334 - Usage of
sealEngine
in blockchain tests, see PR #373 - New
tap-spec
option to get a formatted test run result summary, see README, see PR #363 - Updates/fixes on the JSDoc comments, see PRs #362, #361
Some bug fix and maintenance updates:
Special thanks to:
- @mattdean-digicatapult for his indefatigable work on the new StateManager interface and for fixing a large portion of the failing blockchain tests
- @rmeissner for the work on Constantinople
- @vpulim for jumping in so quickly and doing a reliable
SSTORE
implementation within 4 days - @s1na for the new API test suite
Beyond this release contains contributions from the following people: @jwasinger, @Agusx1211, @HolgerD77, @danjm, @whymarrh, @seesemichaelj, @kn
Thank you all very much, and thanks @axic for keeping an ongoing eye on overall library quality!
## [2.4.2] - [rp fork]
- Fix debug logs and dump logs to file configuration.
## [2.4.1] - [rp fork]
- Add support for debug logs and dump logs to file.
2.4.0 - 2018-07-27
With the 2.4.x
release series we now start to gradually add Constantinople
features with the
bitwise shifting instructions from EIP 145
making the start being introduced in the v2.4.0
release.
Since both the scope of the Constantinople
hardfork as well as the state of at least some of the EIPs
to be included are not yet finalized, this is only meant for EXPERIMENTAL
purposes, e.g. for developer
tools to give users early access and make themself familiar with dedicated features.
Once scope and EIPs from Constantinople
are final we will target a v2.5.0
release which will officially
introduce Constantinople
support with all the changes bundled together.
Note that from this release on we also introduce new chain
(default: mainnet
) and hardfork
(default: byzantium
) initialization parameters, which make use of our new ethereumjs-common library and in the future will allow
for parallel hardfork support from Byzantium
onwards.
Since hardfork
default might be changed or dropped in future releases, you might want to explicitly
set this to byzantium
on your next update to avoid future unexpected behavior.
All the changes from this release:
FEATURES/FUNCTIONALITY
- Improved chain and fork support, see PR #304
- Support for the
Constantinople
bitwise shifiting instructionsSHL
,SHR
andSAR
, see PR #251 - New
newContract
event which can be used to do interrupting tasks on contract/address creation, see PR #306 - Alignment of behavior of bloom filter hashing to go along with mainnet compatible clients BREAKING, see PR #295
UPDATES/TESTING
- Usage of the latest
rustbn.js
API, see PR #312 - Some cleanup in precompile error handling, see PR #318
- Some cleanup for
StateManager
, see PR #266 - Renaming of
util.sha3
usages toutil.keccak256
and bumpethereumjs-util
tov5.2.0
(you should do to if you useethereumjs-util
) - Parallel testing of the
Byzantium
andConstantinople
state tests, see PR #317 - For lower build times our CI configuration now runs solely on
CircleCI
and support forTravis
have been dropped, see PR #316
BUG FIXES
- Programmatic runtime errors in the VM execution context (within an opcode) are no longer absorbed and displayed as a VMError but explicitly thrown, allowing for easier discovery of implementation bugs, see PR #307
- Fix of the
Bloom.check()
method not working properly, see PR #311 - Fix a bug when
REVERT
is used within aCREATE
context, see PR #297 - Fix a bug in
FakeBlockChain
error handing, see PR #320
2.3.5 - 2018-04-25
- Fixed
BYTE
opcode return value bug, PR #293 - Clean up touched-accounts management in
StateManager
, PR #287 - New
stateManager.copy()
function, PR #276 - Updated Circle CI configuration to 2.0 format, PR #292
2.3.4 - 2018-04-06
- Support of external statemanager in VM constructor (experimental), PR #264
ES5
distribution on npm for better toolchain compatibility, PR #281allowUnlimitedContractSize
VM option for debugging purposes, PR #282- Added
gasRefund
to transaction results, PR #284 - Test coverage / coveralls support for the library, PR #270
- Properly calculate totalgas for large return values, PR #275
- Improve iterateVm check output after step hook, PR #279
2.3.3 - 2018-02-02
- Reworked memory expansion/access for opcodes, PR #174 (fixes consensus bugs on large numbers >= 53 bit for opcodes using memory location)
- Keep stack items as bn.js instances (arithmetic performance increases), PRs #159, #254 and #256
- More consistent VM error handling, PR #219
- Validate stack items after operations, PR #222
- Updated
ethereumjs-util
dependency from4.5.0
to5.1.x
, PR #241 - Fixed child contract deletion bug, PR #246
- Fixed a bug associated with direct stack usage, PR #240
- Fix error on large return fees, PR #235
- Various bug fixes
2.3.2 - 2017-10-29
- Better handling of
rustbn.js
exceptions - Fake (default if non-provided) blockchain fixes
- Testing improvements (separate skip lists)
- Minor optimizations and bug fixes
2.3.1 - 2017-10-11
Byzantium
compatible- New opcodes
REVERT
,RETURNDATA
andSTATICCALL
- Precompiles for curve operations and bigint mod exp
- Transaction return data in receipts
- For detailed list of changes see PR #161
- For a
Spurious Dragon
/EIP 150
compatible version of this library install latest version of2.2.x
2.2.2 - 2017-09-19
- Fixed JS number issues and certain edge cases
- Fixed various smaller bugs and improved code consistency
- Some VM speedups
- Testing improvements
- Narrowed down dependencies for library not to break after Byzantium release
2.2.1 - 2017-08-04
- Fixed bug prevent the library to be used in the browser
2.2.0 - 2017-07-28
Spurious Dragon
&EIP 150
compatible- Detailed list of changes in pull requests #147 and #143
- Removed
enableHomestead
option when creating a new VM object (pre-Homestead fork rules not supported any more)
2.1.0 - 2017-06-28
- Homestead compatible
- update state test runner for General State Tests