What's Changed

🎉 Enhancements 🎉

Private state shared cache optimisations

This results in less writes to disk, full details in the pr https://github.com/ConsenSys/quorum/pull/1353

Fixes

• fix: test dumpconfig and TOML read https://github.com/ConsenSys/quorum/pull/1316
• fix: revert reason for private enhanced tx https://github.com/ConsenSys/quorum/pull/1315
• Fix concurrent maps modifications and seg faults https://github.com/ConsenSys/quorum/pull/1331
• fix: ibft1 version for support of besu https://github.com/ConsenSys/quorum/pull/1333
• Upgrade go version and enforce go mod tidy https://github.com/ConsenSys/quorum/pull/1337
• p2p/nat: skip TestUPNP in non-CI environments if discover fails (#22877) https://github.com/ConsenSys/quorum/pull/1341
• Update dependabot alerts daily https://github.com/ConsenSys/quorum/pull/1342
• Bump github.com/go-stack/stack from 1.8.0 to 1.8.1 https://github.com/ConsenSys/quorum/pull/1344
• Bump github.com/hashicorp/go-hclog from 0.13.0 to 1.1.0 https://github.com/ConsenSys/quorum/pull/1347

Full Changelog: https://github.com/ConsenSys/quorum/compare/v22.1.0...v22.1.1

Binaries

This release's main highlight is the addition of a new format for private transactions basing on a pre-compiled smart contract. This new approach allows extending obfuscated fields of a private transaction

This feature addition is not a breaking change and won’t impact normal (standard & enhanced) private transaction processing

Enhancements

• 🎉 [Privacy Precompile]: enables private transactions with extended obfuscated fields #1234
• Amend IntrinsicGas calculation for Privacy Marker Transaction to use actual payload hash, instead of hardcoded value #1236

Fixes

• fix: null pointer when error occurs #1239

Other

• Extend acceptance tests executed, and also on the master branch #1230

This release main highlight is the new consensus engine for the QBFT algorithm. It

• is interoperable with Hyperleger Besu, enabling hybrid GoQuorum <> Besu networks running on a Byzantian Fault-Tolerant consensus
• improves the stability of BFT networks (in particular it addresses a liveness issue of the IBFT implementation)

QBFT is available for

• new networks
• existing IBFT networks through a hard fork migration (as an ALPHA feature)

Enhancements

• 🎉 [QBFT] Add QBFT consensus #1209
• Add raftlogdir commandline option #1110
• Add revert reason to transaction receipt #1215
• [Geth-Upgrade] Go-Ethereum release from v1.9.21 to v1.9.24 #1211, #1214, #1217, #1219
• Add cache on private state trie #1225
• Update receipts encoding to faciliate usage of multiple receipts format #1227

Fixes

• [MPS] fix merge/rebase issues #1197
• Add logging to catch scenario when processing of transactions is aborted due to New Head event #1220
• [QBFT] Check if sb.core is nil before processing NewBlockMsg #1229
• [QBFT] Asynchronously call startNewRound() when transitioning from IBFT to QBFT #1232

Other

• [Docker] Update docker tagging to the following convention: latest is the latest stable release (ie. v21.4.1 on this case) and develop is the latest snapshot release from the current development version (ie. created from master branch) #1171
• [CI/CD] Add acceptance tests on PR and master #1230
• [CI/CD] Add a scheduled job in order to check geth upgrades everyday #1205

Binaries

Release format

Enhancements

• 🎉 [Multi-Tenancy] Allow to serve multiple tenants from a single node #1105 ALPHA RELEASE
• 🎉 [Permissioning] Add support for permissioning v2 compatible with EEA specs #1095
• Add configurable ipc timeout #1100
• Add new status and validator RPC APIs for IBFT and Clique #1113
• change to golang version 1.15.5 #1114
• params: update CHTs for v21.1.0 release #1119

Others

• [CI/CD] Fix Github Actions workflows deprecation warnings #1097

Documentation

• Update Web3 Labs GitHub URL (#1093)

Release format

Quorum is moving its versioning convention scheme to Calendar Versioning (or CalVer) starting with 20.10.0 (f.k.a. 2.8.0) release.

Version scheme convention is YY.MM.Patch where

• YY.MM stands for the year and month of the quarter when the release happens (starting with 20.10 for October 2020)
• Patch stands for the number of the release within the quarter

Example

• Next Quorum releases will be 20.10.1, 20.10.2, etc. (indifferently if they happen in October, November...)
• When moving to the next quarter likely in February 2021, the version will increment to 21.02.0

Get to know more about ConsenSys Quorum CalVer!

Enhancements

• 🎉 [Privacy] Add support for privacy enhancements (#1073)

  Introduce a new privacyFlag parameter to sendTransaction APIs enabling to define the mode for execution of a private transaction.

  • 0 - StandardPrivate (default): same retro-compatible mode for private transactions as available in prior versions of Quorum
  • 1 - PartyProtection: new mode allowing receiving parties in privateFor to validate that the sending party has access to all the affected private smart contracts affected by the transaction
  • 3 - StateValidation: new mode allowing all parties in a private transaction to ensure that their local private smart contract states have not diverged

• [Privacy] Encapsulate private transaction arguments (#1044)

• [Privacy] Formalize the usage of common.EncryptedPayloadHash (#1046)

• [Plugin] Allow security plugin to opt out service implementation (#1052)

• Add debug_dumpAddress API to fetch state of an account including balance, nonce, storage, etc. (#1072)

• Update crypto/secp256k1 submodule path (#1077)

• [Plugin] Expose the plugin@account API over clef's HTTP server (#1078)

• Add a new Geth flag --vm.calltimeout to optionnaly override the 5 seconds default timeout on eth_call (#1085)

Bug fixes

• [Istanbul] Fix VerifyHeaders() to error out all header verification request when the first one fails (#1042)
• Fix tracing on public transaction (#1072)
• Fix for "VM in read-only mode" error seen in logs in stress test of clique networks (#1076)
• [Raft] Fix double addPeer, should also check self (#1080)

Tests

• Add unit tests for common.EncryptedPayloadHash (#1045)

Others

• [CI/CD] Publish Docker image to Docker Hub via GithubActions (#1079)
• [CI/CD] Updates (#1082) (#1086)

Documentation

• Add documentation for Tessera bootstrapNode config (#1016)
• Add documentation for Hashicorp Vault account plugin (#1040)
• Updated Readme.md (#1043)
• Tessera config update for next release (#1047)
• Update Quorum Profiling documentation (#1053)
• Make plugin docs consistent (#1054)
• Smart contracts security editorial updates (#1057)
• Add documentation to clarify the use of bindingAddress in tessera config (#1060)
• Removed docs files now included in doc.goquorum and doc.tessera repos (#1062)
• Change links, emails and more (#1067)

Enhancements

• 🎉 Support HashiCorp Vault for account management with account plugins (#1033) BETA RELEASE
• 🎉 Support adding new members to private smart contracts, private contract state extension (#1030) BETA RELEASE
• 🎉 Protect JSON RPC APIs via a plugin interface (#1019) BETA RELEASE
• Create separate sub-module for crypto/secp256k1 package (#1036)
• Apply upstream go-ethereum updates to Clef documentation (#1032)
• Improve cache implementation for permissions (#961)
• gha: automate release (#994)
• gha: add Github Actions workflows (#984)
• Created special PTM for public-only mode. (#968)
• Adding checkpoint to log the time taken to process a transaction. (#988)

Fixes

• cmd/geth: exit gradually when there's a failure in PluginManager (#1026)
• Issue #1004 - prevent "Mining too far in future" message when using allowedfutureblocktime parameter (#1023)
• change protocol name for clique consensus (#1031)
• Apply upstream changes to prevent crash when keystore-specific methods are called but external signer used (#1028)
• Apply upstream clef bug fixes and add clef documentation (#1009)
• Remove java dependency from go tests (#1018)
• raft: return error when block processing is aborted (#992)
• eth_estimateGas failing when value is not passed as a part of arguments (#989)
• Corrections to logged error messages (#997)
• fix linting issues (#995)
• Update genesis.md (#1027)
• Static mkdocs version to prevent future dependency incompatibilities (#1025)
• Documentation updates (#1022) (#1006) (#996) (#998)
• Quorum Tessera HA Setup (#1015)

Important: Due to DB schema changes, once a node is migrated to this version, the node cannot be rolled back to prior version. Hence we recommend appropriate back ups and testing prior to migration.

This release upgrades Quorum's geth version to 1.9.7. geth v1.9.7 brings in the following key features:

• Performance optimization: Optimization of account and storage trie access patterns across blocks, EVM opcode optimization, optimization of sync process
• Transaction pool optimization for better throughput
• Introduction of freezer db which allows moving historical blocks beyond certain threshold value out of LevelDB into a custom freezer db
• Native GraphQL query capabilities for flexible querying
• Clef: Standalone signer which segregates account management from geth
• Monitoring: Can be integrated with Grafana with enhanced data dump

Please refer to Geth v1.9.0 for the complete list of features added in geth version 1.9.0

Please note the following while migrating to this version:

• If you are using keystore based accounts, use --allow-insecure-unlock to bring up geth. Otherwise geth will crash while starting
• Upon geth restart, any blocks which are below the default immutability threshold(3162240), will be moved to freezer db. If you do not want the blocks to move to freezer db, set the value of --immutabilitythreshold appropriately fo the network.

Please refer to this page for further details on migrating to this version.

Enhancements

• Geth upgrade to 1.9.7 (#960)
• Enable networks to change maxCodeSize multiple times (#975)
• Add configurable threshold for 'future block' check for Istanbul & Clique (#800)
• plugin: delegate JSON RPC calls to plugin (#956)
• plugin: change signature file name and add test case for Bintray signer (#957)

Fixes

• Fix issue with suborg id when node is added to sub orgs(#950)
• Fix params number for debug.dumpBlock in web3ext (#944)

Documentation

• Update genesis samples to reflect latest code updates (#952)
• Update Compatibility table & adding Quorum 2 geth map (#959)
• Add Kubernetes to quorum README.md / docs. (#970)
• Add documentation for quorum wizard (#973)
• Update Tessera encryption & Privacy Manager docs (#972)
• Tessera API documentation update for 10.0.5 version (#977)

Others

• Travis updates (#955) (#958) (#964)

Enhancements

• Framework to allow adding additional Quorum features as plugins (#923)
• Support Quorum import/export chain (#946)

Fixes

• Bloom filter fixes (#945)
• Added a maxCodeSizeChangeBlock to track the block height when maxCodeSize changes from default value of 24K to the given value in genesis.json (#947)
• Fix broken raft consensus link (#940)
• IBFT private state commit issue in a single validator node network (#938)
• Fix DNS issue in 2.4.0 (#937)
• Raft raft.cluster api returns error if no leader is there in the network in version 2.4.0 (#934)
• Remove duplicated flag group: ETHASH (#924)
• Add Quorum eth namespace RPC methods to console (#922)
• Raft: correct the setup sequence for applied index related test (#900)
• Rename the transaction manager package to make it more neutral (#895)

Enhancements

• Quorum Raft upgrade v3.3.13 and add support for Raft Learner nodes(#887)
• DNS support for static nodes (#885)
• rpc: raise HTTP/WebSocket request size limit to 5MB (#898)

Fixes

• p2p: fix connection leakage when peer is not authorized to connect (#897)
• Update file descriptor limits for macOS to support go 1.12 (#892)
• Allow Raft to recover state after non-graceful shutdown in non-archive mode (#860)
• Raft applied index out of range (#880)
• Premature abort during blocks processing for Raft (#881)
• Restrict removed Raft node in p2p connection (#884)
• Update for Raft stability (#886)
• Overflow in parent tracking (cherrypicking go-ethereum#18165 pull) (#876)
• Add check at startup to ensure transaction manager mode is specified. (#868)
• debug.traceTransaction VM in read-only mode error for public tx (#875)
• Optimize travis and fix flaky tests (#873)
• Print TransactionSizeLimit and MaxCodeSize genesis config (#872)
• Permissions service not starting upon restart of the node(#866)
• Add block sealing information to IBFT API (#856)
• eth.SignTransaction APIs: Set tx as private before signing (#864)
• Add CORS configuration parameters (#858)
• Check if message payload is signed by the message sender (#853)
• Add documentation on IBFT parameters (#835)

Thanks to @antonydenyer @timmoreton @montyly for their contributions.

Enhancements:

• BETA RELEASE Smart contract and RBAC based permissions model with support for organisations, sub-organisations, roles, account level access controls and nodes in the network. #715 🎉
• IBFT formula update to support ceil(2N/3) #796
• Quorum private transaction support for Abigen #819

Fixes:

• Update validation for write operations to use operation.writes #798
• CLI flags display #799
• Raft issue with single node networks #815
• Race condition in BFT #833

Special thanks to the OpenZeppelin team for their preliminary review of our permissions module.
Thanks to @panghalamit @jimthematrix for their help and contribution with #796

Fixes:

• Max code size option in genesis config (#786)
• internal/ethapi: ask transaction pool for pending nonce (#784)
• Set tcp port of p2p node by raft peer correctly. (#775)
• Bugfix/geth console displays incorrect block timestamp (#762)
• Adding QuorumPrivateTxSigner for signing and recovering private txs. (#767)
• Raft set gcmode=archive always for Raft (#727)
• rpc: increase server buffer size to 128kb (#663)

Fixes:

• Pass parent block gas limit in Raft #680
• Increase the default min and ceil gas limits #680
• Refund gas in non-party nodes for private transactions #739
• Resolve concurrent access panic in IBFT #684
• Update TX personal_sendTransaction to use the hash. #679

Miscellaneous

• Quorum Security Framework & various documentation updates #738
• Adding signer tests for EIP155, Homestead and private tx #682

Patch release to allow existing chains to run without running geth init.

• Set default transaction size limit if it is not configured #675

Enhancements:

• Geth upgrade 1.8.18 #639
• Improve block downloads and processing in raft based networks. #621
• Configure transaction size limit using the genesis block #636
• Add Quorum version to Node Info #616

Fixes:

• Add validation for raft peer updates #656
• Build issues for Go 1.11+ #619
• Gas limit for private transactions #595
• “impossible re-org” issue #539
• Handle EIP155 transactions before the configured 155 block is reached #667
• Estimate Gas support for private transactions #644

Enhancements:

• Support for private raw transactions via eth_sendRawPrivateTransaction API #591
• Added dual state implementation to StaticCall, requirement for Solidity v0.5+ #592

Fixes:

• Maxing out fdlimit #597
• Prevent deadlock when with IBFT #598
• Prevent reset of V value if the txn is already set to private #563

Enhancements:

• Upgrade Quorum to Geth v1.8.12

Fixes:

• Fix issue with missing events #556
• Fix high estimate gas issue #585
• Add private log blooms to DB #570

Enhancements

• Block signing for Raft #395
• Enable Clique POA consensus #533
• Add an API endpoint for raft cluster details #501
• Validate Consensus selection #540
• IP Look up if host is FQDN #544

Fixes

• Add EIP155 support to eth_sendTrasactionAsync. #541
• Fixed memory leak in Istanbul. #521
• Fix consensus on private contract failure #517
• Disallow p2p or raft port reuse for raft consensus #524
• Private value transfers exception handling #538

Breaking Changes

• Enforce a chain ID greater than 1 which is reserved for Ethereum mainnet (#502, #503)

Enhancements

• Use EIP155 signer (https://github.com/jpmorganchase/quorum/pull/350 , https://github.com/jpmorganchase/quorum/pull/375 ,https://github.com/jpmorganchase/quorum/pull/463)
• Add eth.storageRoot endpoint (https://github.com/jpmorganchase/quorum/pull/436)
• Disable ethash (https://github.com/jpmorganchase/quorum/pull/318)
• Allow quorum node option to not configure a constellation node (https://github.com/jpmorganchase/quorum/pull/462)
• Expose Raft leader Enode ID (https://github.com/jpmorganchase/quorum/pull/426)

Bug fixes

• Istanbul events not firing & logs not captured (https://github.com/jpmorganchase/quorum/pull/460)
• Validate EVM input for private transactions (https://github.com/jpmorganchase/quorum/pull/430)
• Hashrate fix for non-POW algos (https://github.com/jpmorganchase/quorum/pull/409)
• Reject private TXs with ether value (https://github.com/jpmorganchase/quorum/pull/451)
• Update speculative chain head (https://github.com/jpmorganchase/quorum/pull/437)
• Increase minimum gas limit for network

• Various fixes to IstanbulBFT consensus
• Makefile fixed to work with Go 1.10