39 KiB
Changelog
0.9
Breaking Changes to Command Line
Breaking changes have been made to the command line options in v0.9 to improve usability. Many v0.8 command line options no longer work.
The documentation has been updated throughout to use the changed command line options and the command line reference documents the changed options.
Previous Option | New Option | Change |
---|---|---|
--config |
--config-file |
Renamed |
--datadir |
--data-path |
Renamed |
--dev-mode |
--network=dev |
Replaced by --network option |
--genesis |
--genesis-file |
Renamed |
--goerli |
--network=goerli |
Replaced by --network option |
--metrics-listen=<HOST:PORT> |
--metrics-host=<HOST> and --metrics-port=<PORT> |
Split into host and port options |
--miner-extraData |
--miner-extra-data |
Renamed |
--miner-minTransactionGasPriceWei |
--min-gas-price |
Renamed |
--no-discovery |
--discovery-enabled |
Replaced |
--node-private-key |
--node-private-key-file |
Renamed |
--ottoman |
N/A | Removed |
--p2p-listen=<HOST:PORT> |
--p2p-host=<HOST> and --p2p-port=<PORT> |
Split into host and port options |
--rinkeby |
--network=rinkeby |
Replaced by --network option |
--ropsten |
--network=ropsten |
Replaced by --network option |
--rpc-enabled |
--rpc-http-enabled |
Renamed |
--rpc-listen=<HOST:PORT> |
--rpc-http-host=<HOST> and --rpc-http-port=<PORT> |
Split into host and port options |
--rpc-api |
--rpc-http-api |
Renamed |
--rpc-cors-origins |
--rpc-http-cors-origins |
Renamed |
--ws-enabled |
--rpc-ws-enabled |
Renamed |
--ws-api |
--rpc-ws-api |
Renamed |
--ws-listen=<HOST:PORT> |
--rpc-ws-host=<HOST> and --rpc-ws-port=<PORT> |
Split into host and port options |
--ws-refresh-delay |
--rpc-ws-refresh-delay |
Renamed |
Previous Subcommand | New Subcommand | Change |
---|---|---|
pantheon import <block-file> |
pantheon blocks import --from=<block-file> |
Renamed |
pantheon export-pub-key <key-file> |
pantheon public-key export --to=<key-file> |
Renamed |
Private Network Quickstart
The Private Network Quickstart has been moved from the pantheon
repository to the pantheon-quickstart
repository. The Private Network Quickstart tutorial
has been updated to use the moved quickstart.
Additions and Improvements
--network=goerli
supports relaunch of Görli testnet #717- TOML authentication provider #689
- Metrics Push Gateway Options #678
- Additional logging details for IBFT 2.0 #650
- Permissioning config TOML file #643
- Added metrics Prometheus Push Gateway Support #638
- Clique and IBFT not enabled by default in RPC APIs #635
- Added
admin_addPeer
JSON-RPC API method #622 - Implemented
--p2p-enabled
configuration item #619 - Command options and commands renaming #618
- Added IBFT get pending votes #603
- Implement Petersburg hardfork #601
- Added private transaction abstraction #592 (thanks to iikirilov)
- Added privacy command line commands #584 (thanks to Puneetha17)
- Documentation updates include:
- Updated Private Network Quickstart tutorial
to use quickstart in
pantheon-quickstart
repository and indicate that the quickstart is not supported on Windows. - Added IBFT 2.0 content and JSON RPC API methods.
- Added consensus protocols content.
- Added content on events and logs, and using filters.
- Added content on integrating with Prometheus Push Gateway
- Updated Private Network Quickstart tutorial
to use quickstart in
Technical Improvements
- Download receipts during fast sync and import without processing transactions #701
- Removed CLI options for
--nodes-whitelist
and--accounts-whitelist
#694 - Delegate
getRootCause
through to Guava's implementation #692 - Benchmark update #691
- Implement chain download for fast sync #690
- Allow missing accounts to create zero-cost transactions #685
- Node private key location should be fixed under docker #684
- Parallel Processing File Import Performance #683
- Integrate actual
WorldStateDownloader
with the fast sync work flow #682 - Removed
--max-trailing-peers
option #680 - Enabled warning on CLI dependent options #679
- Update WorldStateDownloader run() interface to accept header #677
- Fixed Difficulty calculator #663
discovery-enabled
option refactoring #661- Update orion default port approach #660
- Extract out generic parts of Downloader #659
- Start world downloader #658
- Create a simple
WorldStateDownloader
#657 - Added handling for when p2p is disabled #655
- Enabled command line configuration for privacy precompiled contract address #653 (thanks to Puneetha17)
- IBFT transmitted packets are logged by gossiper #652
admin_addPeer
acceptance test #651- Added
p2pEnabled
configuration toProcessPantheonNodeRunner
#649 - Added description to automatic benchmarks #646
- Added
network
option #645 - Remove OrionConfiguration #644 (thanks to Puneetha17)
- IBFT Json Acceptance tests #634
- Upgraded build image to one that contains libsodium #632
- Command line fixes #630
- Consider peer count insufficient until minimum peers for fast sync are connected #629
- Build tweaks #628
- IBFT ensure non-validator does not partake in consensus #627
- Added ability in acceptance tests to set up a node with
--no-discovery
#624 - Gossip integration test #623
- Removed quickstart code and CI pipeline #616
- IBFT Integration Tests - Spurious Behaviour #615
- Refactoring for more readable IBFT IT #614
- Start of fast sync downloader #613
- Split
IbftProcessor
into looping and event processing #612 - IBFT Int Test - changed
TestContextFactory
to a builder #611 - Discard prior round change msgs #610
IbftGetValidatorsByBlockHash
added to json factory #607- IBFT Validator RPCs to return list of strings #606
- Update Benchmark #605
- Remove db package and move classes to more appropriate locations #599
- Added
GetReceiptsFromPeerTask
#598 - Added
GetNodeDataFromPeerTask
#597 - Fixed deprecation warnings #596
- IBFT Integration Tests - Future Height #591
- Added
getNodeData
toEthPeer
to enable requesting node data #589 Blockcreator
to useparentblock
specified at constuction #588- Support responding to
GetNodeData
requests #587 - IBFT validates block on proposal reception #583
- Rework
NewRoundValidator
tests #582 - IBFT split extra data validation rule into components #581
- Allow attached rules to be flagged
light
#580 - Split Block Validation from Importing #579
- Refactor
RoundChangeManager
creation #578 - Add
-SNAPSHOT
postfix to version #577 - IBFT - prevent proposed block being imported twice #576
- Version upgrades #571
- Tests that CLI options are disabled under docker #566
- Renamed IBFT networking classes #555
- Removed dead code from the consensus package #554
- Prepared private transaction support #538 (thanks to iikirilov)
0.8.5
Indefinitely delays the roll-out of Constantinople on Ethereum Mainnet due to a potential security issue detected.
Additions and Improvements
- Remove Constantinople fork block #574
Technical Improvements
- Rename IBFT message packages #568
0.8.4
Docker Image
If you have been running a node using the v0.8.3 Docker image, the node was not saving data to the specified data directory, or referring to the custom configuration file or genesis file.
To recover the node key and data directory from the Docker container:
docker cp <container>:/opt/pantheon/key <destination_file>
docker cp <container>:/opt/pantheon/database <destination_directory>
Where container
is the name or ID of the Docker container containing the Pantheon node.
The container can be running or stopped when you copy the key and data directory. If your node was fully synchronized to MainNet, the data directory will be ~2TB.
When restarting your node with the v0.8.4 Docker image:
- Save the node key in the
key
file in the data directory or specify the location using the--node-private-key
option. - Specify the
<destination_directory
as a volume for the data directory.
Bug Fixes
- Fixing default resource locations inside docker #529
- NewRoundMessageValidator ignores Round Number when comparing blocks #523
- Fix Array Configurable command line options #514
Additions and Improvements
- RocksDB Metrics #531
- Added
ibft_getValidatorsByBlockHash
JSON RPC #519 - Expose metrics to Prometheus #506
- Added
ibft_getValidatorsByBlockNumber
#499 - Added
Roadmap.md
file. #494 - Added JSON RPC
eth hashrate
method. #488 - Account whitelist API #487
- Added nodes whitelist JSON-RPC APIs #476
- Added account whitelisting #460
- Added configurable refresh delay for SyncingSubscriptionService on start up #383
- Added the Command Line Style Guide #530
- Documentation updates include:
- Migrated to new documentation site
- Added configuration file content
- Added tutorial to create private network
- Added content on enabling non-default APIs
Technical Improvements
- Updated
--bootnodes
command option to take zero arguments #548 - IBFT Integration Testing - Local Node is proposer #527
- Remove vertx from discovery tests #539
- IBFT Integration testing - Round Change #537
- NewRoundMessageValidator creates RoundChangeValidator with correct value #518
- Remove time dependency from BlockTimer tests #513
- Gradle 5.1 #512
- Metrics measurement adjustment #511
- Metrics export for import command. #509
- IBFT Integration test framework #502
- IBFT message gossiping #501
- Remove non-transactional mutation from KeyValueStore #500
- Ensured that the blockchain queries class handles optionals better. #486
- IBFT mining acceptance test #483
- Set base directory name to be lowercase in building.md #474 (Thanks to Matthalp)
- Moved admin_peers to Admin API group #473
- Nodes whitelist acceptance test #472
- Rework RoundChangeManagerTest to not reuse validators #469
- Ignore node files to support truffle. #467
- IBFT pantheon controller #461
- IBFT Round to update internal state on reception of NewRound Message #451
- Update RoundChangeManager correctly create its message validator #450
- Use seconds for block timer time unit #445
- IBFT controller and future msgs handling #431
- Allow IBFT Round to be created using PreparedCert #429
- Added MessageValidatorFactory #425
- Inround payload #423
- Updated IbftConfig Fields #422
- Repair IbftBlockCreator and add tests #421
- Make Pantheon behave as a submodule #419
- Ibft Height Manager #418
- Ensure bootnodes are a subset of node whitelist #414
- IBFT Consensus Round Classes #405
- IBFT message payload tests #404
- Validate enodeurl syntax from command line #403
- Update errorprone #401
- IBFT round change manager #393
- IBFT RoundState #392
- Move Block data generator test helper to test support package #391
- IBFT message tests #367
0.8.3
Breaking Change to JSON RPC-API
From v0.8.3, incoming HTTP requests are only accepted from hostnames specified using the --host-whitelist
command-line option. If not specified, the default value for --host-whitelist
is localhost
.
If using the URL http://127.0.0.1
to make JSON-RPC calls, use --host-whitelist
to specify the hostname 127.0.0.1
or update the hostname to localhost
.
If your application publishes RPC ports, specify the hostnames when starting Pantheon. For example:
pantheon --host-whitelist=example.com
Specify *
or all
for --host-whitelist
to effectively disable host protection and replicate pre-v0.8.3 behavior. This is not recommended for production code.
Bug Fixes
- Repair Clique Proposer Selection #339
- High TX volume swamps block processing #337
- Check if the connectFuture has completed successfully #293
- Switch back to Xerial Snappy Library #284
- ShortHex of 0 should be '0x0', not '0x' #272
- Fix pantheon CLI default values infinite loop #266
Additions and Improvements
- Added
--nodes-whitelist
parameter to CLI and NodeWhitelistController #346 - Discovery wiring for
--node-whitelist
#365 - Plumb in three more metrics #344
ProposerSelection
to support multiple IBFT implementations #307- Configuration to support IBFT original and revised #306
- Added host whitelist for JSON-RPC. Breaking Change #295
- Reduce
Block creation processed cancelled
log message to debug #294 - Implement iterative peer search #268
- Added RLP enc/dec for PrePrepare, Commit and NewRound messages #200
- IBFT block mining #169
- Added
--goerli
CLI option #370 (Thanks to @Nashatyrev) - Begin capturing metrics to better understand Pantheon's behaviour #326
- Documentation updates include:
- Added Coding Conventions #342
- Reorganised Installation documentation and added Chocolatey installation for Windows
- Reorganised JSON-RPC API documentation
- Updated RPC Pub/Sub API documentation
Technical Improvements
- Extracted non-Docker CLI parameters to picoCLI mixin. #323
- IBFT preprepare to validate round matches block #329
- Fix acceptance test #324
- Added the
IbftFinalState
#385 - Constantinople Fork Block #382
- Fix
pantheon.cli.PantheonCommandTest
test on Windows #380 - JDK smoke testing is being configured differently now #374
- Re-enable clique AT #373
- Ignoring acceptance test #372
- Changes to support Gradle 5.0 #371
- Clique: Prevent out of turn blocks interrupt in-turn mining #364
- Time all tasks #361
- Rework
VoteTallyCache
to better represent purpose #360 - Add an
UNKNOWN
DisconnectReason
#359 - New round validation #353
- Update get validators for block hash test to start from block 1 #352
- Idiomatic Builder Pattern #345
- Revert
Repair Clique Proposer Selection
#339 - Breaks Görli testnet #343 - No fixed ports in tests #340
- Update clique acceptance test genesis file to use correct clique property names #338
- Supporting list of addresses in logs subscription #336
- Render handler exception to
System.err
instead of.out
#334 - Renamed IBFT message classes #333
- Add additional RLP tests #332
- Downgrading spotless to 3.13.0 to fix threading issues #325
eth_getTransactionReceipt
acceptance test #322- Upgrade vertx to 3.5.4 #316
- Round change validation #315
- Basic IBFT message validators #314
- Minor repairs to clique block scheduling #308
- Dependencies Version upgrade #303
- Build multiple JVM #301
- Smart contract acceptance test #296
- Fixing WebSocket error response #292
- Reword error messages following exceptions during mining #291
- Clique acceptance tests #290
- Delegate creation of additional JSON-RPC methods to the PantheonController #289
- Remove unnecessary
RlpInput
andRlpOutput
classes #287 - Remove
RlpUtils
#285 - Enabling previously ignored acceptance tests #282
- IPv6 peers #281
- IPv6 Bootnode #280
- Acceptance test for
getTransactionReceipt
JSON-RPC method #278 - Inject
StorageProvider
intoPantheonController
instances #259
0.8.2
Removed
- Removed
import-blockchain
command because nothing exports to the required format yet (PR #223)
Bug Fixes
io.netty.util.internal.OutOfDirectMemoryError
errors by removing reference counting from network messages.- Log spam: endless loop in
nioEventLoopGroup
(#248 thanks to @5chdn for reporting) (PR #261) - Rinkeby import can stall with too many fragments (#228 thanks to @steffenkux and @5chdn for reporting) (PR #255)
- Clique incorrectly used the chain ID instead of the network ID in ETH status messages (PR #209)
- Gradle deprecation warnings (PR #246 with thanks to @jvirtanen)
- Consensus issue on Ropsten:
- File name too long error while building from source (#215 thanks to @5chdn for reporting) (PR #221)
- Loop syntax in
runPantheonPrivateNetwork.sh
(PR #237 thanks to @matt9ucci) - Fix
CompressionException: Snappy decompression failed
errors (#251 thanks to @5chdn for reporting) (PR #274)
Additions and Improvements
- Added
--ropsten
command line argument to make syncing to Ropsten easier (#186) (PR #197 with thanks to @jvirtanen) - Enabled constantinople in
--dev-mode
(PR #256) - Supported Constantinople with Clique (#245 thanks to @5chdn for reporting) (PR #250, PR #247)
- Implemented
eth_chainId
JSON-RPC method (#206) (PR #219) - Updated client version to be ethstats friendly (PR #258)
- Added
--node-private-key
option to allow nodekey file to be specified separately to data directory (#233 thanks to @peterbroadhurst for requesting) (PR #234) - Added
--banned-nodeids
option to prevent connection to specific nodes (PR #254) - Send client quitting disconnect message to peers on shutdown (#184) (PR #253)
- Improved error message for port conflict error (PR #232)
- Improved documentation by adding the following pages:
Technical Improvements
- Upgraded Ethereum reference tests to 6.0 beta 2. (thanks to @jvirtanen for the initial upgrade to beta 1)
- Set Java compiler default encoding to UTF-8 (PR #238 thanks to @matt9ucci)
- Removed duplicate code defining default JSON-RPC APIs (PR #218 thanks to @matt9ucci)
- Improved code for parsing config (PRs #208, #209)
- Use
java.time.Clock
in favour of a custom Clock interface (PR #220) - Improve modularity of storage systems (PR #211, #207)
- Treat JavaDoc warnings as errors (PR #171)
- Add benchmark for
BlockHashOperation
as a template for benchmarking other EVM operations (PR #203) - Added unit tests for
EthBlockNumber
(#189) (PR #195 thanks to @jvirtanen) - Code style improvements (PR #196 thanks to @jvirtanen)
- Added unit tests for
Web3ClientVersion
(#191) (PR #194 with thanks to @jvirtanen) - Removed RLPUtils from
RawBlockIterator
(PR #179) - Replace the JNI based snappy library with a pure-Java version (PR #257)