Bump to v3.3.3

* Made nodes data concatenate as RLP sequences instead of bytes

* Add test for getNodeData dispatch

* Update getNodeData to return data for non-aura networks

.cargo/config

@@ -0,0 +1,3 @@
+[target.x86_64-pc-windows-msvc]
+# Link the C runtime statically ; https://github.com/openethereum/parity-ethereum/issues/6643
+rustflags = ["-Ctarget-feature=+crt-static"]

.dockerignore

@@ -0,0 +1,22 @@
+# Generated by Cargo
+# will have compiled files and executables
+target
+
+*.swp
+*.swo
+*.swn
+*.DS_Store
+
+# Visual Studio Code stuff
+.vscode
+
+# GitEye stuff
+.project
+
+# idea ide
+.idea
+
+# git stuff
+.git
+
+ethcore/res/ethereum/tests

.editorconfig

@@ -9,7 +9,7 @@ trim_trailing_whitespace=true
 max_line_length=120
 insert_final_newline=true
 
-[.travis.yml]
+[*.{yml,sh}]
 indent_style=space
 indent_size=2
 tab_width=8

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Reformat the source code
+610d9baba4af83b5767c659ca2ccfed337af1056

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Code of Conduct
+
+## 1. Purpose
+
+A primary goal of OpenEthereum is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+
+This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
+
+We invite all those who participate in OpenEthereum to help us create safe and positive experiences for everyone.
+
+## 2. Open Source Citizenship
+
+A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
+
+Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
+
+If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
+
+## 3. Expected Behavior
+
+The following behaviors are expected and requested of all community members:
+
+*   Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+*   Exercise consideration and respect in your speech and actions.
+*   Attempt collaboration before conflict.
+*   Refrain from demeaning, discriminatory, or harassing behavior and speech.
+*   Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+*   Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
+
+## 4. Unacceptable Behavior
+
+The following behaviors are considered harassment and are unacceptable within our community:
+
+*   Violence, threats of violence or violent language directed against another person.
+*   Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
+*   Posting or displaying sexually explicit or violent material.
+*   Posting or threatening to post other people’s personally identifying information ("doxing").
+*   Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+*   Inappropriate photography or recording.
+*   Inappropriate physical contact. You should have someone’s consent before touching them.
+*   Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
+*   Deliberate intimidation, stalking or following (online or in person).
+*   Advocating for, or encouraging, any of the above behavior.
+*   Sustained disruption of community events, including talks and presentations.
+
+## 5. Consequences of Unacceptable Behavior
+
+Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately.
+
+If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
+
+## 6. Reporting Guidelines
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. community@parity.io.
+
+Link to reporting guidelines: [CONTRIBUTING.md](CONTRIBUTING.md)
+
+Link to security policy: [SECURITY.md](../SECURITY.md)
+
+Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
+
+## 7. Addressing Grievances
+
+If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify OpenEthereum Technologies with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
+
+## 8. Scope
+
+We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community business.
+
+This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.
+
+## 9. Contact info
+
+You can contact OpenEthereum via Email: community@parity.io
+
+## 10. License and attribution
+
+This Code of Conduct is distributed under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
+
+Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
+
+Retrieved on November 22, 2016 from [http://citizencodeofconduct.org/](http://citizencodeofconduct.org/)

.github/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing Guidelines
+
+## Do you have a question?
+
+Check out our [Beginner Introduction](https://openethereum.github.io/Beginner-Introduction), [Configuration](https://openethereum.github.io//Configuring-OpenEthereum), and [FAQ](https://openethereum.github.io/FAQ) articles on our [wiki](https://openethereum.github.io/)!
+
+See also frequently asked questions [tagged with `parity`](https://ethereum.stackexchange.com/questions/tagged/parity?sort=votes&pageSize=50) on Stack Exchange.
+
+## Report bugs!
+
+Do **not** open an issue on Github if you think your discovered bug could be a **security-relevant vulnerability**. Please, read our [security policy](../SECURITY.md) instead.
+
+Otherwise, just create a [new issue](https://github.com/openethereum/openethereum/issues/new) in our repository and state:
+
+- What's your OpenEthereum version?
+- What's your operating system and version?
+- How did you install OpenEthereum?
+- Is your node fully synchronized?
+- Did you try turning it off and on again?
+
+Also, try to include **steps to reproduce** the issue and expand on the **actual versus expected behavior**.
+
+## Contribute!
+
+If you would like to contribute to OpenEthereum, please **fork it**, fix bugs or implement features, and [propose a pull request](https://github.com/openethereum/openethereum/compare).
+
+### Labels & Milestones
+
+We use [labels](https://github.com/openethereum/openethereum/labels) to manage PRs and issues and communicate the state of a PR. Please familiarize yourself with them. Furthermore we are organizing issues in [milestones](https://github.com/openethereum/openethereum/milestones). Best way to get started is to a pick a ticket from the current milestone tagged [`easy`](https://github.com/openethereum/openethereum/labels/Q2-easy%20%F0%9F%92%83) and get going, or [`mentor`](https://github.com/openethereum/openethereum/labels/Q1-mentor%20%F0%9F%95%BA) and get in contact with the mentor offering their support on that larger task.
+
+### Rules
+
+There are a few basic ground-rules for contributors (including the maintainer(s) of the project):
+
+* **No pushing directly to the master branch**.
+* **All modifications** must be made in a **pull-request** to solicit feedback from other contributors.
+* Pull-requests cannot be merged before CI runs green and two reviewers have given their approval.
+* All code changed should be formated by running `cargo fmt -- --config=merge_imports=true`
+
+### Recommendations
+
+* **Non-master branch names** *should* be prefixed with a short name moniker, followed by the associated Github Issue ID (if any), and a brief description of the task using the format `<GITHUB_USERNAME>-<ISSUE_ID>-<BRIEF_DESCRIPTION>` (e.g. `gavin-123-readme`). The name moniker helps people to inquiry about their unfinished work, and the GitHub Issue ID helps your future self and other developers (particularly those who are onboarding) find out about and understand the original scope of the task, and where it fits into Parity Ethereum [Projects](https://github.com/openethereum/openethereum/projects).
+* **Remove stale branches periodically**
+
+### Preparing Pull Requests
+
+* If your PR does not alter any logic (e.g. comments, dependencies, docs), then it may be tagged [`insubstantial`](https://github.com/openethereum/openethereum/pulls?q=is%3Aopen+is%3Apr+label%3A%22A2-insubstantial+%F0%9F%91%B6%22).
+
+* Once a PR is ready for review please add the [`pleasereview`](https://github.com/openethereum/openethereum/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+label%3A%22A0-pleasereview+%F0%9F%A4%93%22+) label.
+
+### Reviewing Pull Requests*:
+
+* At least two reviewers are required to review PRs (even for PRs tagged [`insubstantial`](https://github.com/openethereum/openethereum/pulls?q=is%3Aopen+is%3Apr+label%3A%22A2-insubstantial+%F0%9F%91%B6%22)).
+
+When doing a review, make sure to look for any:
+
+* Buggy behavior.
+* Undue maintenance burden.
+* Breaking with house coding style.
+* Pessimization (i.e. reduction of speed as measured in the projects benchmarks).
+* Breaking changes should be carefuly reviewed and tagged as such so they end up in the [changelog](../CHANGELOG.md).
+* Uselessness (i.e. it does not strictly add a feature or fix a known issue).
+
+## License.
+
+By contributing to Parity Ethereum, you agree that your contributions will be licensed under the [GPLv3 License](../LICENSE).
+
+Each contributor has to sign our Contributor License Agreement. The purpose of the CLA is to ensure that the guardian of a project's outputs has the necessary ownership or grants of rights over all contributions to allow them to distribute under the chosen license. You can read and sign our full Contributor License Agreement at [cla.parity.io](https://cla.parity.io) before submitting a pull request.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+For questions please use https://discord.io/openethereum, issues are for bugs and feature requests.
+
+_Before filing a new issue, please **provide the following information**._
+
+- **OpenEthereum version (>=3.1.0)**: 0.0.0
+- **Operating system**: Windows / MacOS / Linux
+- **Installation**: homebrew / one-line installer / built from source
+- **Fully synchronized**: no / yes
+- **Network**: ethereum / ropsten / kovan / ...
+- **Restarted**: no / yes
+
+_Your issue description goes here below. Try to include **actual** vs. **expected behavior** and **steps to reproduce** the issue._
+

.github/workflows/build-test-windows.yml

@@ -0,0 +1,33 @@
+name:                           Build and Test Suite on Windows
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+jobs:
+  build-tests:
+    name:                       Test and Build
+    strategy:
+      matrix:
+        platform:
+          - windows2019 # custom runner
+        toolchain:
+          - 1.52.1
+    runs-on:                    ${{ matrix.platform }}
+    steps:
+      - name:                   Checkout sources
+        uses:                   actions/checkout@main
+        with:
+          submodules:           true
+      - name:                   Install toolchain
+        uses:                   actions-rs/toolchain@v1
+        with:
+          toolchain:            ${{ matrix.toolchain }}
+          profile:              minimal
+          override:             true
+      - name:                   Build tests
+        uses:                   actions-rs/cargo@v1
+        with:
+          command:              test
+          args:                 --locked --all --release --features "json-tests" --verbose --no-run

.github/workflows/build-test.yml

@@ -0,0 +1,40 @@
+name:                           Build and Test Suite
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - dev
+jobs:
+  build-tests:
+    name:                       Test and Build
+    strategy:
+      matrix:
+        platform:
+          - ubuntu-16.04
+          - macos-latest
+        toolchain:
+          - 1.52.1
+    runs-on:                    ${{ matrix.platform }}
+    steps:
+      - name:                   Checkout sources
+        uses:                   actions/checkout@main
+        with:
+          submodules:           true
+      - name:                   Install toolchain
+        uses:                   actions-rs/toolchain@v1
+        with:
+          toolchain:            ${{ matrix.toolchain }}
+          profile:              minimal
+          override:             true
+      - name:                   Build tests
+        uses:                   actions-rs/cargo@v1
+        with:
+          command:              test
+          args:                 --locked --all --release --features "json-tests" --verbose --no-run
+      - name:                   Run tests for ${{ matrix.platform }}	
+        uses:                   actions-rs/cargo@v1	
+        with:	
+          command:              test	
+          args:                 --locked --all --release --features "json-tests" --verbose

.github/workflows/build.yml

@@ -0,0 +1,285 @@
+name:                           Build Release Suite
+
+on:
+  push:
+    tags:
+      - v*
+
+# Global vars
+env:
+  AWS_REGION:                   "us-east-1"
+  AWS_S3_ARTIFACTS_BUCKET:      "openethereum-releases"
+  ACTIONS_ALLOW_UNSECURE_COMMANDS: true
+
+jobs:
+  build:
+    name:                       Build Release
+    strategy:
+      matrix:
+        platform:
+          - ubuntu-16.04
+          - macos-latest
+        toolchain:
+          - 1.52.1
+    runs-on:                    ${{ matrix.platform }}
+    steps:
+      - name:                   Checkout sources
+        uses:                   actions/checkout@main
+      - name:                   Install toolchain
+        uses:                   actions-rs/toolchain@v1
+        with:
+          toolchain:            ${{ matrix.toolchain }}
+          profile:              minimal
+          override:             true
+
+      # ==============================
+      #       Windows Build
+      # ==============================
+
+      # - name:                   Install LLVM for Windows
+      #   if:                     matrix.platform == 'windows2019'
+      #   run:                    choco install llvm
+
+      # - name:                   Build OpenEthereum for Windows
+      #   if:                     matrix.platform == 'windows2019'
+      #   run:                    sh scripts/actions/build-windows.sh ${{matrix.platform}}
+
+      # - name:                   Upload Windows build
+      #   uses:                   actions/upload-artifact@v2
+      #   if:                     matrix.platform == 'windows2019'
+      #   with:
+      #     name:                 windows-artifacts
+      #     path:                 artifacts
+
+      # ==============================
+      #       Linux/Macos Build
+      # ==============================
+    
+      - name:                   Build OpenEthereum for ${{matrix.platform}}
+        if:                     matrix.platform != 'windows2019'
+        run:                    sh scripts/actions/build-linux.sh ${{matrix.platform}}
+
+      - name:                   Upload Linux build
+        uses:                   actions/upload-artifact@v2
+        if:                     matrix.platform == 'ubuntu-16.04'
+        with:
+          name:                 linux-artifacts
+          path:                 artifacts
+
+      - name:                   Upload MacOS build
+        uses:                   actions/upload-artifact@v2
+        if:                     matrix.platform == 'macos-latest'
+        with:
+          name:                 macos-artifacts
+          path:                 artifacts
+
+  zip-artifacts-creator:
+    name:                       Create zip artifacts
+    needs:                      build
+    runs-on:                    ubuntu-16.04
+    steps:
+      - name:                   Set env
+        run:                    echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+
+      # ==============================
+      #       Create ZIP files
+      # ==============================
+
+      # - name:                   Download Windows artifacts
+      #   uses:                   actions/download-artifact@v2
+      #   with:
+      #     name:                 windows-artifacts
+      #     path:                 windows-artifacts
+
+      - name:                   Download Linux artifacts
+        uses:                   actions/download-artifact@v2
+        with:
+          name:                 linux-artifacts
+          path:                 linux-artifacts
+
+      - name:                   Download MacOS artifacts
+        uses:                   actions/download-artifact@v2
+        with:
+          name:                 macos-artifacts
+          path:                 macos-artifacts
+
+      - name:                   Display structure of downloaded files
+        run:                    ls
+
+      - name:                   Create zip Linux
+        id:                     create_zip_linux
+        run: |
+          cd linux-artifacts/
+          zip -rT openethereum-linux-${{ env.RELEASE_VERSION }}.zip *
+          ls openethereum-linux-${{ env.RELEASE_VERSION }}.zip
+          cd ..
+          mv linux-artifacts/openethereum-linux-${{ env.RELEASE_VERSION }}.zip .
+
+          echo "Setting outputs..."
+          echo ::set-output name=LINUX_ARTIFACT::openethereum-linux-${{ env.RELEASE_VERSION }}.zip
+          echo ::set-output name=LINUX_SHASUM::$(shasum -a 256 openethereum-linux-${{ env.RELEASE_VERSION }}.zip | awk '{print $1}')
+
+      - name:                   Create zip MacOS
+        id:                     create_zip_macos
+        run: |
+          cd macos-artifacts/
+          zip -rT openethereum-macos-${{ env.RELEASE_VERSION }}.zip *
+          ls openethereum-macos-${{ env.RELEASE_VERSION }}.zip
+          cd ..
+          mv macos-artifacts/openethereum-macos-${{ env.RELEASE_VERSION }}.zip .
+
+          echo "Setting outputs..."
+          echo ::set-output name=MACOS_ARTIFACT::openethereum-macos-${{ env.RELEASE_VERSION }}.zip
+          echo ::set-output name=MACOS_SHASUM::$(shasum -a 256 openethereum-macos-${{ env.RELEASE_VERSION }}.zip | awk '{print $1}')
+
+      # - name:                   Create zip Windows
+      #   id:                     create_zip_windows
+      #   run: |
+      #     cd windows-artifacts/
+      #     zip -rT openethereum-windows-${{ env.RELEASE_VERSION }}.zip *
+      #     ls openethereum-windows-${{ env.RELEASE_VERSION }}.zip
+      #     cd ..
+      #     mv windows-artifacts/openethereum-windows-${{ env.RELEASE_VERSION }}.zip .
+
+      #     echo "Setting outputs..."
+      #     echo ::set-output name=WINDOWS_ARTIFACT::openethereum-windows-${{ env.RELEASE_VERSION }}.zip
+      #     echo ::set-output name=WINDOWS_SHASUM::$(shasum -a 256 openethereum-windows-${{ env.RELEASE_VERSION }}.zip | awk '{print $1}')
+
+      # =======================================================================
+      # Upload artifacts
+      # This is required to share artifacts between different jobs
+      # =======================================================================
+
+      - name:                   Upload artifacts
+        uses:                   actions/upload-artifact@v2
+        with:
+          name:                 openethereum-linux-${{ env.RELEASE_VERSION }}.zip
+          path:                 openethereum-linux-${{ env.RELEASE_VERSION }}.zip
+
+      - name:                   Upload artifacts
+        uses:                   actions/upload-artifact@v2
+        with:
+          name:                 openethereum-macos-${{ env.RELEASE_VERSION }}.zip
+          path:                 openethereum-macos-${{ env.RELEASE_VERSION }}.zip
+
+      # - name:                   Upload artifacts
+      #   uses:                   actions/upload-artifact@v2
+      #   with:
+      #     name:                 openethereum-windows-${{ env.RELEASE_VERSION }}.zip
+      #     path:                 openethereum-windows-${{ env.RELEASE_VERSION }}.zip
+
+      # =======================================================================
+      # Upload artifacts to S3
+      # This is required by some software distribution systems which require
+      # artifacts to be downloadable, like Brew on MacOS.
+      # =======================================================================
+      - name:                   Configure AWS credentials
+        uses:                   aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id:     ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region:            ${{ env.AWS_REGION }}
+
+      - name:                   Copy files to S3 with the AWS CLI
+        run: |
+          # Deploy zip artifacts to S3 bucket to a directory whose name is the tagged release version.
+          # Deploy macos binary artifact (if required, add more `aws s3 cp` commands to deploy specific OS versions)
+          aws s3 cp macos-artifacts/openethereum s3://${{ env.AWS_S3_ARTIFACTS_BUCKET }}/${{ env.RELEASE_VERSION }}/macos/ --region ${{ env.AWS_REGION }}
+
+    outputs:
+      linux-artifact:           ${{ steps.create_zip_linux.outputs.LINUX_ARTIFACT }}
+      linux-shasum:             ${{ steps.create_zip_linux.outputs.LINUX_SHASUM }}
+      macos-artifact:           ${{ steps.create_zip_macos.outputs.MACOS_ARTIFACT }}
+      macos-shasum:             ${{ steps.create_zip_macos.outputs.MACOS_SHASUM }}
+      # windows-artifact:         ${{ steps.create_zip_windows.outputs.WINDOWS_ARTIFACT }}
+      # windows-shasum:           ${{ steps.create_zip_windows.outputs.WINDOWS_SHASUM }}
+
+  draft-release:
+    name:                       Draft Release
+    needs:                      zip-artifacts-creator
+    runs-on:                    ubuntu-16.04
+    steps:
+      - name:                   Set env
+        run:                    echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+
+      # ==============================
+      #       Download artifacts
+      # ==============================
+
+      - name:                   Download artifacts
+        uses:                   actions/download-artifact@v2
+        with:
+          name:                 openethereum-linux-${{ env.RELEASE_VERSION }}.zip
+
+      - name:                   Download artifacts
+        uses:                   actions/download-artifact@v2
+        with:
+          name:                 openethereum-macos-${{ env.RELEASE_VERSION }}.zip
+
+      # - name:                   Download artifacts
+      #   uses:                   actions/download-artifact@v2
+      #   with:
+      #     name:                 openethereum-windows-${{ env.RELEASE_VERSION }}.zip
+
+      - name:                   Display structure of downloaded files
+        run:                    ls
+
+      # ==============================
+      #       Create release draft
+      # ==============================
+
+      - name:                   Create Release Draft
+        id:                     create_release_draft
+        uses:                   actions/create-release@v1
+        env:
+          GITHUB_TOKEN:         ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name:             ${{ github.ref }}
+          release_name:         OpenEthereum ${{ github.ref }}
+          body: |
+            This release contains <ADD_TEXT>
+
+            | System | Architecture | Binary | Sha256 Checksum |
+            |:---:|:---:|:---:|:---|
+            | <img src="https://gist.github.com/5chdn/1fce888fde1d773761f809b607757f76/raw/44c4f0fc63f1ea8e61a9513af5131ef65eaa6c75/apple.png" alt="Apple Icon by Pixel Perfect from https://www.flaticon.com/authors/pixel-perfect" style="width: 32px;"/> | x64 | [${{ needs.zip-artifacts-creator.outputs.macos-artifact }}](https://github.com/openethereum/openethereum/releases/download/${{ env.RELEASE_VERSION }}/${{ needs.zip-artifacts-creator.outputs.macos-artifact }}) | `${{ needs.zip-artifacts-creator.outputs.macos-shasum }}` |
+            | <img src="https://gist.github.com/5chdn/1fce888fde1d773761f809b607757f76/raw/44c4f0fc63f1ea8e61a9513af5131ef65eaa6c75/linux.png" alt="Linux Icon by Pixel Perfect from https://www.flaticon.com/authors/pixel-perfect" style="width: 32px;"/> | x64 | [${{ needs.zip-artifacts-creator.outputs.linux-artifact }}](https://github.com/openethereum/openethereum/releases/download/${{ env.RELEASE_VERSION }}/${{ needs.zip-artifacts-creator.outputs.linux-artifact }}) | `${{ needs.zip-artifacts-creator.outputs.linux-shasum }}` |
+            | <img src="https://gist.github.com/5chdn/1fce888fde1d773761f809b607757f76/raw/44c4f0fc63f1ea8e61a9513af5131ef65eaa6c75/windows.png" alt="Windows Icon by Pixel Perfect from https://www.flaticon.com/authors/pixel-perfect" style="width: 32px;"/> | x64 | [${{ needs.zip-artifacts-creator.outputs.windows-artifact }}](https://github.com/openethereum/openethereum/releases/download/${{ env.RELEASE_VERSION }}/${{ needs.zip-artifacts-creator.outputs.windows-artifact }}) | `${{ needs.zip-artifacts-creator.outputs.windows-shasum }}` |
+            | | | | |
+            | **System** | **Option** | - | **Resource** |
+            | <img src="https://gist.github.com/5chdn/1fce888fde1d773761f809b607757f76/raw/44c4f0fc63f1ea8e61a9513af5131ef65eaa6c75/settings.png" alt="Settings Icon by Pixel Perfect from https://www.flaticon.com/authors/pixel-perfect" style="width: 32px;"/> | Docker | - | [hub.docker.com/r/openethereum/openethereum](https://hub.docker.com/r/openethereum/openethereum) |
+
+          draft:                true
+          prerelease:           true
+
+      - name:                   Upload Release Asset - Linux
+        id:                     upload_release_asset_linux
+        uses:                   actions/upload-release-asset@v1.0.1
+        env:
+          GITHUB_TOKEN:         ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url:           ${{ steps.create_release_draft.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
+          asset_path:           ./openethereum-linux-${{ env.RELEASE_VERSION }}.zip
+          asset_name:           openethereum-linux-${{ env.RELEASE_VERSION }}.zip
+          asset_content_type:   application/zip
+
+      - name:                   Upload Release Asset - MacOS
+        id:                     upload_release_asset_macos
+        uses:                   actions/upload-release-asset@v1.0.1
+        env:
+          GITHUB_TOKEN:         ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url:           ${{ steps.create_release_draft.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
+          asset_path:           ./openethereum-macos-${{ env.RELEASE_VERSION }}.zip
+          asset_name:           openethereum-macos-${{ env.RELEASE_VERSION }}.zip
+          asset_content_type:   application/zip
+
+      # - name:                   Upload Release Asset - Windows
+      #   id:                     upload_release_asset_windows
+      #   uses:                   actions/upload-release-asset@v1
+      #   env:
+      #     GITHUB_TOKEN:         ${{ secrets.GITHUB_TOKEN }}
+      #   with:
+      #     upload_url:           ${{ steps.create_release_draft.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
+      #     asset_path:           ./openethereum-windows-${{ env.RELEASE_VERSION }}.zip
+      #     asset_name:           openethereum-windows-${{ env.RELEASE_VERSION }}.zip
+      #     asset_content_type:   application/zip

.github/workflows/check.yml

@@ -0,0 +1,50 @@
+name:                           Check
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - dev
+jobs:
+  check:
+    name:                       Check
+    runs-on:                    ubuntu-16.04
+    steps:
+      - name:                   Checkout sources
+        uses:                   actions/checkout@main
+        with:
+          submodules:           true
+      - name:                   Install 1.52.1 toolchain
+        uses:                   actions-rs/toolchain@v1
+        with:
+          toolchain:            1.52.1
+          profile:              minimal
+          override:             true
+      - name:                   Run cargo check 1/3
+        uses:                   actions-rs/cargo@v1
+        with:
+          command:              check
+          args:                 --locked --no-default-features --verbose
+      - name:                   Run cargo check 2/3
+        uses:                   actions-rs/cargo@v1
+        with:
+          command:              check
+          args:                 --locked --manifest-path crates/runtime/io/Cargo.toml --no-default-features --verbose
+      - name:                   Run cargo check 3/3
+        uses:                   actions-rs/cargo@v1
+        with:
+          command:              check
+          args:                 --locked --manifest-path crates/runtime/io/Cargo.toml --features "mio" --verbose
+      - name:                   Run cargo check evmbin
+        uses:                   actions-rs/cargo@v1
+        with:
+          command:              check
+          args:                 --locked -p evmbin --verbose
+      - name:                   Run cargo check benches
+        uses:                   actions-rs/cargo@v1
+        with:
+          command:              check
+          args:                 --locked --all --benches --verbose
+      - name:                   Run validate chainspecs
+        run:                    ./scripts/actions/validate-chainspecs.sh

.github/workflows/deploy-docker-nightly.yml

@@ -0,0 +1,29 @@
+name:                           Docker Image Nightly Release
+
+# Run "nightly" build on each commit to "dev" branch.
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  deploy-docker:
+    name:                       Build Release
+    runs-on:                    ubuntu-latest
+    steps:
+      - name:                   Checkout sources
+        uses:                   actions/checkout@master
+      - name:                   Install toolchain
+        uses:                   actions-rs/toolchain@v1
+        with:
+          toolchain:            1.52.1
+          profile:              minimal
+          override:             true
+      - name:                   Deploy to docker hub
+        uses: elgohr/Publish-Docker-Github-Action@master
+        with:
+          name: openethereum/openethereum
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          dockerfile: scripts/docker/alpine/Dockerfile
+          tags: "nightly"

.github/workflows/deploy-docker-tag.yml

@@ -0,0 +1,30 @@
+name:                           Docker Image Tag and Latest Release
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  deploy-docker:
+    name:                       Build Release
+    runs-on:                    ubuntu-latest
+    steps:
+      - name:                   Checkout sources
+        uses:                   actions/checkout@master
+      - name:                   Set env
+        run:                    echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+      - name:                   Install toolchain
+        uses:                   actions-rs/toolchain@v1
+        with:
+          toolchain:            1.52.1
+          profile:              minimal
+          override:             true
+      - name:                   Deploy to docker hub
+        uses: elgohr/Publish-Docker-Github-Action@master
+        with:
+          name: openethereum/openethereum
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          dockerfile: scripts/docker/alpine/Dockerfile
+          tags: "latest,${{ env.RELEASE_VERSION }}"

.github/workflows/deploy-docker.yml

@@ -0,0 +1,30 @@
+name:                           Docker Image Release
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+
+jobs:
+  deploy-docker:
+    name:                       Build Release
+    runs-on:                    ubuntu-latest
+    steps:
+      - name:                   Checkout sources
+        uses:                   actions/checkout@master
+      - name:                   Install toolchain
+        uses:                   actions-rs/toolchain@v1
+        with:
+          toolchain:            1.52.1
+          profile:              minimal
+          override:             true
+      - name:                   Deploy to docker hub
+        uses: elgohr/Publish-Docker-Github-Action@master
+        with:
+          name: openethereum/openethereum
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+          dockerfile: scripts/docker/alpine/Dockerfile
+          tag_names: true

.github/workflows/fmt.yml

@@ -0,0 +1,20 @@
+on: [push, pull_request]
+
+name: rustfmt
+
+jobs:
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: 1.52.1
+          override: true
+      - run: rustup component add rustfmt
+      - uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check --config merge_imports=true

.gitignore

@@ -15,10 +15,18 @@
 
 # vim stuff
 *.swp
+*.swo
 
 # mac stuff
 .DS_Store
 
+# npm stuff
+npm-debug.log
+node_modules
+
+# js build artifacts
+.git-release.log
+
 # gdb files
 .gdb_history
 
@@ -32,5 +40,8 @@
 out/
 
 .vscode
-
+rls/
 /parity.*
+
+# cargo remote artifacts
+remote-target

.gitlab-ci.yml

@@ -1,541 +0,0 @@
-stages:
-  - test
-  - js-build
-  - push-release
-  - build
-variables:
-  GIT_DEPTH: "3"
-  SIMPLECOV: "true"
-  RUST_BACKTRACE: "1"
-  RUSTFLAGS: ""
-  CARGOFLAGS: ""
-cache:
-  key: "$CI_BUILD_STAGE/$CI_BUILD_REF_NAME"
-  untracked: true
-linux-stable:
-  stage: build
-  image: ethcore/rust:stable
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - cargo build -j $(nproc) --release --features final $CARGOFLAGS
-    - strip target/release/parity
-    - export SHA3=$(target/release/parity tools hash target/release/parity)
-    - md5sum target/release/parity > parity.md5
-    - sh scripts/deb-build.sh amd64
-    - cp target/release/parity deb/usr/bin/parity
-    - export VER=$(grep -m 1 version Cargo.toml | awk '{print $3}' | tr -d '"' | tr -d "\n")
-    - dpkg-deb -b deb "parity_"$VER"_amd64.deb"
-    - md5sum "parity_"$VER"_amd64.deb" > "parity_"$VER"_amd64.deb.md5"
-    - aws configure set aws_access_key_id $s3_key
-    - aws configure set aws_secret_access_key $s3_secret
-    - if [[ $CI_BUILD_REF_NAME =~ ^(master|beta|stable)$ ]]; then export S3_BUCKET=builds-parity-published; else export S3_BUCKET=builds-parity; fi
-    - aws s3 rm --recursive s3://$S3_BUCKET/$CI_BUILD_REF_NAME/x86_64-unknown-linux-gnu
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/x86_64-unknown-linux-gnu/parity --body target/release/parity
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/x86_64-unknown-linux-gnu/parity.md5 --body parity.md5
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/x86_64-unknown-linux-gnu/"parity_"$VER"_amd64.deb" --body "parity_"$VER"_amd64.deb"
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/x86_64-unknown-linux-gnu/"parity_"$VER"_amd64.deb.md5" --body "parity_"$VER"_amd64.deb.md5"
-#    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1337/push-build/$CI_BUILD_REF_NAME/x86_64-unknown-linux-gnu
-    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1338/push-build/$CI_BUILD_REF_NAME/x86_64-unknown-linux-gnu
-  tags:
-    - rust
-    - rust-stable
-  artifacts:
-    paths:
-    - target/release/parity
-    name: "stable-x86_64-unknown-linux-gnu_parity"
-linux-beta:
-  stage: build
-  image: ethcore/rust:beta
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - cargo build -j $(nproc) --release $CARGOFLAGS
-    - strip target/release/parity
-  tags:
-    - rust
-    - rust-beta
-  artifacts:
-    paths:
-    - target/release/parity
-    name: "beta-x86_64-unknown-linux-gnu_parity"
-  allow_failure: true
-linux-nightly:
-  stage: build
-  image: ethcore/rust:nightly
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - cargo build -j $(nproc) --release $CARGOFLAGS
-    - strip target/release/parity
-  tags:
-    - rust
-    - rust-nightly
-  artifacts:
-    paths:
-    - target/release/parity
-    name: "nigthly-x86_64-unknown-linux-gnu_parity"
-  allow_failure: true
-linux-centos:
-  stage: build
-  image: ethcore/rust-centos:latest
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - export CXX="g++"
-    - export CC="gcc"
-    - export PLATFORM=x86_64-unknown-centos-gnu
-    - cargo build -j $(nproc) --release --features final $CARGOFLAGS
-    - strip target/release/parity
-    - md5sum target/release/parity > parity.md5
-    - export SHA3=$(target/release/parity tools hash target/release/parity)
-    - aws configure set aws_access_key_id $s3_key
-    - aws configure set aws_secret_access_key $s3_secret
-    - if [[ $CI_BUILD_REF_NAME =~ ^(master|beta|stable)$ ]]; then export S3_BUCKET=builds-parity-published; else export S3_BUCKET=builds-parity; fi
-    - aws s3 rm --recursive s3://$S3_BUCKET/$CI_BUILD_REF_NAME/x86_64-unknown-centos-gnu
-    - aws s3api put-object --bucket builds-parity --key $CI_BUILD_REF_NAME/x86_64-unknown-centos-gnu/parity --body target/release/parity
-    - aws s3api put-object --bucket builds-parity --key $CI_BUILD_REF_NAME/x86_64-unknown-centos-gnu/parity.md5 --body parity.md5
-#    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1337/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1338/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-  tags:
-    - rust
-    - rust-centos
-  artifacts:
-    paths:
-    - target/release/parity
-    name: "x86_64-unknown-centos-gnu_parity"
-linux-i686:
-  stage: build
-  image: ethcore/rust-i686:latest
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - export HOST_CC=gcc
-    - export HOST_CXX=g++
-    - export COMMIT=$(git rev-parse HEAD)
-    - export PLATFORM=i686-unknown-linux-gnu
-    - cargo build -j $(nproc) --target i686-unknown-linux-gnu --features final --release $CARGOFLAGS
-    - strip target/$PLATFORM/release/parity
-    - md5sum target/$PLATFORM/release/parity > parity.md5
-    - export SHA3=$(target/$PLATFORM/release/parity tools hash target/$PLATFORM/release/parity)
-    - sh scripts/deb-build.sh i386
-    - cp target/$PLATFORM/release/parity deb/usr/bin/parity
-    - export VER=$(grep -m 1 version Cargo.toml | awk '{print $3}' | tr -d '"' | tr -d "\n")
-    - dpkg-deb -b deb "parity_"$VER"_i386.deb"
-    - md5sum "parity_"$VER"_i386.deb" > "parity_"$VER"_i386.deb.md5"
-    - aws configure set aws_access_key_id $s3_key
-    - aws configure set aws_secret_access_key $s3_secret
-    - if [[ $CI_BUILD_REF_NAME =~ ^(master|beta|stable)$ ]]; then export S3_BUCKET=builds-parity-published; else export S3_BUCKET=builds-parity; fi
-    - aws s3 rm --recursive s3://$S3_BUCKET/$CI_BUILD_REF_NAME/$PLATFORM
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity --body target/$PLATFORM/release/parity
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity.md5 --body parity.md5
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity_"$VER"_i386.deb" --body "parity_"$VER"_i386.deb"
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity_"$VER"_i386.deb.md5" --body "parity_"$VER"_i386.deb.md5"
-#    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1337/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1338/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-  tags:
-    - rust
-    - rust-i686
-  artifacts:
-    paths:
-      - target/i686-unknown-linux-gnu/release/parity
-    name: "i686-unknown-linux-gnu"
-  allow_failure: true
-linux-armv7:
-  stage: build
-  image: ethcore/rust-armv7:latest
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - export CC=arm-linux-gnueabihf-gcc
-    - export CXX=arm-linux-gnueabihf-g++
-    - export HOST_CC=gcc
-    - export HOST_CXX=g++
-    - export PLATFORM=armv7-unknown-linux-gnueabihf
-    - rm -rf .cargo
-    - mkdir -p .cargo
-    - echo "[target.$PLATFORM]" >> .cargo/config
-    - echo "linker= \"arm-linux-gnueabihf-gcc\"" >> .cargo/config
-    - cat .cargo/config
-    - cargo build -j $(nproc) --target $PLATFORM --features final --release $CARGOFLAGS
-    - arm-linux-gnueabihf-strip target/$PLATFORM/release/parity
-    - export SHA3=$(rhash --sha3-256 ~/Core/parity/target/release/parity -p %h)
-    - md5sum target/$PLATFORM/release/parity > parity.md5
-    - sh scripts/deb-build.sh armhf
-    - cp target/$PLATFORM/release/parity deb/usr/bin/parity
-    - export VER=$(grep -m 1 version Cargo.toml | awk '{print $3}' | tr -d '"' | tr -d "\n")
-    - dpkg-deb -b deb "parity_"$VER"_armhf.deb"
-    - md5sum "parity_"$VER"_armhf.deb" > "parity_"$VER"_armhf.deb.md5"
-    - aws configure set aws_access_key_id $s3_key
-    - aws configure set aws_secret_access_key $s3_secret
-    - if [[ $CI_BUILD_REF_NAME =~ ^(master|beta|stable)$ ]]; then export S3_BUCKET=builds-parity-published; else export S3_BUCKET=builds-parity; fi
-    - aws s3 rm --recursive s3://$S3_BUCKET/$CI_BUILD_REF_NAME/$PLATFORM
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity --body target/$PLATFORM/release/parity
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity.md5 --body parity.md5
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity_"$VER"_armhf.deb" --body "parity_"$VER"_armhf.deb"
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity_"$VER"_armhf.deb.md5" --body "parity_"$VER"_armhf.deb.md5"
-#    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1337/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1338/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-  tags:
-    - rust
-    - rust-arm
-  artifacts:
-    paths:
-    - target/armv7-unknown-linux-gnueabihf/release/parity
-    name: "armv7_unknown_linux_gnueabihf_parity"
-  allow_failure: true
-linux-arm:
-  stage: build
-  image: ethcore/rust-arm:latest
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - export CC=arm-linux-gnueabihf-gcc
-    - export CXX=arm-linux-gnueabihf-g++
-    - export HOST_CC=gcc
-    - export HOST_CXX=g++
-    - export PLATFORM=arm-unknown-linux-gnueabihf
-    - rm -rf .cargo
-    - mkdir -p .cargo
-    - echo "[target.$PLATFORM]" >> .cargo/config
-    - echo "linker= \"arm-linux-gnueabihf-gcc\"" >> .cargo/config
-    - cat .cargo/config
-    - cargo build -j $(nproc) --target $PLATFORM --features final --release $CARGOFLAGS
-    - arm-linux-gnueabihf-strip target/$PLATFORM/release/parity
-    - export SHA3=$(rhash --sha3-256 ~/Core/parity/target/release/parity -p %h)
-    - md5sum target/$PLATFORM/release/parity > parity.md5
-    - sh scripts/deb-build.sh armhf
-    - cp target/$PLATFORM/release/parity deb/usr/bin/parity
-    - export VER=$(grep -m 1 version Cargo.toml | awk '{print $3}' | tr -d '"' | tr -d "\n")
-    - dpkg-deb -b deb "parity_"$VER"_armhf.deb"
-    - md5sum "parity_"$VER"_armhf.deb" > "parity_"$VER"_armhf.deb.md5"
-    - aws configure set aws_access_key_id $s3_key
-    - aws configure set aws_secret_access_key $s3_secret
-    - if [[ $CI_BUILD_REF_NAME =~ ^(master|beta|stable)$ ]]; then export S3_BUCKET=builds-parity-published; else export S3_BUCKET=builds-parity; fi
-    - aws s3 rm --recursive s3://$S3_BUCKET/$CI_BUILD_REF_NAME/$PLATFORM
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity --body target/$PLATFORM/release/parity
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity.md5 --body parity.md5
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity_"$VER"_armhf.deb" --body "parity_"$VER"_armhf.deb"
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity_"$VER"_armhf.deb.md5" --body "parity_"$VER"_armhf.deb.md5"
-    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://icarus.parity.io:1337/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1338/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-  tags:
-    - rust
-    - rust-arm
-  artifacts:
-    paths:
-    - target/arm-unknown-linux-gnueabihf/release/parity
-    name: "arm-unknown-linux-gnueabihf_parity"
-  allow_failure: true
-linux-armv6:
-  stage: build
-  image: ethcore/rust-armv6:latest
-  only:
-    - beta
-#    - tags
-#    - stable
-#    - triggers
-  script:
-    - export CC=arm-linux-gnueabi-gcc
-    - export CXX=arm-linux-gnueabi-g++
-    - export HOST_CC=gcc
-    - export HOST_CXX=g++
-    - export PLATFORM=arm-unknown-linux-gnueabi
-    - rm -rf .cargo
-    - mkdir -p .cargo
-    - echo "[target.$PLATFORM]" >> .cargo/config
-    - echo "linker= \"arm-linux-gnueabi-gcc\"" >> .cargo/config
-    - cat .cargo/config
-    - cargo build -j $(nproc) --target $PLATFORM --features final --release $CARGOFLAGS
-    - arm-linux-gnueabi-strip target/$PLATFORM/release/parity
-    - export SHA3=$(rhash --sha3-256 ~/Core/parity/target/release/parity -p %h)
-    - md5sum target/$PLATFORM/release/parity > parity.md5
-    - aws configure set aws_access_key_id $s3_key
-    - aws configure set aws_secret_access_key $s3_secret
-    - if [[ $CI_BUILD_REF_NAME =~ ^(master|beta|stable)$ ]]; then export S3_BUCKET=builds-parity-published; else export S3_BUCKET=builds-parity; fi
-    - aws s3 rm --recursive s3://$S3_BUCKET/$CI_BUILD_REF_NAME/$PLATFORM
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity --body target/$PLATFORM/release/parity
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity.md5 --body parity.md5
-#    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1337/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1338/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-  tags:
-    - rust
-    - rust-arm
-  artifacts:
-    paths:
-    - target/arm-unknown-linux-gnueabi/release/parity
-    name: "arm-unknown-linux-gnueabi_parity"
-  allow_failure: true
-linux-aarch64:
-  stage: build
-  image: ethcore/rust-aarch64:latest
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - export CC=aarch64-linux-gnu-gcc
-    - export CXX=aarch64-linux-gnu-g++
-    - export HOST_CC=gcc
-    - export HOST_CXX=g++
-    - export PLATFORM=aarch64-unknown-linux-gnu
-    - rm -rf .cargo
-    - mkdir -p .cargo
-    - echo "[target.$PLATFORM]" >> .cargo/config
-    - echo "linker= \"aarch64-linux-gnu-gcc\"" >> .cargo/config
-    - cat .cargo/config
-    - cargo build -j $(nproc) --target $PLATFORM --features final --release $CARGOFLAGS
-    - aarch64-linux-gnu-strip target/$PLATFORM/release/parity
-    - export SHA3=$(rhash --sha3-256 ~/Core/parity/target/release/parity -p %h)
-    - md5sum target/$PLATFORM/release/parity > parity.md5
-    - sh scripts/deb-build.sh arm64
-    - cp target/$PLATFORM/release/parity deb/usr/bin/parity
-    - export VER=$(grep -m 1 version Cargo.toml | awk '{print $3}' | tr -d '"' | tr -d "\n")
-    - dpkg-deb -b deb "parity_"$VER"_arm64.deb"
-    - md5sum "parity_"$VER"_arm64.deb" > "parity_"$VER"_arm64.deb.md5"
-    - aws configure set aws_access_key_id $s3_key
-    - aws configure set aws_secret_access_key $s3_secret
-    - if [[ $CI_BUILD_REF_NAME =~ ^(master|beta|stable)$ ]]; then export S3_BUCKET=builds-parity-published; else export S3_BUCKET=builds-parity; fi
-    - aws s3 rm --recursive s3://$S3_BUCKET/$CI_BUILD_REF_NAME/$PLATFORM
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity.md5 --body parity.md5
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity_"$VER"_arm64.deb" --body "parity_"$VER"_arm64.deb"
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity_"$VER"_arm64.deb.md5" --body "parity_"$VER"_arm64.deb.md5"
-#    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1337/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1338/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-  tags:
-    - rust
-    - rust-arm
-  artifacts:
-    paths:
-    - target/aarch64-unknown-linux-gnu/release/parity
-    name: "aarch64-unknown-linux-gnu_parity"
-  allow_failure: true
-darwin:
-  stage: build
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - export COMMIT=$(git rev-parse HEAD)
-    - export PLATFORM=x86_64-apple-darwin
-    - cargo build -j 8 --features final --release #$CARGOFLAGS
-    - cargo build -j 8 --features final --release -p ethstore #$CARGOFLAGS
-    - rm -rf parity.md5
-    - md5sum target/release/parity > parity.md5
-    - export SHA3=$(target/release/parity tools hash target/release/parity)
-    - packagesbuild -v mac/Parity.pkgproj
-    - export VER=$(grep -m 1 version Cargo.toml | awk '{print $3}' | tr -d '"' | tr -d "\n")
-    - mv target/release/Parity\ Ethereum.pkg "parity-"$VER"-osx-installer-EXPERIMENTAL.pkg"
-    - md5sum "parity-"$VER"-osx-installer-EXPERIMENTAL.pkg" >> "parity-"$VER"-osx-installer-EXPERIMENTAL.pkg.md5"
-    - aws configure set aws_access_key_id $s3_key
-    - aws configure set aws_secret_access_key $s3_secret
-    - if [[ $CI_BUILD_REF_NAME =~ ^(master|beta|stable)$ ]]; then export S3_BUCKET=builds-parity-published; else export S3_BUCKET=builds-parity; fi
-    - aws s3 rm --recursive s3://$S3_BUCKET/$CI_BUILD_REF_NAME/$PLATFORM
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity --body target/release/parity
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/parity.md5 --body parity.md5
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity-"$VER"-osx-installer-EXPERIMENTAL.pkg" --body "parity-"$VER"-osx-installer-EXPERIMENTAL.pkg"
-    - aws s3api put-object --bucket $S3_BUCKET --key $CI_BUILD_REF_NAME/$PLATFORM/"parity-"$VER"-osx-installer-EXPERIMENTAL.pkg.md5" --body "parity-"$VER"-osx-installer-EXPERIMENTAL.pkg.md5"
-#    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1337/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-    - curl --data "commit=$CI_BUILD_REF&sha3=$SHA3&filename=parity&secret=$RELEASES_SECRET" http://update.parity.io:1338/push-build/$CI_BUILD_REF_NAME/$PLATFORM
-  tags:
-    - osx
-  artifacts:
-    paths:
-    - target/release/parity
-    name: "x86_64-apple-darwin_parity"
-windows:
-  cache:
-    key: "%CI_BUILD_STAGE%/%CI_BUILD_REF_NAME%"
-    untracked: true
-  stage: build
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  script:
-    - set PLATFORM=x86_64-pc-windows-msvc
-    - set INCLUDE=C:\Program Files (x86)\Microsoft SDKs\Windows\v7.1A\Include;C:\vs2015\VC\include;C:\Program Files (x86)\Windows Kits\10\Include\10.0.10240.0\ucrt
-    - set LIB=C:\vs2015\VC\lib;C:\Program Files (x86)\Windows Kits\10\Lib\10.0.10240.0\ucrt\x64
-    - set RUST_BACKTRACE=1
-    - set RUSTFLAGS=%RUSTFLAGS%
-    - rustup default stable-x86_64-pc-windows-msvc
-    - cargo build --features final --release #%CARGOFLAGS%
-    - signtool sign /f %keyfile% /p %certpass% target\release\parity.exe
-    - target\release\parity.exe tools hash target\release\parity.exe > parity.sha3
-    - set /P SHA3=<parity.sha3
-    - curl -sL --url "https://github.com/ethcore/win-build/raw/master/SimpleFC.dll" -o nsis\SimpleFC.dll
-    - curl -sL --url "https://github.com/ethcore/win-build/raw/master/vc_redist.x64.exe" -o nsis\vc_redist.x64.exe
-    - msbuild windows\ptray\ptray.vcxproj /p:Platform=x64 /p:Configuration=Release
-    - signtool sign /f %keyfile% /p %certpass% windows\ptray\x64\release\ptray.exe
-    - cd nsis
-    - makensis.exe installer.nsi
-    - copy installer.exe InstallParity.exe
-    - signtool sign /f %keyfile% /p %certpass% InstallParity.exe
-    - md5sums InstallParity.exe > InstallParity.exe.md5
-    - zip win-installer.zip InstallParity.exe InstallParity.exe.md5
-    - md5sums win-installer.zip > win-installer.zip.md5
-    - cd ..\target\release\
-    - md5sums parity.exe parity.pdb > parity.md5
-    - md5sums parity.exe > parity.exe.md5
-    - zip parity.zip parity.exe parity.pdb parity.md5
-    - md5sums parity.zip > parity.zip.md5
-    - cd ..\..
-    - aws configure set aws_access_key_id %s3_key%
-    - aws configure set aws_secret_access_key %s3_secret%
-    - echo %CI_BUILD_REF_NAME%
-    - echo %CI_BUILD_REF_NAME% | findstr /R "master" >nul 2>&1 && set S3_BUCKET=builds-parity-published || set S3_BUCKET=builds-parity
-    - echo %CI_BUILD_REF_NAME% | findstr /R "beta" >nul 2>&1 && set S3_BUCKET=builds-parity-published || set S3_BUCKET=builds-parity
-    - echo %CI_BUILD_REF_NAME% | findstr /R "stable" >nul 2>&1 && set S3_BUCKET=builds-parity-published || set S3_BUCKET=builds-parity
-    - echo %S3_BUCKET%
-    - aws s3 rm --recursive s3://%S3_BUCKET%/%CI_BUILD_REF_NAME%/x86_64-pc-windows-msvc
-    - aws s3api put-object --bucket %S3_BUCKET% --key %CI_BUILD_REF_NAME%/x86_64-pc-windows-msvc/parity.exe --body target\release\parity.exe
-    - aws s3api put-object --bucket %S3_BUCKET% --key %CI_BUILD_REF_NAME%/x86_64-pc-windows-msvc/parity.exe.md5 --body target\release\parity.exe.md5
-    - aws s3api put-object --bucket %S3_BUCKET% --key %CI_BUILD_REF_NAME%/x86_64-pc-windows-msvc/parity.zip --body target\release\parity.zip
-    - aws s3api put-object --bucket %S3_BUCKET% --key %CI_BUILD_REF_NAME%/x86_64-pc-windows-msvc/parity.zip.md5 --body target\release\parity.zip.md5
-    - aws s3api put-object --bucket %S3_BUCKET% --key %CI_BUILD_REF_NAME%/x86_64-pc-windows-msvc/InstallParity.exe --body nsis\InstallParity.exe
-    - aws s3api put-object --bucket %S3_BUCKET% --key %CI_BUILD_REF_NAME%/x86_64-pc-windows-msvc/InstallParity.exe.md5 --body nsis\InstallParity.exe.md5
-    - aws s3api put-object --bucket %S3_BUCKET% --key %CI_BUILD_REF_NAME%/x86_64-pc-windows-msvc/win-installer.zip --body nsis\win-installer.zip
-    - aws s3api put-object --bucket %S3_BUCKET% --key %CI_BUILD_REF_NAME%/x86_64-pc-windows-msvc/win-installer.zip.md5 --body nsis\win-installer.zip.md5
-#    - curl --data "commit=%CI_BUILD_REF%&sha3=%SHA3%&filename=parity.exe&secret=%RELEASES_SECRET%" http://update.parity.io:1337/push-build/%CI_BUILD_REF_NAME%/%PLATFORM%
-    - curl --data "commit=%CI_BUILD_REF%&sha3=%SHA3%&filename=parity.exe&secret=%RELEASES_SECRET%" http://update.parity.io:1338/push-build/%CI_BUILD_REF_NAME%/%PLATFORM%
-  tags:
-   - rust-windows
-  artifacts:
-    paths:
-    - target/release/parity.exe
-    - target/release/parity.pdb
-    - nsis/InstallParity.exe
-    name: "x86_64-pc-windows-msvc_parity"
-test-darwin:
-  stage: test
-  only:
-    - triggers
-  before_script:
-    - git submodule update --init --recursive
-    - export RUST_FILES_MODIFIED=$(git --no-pager diff --name-only $CI_BUILD_REF^ $CI_BUILD_REF | grep -v -e ^js -e ^\\. -e ^LICENSE -e ^README.md -e ^appveyor.yml -e ^test.sh -e ^windows/ -e ^scripts/ -e^mac/ -e ^nsis/ | wc -l)
-  script:
-    - export RUST_BACKTRACE=1
-    - if [ $RUST_FILES_MODIFIED -eq 0 ]; then echo "Skipping Rust tests since no Rust files modified."; else ./test.sh $CARGOFLAGS; fi
-  tags:
-    - osx
-  allow_failure: true
-test-windows:
-  stage: test
-  only:
-    - triggers
-  before_script:
-    - git submodule update --init --recursive
-  script:
-    - set RUST_BACKTRACE=1
-    - echo cargo test --features json-tests -p rlp -p ethash -p ethcore -p ethcore-bigint -p ethcore-dapps -p ethcore-rpc -p ethcore-signer -p ethcore-util -p ethcore-network -p ethcore-io -p ethkey -p ethstore -p ethsync -p ethcore-ipc -p ethcore-ipc-tests -p ethcore-ipc-nano -p parity %CARGOFLAGS% --verbose --release
-  tags:
-    - rust-windows
-  allow_failure: true
-test-rust-stable:
-  stage: test
-  image: ethcore/rust:stable
-  before_script:
-    - git submodule update --init --recursive
-    - export RUST_FILES_MODIFIED=$(git --no-pager diff --name-only $CI_BUILD_REF^ $CI_BUILD_REF | grep -v -e ^js -e ^\\. -e ^LICENSE -e ^README.md -e ^appveyor.yml -e ^test.sh -e ^windows/ -e ^scripts/ -e^mac/ -e ^nsis/ | wc -l)
-  script:
-    - export RUST_BACKTRACE=1
-    - if [ $RUST_FILES_MODIFIED -eq 0 ]; then echo "Skipping Rust tests since no Rust files modified."; else ./test.sh $CARGOFLAGS; fi
-  tags:
-    - rust
-    - rust-stable
-js-test:
-  stage: test
-  image: ethcore/rust:stable
-  before_script:
-    - git submodule update --init --recursive
-    - export JS_FILES_MODIFIED=$(git --no-pager diff --name-only $CI_BUILD_REF^ $CI_BUILD_REF | grep ^js/ | wc -l)
-    - if [ $JS_FILES_MODIFIED -eq 0 ]; then echo "Skipping JS deps install since no JS files modified."; else ./js/scripts/install-deps.sh;fi
-  script:
-    - if [ $JS_FILES_MODIFIED -eq 0 ]; then echo "Skipping JS lint since no JS files modified."; else ./js/scripts/lint.sh && ./js/scripts/test.sh && ./js/scripts/build.sh; fi
-  tags:
-    - rust
-    - rust-stable
-test-rust-beta:
-  stage: test
-  only:
-    - triggers
-  image: ethcore/rust:beta
-  before_script:
-    - git submodule update --init --recursive
-    - export RUST_FILES_MODIFIED=$(git --no-pager diff --name-only $CI_BUILD_REF^ $CI_BUILD_REF | grep -v -e ^js -e ^\\. -e ^LICENSE -e ^README.md -e ^appveyor.yml -e ^test.sh -e ^windows/ -e ^scripts/ -e^mac/ -e ^nsis/ | wc -l)
-  script:
-    - export RUST_BACKTRACE=1
-    - if [ $RUST_FILES_MODIFIED -eq 0 ]; then echo "Skipping Rust tests since no Rust files modified."; else ./test.sh $CARGOFLAGS; fi
-  tags:
-    - rust
-    - rust-beta
-  allow_failure: true
-test-rust-nightly:
-  stage: test
-  only:
-    - triggers
-  image: ethcore/rust:nightly
-  before_script:
-    - git submodule update --init --recursive
-    - export RUST_FILES_MODIFIED=$(git --no-pager diff --name-only $CI_BUILD_REF^ $CI_BUILD_REF | grep -v -e ^js -e ^\\. -e ^LICENSE -e ^README.md -e ^appveyor.yml -e ^test.sh -e ^windows/ -e ^scripts/ -e^mac/ -e ^nsis/ | wc -l)
-  script:
-    - export RUST_BACKTRACE=1
-    - if [ $RUST_FILES_MODIFIED -eq 0 ]; then echo "Skipping Rust tests since no Rust files modified."; else ./test.sh $CARGOFLAGS; fi
-  tags:
-    - rust
-    - rust-nightly
-  allow_failure: true
-js-release:
-  stage: js-build
-  only:
-    - master
-    - beta
-    - stable
-  image: ethcore/rust:stable
-  before_script:
-    - export JS_FILES_MODIFIED=$(git --no-pager diff --name-only $CI_BUILD_REF^ $CI_BUILD_REF | grep ^js/ | wc -l)
-    - echo $JS_FILES_MODIFIED
-    - if [ $JS_FILES_MODIFIED -eq 0  ]; then echo "Skipping JS deps install since no JS files modified."; else ./js/scripts/install-deps.sh;fi
-  script:
-    - echo $JS_FILES_MODIFIED
-    - if [ $JS_FILES_MODIFIED -eq 0 ]; then echo "Skipping JS rebuild since no JS files modified."; else ./js/scripts/build.sh && ./js/scripts/release.sh; fi
-  tags:
-    - javascript
-push-release:
-  stage: push-release
-  only:
-    - beta
-    - tags
-    - stable
-    - triggers
-  image: ethcore/rust:stable
-  script:
-#    - curl --data "secret=$RELEASES_SECRET" http://update.parity.io:1337/push-release/$CI_BUILD_REF_NAME/$CI_BUILD_REF
-    - curl --data "secret=$RELEASES_SECRET" http://update.parity.io:1338/push-release/$CI_BUILD_REF_NAME/$CI_BUILD_REF
-  tags:
-    - curl

.gitmodules

@@ -1,4 +1,3 @@
-[submodule "ethcore/res/ethereum/tests"]
-	path = ethcore/res/ethereum/tests
+[submodule "crates/ethcore/res/json_tests"]
+	path = crates/ethcore/res/json_tests
 	url = https://github.com/ethereum/tests.git
-	branch = develop

.travis.yml

@@ -1,85 +0,0 @@
-sudo: required
-dist: trusty
-language: rust
-
-branches:
-  only:
-  - master
-  - /^beta-.*$/
-  - /^stable-.*$/
-  - /^beta$/
-  - /^stable$/
-
-git:
-  depth: 3
-
-matrix:
-  include:
-  - rust: stable
-    env: RUN_TESTS="true" TEST_OPTIONS=""
-  - rust: stable
-    env: RUN_COVERAGE="true"
-  - rust: stable
-    env: RUN_DOCS="true"
-
-env:
-  global:
-  - CXX="g++-4.8"
-  - CC="gcc-4.8"
-  - RUST_BACKTRACE="1"
-  - RUN_TESTS="false"
-  - RUN_COVERAGE="false"
-  - RUN_DOCS="false"
-  - TEST_OPTIONS=""
-  - RUSTFLAGS="-D warnings"
-  - TRAVIS_NODE_VERSION="6"
-  # GH_TOKEN for documentation
-  - secure: bumJASbZSU8bxJ0EyPUJmu16AiV9EXOpyOj86Jlq/Ty9CfwGqsSXt96uDyE+OUJf34RUFQMsw0nk37/zC4lcn6kqk2wpuH3N/o85Zo/cVZY/NusBWLQqtT5VbYWsV+u2Ua4Tmmsw8yVYQhYwU2ZOejNpflL+Cs9XGgORp1L+/gMRMC2y5Se6ZhwnKPQlRJ8LGsG1dzjQULxzADIt3/zuspNBS8a2urJwlHfGMkvHDoUWCviP/GXoSqw3TZR7FmKyxE19I8n9+iSvm9+oZZquvcgfUxMHn8Gq/b44UbPvjtFOg2yam4xdWXF/RyWCHdc/R9EHorSABeCbefIsm+zcUF3/YQxwpSxM4IZEeH2rTiC7dcrsKw3XsO16xFQz5YI5Bay+CT/wTdMmJd7DdYz7Dyf+pOvcM9WOf/zorxYWSBOMYy0uzbusU2iyIghQ82s7E/Ahg+WARtPgkuTLSB5aL1oCTBKHqQscMr7lo5Ti6RpWLxEdTQMBznc+bMr+6dEtkEcG9zqc6cE9XX+ox3wTU6+HVMfQ1ltCntJ4UKcw3A6INEbw9wgocQa812CIASQ2fE+SCAbz6JxBjIAlFUnD1lUB7S8PdMPwn9plfQgKQ2A5YZqg6FnBdf0rQXIJYxQWKHXj/rBHSUCT0tHACDlzTA+EwWggvkP5AGIxRxm8jhw=
-  - KCOV_CMD="./kcov-master/tmp/usr/local/bin/kcov"
-
-cache:
-  apt: true
-  directories:
-  - $TRAVIS_BUILD_DIR/target
-  - $TRAVIS_BUILD_DIR/kcov-master
-  - $TRAVIS_BUILD_DIR/js/node_modules
-  - $HOME/.cargo
-
-addons:
-  apt:
-    sources:
-    - ubuntu-toolchain-r-test
-    packages:
-    - libcurl4-openssl-dev
-    - libelf-dev
-    - libdw-dev
-    - gcc-4.8
-    - g++-4.8
-
-install:
-  - ([ "$RUN_COVERAGE" = "false" ]) || (test -x $KCOV_CMD) || (
-      wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz &&
-      tar xzf master.tar.gz &&
-      mkdir -p kcov-master/build &&
-      cd kcov-master/build &&
-      cmake .. &&
-      make && make install DESTDIR=../tmp &&
-      cd
-    )
-  - nvm install $TRAVIS_NODE_VERSION && nvm use $TRAVIS_NODE_VERSION && ./js/scripts/install-deps.sh
-
-script:
-  - if [ "$RUN_TESTS" = "true" ]; then
-      ./js/scripts/lint.sh &&
-      travis_wait 40 ./test.sh $TEST_OPTIONS;
-    fi
-  - if [ "$RUN_COVERAGE" = "true" ]; then ./scripts/cov.sh "$KCOV_CMD"; fi
-
-after_success: |
-  [ $TRAVIS_BRANCH = master ] &&
-  [ $TRAVIS_PULL_REQUEST = false ] &&
-  [ "$RUN_DOCS" = "true" ] &&
-  ./scripts/doc.sh &&
-  pip install --user ghp-import &&
-  /home/travis/.local/bin/ghp-import -n target/doc &&
-  git push -fq https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages

CHANGELOG.md

@@ -0,0 +1,208 @@
+## OpenEthereum v3.3.3
+
+Enhancements:
+* Implement eip-3607 (#593)
+
+Bug fixes:
+* Add type field for legacy transactions in RPC calls (#580)
+* Makes eth_mining to return False if not is not allowed to seal (#581)
+* Made nodes data concatenate as RLP sequences instead of bytes (#598)
+
+## OpenEthereum v3.3.2
+
+Enhancements:
+* London hardfork block: Sokol (24114400)
+
+Bug fixes:
+* Fix for maxPriorityFeePerGas overflow
+
+## OpenEthereum v3.3.1
+
+Enhancements:
+* Add eth_maxPriorityFeePerGas implementation (#570)
+* Add a bootnode for Kovan
+
+Bug fixes:
+* Fix for modexp overflow in debug mode (#578)
+
+## OpenEthereum v3.3.0
+
+Enhancements:
+* Add `validateServiceTransactionsTransition` spec option to be able to enable additional checking of zero gas price transactions by block verifier
+
+## OpenEthereum v3.3.0-rc.15
+
+* Revert eip1559BaseFeeMinValue activation on xDai at London hardfork block
+
+## OpenEthereum v3.3.0-rc.14
+
+Enhancements:
+* Add eip1559BaseFeeMinValue and eip1559BaseFeeMinValueTransition spec options
+* Activate eip1559BaseFeeMinValue on xDai at London hardfork block (19040000), set it to 20 GWei
+* Activate eip1559BaseFeeMinValue on POA Core at block 24199500 (November 8, 2021), set it to 10 GWei
+* Delay difficulty bomb to June 2022 for Ethereum Mainnet (EIP-4345)
+
+## OpenEthereum v3.3.0-rc.13
+
+Enhancements:
+* London hardfork block: POA Core (24090200)
+
+## OpenEthereum v3.3.0-rc.12
+
+Enhancements:
+* London hardfork block: xDai (19040000)
+
+## OpenEthereum v3.3.0-rc.11
+
+Bug fixes:
+* Ignore GetNodeData requests only for non-AuRa chains
+
+## OpenEthereum v3.3.0-rc.10
+
+Enhancements:
+* Add eip1559FeeCollector and eip1559FeeCollectorTransition spec options
+
+## OpenEthereum v3.3.0-rc.9
+
+Bug fixes:
+* Add service transactions support for EIP-1559
+* Fix MinGasPrice config option for POSDAO and EIP-1559
+
+Enhancements:
+* min_gas_price becomes min_effective_priority_fee
+* added version 4 for TxPermission contract
+
+## OpenEthereum v3.3.0-rc.8
+
+Bug fixes:
+* Ignore GetNodeData requests (#519)
+
+## OpenEthereum v3.3.0-rc.7
+
+Bug fixes:
+* GetPooledTransactions is sent in invalid form (wrong packet id)
+
+## OpenEthereum v3.3.0-rc.6
+
+Enhancements:
+* London hardfork block: kovan (26741100) (#502)
+
+## OpenEthereum v3.3.0-rc.4
+
+Enhancements:
+* London hardfork block: mainnet (12,965,000) (#475)
+* Support for eth/66 protocol version (#465)
+* Bump ethereum/tests to v9.0.3
+* Add eth_feeHistory
+
+Bug fixes:
+* GetNodeData from eth63 is missing (#466)
+* Effective gas price not omitting (#477)
+* London support in openethereum-evm (#479)
+* gasPrice is required field for Transaction object (#481)
+
+## OpenEthereum v3.3.0-rc.3
+
+Bug fixes:
+* Add effective_gas_price to eth_getTransactionReceipt #445 (#450)
+* Update eth_gasPrice to support EIP-1559 #449 (#458)
+* eth_estimateGas returns "Requires higher than upper limit of X" after London Ropsten Hard Fork #459 (#460)
+
+## OpenEthereum v3.3.0-rc.2
+
+Enhancements:
+* EIP-1559: Fee market change for ETH 1.0 chain
+* EIP-3198: BASEFEE opcode
+* EIP-3529: Reduction in gas refunds
+* EIP-3541: Reject new contracts starting with the 0xEF byte
+* Delay difficulty bomb to December 2021 (EIP-3554)
+* London hardfork blocks: goerli (5,062,605), rinkeby (8,897,988), ropsten (10,499,401)
+* Add chainspecs for aleut and baikal
+* Bump ethereum/tests to v9.0.2
+
+## OpenEthereum v3.2.6
+
+Enhancement:
+* Berlin hardfork blocks: poacore (21,364,900), poasokol (21,050,600)
+
+## OpenEthereum v3.2.5
+
+Bug fixes:
+* Backport: Block sync stopped without any errors. #277 (#286)
+* Strict memory order (#306)
+
+Enhancements:
+* Executable queue for ancient blocks inclusion (#208)
+* Backport AuRa commits for xdai (#330)
+* Add Nethermind to clients that accept service transactions (#324)
+* Implement the filter argument in parity_pendingTransactions (#295)
+* Ethereum-types and various libs upgraded (#315)
+* [evmbin] Omit storage output, now for std-json (#311)
+* Freeze pruning while creating snapshot (#205)
+* AuRa multi block reward (#290)
+* Improved metrics. DB read/write. prometheus prefix config (#240)
+* Send RLPx auth in EIP-8 format (#287)
+* rpc module reverted for RPC JSON api (#284)
+* Revert "Remove eth/63 protocol version (#252)"
+* Support for eth/65 protocol version (#366)
+* Berlin hardfork blocks: kovan (24,770,900), xdai (16,101,500)
+* Bump ethereum/tests to v8.0.3
+
+devops:
+* Upgrade docker alpine to `v1.13.2`. for rust `v1.47`.
+* Send SIGTERM instead of SIGHUP to OE daemon (#317)
+
+## OpenEthereum v3.2.4
+
+* Fix for Typed transaction broadcast.
+
+## OpenEthereum v3.2.3
+
+* Hotfix for berlin consensus error.
+
+## OpenEthereum v3.2.2-rc.1
+
+Bug fixes:
+* Backport: Block sync stopped without any errors. #277 (#286)
+* Strict memory order (#306)
+
+Enhancements:
+* Executable queue for ancient blocks inclusion (#208)
+* Backport AuRa commits for xdai (#330)
+* Add Nethermind to clients that accept service transactions (#324)
+* Implement the filter argument in parity_pendingTransactions (#295) 
+* Ethereum-types and various libs upgraded (#315)
+* Bump ethereum/tests to v8.0.2
+* [evmbin] Omit storage output, now for std-json (#311)
+* Freeze pruning while creating snapshot (#205)
+* AuRa multi block reward (#290)
+* Improved metrics. DB read/write. prometheus prefix config (#240)
+* Send RLPx auth in EIP-8 format (#287)
+* rpc module reverted for RPC JSON api (#284)
+* Revert "Remove eth/63 protocol version (#252)"
+
+devops:
+* Upgrade docker alpine to `v1.13.2`. for rust `v1.47`.
+* Send SIGTERM instead of SIGHUP to OE daemon (#317)
+
+## OpenEthereum v3.2.1
+
+Hot fix issue, related to initial sync:
+* Initial sync gets stuck. (#318)
+
+## OpenEthereum v3.2.0
+
+Bug fixes:
+* Update EWF's chains with Istanbul transition block numbers (#11482) (#254)
+* fix Supplied instant is later than self (#169)
+* ethcore/snapshot: fix double-lock in Service::feed_chunk (#289)
+
+Enhancements:
+* Berlin hardfork blocks: mainnet (12,244,000), goerli (4,460,644), rinkeby (8,290,928) and ropsten (9,812,189)
+* yolo3x spec (#241)
+* EIP-2930 RPC support
+* Remove eth/63 protocol version (#252)
+* Snapshot manifest block added to prometheus (#232)
+* EIP-1898: Allow default block parameter to be blockHash
+* Change ProtocolId to U64
+* Update ethereum/tests

Cargo.toml

@@ -1,96 +1,133 @@
 [package]
-description = "Parity Ethereum client"
-name = "parity"
-version = "1.5.0"
+description = "OpenEthereum"
+name = "openethereum"
+# NOTE Make sure to update util/version/Cargo.toml as well
+version = "3.3.3"
 license = "GPL-3.0"
-authors = ["Parity Technologies <admin@parity.io>"]
-build = "build.rs"
-
-[build-dependencies]
-rustc_version = "0.1"
-ethcore-ipc-codegen = { path = "ipc/codegen" }
-ethcore-ipc-tests = { path = "ipc/tests" }
+authors = [
+	"OpenEthereum developers",
+	"Parity Technologies <admin@parity.io>"
+]
 
 [dependencies]
-log = "0.3"
-env_logger = "0.3"
-rustc-serialize = "0.3"
-docopt = "0.6"
-time = "0.1"
-num_cpus = "0.2"
+blooms-db = { path = "crates/db/blooms-db" }
+log = "0.4"
+rustc-hex = "1.0"
+docopt = "1.0"
+clap = "2"
+term_size = "0.3"
+textwrap = "0.9"
+num_cpus = "1.2"
 number_prefix = "0.2"
-rpassword = "0.2.1"
-semver = "0.5"
-ansi_term = "0.7"
-lazy_static = "0.2"
-regex = "0.1"
-isatty = "0.1"
-toml = "0.2"
-serde = "0.8.0"
-serde_json = "0.8.0"
-app_dirs = "1.1.1"
-hyper = { version = "0.9", default-features = false }
-ctrlc = { git = "https://github.com/ethcore/rust-ctrlc.git" }
+rpassword = "1.0"
+semver = "0.9"
+ansi_term = "0.10"
+parking_lot = "0.11.1"
+regex = "1.0"
+atty = "0.2.8"
+toml = "0.4"
+serde = "1.0"
+serde_json = "1.0"
+serde_derive = "1.0"
+futures = "0.1"
+hyper = { version = "0.12" }
 fdlimit = "0.1"
-clippy = { version = "0.0.103", optional = true}
-rlp = { path = "util/rlp" }
-ethsync = { path = "sync" }
-ethcore = { path = "ethcore" }
-ethcore-util = { path = "util" }
-ethcore-io = { path = "util/io" }
-ethcore-devtools = { path = "devtools" }
-ethcore-rpc = { path = "rpc" }
-ethcore-signer = { path = "signer" }
-ethcore-ipc = { path = "ipc/rpc" }
-ethcore-ipc-nano = { path = "ipc/nano" }
-ethcore-ipc-hypervisor = { path = "ipc/hypervisor" }
-ethcore-logger = { path = "logger" }
-ethcore-stratum = { path = "stratum" }
-ethcore-dapps = { path = "dapps", optional = true }
-rpc-cli = { path = "rpc_cli" }
-parity-rpc-client = { path = "rpc_client" }
-ethcore-light = { path = "ethcore/light" }
-parity-hash-fetch = { path = "hash-fetch" }
-parity-updater = { path = "updater" }
-parity-reactor = { path = "util/reactor" }
+ctrlc = { git = "https://github.com/paritytech/rust-ctrlc.git" }
+jsonrpc-core = "15.0.0"
+parity-bytes = "0.1"
+common-types = { path = "crates/ethcore/types" }
+ethcore = { path = "crates/ethcore", features = ["parity"] }
+ethcore-accounts = { path = "crates/accounts", optional = true }
+ethcore-blockchain = { path = "crates/ethcore/blockchain" }
+ethcore-call-contract = { path = "crates/vm/call-contract"}
+ethcore-db = { path = "crates/db/db" }
+ethcore-io = { path = "crates/runtime/io" }
+ethcore-logger = { path = "bin/oe/logger" }
+ethcore-miner = { path = "crates/concensus/miner" }
+ethcore-network = { path = "crates/net/network" }
+ethcore-service = { path = "crates/ethcore/service" }
+ethcore-sync = { path = "crates/ethcore/sync" }
+ethereum-types = "0.9.2"
+ethkey = { path = "crates/accounts/ethkey" }
+ethstore = { path = "crates/accounts/ethstore" }
+fetch = { path = "crates/net/fetch" }
+node-filter = { path = "crates/net/node-filter" }
+parity-crypto = { version = "0.6.2", features = [ "publickey" ] }
+rlp = { version = "0.4.6" }
+cli-signer= { path = "crates/util/cli-signer" }
+parity-daemonize = "0.3"
+parity-local-store = { path = "crates/concensus/miner/local-store" }
+parity-runtime = { path = "crates/runtime/runtime" }
+parity-rpc = { path = "crates/rpc" }
+parity-version = { path = "crates/util/version" }
+parity-path = "0.1"
+dir = { path = "crates/util/dir" }
+panic_hook = { path = "crates/util/panic-hook" }
+keccak-hash = "0.5.0"
+migration-rocksdb = { path = "crates/db/migration-rocksdb" }
+kvdb = "0.1"
+kvdb-rocksdb = "0.1.3"
+journaldb = { path = "crates/db/journaldb" }
+stats = { path = "crates/util/stats" }
+prometheus = "0.9.0"
+
+# ethcore-secretstore = { path = "crates/util/secret-store", optional = true }
+
+[build-dependencies]
+rustc_version = "0.2"
+
+[dev-dependencies]
+pretty_assertions = "0.1"
+ipnetwork = "0.12.6"
+tempdir = "0.3"
+fake-fetch = { path = "crates/net/fake-fetch" }
+lazy_static = "1.2.0"
 
 [target.'cfg(windows)'.dependencies]
-winapi = "0.2"
-
-[target.'cfg(not(windows))'.dependencies]
-daemonize = "0.2"
+winapi = { version = "0.3.4", features = ["winsock2", "winuser", "shellapi"] }
 
 [features]
-default = ["ui-precompiled"]
-ui = [
-	"dapps",
-	"ethcore-dapps/ui",
-	"ethcore-signer/ui",
-]
-ui-precompiled = [
-	"dapps",
-	"ethcore-signer/ui-precompiled",
-	"ethcore-dapps/ui-precompiled",
-]
-dapps = ["ethcore-dapps"]
-ipc = ["ethcore/ipc", "ethsync/ipc"]
-jit = ["ethcore/jit"]
-dev = ["clippy", "ethcore/dev", "ethcore-util/dev", "ethsync/dev", "ethcore-rpc/dev", "ethcore-dapps/dev", "ethcore-signer/dev"]
+default = ["accounts"]
+accounts = ["ethcore-accounts", "parity-rpc/accounts"]
+miner-debug = ["ethcore/miner-debug"]
 json-tests = ["ethcore/json-tests"]
+ci-skip-tests = ["ethcore/ci-skip-tests"]
 test-heavy = ["ethcore/test-heavy"]
-stratum = ["ipc"]
-ethkey-cli = ["ethcore/ethkey-cli"]
-ethstore-cli = ["ethcore/ethstore-cli"]
 evm-debug = ["ethcore/evm-debug"]
 evm-debug-tests = ["ethcore/evm-debug-tests"]
 slow-blocks = ["ethcore/slow-blocks"]
-final = ["ethcore-util/final"]
+final = ["parity-version/final"]
+deadlock_detection = ["parking_lot/deadlock_detection"]
+# to create a memory profile (requires nightly rust), use e.g.
+# `heaptrack /path/to/parity <parity params>`,
+# to visualize a memory profile, use `heaptrack_gui`
+# or
+# `valgrind --tool=massif /path/to/parity <parity params>`
+# and `massif-visualizer` for visualization
+memory_profiling = []
+
+[lib]
+path = "bin/oe/lib.rs"
 
 [[bin]]
-path = "parity/main.rs"
-name = "parity"
+path = "bin/oe/main.rs"
+name = "openethereum"
+
+[profile.test]
+lto = false
+opt-level = 3 # makes tests slower to compile, but faster to run
 
 [profile.release]
 debug = false
-lto = false
-panic = "abort"
+lto = true
+
+[workspace]
+# This should only list projects that are not
+# in the dependency tree in any other way
+# (i.e. pretty much only standalone CLI tools)
+members = [
+	"bin/ethkey",
+	"bin/ethstore",
+	"bin/evmbin",
+	"bin/chainspec"
+]

README.md

@@ -1,131 +1,318 @@
-# [Parity](https://ethcore.io/parity.html)
-### Fast, light, and robust Ethereum implementation
+# OpenEthereum
 
-[![Build Status][travis-image]][travis-url] [![build status](https://gitlab.ethcore.io/Mirrors/ethcore-parity/badges/master/build.svg)](https://gitlab.ethcore.io/Mirrors/ethcore-parity/commits/master) [![Coverage Status][coveralls-image]][coveralls-url]  [![GPLv3][license-image]][license-url]
+Fast and feature-rich multi-network Ethereum client.
 
-### Join the chat!
+[» Download the latest release «](https://github.com/openethereum/openethereum/releases/latest)
 
-Parity [![Join the chat at https://gitter.im/ethcore/parity][gitter-image]][gitter-url] and
-parity.js [![Join the chat at https://gitter.im/ethcore/parity.js](https://badges.gitter.im/ethcore/parity.js.svg)](https://gitter.im/ethcore/parity.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![GPL licensed][license-badge]][license-url]
+[![Build Status][ci-badge]][ci-url]
+[![Discord chat][chat-badge]][chat-url]
 
-[Internal Documentation][doc-url]
+[license-badge]: https://img.shields.io/badge/license-GPL_v3-green.svg
+[license-url]: LICENSE
+[ci-badge]: https://github.com/openethereum/openethereum/workflows/Build%20and%20Test%20Suite/badge.svg
+[ci-url]: https://github.com/openethereum/openethereum/actions
+[chat-badge]: https://img.shields.io/discord/669192218728202270.svg?logo=discord
+[chat-url]: https://discord.io/openethereum
+
+## Table of Contents
+
+1. [Description](#chapter-001)
+2. [Technical Overview](#chapter-002)
+3. [Building](#chapter-003)<br>
+  3.1 [Building Dependencies](#chapter-0031)<br>
+  3.2 [Building from Source Code](#chapter-0032)<br>
+  3.3 [Starting OpenEthereum](#chapter-0034)
+4. [Testing](#chapter-004)
+5. [Documentation](#chapter-005)
+6. [Toolchain](#chapter-006)
+7. [Contributing](#chapter-008)
+8. [License](#chapter-009)
 
 
-Be sure to check out [our wiki][wiki-url] for more information.
+## 1. Description <a id="chapter-001"></a>
 
-[travis-image]: https://travis-ci.org/ethcore/parity.svg?branch=master
-[travis-url]: https://travis-ci.org/ethcore/parity
-[coveralls-image]: https://coveralls.io/repos/github/ethcore/parity/badge.svg?branch=master
-[coveralls-url]: https://coveralls.io/github/ethcore/parity?branch=master
-[gitter-image]: https://badges.gitter.im/Join%20Chat.svg
-[gitter-url]: https://gitter.im/ethcore/parity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
-[license-image]: https://img.shields.io/badge/license-GPL%20v3-green.svg
-[license-url]: https://www.gnu.org/licenses/gpl-3.0.en.html
-[doc-url]: https://ethcore.github.io/parity/ethcore/index.html
-[wiki-url]: https://github.com/ethcore/parity/wiki
+**Built for mission-critical use**: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. OpenEthereum provides the core infrastructure essential for speedy and reliable services.
 
-**Parity requires Rust version 1.12.0 to build**
+- Clean, modular codebase for easy customisation
+- Advanced CLI-based client
+- Minimal memory and storage footprint
+- Synchronise in hours, not days with Warp Sync
+- Modular for light integration into your service or product
 
-----
+## 2. Technical Overview <a id="chapter-002"></a>
 
+OpenEthereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing OpenEthereum using the **Rust programming language**. OpenEthereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
 
-## About Parity
+By default, OpenEthereum runs a JSON-RPC HTTP server on port `:8545` and a Web-Sockets server on port `:8546`. This is fully configurable and supports a number of APIs.
 
-Parity's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity using the sophisticated and
-cutting-edge Rust programming language. Parity is licensed under the GPLv3, and can be used for all your Ethereum needs.
+If you run into problems while using OpenEthereum, check out the [old wiki for documentation](https://openethereum.github.io/), feel free to [file an issue in this repository](https://github.com/openethereum/openethereum/issues/new), or hop on our [Discord](https://discord.io/openethereum) chat room to ask a question. We are glad to help!
 
-Parity comes with a built-in wallet. To access [Parity Wallet](http://127.0.0.1:8080/) this simply go to http://127.0.0.1:8080/. It
-includes various functionality allowing you to:
-- create and manage your Ethereum accounts;
-- manage your Ether and any Ethereum tokens;
-- create and register your own tokens;
-- and much more.    
+You can download OpenEthereum's latest release at [the releases page](https://github.com/openethereum/openethereum/releases) or follow the instructions below to build from source. Read the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
 
-By default, Parity will also run a JSONRPC server on `127.0.0.1:8545`. This is fully configurable and supports a number
-of RPC APIs.
+## 3. Building <a id="chapter-003"></a>
 
-If you run into an issue while using parity, feel free to file one in this repository
-or hop on our [gitter chat room][gitter-url] to ask a question. We are glad to help!
+### 3.1 Build Dependencies <a id="chapter-0031"></a>
 
-Parity's current release is 1.3. You can download it at https://ethcore.io/parity.html or follow the instructions
-below to build from source.
+OpenEthereum requires **latest stable Rust version** to build.
 
-----
-
-## Build dependencies
-
-Parity is fully compatible with Stable Rust.
-
-We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have rustup, you can install it like this:
+We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have `rustup`, you can install it like this:
 
 - Linux:
-	```bash
-	$ curl https://sh.rustup.rs -sSf | sh
-	```
-	
-	Parity also requires `gcc`, `g++`, `libssl-dev`/`openssl` and `pkg-config` packages to be installed.
+  ```bash
+  $ curl https://sh.rustup.rs -sSf | sh
+  ```
+
+  OpenEthereum also requires `clang` (>= 9.0), `clang++`, `pkg-config`, `file`, `make`, and `cmake` packages to be installed.
+
 - OSX:
-	```bash
-	$ curl https://sh.rustup.rs -sSf | sh
-	```
+  ```bash
+  $ curl https://sh.rustup.rs -sSf | sh
+  ```
 
-	`clang` is required. It comes with Xcode command line tools or can be installed with homebrew.
-- Windows
+  `clang` is required. It comes with Xcode command line tools or can be installed with homebrew.
 
-    Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the rustup installer from
-	https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe, start "VS2015 x64 Native Tools Command Prompt", and use the following command to install and set up the msvc toolchain:
-    ```
-	$ rustup default stable-x86_64-pc-windows-msvc
-    ```
+- Windows:
+  Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the `rustup` installer from
+  https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe, start "VS2015 x64 Native Tools Command Prompt", and use the following command to install and set up the `msvc` toolchain:
+  ```bash
+  $ rustup default stable-x86_64-pc-windows-msvc
+  ```
 
-Once you have rustup, install parity or download and build from source
+Once you have `rustup` installed, then you need to install:
+* [Perl](https://www.perl.org)
+* [Yasm](https://yasm.tortall.net)
 
-----
+Make sure that these binaries are in your `PATH`. After that, you should be able to build OpenEthereum from source.
 
-## Quick install
+### 3.2 Build from Source Code <a id="chapter-0032"></a>
 
 ```bash
-cargo install --git https://github.com/ethcore/parity.git parity
-```
-
-----
-
-## Build from source
-
-```bash
-# download Parity code
-$ git clone https://github.com/ethcore/parity
-$ cd parity
+# download OpenEthereum code
+$ git clone https://github.com/openethereum/openethereum
+$ cd openethereum
 
 # build in release mode
-$ cargo build --release
+$ cargo build --release --features final
 ```
 
-This will produce an executable in the `./target/release` subdirectory.
+This produces an executable in the `./target/release` subdirectory.
 
-----
-
-## Simple one-line installer for Mac and Ubuntu
+Note: if cargo fails to parse manifest try:
 
 ```bash
-bash <(curl https://get.parity.io -Lk)
+$ ~/.cargo/bin/cargo build --release
 ```
 
-## Start Parity
-### Manually
-To start Parity manually, just run
+Note, when compiling a crate and you receive errors, it's in most cases your outdated version of Rust, or some of your crates have to be recompiled. Cleaning the repository will most likely solve the issue if you are on the latest stable version of Rust, try:
+
 ```bash
-$ ./target/release/parity
+$ cargo clean
 ```
 
-and Parity will begin syncing the Ethereum blockchain.
+This always compiles the latest nightly builds. If you want to build stable, do a
 
-### Using systemd service file
-To start Parity as a regular user using systemd init:
+```bash
+$ git checkout stable
+```
 
-1. Copy `parity/scripts/parity.service` to your
-systemd user directory (usually `~/.config/systemd/user`).
-2. To pass any argument to Parity, write a `~/.parity/parity.conf` file this way:
-`ARGS="ARG1 ARG2 ARG3"`.
+### 3.3 Starting OpenEthereum <a id="chapter-0034"></a>
 
-	Example: `ARGS="ui --geth --identity MyMachine"`.
+#### Manually
+
+To start OpenEthereum manually, just run
+
+```bash
+$ ./target/release/openethereum
+```
+
+so OpenEthereum begins syncing the Ethereum blockchain.
+
+#### Using `systemd` service file
+
+To start OpenEthereum as a regular user using `systemd` init:
+
+1. Copy `./scripts/openethereum.service` to your
+`systemd` user directory (usually `~/.config/systemd/user`).
+2. Copy release to bin folder, write `sudo install ./target/release/openethereum /usr/bin/openethereum`
+3. To configure OpenEthereum, see [our wiki](https://openethereum.github.io/Configuring-OpenEthereum) for details.
+
+## 4. Testing <a id="chapter-004"></a>
+
+Download the required test files: `git submodule update --init --recursive`. You can run tests with the following commands:
+
+* **All** packages
+  ```
+  cargo test --all
+  ```
+
+* Specific package
+  ```
+  cargo test --package <spec>
+  ```
+
+Replace `<spec>` with one of the packages from the [package list](#package-list) (e.g. `cargo test --package evmbin`).
+
+You can show your logs in the test output by passing `--nocapture` (i.e. `cargo test --package evmbin -- --nocapture`)
+
+## 5. Documentation <a id="chapter-005"></a>
+
+Be sure to [check out our wiki](https://openethereum.github.io/) for more information.
+
+### Viewing documentation for OpenEthereum packages
+
+You can generate documentation for OpenEthereum Rust packages that automatically opens in your web browser using [rustdoc with Cargo](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html#using-rustdoc-with-cargo) (of the The Rustdoc Book), by running the the following commands:
+
+* **All** packages
+  ```
+  cargo doc --document-private-items --open
+  ```
+
+* Specific package
+  ```
+  cargo doc --package <spec> -- --document-private-items --open
+  ```
+
+Use`--document-private-items` to also view private documentation and `--no-deps` to exclude building documentation for dependencies.
+
+Replacing `<spec>` with one of the following from the details section below (i.e. `cargo doc --package openethereum --open`):
+
+<a id="package-list"></a>
+**Package List**
+<details><p>
+
+* OpenEthereum Client Application
+  ```bash
+  openethereum
+  ```
+* OpenEthereum Account Management, Key Management Tool, and Keys Generator
+  ```bash
+  ethcore-accounts, ethkey-cli, ethstore, ethstore-cli
+  ```
+* OpenEthereum Chain Specification
+  ```bash
+  chainspec
+  ```
+* OpenEthereum CLI Signer Tool & RPC Client
+  ```bash
+  cli-signer parity-rpc-client
+  ```
+* OpenEthereum Ethash & ProgPoW Implementations
+  ```bash
+  ethash
+  ```
+* EthCore Library
+  ```bash
+  ethcore
+  ```
+  * OpenEthereum Blockchain Database, Test Generator, Configuration,
+Caching, Importing Blocks, and Block Information
+    ```bash
+    ethcore-blockchain
+    ```
+  * OpenEthereum Contract Calls and Blockchain Service & Registry Information
+    ```bash
+    ethcore-call-contract
+    ```
+  * OpenEthereum Database Access & Utilities, Database Cache Manager
+    ```bash
+    ethcore-db
+    ```
+  * OpenEthereum Virtual Machine (EVM) Rust Implementation
+    ```bash
+    evm
+    ```
+  * OpenEthereum Light Client Implementation
+    ```bash
+    ethcore-light
+    ```
+  * Smart Contract based Node Filter, Manage Permissions of Network Connections
+    ```bash
+    node-filter
+    ```
+  * OpenEthereum Client & Network Service Creation & Registration with the I/O Subsystem
+    ```bash
+    ethcore-service
+    ```
+  * OpenEthereum Blockchain Synchronization
+    ```bash
+    ethcore-sync
+    ```
+  * OpenEthereum Common Types
+    ```bash
+    common-types
+    ```
+  * OpenEthereum Virtual Machines (VM) Support Library
+    ```bash
+    vm
+    ```
+  * OpenEthereum WASM Interpreter
+    ```bash
+    wasm
+    ```
+  * OpenEthereum WASM Test Runner
+    ```bash
+    pwasm-run-test
+    ```
+  * OpenEthereum EVM Implementation
+    ```bash
+    evmbin
+    ```
+  * OpenEthereum JSON Deserialization
+    ```bash
+    ethjson
+    ```
+  * OpenEthereum State Machine Generalization for Consensus Engines
+    ```bash
+    parity-machine
+    ```
+* OpenEthereum Miner Interface
+  ```bash
+  ethcore-miner parity-local-store price-info ethcore-stratum using_queue
+  ```
+* OpenEthereum Logger Implementation
+  ```bash
+  ethcore-logger
+  ```
+* OpenEthereum JSON-RPC Servers
+  ```bash
+  parity-rpc
+  ```
+* OpenEthereum Updater Service
+  ```bash
+  parity-updater parity-hash-fetch
+  ```
+* OpenEthereum Core Libraries (`util`)
+  ```bash
+  accounts-bloom blooms-db dir eip-712 fake-fetch fastmap fetch ethcore-io
+  journaldb keccak-hasher len-caching-lock memory-cache memzero
+  migration-rocksdb ethcore-network ethcore-network-devp2p panic_hook
+  patricia-trie-ethereum registrar rlp_compress stats
+  time-utils triehash-ethereum unexpected parity-version
+  ```
+
+</p></details>
+
+## 6. Toolchain <a id="chapter-006"></a>
+
+In addition to the OpenEthereum client, there are additional tools in this repository available:
+
+- [evmbin](./bin/evmbin) - OpenEthereum EVM Implementation.
+- [ethstore](./crates/accounts/ethstore) - OpenEthereum Key Management.
+- [ethkey](./crates/accounts/ethkey) - OpenEthereum Keys Generator.
+
+The following tools are available in a separate repository:
+- [ethabi](https://github.com/openethereum/ethabi) - OpenEthereum Encoding of Function Calls. [Docs here](https://crates.io/crates/ethabi)
+- [whisper](https://github.com/openethereum/whisper) - OpenEthereum Whisper-v2 PoC Implementation.
+
+## 7. Contributing <a id="chapter-007"></a>
+
+An introduction has been provided in the ["So You Want to be a Core Developer" presentation slides by Hernando Castano](http://tiny.cc/contrib-to-parity-eth). Additional guidelines are provided in [CONTRIBUTING](./.github/CONTRIBUTING.md).
+
+### Contributor Code of Conduct
+
+[CODE_OF_CONDUCT](./.github/CODE_OF_CONDUCT.md)
+
+## 8. License <a id="chapter-008"></a>
+
+[LICENSE](./LICENSE)

appveyor.yml

@@ -1,52 +0,0 @@
-environment:
-  matrix:
-  - TARGET: x86_64-pc-windows-msvc
-  cert:
-    secure: ESPpYVVAMG1fbJx6kq4ct/g9SQTXac4Hs6xXr6Oh4Zrk2dwYglNjxmzErdPnvu7gs/gekzrJ6KEQHYRc+5+4dKg6rRADQ681NLVx9vOggBs=
-  certpass:
-    secure: 0BgXJqxq9Ei34/hZ7121FQ==
-  keyfile: C:\users\appveyor\Certificates.p12
-  RUSTFLAGS: -D warnings
-
-branches:
-  only:
-    - master
-    - /^beta-.*$/
-    - /^stable-.*$/
-    - /^beta$/
-    - /^stable$/
-
-install:
-  - git submodule update --init --recursive
-  - ps: Install-Product node 6
-  - ps: Start-FileDownload "https://static.rust-lang.org/dist/rust-1.13.0-x86_64-pc-windows-msvc.exe"
-  - ps: Start-FileDownload "https://github.com/ethcore/win-build/raw/master/SimpleFC.dll" -FileName nsis\SimpleFC.dll
-  - ps: Start-FileDownload "https://github.com/ethcore/win-build/raw/master/vc_redist.x64.exe" -FileName nsis\vc_redist.x64.exe
-  - rust-1.13.0-x86_64-pc-windows-msvc.exe /VERYSILENT /NORESTART /DIR="C:\Program Files (x86)\Rust"
-  - SET PATH=%PATH%;C:\Program Files (x86)\Rust\bin;C:\Program Files (x86)\NSIS;C:\Program Files (x86)\Microsoft SDKs\Windows\v7.1A\Bin
-  - rustc -V
-  - cargo -V
-  - node -v
-  - npm -v
-
-build: off
-
-test_script:
-  - cargo test --verbose --release
-
-after_test:
-  - cargo build --verbose --release
-  - ps: if($env:cert) { Start-FileDownload $env:cert -FileName $env:keyfile }
-  - ps: if($env:cert) { signtool sign /f $env:keyfile /p $env:certpass target\release\parity.exe }
-  - msbuild windows\ptray\ptray.vcxproj /p:Platform=x64 /p:Configuration=Release
-  - ps: if($env:cert) { signtool sign /f $env:keyfile /p $env:certpass windows\ptray\x64\release\ptray.exe }
-  - makensis.exe nsis\installer.nsi
-  - ps: if($env:cert) { signtool sign /f $env:keyfile /p $env:certpass nsis\installer.exe }
-
-artifacts:
-  - path: nsis\installer.exe
-    name: Windows Installer (x86_64)
-
-cache:
-  - target
-  - C:\users\appveyor\.cargo -> appveyor.yml

bin/chainspec/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+description = "Parity Ethereum Chain Specification"
+name = "chainspec"
+version = "0.1.0"
+authors = ["Marek Kotewicz <marek@parity.io>"]
+
+[dependencies]
+ethjson = { path = "../../crates/ethjson" }
+serde_json = "1.0"

bin/chainspec/src/main.rs

@@ -0,0 +1,51 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+extern crate ethjson;
+extern crate serde_json;
+
+use ethjson::spec::Spec;
+use std::{env, fs, process};
+
+fn quit(s: &str) -> ! {
+    println!("{}", s);
+    process::exit(1);
+}
+
+fn main() {
+    let mut args = env::args();
+    if args.len() != 2 {
+        quit(
+            "You need to specify chainspec.json\n\
+		\n\
+		./chainspec <chainspec.json>",
+        );
+    }
+
+    let path = args.nth(1).expect("args.len() == 2; qed");
+    let file = match fs::File::open(&path) {
+        Ok(file) => file,
+        Err(_) => quit(&format!("{} could not be opened", path)),
+    };
+
+    let spec: Result<Spec, _> = serde_json::from_reader(file);
+
+    if let Err(err) = spec {
+        quit(&format!("{} {}", path, err.to_string()));
+    }
+
+    println!("{} is valid", path);
+}

bin/ethkey/Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+description = "Parity Ethereum Keys Generator CLI"
+name = "ethkey-cli"
+version = "0.1.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+
+[dependencies]
+docopt = "1.0"
+env_logger = "0.5"
+ethkey = { path = "../../crates/accounts/ethkey" }
+panic_hook = { path = "../../crates/util/panic-hook" }
+parity-crypto = { version = "0.6.2", features = [ "publickey" ] }
+parity-wordlist="1.3"
+rustc-hex = "1.0"
+serde = "1.0"
+serde_derive = "1.0"
+threadpool = "1.7"
+
+[[bin]]
+name = "ethkey"
+path = "src/main.rs"
+doc = false

bin/ethkey/src/main.rs

@@ -0,0 +1,493 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+extern crate docopt;
+extern crate env_logger;
+extern crate ethkey;
+extern crate panic_hook;
+extern crate parity_crypto as crypto;
+extern crate parity_wordlist;
+extern crate rustc_hex;
+extern crate serde;
+extern crate threadpool;
+
+#[macro_use]
+extern crate serde_derive;
+
+use std::{env, fmt, io, num::ParseIntError, process, sync};
+
+use crypto::publickey::{
+    sign, verify_address, verify_public, Error as EthkeyError, Generator, KeyPair, Random,
+};
+use docopt::Docopt;
+use ethkey::{brain_recover, Brain, BrainPrefix, Prefix};
+use rustc_hex::{FromHex, FromHexError};
+
+const USAGE: &'static str = r#"
+Parity Ethereum keys generator.
+  Copyright 2015-2019 Parity Technologies (UK) Ltd.
+
+Usage:
+    ethkey info <secret-or-phrase> [options]
+    ethkey generate random [options]
+    ethkey generate prefix <prefix> [options]
+    ethkey sign <secret> <message>
+    ethkey verify public <public> <signature> <message>
+    ethkey verify address <address> <signature> <message>
+    ethkey recover <address> <known-phrase>
+    ethkey [-h | --help]
+
+Options:
+    -h, --help         Display this message and exit.
+    -s, --secret       Display only the secret key.
+    -p, --public       Display only the public key.
+    -a, --address      Display only the address.
+    -b, --brain        Use parity brain wallet algorithm. Not recommended.
+
+Commands:
+    info               Display public key and address of the secret.
+    generate random    Generates new random Ethereum key.
+    generate prefix    Random generation, but address must start with a prefix ("vanity address").
+    sign               Sign message using a secret key.
+    verify             Verify signer of the signature by public key or address.
+    recover            Try to find brain phrase matching given address from partial phrase.
+"#;
+
+#[derive(Debug, Deserialize)]
+struct Args {
+    cmd_info: bool,
+    cmd_generate: bool,
+    cmd_random: bool,
+    cmd_prefix: bool,
+    cmd_sign: bool,
+    cmd_verify: bool,
+    cmd_public: bool,
+    cmd_address: bool,
+    cmd_recover: bool,
+    arg_prefix: String,
+    arg_secret: String,
+    arg_secret_or_phrase: String,
+    arg_known_phrase: String,
+    arg_message: String,
+    arg_public: String,
+    arg_address: String,
+    arg_signature: String,
+    flag_secret: bool,
+    flag_public: bool,
+    flag_address: bool,
+    flag_brain: bool,
+}
+
+#[derive(Debug)]
+enum Error {
+    Ethkey(EthkeyError),
+    FromHex(FromHexError),
+    ParseInt(ParseIntError),
+    Docopt(docopt::Error),
+    Io(io::Error),
+}
+
+impl From<EthkeyError> for Error {
+    fn from(err: EthkeyError) -> Self {
+        Error::Ethkey(err)
+    }
+}
+
+impl From<FromHexError> for Error {
+    fn from(err: FromHexError) -> Self {
+        Error::FromHex(err)
+    }
+}
+
+impl From<ParseIntError> for Error {
+    fn from(err: ParseIntError) -> Self {
+        Error::ParseInt(err)
+    }
+}
+
+impl From<docopt::Error> for Error {
+    fn from(err: docopt::Error) -> Self {
+        Error::Docopt(err)
+    }
+}
+
+impl From<io::Error> for Error {
+    fn from(err: io::Error) -> Self {
+        Error::Io(err)
+    }
+}
+
+impl fmt::Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
+        match *self {
+            Error::Ethkey(ref e) => write!(f, "{}", e),
+            Error::FromHex(ref e) => write!(f, "{}", e),
+            Error::ParseInt(ref e) => write!(f, "{}", e),
+            Error::Docopt(ref e) => write!(f, "{}", e),
+            Error::Io(ref e) => write!(f, "{}", e),
+        }
+    }
+}
+
+enum DisplayMode {
+    KeyPair,
+    Secret,
+    Public,
+    Address,
+}
+
+impl DisplayMode {
+    fn new(args: &Args) -> Self {
+        if args.flag_secret {
+            DisplayMode::Secret
+        } else if args.flag_public {
+            DisplayMode::Public
+        } else if args.flag_address {
+            DisplayMode::Address
+        } else {
+            DisplayMode::KeyPair
+        }
+    }
+}
+
+fn main() {
+    panic_hook::set_abort();
+    env_logger::try_init().expect("Logger initialized only once.");
+
+    match execute(env::args()) {
+        Ok(ok) => println!("{}", ok),
+        Err(Error::Docopt(ref e)) => e.exit(),
+        Err(err) => {
+            eprintln!("{}", err);
+            process::exit(1);
+        }
+    }
+}
+
+fn display(result: (KeyPair, Option<String>), mode: DisplayMode) -> String {
+    let keypair = result.0;
+    match mode {
+        DisplayMode::KeyPair => match result.1 {
+            Some(extra_data) => format!("{}\n{}", extra_data, keypair),
+            None => format!("{}", keypair),
+        },
+        DisplayMode::Secret => format!("{:x}", keypair.secret()),
+        DisplayMode::Public => format!("{:x}", keypair.public()),
+        DisplayMode::Address => format!("{:x}", keypair.address()),
+    }
+}
+
+fn execute<S, I>(command: I) -> Result<String, Error>
+where
+    I: IntoIterator<Item = S>,
+    S: AsRef<str>,
+{
+    let args: Args = Docopt::new(USAGE).and_then(|d| d.argv(command).deserialize())?;
+
+    return if args.cmd_info {
+        let display_mode = DisplayMode::new(&args);
+
+        let result = if args.flag_brain {
+            let phrase = args.arg_secret_or_phrase;
+            let phrase_info = validate_phrase(&phrase);
+            let keypair = Brain::new(phrase).generate();
+            (keypair, Some(phrase_info))
+        } else {
+            let secret = args
+                .arg_secret_or_phrase
+                .parse()
+                .map_err(|_| EthkeyError::InvalidSecretKey)?;
+            (KeyPair::from_secret(secret)?, None)
+        };
+        Ok(display(result, display_mode))
+    } else if args.cmd_generate {
+        let display_mode = DisplayMode::new(&args);
+        let result = if args.cmd_random {
+            if args.flag_brain {
+                let mut brain = BrainPrefix::new(vec![0], usize::max_value(), BRAIN_WORDS);
+                let keypair = brain.generate()?;
+                let phrase = format!("recovery phrase: {}", brain.phrase());
+                (keypair, Some(phrase))
+            } else {
+                (Random.generate(), None)
+            }
+        } else if args.cmd_prefix {
+            let prefix = args.arg_prefix.from_hex()?;
+            let brain = args.flag_brain;
+            in_threads(move || {
+                let iterations = 1024;
+                let prefix = prefix.clone();
+                move || {
+                    let prefix = prefix.clone();
+                    let res = if brain {
+                        let mut brain = BrainPrefix::new(prefix, iterations, BRAIN_WORDS);
+                        let result = brain.generate();
+                        let phrase = format!("recovery phrase: {}", brain.phrase());
+                        result.map(|keypair| (keypair, Some(phrase)))
+                    } else {
+                        let result = Prefix::new(prefix, iterations).generate();
+                        result.map(|res| (res, None))
+                    };
+
+                    Ok(res.map(Some).unwrap_or(None))
+                }
+            })?
+        } else {
+            return Ok(format!("{}", USAGE));
+        };
+        Ok(display(result, display_mode))
+    } else if args.cmd_sign {
+        let secret = args
+            .arg_secret
+            .parse()
+            .map_err(|_| EthkeyError::InvalidSecretKey)?;
+        let message = args
+            .arg_message
+            .parse()
+            .map_err(|_| EthkeyError::InvalidMessage)?;
+        let signature = sign(&secret, &message)?;
+        Ok(format!("{}", signature))
+    } else if args.cmd_verify {
+        let signature = args
+            .arg_signature
+            .parse()
+            .map_err(|_| EthkeyError::InvalidSignature)?;
+        let message = args
+            .arg_message
+            .parse()
+            .map_err(|_| EthkeyError::InvalidMessage)?;
+        let ok = if args.cmd_public {
+            let public = args
+                .arg_public
+                .parse()
+                .map_err(|_| EthkeyError::InvalidPublicKey)?;
+            verify_public(&public, &signature, &message)?
+        } else if args.cmd_address {
+            let address = args
+                .arg_address
+                .parse()
+                .map_err(|_| EthkeyError::InvalidAddress)?;
+            verify_address(&address, &signature, &message)?
+        } else {
+            return Ok(format!("{}", USAGE));
+        };
+        Ok(format!("{}", ok))
+    } else if args.cmd_recover {
+        let display_mode = DisplayMode::new(&args);
+        let known_phrase = args.arg_known_phrase;
+        let address = args
+            .arg_address
+            .parse()
+            .map_err(|_| EthkeyError::InvalidAddress)?;
+        let (phrase, keypair) = in_threads(move || {
+            let mut it =
+                brain_recover::PhrasesIterator::from_known_phrase(&known_phrase, BRAIN_WORDS);
+            move || {
+                let mut i = 0;
+                while let Some(phrase) = it.next() {
+                    i += 1;
+
+                    let keypair = Brain::new(phrase.clone()).generate();
+                    if keypair.address() == address {
+                        return Ok(Some((phrase, keypair)));
+                    }
+
+                    if i >= 1024 {
+                        return Ok(None);
+                    }
+                }
+
+                Err(EthkeyError::Custom("Couldn't find any results.".into()))
+            }
+        })?;
+        Ok(display((keypair, Some(phrase)), display_mode))
+    } else {
+        Ok(format!("{}", USAGE))
+    };
+}
+
+const BRAIN_WORDS: usize = 12;
+
+fn validate_phrase(phrase: &str) -> String {
+    match Brain::validate_phrase(phrase, BRAIN_WORDS) {
+        Ok(()) => format!("The recovery phrase looks correct.\n"),
+        Err(err) => format!("The recover phrase was not generated by Parity: {}", err),
+    }
+}
+
+fn in_threads<F, X, O>(prepare: F) -> Result<O, EthkeyError>
+where
+    O: Send + 'static,
+    X: Send + 'static,
+    F: Fn() -> X,
+    X: FnMut() -> Result<Option<O>, EthkeyError>,
+{
+    let pool = threadpool::Builder::new().build();
+
+    let (tx, rx) = sync::mpsc::sync_channel(1);
+    let is_done = sync::Arc::new(sync::atomic::AtomicBool::default());
+
+    for _ in 0..pool.max_count() {
+        let is_done = is_done.clone();
+        let tx = tx.clone();
+        let mut task = prepare();
+        pool.execute(move || {
+            loop {
+                if is_done.load(sync::atomic::Ordering::SeqCst) {
+                    return;
+                }
+
+                let res = match task() {
+                    Ok(None) => continue,
+                    Ok(Some(v)) => Ok(v),
+                    Err(err) => Err(err),
+                };
+
+                // We are interested only in the first response.
+                let _ = tx.send(res);
+            }
+        });
+    }
+
+    if let Ok(solution) = rx.recv() {
+        is_done.store(true, sync::atomic::Ordering::SeqCst);
+        return solution;
+    }
+
+    Err(EthkeyError::Custom("No results found.".into()))
+}
+
+#[cfg(test)]
+mod tests {
+    use super::execute;
+
+    #[test]
+    fn info() {
+        let command = vec![
+            "ethkey",
+            "info",
+            "17d08f5fe8c77af811caa0c9a187e668ce3b74a99acc3f6d976f075fa8e0be55",
+        ]
+        .into_iter()
+        .map(Into::into)
+        .collect::<Vec<String>>();
+
+        let expected =
+"secret:  17d08f5fe8c77af811caa0c9a187e668ce3b74a99acc3f6d976f075fa8e0be55
+public:  689268c0ff57a20cd299fa60d3fb374862aff565b20b5f1767906a99e6e09f3ff04ca2b2a5cd22f62941db103c0356df1a8ed20ce322cab2483db67685afd124
+address: 26d1ec50b4e62c1d1a40d16e7cacc6a6580757d5".to_owned();
+        assert_eq!(execute(command).unwrap(), expected);
+    }
+
+    #[test]
+    fn brain() {
+        let command = vec!["ethkey", "info", "--brain", "this is sparta"]
+            .into_iter()
+            .map(Into::into)
+            .collect::<Vec<String>>();
+
+        let expected =
+"The recover phrase was not generated by Parity: The word 'this' does not come from the dictionary.
+
+secret:  aa22b54c0cb43ee30a014afe5ef3664b1cde299feabca46cd3167a85a57c39f2
+public:  c4c5398da6843632c123f543d714d2d2277716c11ff612b2a2f23c6bda4d6f0327c31cd58c55a9572c3cc141dade0c32747a13b7ef34c241b26c84adbb28fcf4
+address: 006e27b6a72e1f34c626762f3c4761547aff1421".to_owned();
+        assert_eq!(execute(command).unwrap(), expected);
+    }
+
+    #[test]
+    fn secret() {
+        let command = vec!["ethkey", "info", "--brain", "this is sparta", "--secret"]
+            .into_iter()
+            .map(Into::into)
+            .collect::<Vec<String>>();
+
+        let expected =
+            "aa22b54c0cb43ee30a014afe5ef3664b1cde299feabca46cd3167a85a57c39f2".to_owned();
+        assert_eq!(execute(command).unwrap(), expected);
+    }
+
+    #[test]
+    fn public() {
+        let command = vec!["ethkey", "info", "--brain", "this is sparta", "--public"]
+            .into_iter()
+            .map(Into::into)
+            .collect::<Vec<String>>();
+
+        let expected = "c4c5398da6843632c123f543d714d2d2277716c11ff612b2a2f23c6bda4d6f0327c31cd58c55a9572c3cc141dade0c32747a13b7ef34c241b26c84adbb28fcf4".to_owned();
+        assert_eq!(execute(command).unwrap(), expected);
+    }
+
+    #[test]
+    fn address() {
+        let command = vec!["ethkey", "info", "-b", "this is sparta", "--address"]
+            .into_iter()
+            .map(Into::into)
+            .collect::<Vec<String>>();
+
+        let expected = "006e27b6a72e1f34c626762f3c4761547aff1421".to_owned();
+        assert_eq!(execute(command).unwrap(), expected);
+    }
+
+    #[test]
+    fn sign() {
+        let command = vec![
+            "ethkey",
+            "sign",
+            "17d08f5fe8c77af811caa0c9a187e668ce3b74a99acc3f6d976f075fa8e0be55",
+            "bd50b7370c3f96733b31744c6c45079e7ae6c8d299613246d28ebcef507ec987",
+        ]
+        .into_iter()
+        .map(Into::into)
+        .collect::<Vec<String>>();
+
+        let expected = "c1878cf60417151c766a712653d26ef350c8c75393458b7a9be715f053215af63dfd3b02c2ae65a8677917a8efa3172acb71cb90196e42106953ea0363c5aaf200".to_owned();
+        assert_eq!(execute(command).unwrap(), expected);
+    }
+
+    #[test]
+    fn verify_valid_public() {
+        let command = vec!["ethkey", "verify", "public", "689268c0ff57a20cd299fa60d3fb374862aff565b20b5f1767906a99e6e09f3ff04ca2b2a5cd22f62941db103c0356df1a8ed20ce322cab2483db67685afd124", "c1878cf60417151c766a712653d26ef350c8c75393458b7a9be715f053215af63dfd3b02c2ae65a8677917a8efa3172acb71cb90196e42106953ea0363c5aaf200", "bd50b7370c3f96733b31744c6c45079e7ae6c8d299613246d28ebcef507ec987"]
+			.into_iter()
+			.map(Into::into)
+			.collect::<Vec<String>>();
+
+        let expected = "true".to_owned();
+        assert_eq!(execute(command).unwrap(), expected);
+    }
+
+    #[test]
+    fn verify_valid_address() {
+        let command = vec!["ethkey", "verify", "address", "26d1ec50b4e62c1d1a40d16e7cacc6a6580757d5", "c1878cf60417151c766a712653d26ef350c8c75393458b7a9be715f053215af63dfd3b02c2ae65a8677917a8efa3172acb71cb90196e42106953ea0363c5aaf200", "bd50b7370c3f96733b31744c6c45079e7ae6c8d299613246d28ebcef507ec987"]
+			.into_iter()
+			.map(Into::into)
+			.collect::<Vec<String>>();
+
+        let expected = "true".to_owned();
+        assert_eq!(execute(command).unwrap(), expected);
+    }
+
+    #[test]
+    fn verify_invalid() {
+        let command = vec!["ethkey", "verify", "public", "689268c0ff57a20cd299fa60d3fb374862aff565b20b5f1767906a99e6e09f3ff04ca2b2a5cd22f62941db103c0356df1a8ed20ce322cab2483db67685afd124", "c1878cf60417151c766a712653d26ef350c8c75393458b7a9be715f053215af63dfd3b02c2ae65a8677917a8efa3172acb71cb90196e42106953ea0363c5aaf200", "bd50b7370c3f96733b31744c6c45079e7ae6c8d299613246d28ebcef507ec986"]
+			.into_iter()
+			.map(Into::into)
+			.collect::<Vec<String>>();
+
+        let expected = "false".to_owned();
+        assert_eq!(execute(command).unwrap(), expected);
+    }
+}

bin/ethstore/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+description = "Parity Ethereum Key Management CLI"
+name = "ethstore-cli"
+version = "0.1.1"
+authors = ["Parity Technologies <admin@parity.io>"]
+
+[dependencies]
+docopt = "1.0"
+env_logger = "0.5"
+num_cpus = "1.6"
+rustc-hex = "1.0"
+serde = "1.0"
+serde_derive = "1.0"
+parking_lot = "0.11.1"
+ethstore = { path = "../../crates/accounts/ethstore" }
+dir = { path = '../../crates/util/dir' }
+panic_hook = { path = "../../crates/util/panic-hook" }
+
+[[bin]]
+name = "ethstore"
+path = "src/main.rs"
+doc = false
+
+[dev-dependencies]
+tempdir = "0.3.5"

bin/ethstore/src/crack.rs

@@ -0,0 +1,66 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use parking_lot::Mutex;
+use std::{cmp, collections::VecDeque, sync::Arc, thread};
+
+use ethstore::{ethkey::Password, Error, PresaleWallet};
+use num_cpus;
+
+pub fn run(passwords: VecDeque<Password>, wallet_path: &str) -> Result<(), Error> {
+    let passwords = Arc::new(Mutex::new(passwords));
+
+    let mut handles = Vec::new();
+
+    for _ in 0..num_cpus::get() {
+        let passwords = passwords.clone();
+        let wallet = PresaleWallet::open(&wallet_path)?;
+        handles.push(thread::spawn(move || {
+            look_for_password(passwords, wallet);
+        }));
+    }
+
+    for handle in handles {
+        handle
+            .join()
+            .map_err(|err| Error::Custom(format!("Error finishing thread: {:?}", err)))?;
+    }
+
+    Ok(())
+}
+
+fn look_for_password(passwords: Arc<Mutex<VecDeque<Password>>>, wallet: PresaleWallet) {
+    let mut counter = 0;
+    while !passwords.lock().is_empty() {
+        let package = {
+            let mut passwords = passwords.lock();
+            let len = passwords.len();
+            passwords.split_off(cmp::min(len, 32))
+        };
+        for pass in package {
+            counter += 1;
+            match wallet.decrypt(&pass) {
+                Ok(_) => {
+                    println!("Found password: {}", pass.as_str());
+                    passwords.lock().clear();
+                    return;
+                }
+                _ if counter % 100 == 0 => print!("."),
+                _ => {}
+            }
+        }
+    }
+}

bin/ethstore/src/main.rs

@@ -0,0 +1,363 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+extern crate dir;
+extern crate docopt;
+extern crate ethstore;
+extern crate num_cpus;
+extern crate panic_hook;
+extern crate parking_lot;
+extern crate rustc_hex;
+extern crate serde;
+
+extern crate env_logger;
+
+#[macro_use]
+extern crate serde_derive;
+
+use std::{collections::VecDeque, env, fmt, fs, io::Read, process};
+
+use docopt::Docopt;
+use ethstore::{
+    accounts_dir::{KeyDirectory, RootDiskDirectory},
+    ethkey::{Address, Password},
+    import_accounts, EthStore, PresaleWallet, SecretStore, SecretVaultRef, SimpleSecretStore,
+    StoreAccountRef,
+};
+
+mod crack;
+
+pub const USAGE: &'static str = r#"
+Parity Ethereum key management tool.
+  Copyright 2015-2019 Parity Technologies (UK) Ltd.
+
+Usage:
+    ethstore insert <secret> <password> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
+    ethstore change-pwd <address> <old-pwd> <new-pwd> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
+    ethstore list [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
+    ethstore import [<password>] [--src DIR] [--dir DIR]
+    ethstore import-wallet <path> <password> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
+    ethstore find-wallet-pass <path> <password>
+    ethstore remove <address> <password> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
+    ethstore sign <address> <password> <message> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
+    ethstore public <address> <password> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
+    ethstore list-vaults [--dir DIR]
+    ethstore create-vault <vault> <password> [--dir DIR]
+    ethstore change-vault-pwd <vault> <old-pwd> <new-pwd> [--dir DIR]
+    ethstore move-to-vault <address> <vault> <password> [--dir DIR] [--vault VAULT] [--vault-pwd VAULTPWD]
+    ethstore move-from-vault <address> <vault> <password> [--dir DIR]
+    ethstore [-h | --help]
+
+Options:
+    -h, --help               Display this message and exit.
+    --dir DIR                Specify the secret store directory. It may be either
+                             parity, parity-(chain), geth, geth-test
+                             or a path [default: parity].
+    --vault VAULT            Specify vault to use in this operation.
+    --vault-pwd VAULTPWD     Specify vault password to use in this operation. Please note
+                             that this option is required when vault option is set.
+                             Otherwise it is ignored.
+    --src DIR                Specify import source. It may be either
+                             parity, parity-(chain), geth, geth-test
+                             or a path [default: geth].
+
+Commands:
+    insert             Save account with password.
+    change-pwd         Change password.
+    list               List accounts.
+    import             Import accounts from src.
+    import-wallet      Import presale wallet.
+    find-wallet-pass   Tries to open a wallet with list of passwords given.
+    remove             Remove account.
+    sign               Sign message.
+    public             Displays public key for an address.
+    list-vaults        List vaults.
+    create-vault       Create new vault.
+    change-vault-pwd   Change vault password.
+    move-to-vault      Move account to vault from another vault/root directory.
+    move-from-vault    Move account to root directory from given vault.
+"#;
+
+#[derive(Debug, Deserialize)]
+struct Args {
+    cmd_insert: bool,
+    cmd_change_pwd: bool,
+    cmd_list: bool,
+    cmd_import: bool,
+    cmd_import_wallet: bool,
+    cmd_find_wallet_pass: bool,
+    cmd_remove: bool,
+    cmd_sign: bool,
+    cmd_public: bool,
+    cmd_list_vaults: bool,
+    cmd_create_vault: bool,
+    cmd_change_vault_pwd: bool,
+    cmd_move_to_vault: bool,
+    cmd_move_from_vault: bool,
+    arg_secret: String,
+    arg_password: String,
+    arg_old_pwd: String,
+    arg_new_pwd: String,
+    arg_address: String,
+    arg_message: String,
+    arg_path: String,
+    arg_vault: String,
+    flag_src: String,
+    flag_dir: String,
+    flag_vault: String,
+    flag_vault_pwd: String,
+}
+
+enum Error {
+    Ethstore(ethstore::Error),
+    Docopt(docopt::Error),
+}
+
+impl From<ethstore::Error> for Error {
+    fn from(err: ethstore::Error) -> Self {
+        Error::Ethstore(err)
+    }
+}
+
+impl From<docopt::Error> for Error {
+    fn from(err: docopt::Error) -> Self {
+        Error::Docopt(err)
+    }
+}
+
+impl fmt::Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match *self {
+            Error::Ethstore(ref err) => fmt::Display::fmt(err, f),
+            Error::Docopt(ref err) => fmt::Display::fmt(err, f),
+        }
+    }
+}
+
+fn main() {
+    panic_hook::set_abort();
+    if env::var("RUST_LOG").is_err() {
+        env::set_var("RUST_LOG", "warn")
+    }
+    env_logger::try_init().expect("Logger initialized only once.");
+
+    match execute(env::args()) {
+        Ok(result) => println!("{}", result),
+        Err(Error::Docopt(ref e)) => e.exit(),
+        Err(err) => {
+            eprintln!("{}", err);
+            process::exit(1);
+        }
+    }
+}
+
+fn key_dir(location: &str, password: Option<Password>) -> Result<Box<dyn KeyDirectory>, Error> {
+    let dir: RootDiskDirectory = match location {
+        path if path.starts_with("parity") => {
+            let chain = path.split('-').nth(1).unwrap_or("ethereum");
+            let mut path = dir::default_data_pathbuf();
+            path.push("keys");
+            path.push(chain);
+            RootDiskDirectory::create(path)?
+        }
+        path => RootDiskDirectory::create(path)?,
+    };
+
+    Ok(Box::new(dir.with_password(password)))
+}
+
+fn open_args_vault(store: &EthStore, args: &Args) -> Result<SecretVaultRef, Error> {
+    if args.flag_vault.is_empty() {
+        return Ok(SecretVaultRef::Root);
+    }
+
+    let vault_pwd = load_password(&args.flag_vault_pwd)?;
+    store.open_vault(&args.flag_vault, &vault_pwd)?;
+    Ok(SecretVaultRef::Vault(args.flag_vault.clone()))
+}
+
+fn open_args_vault_account(
+    store: &EthStore,
+    address: Address,
+    args: &Args,
+) -> Result<StoreAccountRef, Error> {
+    match open_args_vault(store, args)? {
+        SecretVaultRef::Root => Ok(StoreAccountRef::root(address)),
+        SecretVaultRef::Vault(name) => Ok(StoreAccountRef::vault(&name, address)),
+    }
+}
+
+fn format_accounts(accounts: &[Address]) -> String {
+    accounts
+        .iter()
+        .enumerate()
+        .map(|(i, a)| format!("{:2}: 0x{:x}", i, a))
+        .collect::<Vec<String>>()
+        .join("\n")
+}
+
+fn format_vaults(vaults: &[String]) -> String {
+    vaults.join("\n")
+}
+
+fn load_password(path: &str) -> Result<Password, Error> {
+    let mut file = fs::File::open(path).map_err(|e| {
+        ethstore::Error::Custom(format!("Error opening password file '{}': {}", path, e))
+    })?;
+    let mut password = String::new();
+    file.read_to_string(&mut password).map_err(|e| {
+        ethstore::Error::Custom(format!("Error reading password file '{}': {}", path, e))
+    })?;
+    // drop EOF
+    let _ = password.pop();
+    Ok(password.into())
+}
+
+fn execute<S, I>(command: I) -> Result<String, Error>
+where
+    I: IntoIterator<Item = S>,
+    S: AsRef<str>,
+{
+    let args: Args = Docopt::new(USAGE).and_then(|d| d.argv(command).deserialize())?;
+
+    let store = EthStore::open(key_dir(&args.flag_dir, None)?)?;
+
+    return if args.cmd_insert {
+        let secret = args
+            .arg_secret
+            .parse()
+            .map_err(|_| ethstore::Error::InvalidSecret)?;
+        let password = load_password(&args.arg_password)?;
+        let vault_ref = open_args_vault(&store, &args)?;
+        let account_ref = store.insert_account(vault_ref, secret, &password)?;
+        Ok(format!("0x{:x}", account_ref.address))
+    } else if args.cmd_change_pwd {
+        let address = args
+            .arg_address
+            .parse()
+            .map_err(|_| ethstore::Error::InvalidAccount)?;
+        let old_pwd = load_password(&args.arg_old_pwd)?;
+        let new_pwd = load_password(&args.arg_new_pwd)?;
+        let account_ref = open_args_vault_account(&store, address, &args)?;
+        let ok = store
+            .change_password(&account_ref, &old_pwd, &new_pwd)
+            .is_ok();
+        Ok(format!("{}", ok))
+    } else if args.cmd_list {
+        let vault_ref = open_args_vault(&store, &args)?;
+        let accounts = store.accounts()?;
+        let accounts: Vec<_> = accounts
+            .into_iter()
+            .filter(|a| &a.vault == &vault_ref)
+            .map(|a| a.address)
+            .collect();
+        Ok(format_accounts(&accounts))
+    } else if args.cmd_import {
+        let password = match args.arg_password.as_ref() {
+            "" => None,
+            _ => Some(load_password(&args.arg_password)?),
+        };
+        let src = key_dir(&args.flag_src, password)?;
+        let dst = key_dir(&args.flag_dir, None)?;
+
+        let accounts = import_accounts(&*src, &*dst)?;
+        Ok(format_accounts(&accounts))
+    } else if args.cmd_import_wallet {
+        let wallet = PresaleWallet::open(&args.arg_path)?;
+        let password = load_password(&args.arg_password)?;
+        let kp = wallet.decrypt(&password)?;
+        let vault_ref = open_args_vault(&store, &args)?;
+        let account_ref = store.insert_account(vault_ref, kp.secret().clone(), &password)?;
+        Ok(format!("0x{:x}", account_ref.address))
+    } else if args.cmd_find_wallet_pass {
+        let passwords = load_password(&args.arg_password)?;
+        let passwords = passwords
+            .as_str()
+            .lines()
+            .map(|line| str::to_owned(line).into())
+            .collect::<VecDeque<_>>();
+        crack::run(passwords, &args.arg_path)?;
+        Ok(format!("Password not found."))
+    } else if args.cmd_remove {
+        let address = args
+            .arg_address
+            .parse()
+            .map_err(|_| ethstore::Error::InvalidAccount)?;
+        let password = load_password(&args.arg_password)?;
+        let account_ref = open_args_vault_account(&store, address, &args)?;
+        let ok = store.remove_account(&account_ref, &password).is_ok();
+        Ok(format!("{}", ok))
+    } else if args.cmd_sign {
+        let address = args
+            .arg_address
+            .parse()
+            .map_err(|_| ethstore::Error::InvalidAccount)?;
+        let message = args
+            .arg_message
+            .parse()
+            .map_err(|_| ethstore::Error::InvalidMessage)?;
+        let password = load_password(&args.arg_password)?;
+        let account_ref = open_args_vault_account(&store, address, &args)?;
+        let signature = store.sign(&account_ref, &password, &message)?;
+        Ok(format!("0x{}", signature))
+    } else if args.cmd_public {
+        let address = args
+            .arg_address
+            .parse()
+            .map_err(|_| ethstore::Error::InvalidAccount)?;
+        let password = load_password(&args.arg_password)?;
+        let account_ref = open_args_vault_account(&store, address, &args)?;
+        let public = store.public(&account_ref, &password)?;
+        Ok(format!("0x{:x}", public))
+    } else if args.cmd_list_vaults {
+        let vaults = store.list_vaults()?;
+        Ok(format_vaults(&vaults))
+    } else if args.cmd_create_vault {
+        let password = load_password(&args.arg_password)?;
+        store.create_vault(&args.arg_vault, &password)?;
+        Ok("OK".to_owned())
+    } else if args.cmd_change_vault_pwd {
+        let old_pwd = load_password(&args.arg_old_pwd)?;
+        let new_pwd = load_password(&args.arg_new_pwd)?;
+        store.open_vault(&args.arg_vault, &old_pwd)?;
+        store.change_vault_password(&args.arg_vault, &new_pwd)?;
+        Ok("OK".to_owned())
+    } else if args.cmd_move_to_vault {
+        let address = args
+            .arg_address
+            .parse()
+            .map_err(|_| ethstore::Error::InvalidAccount)?;
+        let password = load_password(&args.arg_password)?;
+        let account_ref = open_args_vault_account(&store, address, &args)?;
+        store.open_vault(&args.arg_vault, &password)?;
+        store.change_account_vault(SecretVaultRef::Vault(args.arg_vault), account_ref)?;
+        Ok("OK".to_owned())
+    } else if args.cmd_move_from_vault {
+        let address = args
+            .arg_address
+            .parse()
+            .map_err(|_| ethstore::Error::InvalidAccount)?;
+        let password = load_password(&args.arg_password)?;
+        store.open_vault(&args.arg_vault, &password)?;
+        store.change_account_vault(
+            SecretVaultRef::Root,
+            StoreAccountRef::vault(&args.arg_vault, address),
+        )?;
+        Ok("OK".to_owned())
+    } else {
+        Ok(format!("{}", USAGE))
+    };
+}

bin/evmbin/Cargo.toml

@@ -0,0 +1,33 @@
+[package]
+description = "Parity EVM Implementation"
+name = "evmbin"
+version = "0.1.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+
+[[bin]]
+name = "openethereum-evm"
+path = "./src/main.rs"
+
+[dependencies]
+common-types = { path = "../../crates/ethcore/types", features = ["test-helpers"] }
+docopt = "1.0"
+env_logger = "0.5"
+ethcore = { path = "../../crates/ethcore", features = ["test-helpers", "json-tests", "to-pod-full"] }
+ethereum-types = "0.9.2"
+ethjson = { path = "../../crates/ethjson" }
+evm = { path = "../../crates/vm/evm" }
+panic_hook = { path = "../../crates/util/panic-hook" }
+parity-bytes = "0.1"
+rustc-hex = "1.0"
+serde = "1.0"
+serde_derive = "1.0"
+serde_json = "1.0"
+vm = { path = "../../crates/vm/vm" }
+
+[dev-dependencies]
+criterion = "0.3.0"
+pretty_assertions = "0.1"
+tempdir = "0.3"
+
+[features]
+evm-debug = ["ethcore/evm-debug-tests"]

bin/evmbin/README.md

@@ -0,0 +1,60 @@
+## evmbin
+
+EVM implementation for OpenEthereum.
+
+### Usage
+
+```
+EVM implementation for Parity.
+  Copyright 2015-2020 Parity Technologies (UK) Ltd.
+
+Usage:
+    openethereum-evm state-test <file> [--json --std-json --std-dump-json --only NAME --chain CHAIN --std-out-only --std-err-only --omit-storage-output --omit-memory-output]
+    openethereum-evm stats [options]
+    openethereum-evm stats-jsontests-vm <file>
+    openethereum-evm [options]
+    openethereum-evm [-h | --help]
+
+Commands:
+    state-test         Run a state test from a json file.
+    stats              Execute EVM runtime code and return the statistics.
+    stats-jsontests-vm Execute standard json-tests format VMTests and return
+                       timing statistics in tsv format.
+
+Transaction options:
+    --code CODE        Contract code as hex (without 0x).
+    --to ADDRESS       Recipient address (without 0x).
+    --from ADDRESS     Sender address (without 0x).
+    --input DATA       Input data as hex (without 0x).
+    --gas GAS          Supplied gas as hex (without 0x).
+    --gas-price WEI    Supplied gas price as hex (without 0x).
+
+State test options:
+    --chain CHAIN      Run only from specific chain name (i.e. one of EIP150, EIP158,
+                       Frontier, Homestead, Byzantium, Constantinople,
+                       ConstantinopleFix, Istanbul, EIP158ToByzantiumAt5, FrontierToHomesteadAt5,
+                       HomesteadToDaoAt5, HomesteadToEIP150At5, Berlin, Yolo3).
+    --only NAME        Runs only a single test matching the name.
+
+General options:
+    --json                    Display verbose results in JSON.
+    --std-json                Display results in standardized JSON format.
+    --std-err-only            With --std-json redirect to err output only.
+    --std-out-only            With --std-json redirect to out output only.
+    --omit-storage-output     With --std-json omit storage output.
+    --omit-memory-output      With --std-json omit memory output.
+    --std-dump-json           Display results in standardized JSON format
+                              with additional state dump.
+
+Display result state dump in standardized JSON format.
+    --chain CHAIN      Chain spec file path.
+    -h, --help         Display this message and exit.
+```
+
+## OpenEthereum toolchain
+_This project is a part of the OpenEthereum toolchain._
+
+- [evmbin](https://github.com/openethereum/openethereum/blob/master/evmbin/) - EVM implementation for OpenEthereum
+- [ethabi](https://github.com/openethereum/ethabi) - OpenEthereum function calls encoding.
+- [ethstore](https://github.com/openethereum/openethereum/blob/master/accounts/ethstore) - OpenEthereum key management.
+- [ethkey](https://github.com/openethereum/openethereum/blob/master/accounts/ethkey) - OpenEthereum keys generator.

bin/evmbin/benches/mod.rs

@@ -0,0 +1,98 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! benchmarking for EVM
+//! should be started with:
+//! ```bash
+//! cargo bench
+//! ```
+
+#[macro_use]
+extern crate criterion;
+extern crate ethcore;
+extern crate ethereum_types;
+extern crate evm;
+extern crate rustc_hex;
+extern crate vm;
+
+use criterion::{black_box, Criterion};
+use std::sync::Arc;
+
+use ethereum_types::U256;
+use evm::Factory;
+use rustc_hex::FromHex;
+use vm::{tests::FakeExt, ActionParams, Ext};
+
+criterion_group!(
+    evmbin,
+    bench_simple_loop_usize,
+    bench_simple_loop_u256,
+    bench_rng_usize,
+    bench_rng_u256
+);
+criterion_main!(evmbin);
+
+fn bench_simple_loop_usize(c: &mut Criterion) {
+    simple_loop(U256::from(::std::usize::MAX), c, "simple_loop_usize")
+}
+
+fn bench_simple_loop_u256(c: &mut Criterion) {
+    simple_loop(!U256::zero(), c, "simple_loop_u256")
+}
+
+fn simple_loop(gas: U256, c: &mut Criterion, bench_id: &str) {
+    let code = black_box(
+		"606060405260005b620042408112156019575b6001016007565b600081905550600680602b6000396000f3606060405200".from_hex().unwrap()
+	);
+
+    c.bench_function(bench_id, move |b| {
+        b.iter(|| {
+            let mut params = ActionParams::default();
+            params.gas = gas;
+            params.code = Some(Arc::new(code.clone()));
+
+            let mut ext = FakeExt::new();
+            let evm = Factory::default().create(params, ext.schedule(), ext.depth());
+            let _ = evm.exec(&mut ext);
+        })
+    });
+}
+
+fn bench_rng_usize(c: &mut Criterion) {
+    rng(U256::from(::std::usize::MAX), c, "rng_usize")
+}
+
+fn bench_rng_u256(c: &mut Criterion) {
+    rng(!U256::zero(), c, "rng_u256")
+}
+
+fn rng(gas: U256, c: &mut Criterion, bench_id: &str) {
+    let code = black_box(
+		"6060604052600360056007600b60005b62004240811215607f5767ffe7649d5eca84179490940267f47ed85c4b9a6379019367f8e5dd9a5c994bba9390930267f91d87e4b8b74e55019267ff97f6f3b29cda529290920267f393ada8dd75c938019167fe8d437c45bb3735830267f47d9a7b5428ffec019150600101600f565b838518831882186000555050505050600680609a6000396000f3606060405200".from_hex().unwrap()
+	);
+
+    c.bench_function(bench_id, move |b| {
+        b.iter(|| {
+            let mut params = ActionParams::default();
+            params.gas = gas;
+            params.code = Some(Arc::new(code.clone()));
+
+            let mut ext = FakeExt::new();
+            let evm = Factory::default().create(params, ext.schedule(), ext.depth());
+            let _ = evm.exec(&mut ext);
+        })
+    });
+}

bin/evmbin/res/testchain.json

@@ -0,0 +1,38 @@
+{
+    "name": "lab",
+    "engine": {
+        "Ethash": {
+			"params": {
+				"minimumDifficulty": "0x1",
+				"difficultyBoundDivisor": "0x800"
+			}
+		}
+    },
+    "accounts": {
+        "0000000000000000000000000000000000000020": {
+            "nonce": "0x0",
+            "balance": "0x64",
+            "code": "0x62aaaaaa60aa60aa5060aa60aa60aa60aa60aa60aa"
+        }
+    },
+	"params":{
+		"networkID": "0x42",
+		"maximumExtraDataSize": "0x20",
+		"minGasLimit": "0x1",
+		"gasLimitBoundDivisor": "0x400"
+	},
+	"genesis": {
+		"gasLimit": "0x8000000",
+		"seal": {
+			"ethereum": {
+				"mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
+				"nonce": "0x0000000000000042"
+			}
+		},
+		"difficulty": "0x400",
+		"extraData": "0x0",
+		"author": "0x3333333333333333333333333333333333333333",
+		"timestamp": "0x0",
+		"parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000"
+	}
+}

bin/evmbin/src/display/config.rs

@@ -0,0 +1,40 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Config used by display informants
+
+#[derive(Default, Copy, Clone, Debug)]
+pub struct Config {
+    omit_storage_output: bool,
+    omit_memory_output: bool,
+}
+
+impl Config {
+    pub fn new(omit_storage_output: bool, omit_memory_output: bool) -> Config {
+        Config {
+            omit_storage_output,
+            omit_memory_output,
+        }
+    }
+
+    pub fn omit_storage_output(&self) -> bool {
+        self.omit_storage_output
+    }
+
+    pub fn omit_memory_output(&self) -> bool {
+        self.omit_memory_output
+    }
+}

bin/evmbin/src/display/json.rs

@@ -0,0 +1,425 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! JSON VM output.
+
+use std::{collections::HashMap, mem};
+
+use super::config::Config;
+use bytes::ToPretty;
+use display;
+use ethcore::trace;
+use ethereum_types::{BigEndianHash, H256, U256};
+use info as vm;
+
+/// JSON formatting informant.
+#[derive(Default)]
+pub struct Informant {
+    code: Vec<u8>,
+    depth: usize,
+    pc: usize,
+    instruction: u8,
+    gas_cost: U256,
+    gas_used: U256,
+    mem_written: Option<(usize, usize)>,
+    store_written: Option<(U256, U256)>,
+    stack: Vec<U256>,
+    memory: Vec<u8>,
+    storage: HashMap<H256, H256>,
+    traces: Vec<String>,
+    subtraces: Vec<String>,
+    subinfos: Vec<Informant>,
+    subdepth: usize,
+    unmatched: bool,
+    config: Config,
+}
+
+impl Informant {
+    pub fn new(config: Config) -> Informant {
+        let mut def = Informant::default();
+        def.config = config;
+        def
+    }
+
+    fn with_informant_in_depth<F: Fn(&mut Informant)>(
+        informant: &mut Informant,
+        depth: usize,
+        f: F,
+    ) {
+        if depth == 0 {
+            f(informant);
+        } else {
+            Self::with_informant_in_depth(
+                informant
+                    .subinfos
+                    .last_mut()
+                    .expect("prepare/done_trace are not balanced"),
+                depth - 1,
+                f,
+            );
+        }
+    }
+
+    fn informant_trace(informant: &Informant, gas_used: U256) -> String {
+        let memory = if informant.config.omit_memory_output() {
+            "".to_string()
+        } else {
+            format!("0x{}", informant.memory.to_hex())
+        };
+        let storage = if informant.config.omit_storage_output() {
+            None
+        } else {
+            Some(&informant.storage)
+        };
+        let info = ::evm::Instruction::from_u8(informant.instruction).map(|i| i.info());
+        json!({
+            "pc": informant.pc,
+            "op": informant.instruction,
+            "opName": info.map(|i| i.name).unwrap_or(""),
+            "gas": format!("{:#x}", gas_used.saturating_add(informant.gas_cost)),
+            "gasCost": format!("{:#x}", informant.gas_cost),
+            "memory": memory,
+            "stack": informant.stack,
+            "storage": storage,
+            "depth": informant.depth,
+        })
+        .to_string()
+    }
+}
+
+impl vm::Informant for Informant {
+    type Sink = Config;
+
+    fn before_test(&mut self, name: &str, action: &str) {
+        println!("{}", json!({"action": action, "test": name}));
+    }
+
+    fn set_gas(&mut self, gas: U256) {
+        self.gas_used = gas;
+    }
+
+    fn clone_sink(&self) -> Self::Sink {
+        self.config
+    }
+
+    fn finish(result: vm::RunResult<Self::Output>, config: &mut Self::Sink) {
+        match result {
+            Ok(success) => {
+                for trace in success.traces.unwrap_or_else(Vec::new) {
+                    println!("{}", trace);
+                }
+
+                let success_msg = json!({
+                    "output": format!("0x{}", success.output.to_hex()),
+                    "gasUsed": format!("{:#x}", success.gas_used),
+                    "time": display::as_micros(&success.time),
+                });
+
+                println!("{}", success_msg)
+            }
+            Err(failure) => {
+                if !config.omit_storage_output() {
+                    for trace in failure.traces.unwrap_or_else(Vec::new) {
+                        println!("{}", trace);
+                    }
+                }
+
+                let failure_msg = json!({
+                    "error": &failure.error.to_string(),
+                    "gasUsed": format!("{:#x}", failure.gas_used),
+                    "time": display::as_micros(&failure.time),
+                });
+
+                println!("{}", failure_msg)
+            }
+        }
+    }
+}
+
+impl trace::VMTracer for Informant {
+    type Output = Vec<String>;
+
+    fn trace_next_instruction(&mut self, pc: usize, instruction: u8, _current_gas: U256) -> bool {
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant| {
+            informant.pc = pc;
+            informant.instruction = instruction;
+            informant.unmatched = true;
+        });
+        true
+    }
+
+    fn trace_prepare_execute(
+        &mut self,
+        pc: usize,
+        instruction: u8,
+        gas_cost: U256,
+        mem_written: Option<(usize, usize)>,
+        store_written: Option<(U256, U256)>,
+    ) {
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant| {
+            informant.pc = pc;
+            informant.instruction = instruction;
+            informant.gas_cost = gas_cost;
+            informant.mem_written = mem_written;
+            informant.store_written = store_written;
+        });
+    }
+
+    fn trace_executed(&mut self, gas_used: U256, stack_push: &[U256], mem: &[u8]) {
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant| {
+            let store_diff = informant.store_written.clone();
+            let info = ::evm::Instruction::from_u8(informant.instruction).map(|i| i.info());
+
+            let trace = Self::informant_trace(informant, gas_used);
+            informant.traces.push(trace);
+
+            informant.unmatched = false;
+            informant.gas_used = gas_used;
+
+            let len = informant.stack.len();
+            let info_args = info.map(|i| i.args).unwrap_or(0);
+            informant
+                .stack
+                .truncate(if len > info_args { len - info_args } else { 0 });
+            informant.stack.extend_from_slice(stack_push);
+
+            // TODO [ToDr] Align memory?
+            if let Some((pos, size)) = informant.mem_written.clone() {
+                if informant.memory.len() < (pos + size) {
+                    informant.memory.resize(pos + size, 0);
+                }
+                informant.memory[pos..(pos + size)].copy_from_slice(&mem[pos..(pos + size)]);
+            }
+
+            if let Some((pos, val)) = store_diff {
+                informant.storage.insert(
+                    BigEndianHash::from_uint(&pos),
+                    BigEndianHash::from_uint(&val),
+                );
+            }
+
+            if !informant.subtraces.is_empty() {
+                informant
+                    .traces
+                    .extend(mem::replace(&mut informant.subtraces, vec![]));
+            }
+        });
+    }
+
+    fn prepare_subtrace(&mut self, code: &[u8]) {
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant| {
+            let mut vm = Informant::default();
+            vm.config = informant.config;
+            vm.depth = informant.depth + 1;
+            vm.code = code.to_vec();
+            vm.gas_used = informant.gas_used;
+            informant.subinfos.push(vm);
+        });
+        self.subdepth += 1;
+    }
+
+    fn done_subtrace(&mut self) {
+        self.subdepth -= 1;
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant| {
+            if let Some(subtraces) = informant
+                .subinfos
+                .pop()
+                .expect("prepare/done_subtrace are not balanced")
+                .drain()
+            {
+                informant.subtraces.extend(subtraces);
+            }
+        });
+    }
+
+    fn drain(mut self) -> Option<Self::Output> {
+        if self.unmatched {
+            // print last line with final state:
+            self.gas_cost = 0.into();
+            let gas_used = self.gas_used;
+            let subdepth = self.subdepth;
+
+            Self::with_informant_in_depth(&mut self, subdepth, |informant: &mut Informant| {
+                let trace = Self::informant_trace(informant, gas_used);
+                informant.traces.push(trace);
+            });
+        } else if !self.subtraces.is_empty() {
+            self.traces
+                .extend(mem::replace(&mut self.subtraces, vec![]));
+        }
+        Some(self.traces)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use info::tests::run_test;
+    use serde_json;
+
+    #[derive(Serialize, Deserialize, Debug, PartialEq)]
+    #[serde(rename_all = "camelCase")]
+    struct TestTrace {
+        pc: usize,
+        #[serde(rename = "op")]
+        instruction: u8,
+        op_name: String,
+        #[serde(rename = "gas")]
+        gas_used: U256,
+        gas_cost: U256,
+        memory: String,
+        stack: Vec<U256>,
+        storage: Option<HashMap<H256, H256>>,
+        depth: usize,
+    }
+
+    fn assert_traces_eq(a: &[String], b: &[String]) {
+        let mut ita = a.iter();
+        let mut itb = b.iter();
+
+        loop {
+            match (ita.next(), itb.next()) {
+                (Some(a), Some(b)) => {
+                    // Compare both without worrying about the order of the fields
+                    let actual: TestTrace = serde_json::from_str(a).unwrap();
+                    let expected: TestTrace = serde_json::from_str(b).unwrap();
+                    assert_eq!(actual, expected);
+                    println!("{}", a);
+                }
+                (None, None) => return,
+                e => {
+                    panic!("Traces mismatch: {:?}", e);
+                }
+            }
+        }
+    }
+
+    fn compare_json(traces: Option<Vec<String>>, expected: &str) {
+        let expected = expected
+            .split("\n")
+            .map(|x| x.trim())
+            .map(|x| x.to_owned())
+            .filter(|x| !x.is_empty())
+            .collect::<Vec<_>>();
+        assert_traces_eq(&traces.unwrap(), &expected);
+    }
+
+    #[test]
+    fn should_trace_failure() {
+        run_test(
+            Informant::default(),
+            &compare_json,
+            "60F8d6",
+            0xffff,
+            r#"
+{"pc":0,"op":96,"opName":"PUSH1","gas":"0xffff","gasCost":"0x3","memory":"0x","stack":[],"storage":{},"depth":1}
+{"pc":2,"op":214,"opName":"","gas":"0xfffc","gasCost":"0x0","memory":"0x","stack":["0xf8"],"storage":{},"depth":1}
+			"#,
+        );
+
+        run_test(
+            Informant::default(),
+            &compare_json,
+            "F8d6",
+            0xffff,
+            r#"
+{"pc":0,"op":248,"opName":"","gas":"0xffff","gasCost":"0x0","memory":"0x","stack":[],"storage":{},"depth":1}
+			"#,
+        );
+
+        run_test(
+            Informant::default(),
+            &compare_json,
+            "5A51",
+            0xfffff,
+            r#"
+{"depth":1,"gas":"0xfffff","gasCost":"0x2","memory":"0x","op":90,"opName":"GAS","pc":0,"stack":[],"storage":{}}
+{"depth":1,"gas":"0xffffd","gasCost":"0x0","memory":"0x","op":81,"opName":"MLOAD","pc":1,"stack":["0xffffd"],"storage":{}}
+			"#,
+        );
+    }
+
+    #[test]
+    fn should_trace_create_correctly() {
+        run_test(
+            Informant::default(),
+            &compare_json,
+            "32343434345830f138343438323439f0",
+            0xffff,
+            r#"
+{"pc":0,"op":50,"opName":"ORIGIN","gas":"0xffff","gasCost":"0x2","memory":"0x","stack":[],"storage":{},"depth":1}
+{"pc":1,"op":52,"opName":"CALLVALUE","gas":"0xfffd","gasCost":"0x2","memory":"0x","stack":["0x0"],"storage":{},"depth":1}
+{"pc":2,"op":52,"opName":"CALLVALUE","gas":"0xfffb","gasCost":"0x2","memory":"0x","stack":["0x0","0x0"],"storage":{},"depth":1}
+{"pc":3,"op":52,"opName":"CALLVALUE","gas":"0xfff9","gasCost":"0x2","memory":"0x","stack":["0x0","0x0","0x0"],"storage":{},"depth":1}
+{"pc":4,"op":52,"opName":"CALLVALUE","gas":"0xfff7","gasCost":"0x2","memory":"0x","stack":["0x0","0x0","0x0","0x0"],"storage":{},"depth":1}
+{"pc":5,"op":88,"opName":"PC","gas":"0xfff5","gasCost":"0x2","memory":"0x","stack":["0x0","0x0","0x0","0x0","0x0"],"storage":{},"depth":1}
+{"pc":6,"op":48,"opName":"ADDRESS","gas":"0xfff3","gasCost":"0x2","memory":"0x","stack":["0x0","0x0","0x0","0x0","0x0","0x5"],"storage":{},"depth":1}
+{"pc":7,"op":241,"opName":"CALL","gas":"0xfff1","gasCost":"0x61d0","memory":"0x","stack":["0x0","0x0","0x0","0x0","0x0","0x5","0x0"],"storage":{},"depth":1}
+{"pc":8,"op":56,"opName":"CODESIZE","gas":"0x9e21","gasCost":"0x2","memory":"0x","stack":["0x1"],"storage":{},"depth":1}
+{"pc":9,"op":52,"opName":"CALLVALUE","gas":"0x9e1f","gasCost":"0x2","memory":"0x","stack":["0x1","0x10"],"storage":{},"depth":1}
+{"pc":10,"op":52,"opName":"CALLVALUE","gas":"0x9e1d","gasCost":"0x2","memory":"0x","stack":["0x1","0x10","0x0"],"storage":{},"depth":1}
+{"pc":11,"op":56,"opName":"CODESIZE","gas":"0x9e1b","gasCost":"0x2","memory":"0x","stack":["0x1","0x10","0x0","0x0"],"storage":{},"depth":1}
+{"pc":12,"op":50,"opName":"ORIGIN","gas":"0x9e19","gasCost":"0x2","memory":"0x","stack":["0x1","0x10","0x0","0x0","0x10"],"storage":{},"depth":1}
+{"pc":13,"op":52,"opName":"CALLVALUE","gas":"0x9e17","gasCost":"0x2","memory":"0x","stack":["0x1","0x10","0x0","0x0","0x10","0x0"],"storage":{},"depth":1}
+{"pc":14,"op":57,"opName":"CODECOPY","gas":"0x9e15","gasCost":"0x9","memory":"0x","stack":["0x1","0x10","0x0","0x0","0x10","0x0","0x0"],"storage":{},"depth":1}
+{"pc":15,"op":240,"opName":"CREATE","gas":"0x9e0c","gasCost":"0x9e0c","memory":"0x32343434345830f138343438323439f0","stack":["0x1","0x10","0x0","0x0"],"storage":{},"depth":1}
+{"pc":0,"op":50,"opName":"ORIGIN","gas":"0x210c","gasCost":"0x2","memory":"0x","stack":[],"storage":{},"depth":2}
+{"pc":1,"op":52,"opName":"CALLVALUE","gas":"0x210a","gasCost":"0x2","memory":"0x","stack":["0x0"],"storage":{},"depth":2}
+{"pc":2,"op":52,"opName":"CALLVALUE","gas":"0x2108","gasCost":"0x2","memory":"0x","stack":["0x0","0x0"],"storage":{},"depth":2}
+{"pc":3,"op":52,"opName":"CALLVALUE","gas":"0x2106","gasCost":"0x2","memory":"0x","stack":["0x0","0x0","0x0"],"storage":{},"depth":2}
+{"pc":4,"op":52,"opName":"CALLVALUE","gas":"0x2104","gasCost":"0x2","memory":"0x","stack":["0x0","0x0","0x0","0x0"],"storage":{},"depth":2}
+{"pc":5,"op":88,"opName":"PC","gas":"0x2102","gasCost":"0x2","memory":"0x","stack":["0x0","0x0","0x0","0x0","0x0"],"storage":{},"depth":2}
+{"pc":6,"op":48,"opName":"ADDRESS","gas":"0x2100","gasCost":"0x2","memory":"0x","stack":["0x0","0x0","0x0","0x0","0x0","0x5"],"storage":{},"depth":2}
+{"pc":7,"op":241,"opName":"CALL","gas":"0x20fe","gasCost":"0x0","memory":"0x","stack":["0x0","0x0","0x0","0x0","0x0","0x5","0xbd770416a3345f91e4b34576cb804a576fa48eb1"],"storage":{},"depth":2}
+"#,
+        );
+
+        run_test(
+            Informant::default(),
+            &compare_json,
+            "3260D85554",
+            0xffff,
+            r#"
+{"pc":0,"op":50,"opName":"ORIGIN","gas":"0xffff","gasCost":"0x2","memory":"0x","stack":[],"storage":{},"depth":1}
+{"pc":1,"op":96,"opName":"PUSH1","gas":"0xfffd","gasCost":"0x3","memory":"0x","stack":["0x0"],"storage":{},"depth":1}
+{"pc":3,"op":85,"opName":"SSTORE","gas":"0xfffa","gasCost":"0x1388","memory":"0x","stack":["0x0","0xd8"],"storage":{},"depth":1}
+{"pc":4,"op":84,"opName":"SLOAD","gas":"0xec72","gasCost":"0x0","memory":"0x","stack":[],"storage":{"0x00000000000000000000000000000000000000000000000000000000000000d8":"0x0000000000000000000000000000000000000000000000000000000000000000"},"depth":1}
+"#,
+        );
+    }
+
+    #[test]
+    fn should_omit_storage_and_memory_flag() {
+        // should omit storage
+        run_test(
+            Informant::new(Config::new(true, true)),
+            &compare_json,
+            "3260D85554",
+            0xffff,
+            r#"
+{"pc":0,"op":50,"opName":"ORIGIN","gas":"0xffff","gasCost":"0x2","memory":"","stack":[],"storage":null,"depth":1}
+{"pc":1,"op":96,"opName":"PUSH1","gas":"0xfffd","gasCost":"0x3","memory":"","stack":["0x0"],"storage":null,"depth":1}
+{"pc":3,"op":85,"opName":"SSTORE","gas":"0xfffa","gasCost":"0x1388","memory":"","stack":["0x0","0xd8"],"storage":null,"depth":1}
+{"pc":4,"op":84,"opName":"SLOAD","gas":"0xec72","gasCost":"0x0","memory":"","stack":[],"storage":null,"depth":1}
+"#,
+        )
+    }
+}

bin/evmbin/src/display/mod.rs

@@ -0,0 +1,34 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! VM Output display utils.
+
+use std::time::Duration;
+
+pub mod config;
+pub mod json;
+pub mod simple;
+pub mod std_json;
+
+/// Formats duration into human readable format.
+pub fn format_time(time: &Duration) -> String {
+    format!("{}.{:.9}s", time.as_secs(), time.subsec_nanos())
+}
+
+/// Formats the time as microseconds.
+pub fn as_micros(time: &Duration) -> u64 {
+    time.as_secs() * 1_000_000 + time.subsec_nanos() as u64 / 1_000
+}

bin/evmbin/src/display/simple.rs

@@ -0,0 +1,74 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Simple VM output.
+
+use super::config::Config;
+use bytes::ToPretty;
+use ethcore::trace;
+
+use display;
+use info as vm;
+
+/// Simple formatting informant.
+#[derive(Default)]
+pub struct Informant {
+    config: Config,
+}
+
+impl Informant {
+    pub fn new(config: Config) -> Informant {
+        Informant { config }
+    }
+}
+
+impl vm::Informant for Informant {
+    type Sink = Config;
+
+    fn before_test(&mut self, name: &str, action: &str) {
+        println!("Test: {} ({})", name, action);
+    }
+
+    fn clone_sink(&self) -> Self::Sink {
+        self.config
+    }
+
+    fn finish(result: vm::RunResult<Self::Output>, _sink: &mut Self::Sink) {
+        match result {
+            Ok(success) => {
+                println!("Output: 0x{}", success.output.to_hex());
+                println!("Gas used: {:x}", success.gas_used);
+                println!("Time: {}", display::format_time(&success.time));
+            }
+            Err(failure) => {
+                println!("Error: {}", failure.error);
+                println!("Time: {}", display::format_time(&failure.time));
+            }
+        }
+    }
+}
+
+impl trace::VMTracer for Informant {
+    type Output = ();
+
+    fn prepare_subtrace(&mut self, _code: &[u8]) {
+        Default::default()
+    }
+    fn done_subtrace(&mut self) {}
+    fn drain(self) -> Option<()> {
+        None
+    }
+}

bin/evmbin/src/display/std_json.rs

@@ -0,0 +1,413 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Standardized JSON VM output.
+
+use std::{collections::HashMap, io};
+
+use super::config::Config;
+use bytes::ToPretty;
+use display;
+use ethcore::{pod_state, trace};
+use ethereum_types::{BigEndianHash, H256, U256};
+use info as vm;
+
+pub trait Writer: io::Write + Send + Sized {
+    fn clone(&self) -> Self;
+    fn default() -> Self;
+}
+
+impl Writer for io::Stdout {
+    fn clone(&self) -> Self {
+        io::stdout()
+    }
+
+    fn default() -> Self {
+        io::stdout()
+    }
+}
+
+impl Writer for io::Stderr {
+    fn clone(&self) -> Self {
+        io::stderr()
+    }
+
+    fn default() -> Self {
+        io::stderr()
+    }
+}
+
+/// JSON formatting informant.
+pub struct Informant<Trace, Out> {
+    code: Vec<u8>,
+    instruction: u8,
+    depth: usize,
+    stack: Vec<U256>,
+    storage: HashMap<H256, H256>,
+    subinfos: Vec<Informant<Trace, Out>>,
+    subdepth: usize,
+    trace_sink: Trace,
+    out_sink: Out,
+    config: Config,
+}
+
+impl Default for Informant<io::Stderr, io::Stdout> {
+    fn default() -> Self {
+        Self::new(io::stderr(), io::stdout(), Config::default())
+    }
+}
+
+impl Informant<io::Stdout, io::Stdout> {
+    /// std json informant using out only.
+    pub fn out_only(config: Config) -> Self {
+        Self::new(io::stdout(), io::stdout(), config)
+    }
+}
+
+impl Informant<io::Stderr, io::Stderr> {
+    /// std json informant using err only.
+    pub fn err_only(config: Config) -> Self {
+        Self::new(io::stderr(), io::stderr(), config)
+    }
+}
+
+impl Informant<io::Stderr, io::Stdout> {
+    pub fn new_default(config: Config) -> Self {
+        let mut informant = Self::default();
+        informant.config = config;
+        informant
+    }
+}
+
+impl<Trace: Writer, Out: Writer> Informant<Trace, Out> {
+    pub fn new(trace_sink: Trace, out_sink: Out, config: Config) -> Self {
+        Informant {
+            code: Default::default(),
+            instruction: Default::default(),
+            depth: Default::default(),
+            stack: Default::default(),
+            storage: Default::default(),
+            subinfos: Default::default(),
+            subdepth: 0,
+            trace_sink,
+            out_sink,
+            config,
+        }
+    }
+
+    fn with_informant_in_depth<F: Fn(&mut Informant<Trace, Out>)>(
+        informant: &mut Informant<Trace, Out>,
+        depth: usize,
+        f: F,
+    ) {
+        if depth == 0 {
+            f(informant);
+        } else {
+            Self::with_informant_in_depth(
+                informant
+                    .subinfos
+                    .last_mut()
+                    .expect("prepare/done_trace are not balanced"),
+                depth - 1,
+                f,
+            );
+        }
+    }
+
+    fn dump_state_into(
+        trace_sink: &mut Trace,
+        root: H256,
+        end_state: &Option<pod_state::PodState>,
+    ) {
+        if let Some(ref end_state) = end_state {
+            let dump_data = json!({
+                "root": root,
+                "accounts": end_state,
+            });
+            writeln!(trace_sink, "{}", dump_data).expect("The sink must be writeable.");
+        }
+    }
+}
+
+impl<Trace: Writer, Out: Writer> vm::Informant for Informant<Trace, Out> {
+    type Sink = (Trace, Out, Config);
+
+    fn before_test(&mut self, name: &str, action: &str) {
+        let out_data = json!({
+            "action": action,
+            "test": name,
+        });
+
+        writeln!(&mut self.out_sink, "{}", out_data).expect("The sink must be writeable.");
+    }
+
+    fn set_gas(&mut self, _gas: U256) {}
+
+    fn clone_sink(&self) -> Self::Sink {
+        (
+            self.trace_sink.clone(),
+            self.out_sink.clone(),
+            self.config.clone(),
+        )
+    }
+    fn finish(
+        result: vm::RunResult<<Self as trace::VMTracer>::Output>,
+        (ref mut trace_sink, ref mut out_sink, _): &mut Self::Sink,
+    ) {
+        match result {
+            Ok(success) => {
+                let trace_data = json!({"stateRoot": success.state_root});
+                writeln!(trace_sink, "{}", trace_data).expect("The sink must be writeable.");
+
+                Self::dump_state_into(trace_sink, success.state_root, &success.end_state);
+
+                let out_data = json!({
+                    "output": format!("0x{}", success.output.to_hex()),
+                    "gasUsed": format!("{:#x}", success.gas_used),
+                    "time": display::as_micros(&success.time),
+                });
+
+                writeln!(out_sink, "{}", out_data).expect("The sink must be writeable.");
+            }
+            Err(failure) => {
+                let out_data = json!({
+                    "error": &failure.error.to_string(),
+                    "gasUsed": format!("{:#x}", failure.gas_used),
+                    "time": display::as_micros(&failure.time),
+                });
+
+                Self::dump_state_into(trace_sink, failure.state_root, &failure.end_state);
+
+                writeln!(out_sink, "{}", out_data).expect("The sink must be writeable.");
+            }
+        }
+    }
+}
+
+impl<Trace: Writer, Out: Writer> trace::VMTracer for Informant<Trace, Out> {
+    type Output = ();
+
+    fn trace_next_instruction(&mut self, pc: usize, instruction: u8, current_gas: U256) -> bool {
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant<Trace, Out>| {
+            let storage = if informant.config.omit_storage_output() {
+                None
+            } else {
+                Some(&informant.storage)
+            };
+            let info = ::evm::Instruction::from_u8(instruction).map(|i| i.info());
+            informant.instruction = instruction;
+            let trace_data = json!({
+                "pc": pc,
+                "op": instruction,
+                "opName": info.map(|i| i.name).unwrap_or(""),
+                "gas": format!("{:#x}", current_gas),
+                "stack": informant.stack,
+                "storage": storage,
+                "depth": informant.depth,
+            });
+
+            writeln!(&mut informant.trace_sink, "{}", trace_data)
+                .expect("The sink must be writeable.");
+        });
+        true
+    }
+
+    fn trace_prepare_execute(
+        &mut self,
+        _pc: usize,
+        _instruction: u8,
+        _gas_cost: U256,
+        _mem_written: Option<(usize, usize)>,
+        store_written: Option<(U256, U256)>,
+    ) {
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant<Trace, Out>| {
+            if let Some((pos, val)) = store_written {
+                informant.storage.insert(
+                    BigEndianHash::from_uint(&pos),
+                    BigEndianHash::from_uint(&val),
+                );
+            }
+        });
+    }
+
+    fn trace_executed(&mut self, _gas_used: U256, stack_push: &[U256], _mem: &[u8]) {
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant<Trace, Out>| {
+            let info = ::evm::Instruction::from_u8(informant.instruction).map(|i| i.info());
+
+            let len = informant.stack.len();
+            let info_args = info.map(|i| i.args).unwrap_or(0);
+            informant
+                .stack
+                .truncate(if len > info_args { len - info_args } else { 0 });
+            informant.stack.extend_from_slice(stack_push);
+        });
+    }
+
+    fn prepare_subtrace(&mut self, code: &[u8]) {
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant<Trace, Out>| {
+            let mut vm = Informant::new(
+                informant.trace_sink.clone(),
+                informant.out_sink.clone(),
+                informant.config,
+            );
+            vm.depth = informant.depth + 1;
+            vm.code = code.to_vec();
+            informant.subinfos.push(vm);
+        });
+        self.subdepth += 1;
+    }
+
+    fn done_subtrace(&mut self) {
+        self.subdepth -= 1;
+        let subdepth = self.subdepth;
+        Self::with_informant_in_depth(self, subdepth, |informant: &mut Informant<Trace, Out>| {
+            informant.subinfos.pop();
+        });
+    }
+
+    fn drain(self) -> Option<Self::Output> {
+        None
+    }
+}
+
+#[cfg(test)]
+pub mod tests {
+    use super::*;
+    use info::tests::run_test;
+    use std::sync::{Arc, Mutex};
+
+    #[derive(Debug, Clone, Default)]
+    pub struct TestWriter(pub Arc<Mutex<Vec<u8>>>);
+
+    impl Writer for TestWriter {
+        fn clone(&self) -> Self {
+            Clone::clone(self)
+        }
+        fn default() -> Self {
+            Default::default()
+        }
+    }
+
+    impl io::Write for TestWriter {
+        fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+            self.0.lock().unwrap().write(buf)
+        }
+
+        fn flush(&mut self) -> io::Result<()> {
+            self.0.lock().unwrap().flush()
+        }
+    }
+
+    pub fn informant(config: Config) -> (Informant<TestWriter, TestWriter>, Arc<Mutex<Vec<u8>>>) {
+        let trace_writer: TestWriter = Default::default();
+        let out_writer: TestWriter = Default::default();
+        let res = trace_writer.0.clone();
+        (Informant::new(trace_writer, out_writer, config), res)
+    }
+
+    #[test]
+    fn should_trace_failure() {
+        let (inf, res) = informant(Config::default());
+        run_test(
+            inf,
+            move |_, expected| {
+                let bytes = res.lock().unwrap();
+                assert_eq!(expected, &String::from_utf8_lossy(&**bytes))
+            },
+            "60F8d6",
+            0xffff,
+            r#"{"depth":1,"gas":"0xffff","op":96,"opName":"PUSH1","pc":0,"stack":[],"storage":{}}
+{"depth":1,"gas":"0xfffc","op":214,"opName":"","pc":2,"stack":["0xf8"],"storage":{}}
+"#,
+        );
+
+        let (inf, res) = informant(Config::default());
+        run_test(
+            inf,
+            move |_, expected| {
+                let bytes = res.lock().unwrap();
+                assert_eq!(expected, &String::from_utf8_lossy(&**bytes))
+            },
+            "F8d6",
+            0xffff,
+            r#"{"depth":1,"gas":"0xffff","op":248,"opName":"","pc":0,"stack":[],"storage":{}}
+"#,
+        );
+    }
+
+    #[test]
+    fn should_trace_create_correctly() {
+        let (informant, res) = informant(Config::default());
+        run_test(
+            informant,
+            move |_, expected| {
+                let bytes = res.lock().unwrap();
+                assert_eq!(expected, &String::from_utf8_lossy(&**bytes))
+            },
+            "32343434345830f138343438323439f0",
+            0xffff,
+            r#"{"depth":1,"gas":"0xffff","op":50,"opName":"ORIGIN","pc":0,"stack":[],"storage":{}}
+{"depth":1,"gas":"0xfffd","op":52,"opName":"CALLVALUE","pc":1,"stack":["0x0"],"storage":{}}
+{"depth":1,"gas":"0xfffb","op":52,"opName":"CALLVALUE","pc":2,"stack":["0x0","0x0"],"storage":{}}
+{"depth":1,"gas":"0xfff9","op":52,"opName":"CALLVALUE","pc":3,"stack":["0x0","0x0","0x0"],"storage":{}}
+{"depth":1,"gas":"0xfff7","op":52,"opName":"CALLVALUE","pc":4,"stack":["0x0","0x0","0x0","0x0"],"storage":{}}
+{"depth":1,"gas":"0xfff5","op":88,"opName":"PC","pc":5,"stack":["0x0","0x0","0x0","0x0","0x0"],"storage":{}}
+{"depth":1,"gas":"0xfff3","op":48,"opName":"ADDRESS","pc":6,"stack":["0x0","0x0","0x0","0x0","0x0","0x5"],"storage":{}}
+{"depth":1,"gas":"0xfff1","op":241,"opName":"CALL","pc":7,"stack":["0x0","0x0","0x0","0x0","0x0","0x5","0x0"],"storage":{}}
+{"depth":1,"gas":"0x9e21","op":56,"opName":"CODESIZE","pc":8,"stack":["0x1"],"storage":{}}
+{"depth":1,"gas":"0x9e1f","op":52,"opName":"CALLVALUE","pc":9,"stack":["0x1","0x10"],"storage":{}}
+{"depth":1,"gas":"0x9e1d","op":52,"opName":"CALLVALUE","pc":10,"stack":["0x1","0x10","0x0"],"storage":{}}
+{"depth":1,"gas":"0x9e1b","op":56,"opName":"CODESIZE","pc":11,"stack":["0x1","0x10","0x0","0x0"],"storage":{}}
+{"depth":1,"gas":"0x9e19","op":50,"opName":"ORIGIN","pc":12,"stack":["0x1","0x10","0x0","0x0","0x10"],"storage":{}}
+{"depth":1,"gas":"0x9e17","op":52,"opName":"CALLVALUE","pc":13,"stack":["0x1","0x10","0x0","0x0","0x10","0x0"],"storage":{}}
+{"depth":1,"gas":"0x9e15","op":57,"opName":"CODECOPY","pc":14,"stack":["0x1","0x10","0x0","0x0","0x10","0x0","0x0"],"storage":{}}
+{"depth":1,"gas":"0x9e0c","op":240,"opName":"CREATE","pc":15,"stack":["0x1","0x10","0x0","0x0"],"storage":{}}
+{"depth":2,"gas":"0x210c","op":50,"opName":"ORIGIN","pc":0,"stack":[],"storage":{}}
+{"depth":2,"gas":"0x210a","op":52,"opName":"CALLVALUE","pc":1,"stack":["0x0"],"storage":{}}
+{"depth":2,"gas":"0x2108","op":52,"opName":"CALLVALUE","pc":2,"stack":["0x0","0x0"],"storage":{}}
+{"depth":2,"gas":"0x2106","op":52,"opName":"CALLVALUE","pc":3,"stack":["0x0","0x0","0x0"],"storage":{}}
+{"depth":2,"gas":"0x2104","op":52,"opName":"CALLVALUE","pc":4,"stack":["0x0","0x0","0x0","0x0"],"storage":{}}
+{"depth":2,"gas":"0x2102","op":88,"opName":"PC","pc":5,"stack":["0x0","0x0","0x0","0x0","0x0"],"storage":{}}
+{"depth":2,"gas":"0x2100","op":48,"opName":"ADDRESS","pc":6,"stack":["0x0","0x0","0x0","0x0","0x0","0x5"],"storage":{}}
+{"depth":2,"gas":"0x20fe","op":241,"opName":"CALL","pc":7,"stack":["0x0","0x0","0x0","0x0","0x0","0x5","0xbd770416a3345f91e4b34576cb804a576fa48eb1"],"storage":{}}
+"#,
+        )
+    }
+
+    #[test]
+    fn should_omit_storage_and_memory_flag() {
+        // should omit storage
+        let (informant, res) = informant(Config::new(true, true));
+        run_test(
+            informant,
+            move |_, expected| {
+                let bytes = res.lock().unwrap();
+                assert_eq!(expected, &String::from_utf8_lossy(&**bytes))
+            },
+            "3260D85554",
+            0xffff,
+            r#"{"depth":1,"gas":"0xffff","op":50,"opName":"ORIGIN","pc":0,"stack":[],"storage":null}
+{"depth":1,"gas":"0xfffd","op":96,"opName":"PUSH1","pc":1,"stack":["0x0"],"storage":null}
+{"depth":1,"gas":"0xfffa","op":85,"opName":"SSTORE","pc":3,"stack":["0x0","0xd8"],"storage":null}
+{"depth":1,"gas":"0xec72","op":84,"opName":"SLOAD","pc":4,"stack":[],"storage":null}
+"#,
+        )
+    }
+}

bin/evmbin/src/info.rs

@@ -0,0 +1,316 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! VM runner.
+
+use ethcore::{
+    client::{self, EvmTestClient, EvmTestError, TransactErr, TransactSuccess},
+    pod_state, spec, state, state_db, trace, TrieSpec,
+};
+use ethereum_types::{H256, U256};
+use ethjson;
+use std::time::{Duration, Instant};
+use types::transaction;
+use vm::ActionParams;
+
+/// VM execution informant
+pub trait Informant: trace::VMTracer {
+    /// Sink to use with finish
+    type Sink;
+    /// Display a single run init message
+    fn before_test(&mut self, test: &str, action: &str);
+    /// Set initial gas.
+    fn set_gas(&mut self, _gas: U256) {}
+    /// Clone sink.
+    fn clone_sink(&self) -> Self::Sink;
+    /// Display final result.
+    fn finish(result: RunResult<Self::Output>, &mut Self::Sink);
+}
+
+/// Execution finished correctly
+#[derive(Debug)]
+pub struct Success<T> {
+    /// State root
+    pub state_root: H256,
+    /// Used gas
+    pub gas_used: U256,
+    /// Output as bytes
+    pub output: Vec<u8>,
+    /// Time Taken
+    pub time: Duration,
+    /// Traces
+    pub traces: Option<T>,
+    /// Optional end state dump
+    pub end_state: Option<pod_state::PodState>,
+}
+
+/// Execution failed
+#[derive(Debug)]
+pub struct Failure<T> {
+    /// State root
+    pub state_root: H256,
+    /// Used gas
+    pub gas_used: U256,
+    /// Internal error
+    pub error: EvmTestError,
+    /// Duration
+    pub time: Duration,
+    /// Traces
+    pub traces: Option<T>,
+    /// Optional end state dump
+    pub end_state: Option<pod_state::PodState>,
+}
+
+/// EVM Execution result
+pub type RunResult<T> = Result<Success<T>, Failure<T>>;
+
+/// Execute given `ActionParams` and return the result.
+pub fn run_action<T: Informant>(
+    spec: &spec::Spec,
+    mut params: ActionParams,
+    mut informant: T,
+    trie_spec: TrieSpec,
+) -> RunResult<T::Output> {
+    informant.set_gas(params.gas);
+
+    // if the code is not overwritten from CLI, use code from spec file.
+    if params.code.is_none() {
+        if let Some(acc) = spec.genesis_state().get().get(&params.code_address) {
+            params.code = acc.code.clone().map(::std::sync::Arc::new);
+            params.code_hash = None;
+        }
+    }
+    run(
+        spec,
+        trie_spec,
+        params.gas,
+        spec.genesis_state(),
+        |mut client| {
+            let result = match client.call(params, &mut trace::NoopTracer, &mut informant) {
+                Ok(r) => (Ok(r.return_data.to_vec()), Some(r.gas_left)),
+                Err(err) => (Err(err), None),
+            };
+            (result.0, H256::zero(), None, result.1, informant.drain())
+        },
+    )
+}
+
+/// Execute given Transaction and verify resulting state root.
+pub fn run_transaction<T: Informant>(
+    name: &str,
+    idx: usize,
+    spec: &ethjson::spec::ForkSpec,
+    pre_state: &pod_state::PodState,
+    post_root: H256,
+    env_info: &client::EnvInfo,
+    transaction: transaction::SignedTransaction,
+    mut informant: T,
+    trie_spec: TrieSpec,
+) {
+    let spec_name = format!("{:?}", spec).to_lowercase();
+    let spec = match EvmTestClient::spec_from_json(spec) {
+        Some(spec) => {
+            informant.before_test(&format!("{}:{}:{}", name, spec_name, idx), "starting");
+            spec
+        }
+        None => {
+            informant.before_test(
+                &format!("{}:{}:{}", name, spec_name, idx),
+                "skipping because of missing spec",
+            );
+            return;
+        }
+    };
+
+    informant.set_gas(env_info.gas_limit);
+
+    let mut sink = informant.clone_sink();
+    let result = run(
+        &spec,
+        trie_spec,
+        transaction.tx().gas,
+        pre_state,
+        |mut client| {
+            let result = client.transact(env_info, transaction, trace::NoopTracer, informant);
+            match result {
+                Ok(TransactSuccess {
+                    state_root,
+                    gas_left,
+                    output,
+                    vm_trace,
+                    end_state,
+                    ..
+                }) => {
+                    if state_root != post_root {
+                        (
+                            Err(EvmTestError::PostCondition(format!(
+                                "State root mismatch (got: {:#x}, expected: {:#x})",
+                                state_root, post_root,
+                            ))),
+                            state_root,
+                            end_state,
+                            Some(gas_left),
+                            None,
+                        )
+                    } else {
+                        (Ok(output), state_root, end_state, Some(gas_left), vm_trace)
+                    }
+                }
+                Err(TransactErr {
+                    state_root,
+                    error,
+                    end_state,
+                }) => (
+                    Err(EvmTestError::PostCondition(format!(
+                        "Unexpected execution error: {:?}",
+                        error
+                    ))),
+                    state_root,
+                    end_state,
+                    None,
+                    None,
+                ),
+            }
+        },
+    );
+
+    T::finish(result, &mut sink)
+}
+
+fn dump_state(state: &state::State<state_db::StateDB>) -> Option<pod_state::PodState> {
+    state.to_pod_full().ok()
+}
+
+/// Execute VM with given `ActionParams`
+pub fn run<'a, F, X>(
+    spec: &'a spec::Spec,
+    trie_spec: TrieSpec,
+    initial_gas: U256,
+    pre_state: &'a pod_state::PodState,
+    run: F,
+) -> RunResult<X>
+where
+    F: FnOnce(
+        EvmTestClient,
+    ) -> (
+        Result<Vec<u8>, EvmTestError>,
+        H256,
+        Option<pod_state::PodState>,
+        Option<U256>,
+        Option<X>,
+    ),
+{
+    let do_dump = trie_spec == TrieSpec::Fat;
+
+    let mut test_client =
+        EvmTestClient::from_pod_state_with_trie(spec, pre_state.clone(), trie_spec).map_err(
+            |error| Failure {
+                gas_used: 0.into(),
+                error,
+                time: Duration::from_secs(0),
+                traces: None,
+                state_root: H256::default(),
+                end_state: None,
+            },
+        )?;
+
+    if do_dump {
+        test_client.set_dump_state_fn(dump_state);
+    }
+
+    let start = Instant::now();
+    let result = run(test_client);
+    let time = start.elapsed();
+
+    match result {
+        (Ok(output), state_root, end_state, gas_left, traces) => Ok(Success {
+            state_root,
+            gas_used: gas_left
+                .map(|gas_left| initial_gas - gas_left)
+                .unwrap_or(initial_gas),
+            output,
+            time,
+            traces,
+            end_state,
+        }),
+        (Err(error), state_root, end_state, gas_left, traces) => Err(Failure {
+            gas_used: gas_left
+                .map(|gas_left| initial_gas - gas_left)
+                .unwrap_or(initial_gas),
+            error,
+            time,
+            traces,
+            state_root,
+            end_state,
+        }),
+    }
+}
+
+#[cfg(test)]
+pub mod tests {
+    use super::*;
+    use ethereum_types::Address;
+    use rustc_hex::FromHex;
+    use std::sync::Arc;
+    use tempdir::TempDir;
+
+    pub fn run_test<T, I, F>(informant: I, compare: F, code: &str, gas: T, expected: &str)
+    where
+        T: Into<U256>,
+        I: Informant,
+        F: FnOnce(Option<I::Output>, &str),
+    {
+        let mut params = ActionParams::default();
+        params.code = Some(Arc::new(code.from_hex().unwrap()));
+        params.gas = gas.into();
+
+        let tempdir = TempDir::new("").unwrap();
+        let spec = ::ethcore::ethereum::new_foundation(&tempdir.path());
+        let result = run_action(&spec, params, informant, TrieSpec::Secure);
+        match result {
+            Ok(Success { traces, .. }) => compare(traces, expected),
+            Err(Failure { traces, .. }) => compare(traces, expected),
+        }
+    }
+
+    #[test]
+    fn should_call_account_from_spec() {
+        use display::{config::Config, std_json::tests::informant};
+
+        let (inf, res) = informant(Config::default());
+        let mut params = ActionParams::default();
+        params.code_address = Address::from_low_u64_be(0x20);
+        params.gas = 0xffff.into();
+
+        let spec = ::ethcore::ethereum::load(None, include_bytes!("../res/testchain.json"));
+        let _result = run_action(&spec, params, inf, TrieSpec::Secure);
+
+        assert_eq!(
+            &String::from_utf8_lossy(&**res.lock().unwrap()),
+            r#"{"depth":1,"gas":"0xffff","op":98,"opName":"PUSH3","pc":0,"stack":[],"storage":{}}
+{"depth":1,"gas":"0xfffc","op":96,"opName":"PUSH1","pc":4,"stack":["0xaaaaaa"],"storage":{}}
+{"depth":1,"gas":"0xfff9","op":96,"opName":"PUSH1","pc":6,"stack":["0xaaaaaa","0xaa"],"storage":{}}
+{"depth":1,"gas":"0xfff6","op":80,"opName":"POP","pc":8,"stack":["0xaaaaaa","0xaa","0xaa"],"storage":{}}
+{"depth":1,"gas":"0xfff4","op":96,"opName":"PUSH1","pc":9,"stack":["0xaaaaaa","0xaa"],"storage":{}}
+{"depth":1,"gas":"0xfff1","op":96,"opName":"PUSH1","pc":11,"stack":["0xaaaaaa","0xaa","0xaa"],"storage":{}}
+{"depth":1,"gas":"0xffee","op":96,"opName":"PUSH1","pc":13,"stack":["0xaaaaaa","0xaa","0xaa","0xaa"],"storage":{}}
+{"depth":1,"gas":"0xffeb","op":96,"opName":"PUSH1","pc":15,"stack":["0xaaaaaa","0xaa","0xaa","0xaa","0xaa"],"storage":{}}
+{"depth":1,"gas":"0xffe8","op":96,"opName":"PUSH1","pc":17,"stack":["0xaaaaaa","0xaa","0xaa","0xaa","0xaa","0xaa"],"storage":{}}
+{"depth":1,"gas":"0xffe5","op":96,"opName":"PUSH1","pc":19,"stack":["0xaaaaaa","0xaa","0xaa","0xaa","0xaa","0xaa","0xaa"],"storage":{}}
+"#
+        );
+    }
+}

bin/evmbin/src/main.rs

@@ -0,0 +1,511 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! OpenEthereum EVM interpreter binary.
+
+#![warn(missing_docs)]
+
+extern crate common_types as types;
+extern crate ethcore;
+extern crate ethjson;
+extern crate rustc_hex;
+extern crate serde;
+#[macro_use]
+extern crate serde_derive;
+#[macro_use]
+extern crate serde_json;
+extern crate docopt;
+extern crate env_logger;
+extern crate ethereum_types;
+extern crate evm;
+extern crate panic_hook;
+extern crate parity_bytes as bytes;
+extern crate vm;
+
+#[cfg(test)]
+#[macro_use]
+extern crate pretty_assertions;
+
+#[cfg(test)]
+extern crate tempdir;
+
+use bytes::Bytes;
+use docopt::Docopt;
+use ethcore::{json_tests, spec, TrieSpec};
+use ethereum_types::{Address, U256};
+use ethjson::spec::ForkSpec;
+use evm::EnvInfo;
+use rustc_hex::FromHex;
+use std::{fmt, fs, path::PathBuf, sync::Arc};
+use vm::{ActionParams, CallType};
+
+mod display;
+mod info;
+
+use info::Informant;
+
+const USAGE: &'static str = r#"
+EVM implementation for Parity.
+  Copyright 2015-2020 Parity Technologies (UK) Ltd.
+
+Usage:
+    openethereum-evm state-test <file> [--json --std-json --std-dump-json --only NAME --chain CHAIN --std-out-only --std-err-only --omit-storage-output --omit-memory-output]
+    openethereum-evm stats [options]
+    openethereum-evm stats-jsontests-vm <file>
+    openethereum-evm [options]
+    openethereum-evm [-h | --help]
+
+Commands:
+    state-test         Run a state test from a json file.
+    stats              Execute EVM runtime code and return the statistics.
+    stats-jsontests-vm Execute standard json-tests format VMTests and return
+                       timing statistics in tsv format.
+
+Transaction options:
+    --code CODE        Contract code as hex (without 0x).
+    --to ADDRESS       Recipient address (without 0x).
+    --from ADDRESS     Sender address (without 0x).
+    --input DATA       Input data as hex (without 0x).
+    --gas GAS          Supplied gas as hex (without 0x).
+    --gas-price WEI    Supplied gas price as hex (without 0x).
+
+State test options:
+    --chain CHAIN      Run only from specific chain name (i.e. one of EIP150, EIP158,
+                       Frontier, Homestead, Byzantium, Constantinople,
+                       ConstantinopleFix, Istanbul, EIP158ToByzantiumAt5, FrontierToHomesteadAt5,
+                       HomesteadToDaoAt5, HomesteadToEIP150At5, Berlin, Yolo3).
+    --only NAME        Runs only a single test matching the name.
+
+General options:
+    --json                    Display verbose results in JSON.
+    --std-json                Display results in standardized JSON format.
+    --std-err-only            With --std-json redirect to err output only.
+    --std-out-only            With --std-json redirect to out output only.
+    --omit-storage-output     With --std-json omit storage output.
+    --omit-memory-output      With --std-json omit memory output.
+    --std-dump-json           Display results in standardized JSON format
+                              with additional state dump.
+
+Display result state dump in standardized JSON format.
+    --chain CHAIN      Chain spec file path.
+    -h, --help         Display this message and exit.
+"#;
+
+fn main() {
+    panic_hook::set_abort();
+    env_logger::init();
+
+    let args: Args = Docopt::new(USAGE)
+        .and_then(|d| d.deserialize())
+        .unwrap_or_else(|e| e.exit());
+
+    let config = args.config();
+
+    if args.cmd_state_test {
+        run_state_test(args)
+    } else if args.cmd_stats_jsontests_vm {
+        run_stats_jsontests_vm(args)
+    } else if args.flag_json {
+        run_call(args, display::json::Informant::new(config))
+    } else if args.flag_std_dump_json || args.flag_std_json {
+        if args.flag_std_err_only {
+            run_call(args, display::std_json::Informant::err_only(config))
+        } else if args.flag_std_out_only {
+            run_call(args, display::std_json::Informant::out_only(config))
+        } else {
+            run_call(args, display::std_json::Informant::new_default(config))
+        };
+    } else {
+        run_call(args, display::simple::Informant::new(config))
+    }
+}
+
+fn run_stats_jsontests_vm(args: Args) {
+    use json_tests::HookType;
+    use std::{
+        collections::HashMap,
+        time::{Duration, Instant},
+    };
+
+    let file = args.arg_file.expect("FILE (or PATH) is required");
+
+    let mut timings: HashMap<String, (Instant, Option<Duration>)> = HashMap::new();
+
+    {
+        let mut record_time = |name: &str, typ: HookType| match typ {
+            HookType::OnStart => {
+                timings.insert(name.to_string(), (Instant::now(), None));
+            }
+            HookType::OnStop => {
+                timings.entry(name.to_string()).and_modify(|v| {
+                    v.1 = Some(v.0.elapsed());
+                });
+            }
+        };
+        for file_path in json_tests::find_json_files_recursive(&file) {
+            let json_data = std::fs::read(&file_path).unwrap();
+            json_tests::json_executive_test(&file_path, &json_data, &mut record_time);
+        }
+    }
+
+    for (name, v) in timings {
+        println!(
+            "{}\t{}",
+            name,
+            display::as_micros(&v.1.expect("All hooks are called with OnStop; qed"))
+        );
+    }
+}
+
+fn run_state_test(args: Args) {
+    use ethjson::state::test::Test;
+    let config = args.config();
+    let file = args.arg_file.expect("FILE is required");
+    let mut file = match fs::File::open(&file) {
+        Err(err) => die(format!("Unable to open: {:?}: {}", file, err)),
+        Ok(file) => file,
+    };
+    let state_test = match Test::load(&mut file) {
+        Err(err) => die(format!("Unable to load the test file: {}", err)),
+        Ok(test) => test,
+    };
+    let only_test = args.flag_only.map(|s| s.to_lowercase());
+    let only_chain = args.flag_chain.map(|s| s.to_lowercase());
+
+    for (name, test) in state_test {
+        if let Some(false) = only_test
+            .as_ref()
+            .map(|only_test| &name.to_lowercase() == only_test)
+        {
+            continue;
+        }
+
+        let multitransaction = test.transaction;
+        let env_info: EnvInfo = test.env.into();
+        let pre = test.pre_state.into();
+
+        for (spec, states) in test.post_states {
+            //hardcode base fee for part of the london tests, that miss base fee field in env
+            let mut test_env = env_info.clone();
+            if spec >= ForkSpec::London {
+                if test_env.base_fee.is_none() {
+                    test_env.base_fee = Some(0x0a.into());
+                }
+            }
+
+            if let Some(false) = only_chain
+                .as_ref()
+                .map(|only_chain| &format!("{:?}", spec).to_lowercase() == only_chain)
+            {
+                continue;
+            }
+            for (idx, state) in states.into_iter().enumerate() {
+                let post_root = state.hash.into();
+                let transaction = multitransaction.select(&state.indexes);
+
+                let trie_spec = if args.flag_std_dump_json {
+                    TrieSpec::Fat
+                } else {
+                    TrieSpec::Secure
+                };
+                if args.flag_json {
+                    info::run_transaction(
+                        &name,
+                        idx,
+                        &spec,
+                        &pre,
+                        post_root,
+                        &test_env,
+                        transaction,
+                        display::json::Informant::new(config),
+                        trie_spec,
+                    )
+                } else if args.flag_std_dump_json || args.flag_std_json {
+                    if args.flag_std_err_only {
+                        info::run_transaction(
+                            &name,
+                            idx,
+                            &spec,
+                            &pre,
+                            post_root,
+                            &test_env,
+                            transaction,
+                            display::std_json::Informant::err_only(config),
+                            trie_spec,
+                        )
+                    } else if args.flag_std_out_only {
+                        info::run_transaction(
+                            &name,
+                            idx,
+                            &spec,
+                            &pre,
+                            post_root,
+                            &test_env,
+                            transaction,
+                            display::std_json::Informant::out_only(config),
+                            trie_spec,
+                        )
+                    } else {
+                        info::run_transaction(
+                            &name,
+                            idx,
+                            &spec,
+                            &pre,
+                            post_root,
+                            &test_env,
+                            transaction,
+                            display::std_json::Informant::new_default(config),
+                            trie_spec,
+                        )
+                    }
+                } else {
+                    info::run_transaction(
+                        &name,
+                        idx,
+                        &spec,
+                        &pre,
+                        post_root,
+                        &test_env,
+                        transaction,
+                        display::simple::Informant::new(config),
+                        trie_spec,
+                    )
+                }
+            }
+        }
+    }
+}
+
+fn run_call<T: Informant>(args: Args, informant: T) {
+    let from = arg(args.from(), "--from");
+    let to = arg(args.to(), "--to");
+    let code = arg(args.code(), "--code");
+    let spec = arg(args.spec(), "--chain");
+    let gas = arg(args.gas(), "--gas");
+    let gas_price = arg(args.gas_price(), "--gas-price");
+    let data = arg(args.data(), "--input");
+
+    if code.is_none() && to == Address::default() {
+        die("Either --code or --to is required.");
+    }
+    let mut params = ActionParams::default();
+    if spec.engine.params().eip2929_transition == 0 {
+        params.access_list.enable();
+        params.access_list.insert_address(from);
+        params.access_list.insert_address(to);
+        for (builtin, _) in spec.engine.builtins() {
+            params.access_list.insert_address(*builtin);
+        }
+    }
+
+    params.call_type = if code.is_none() {
+        CallType::Call
+    } else {
+        CallType::None
+    };
+    params.code_address = to;
+    params.address = to;
+    params.sender = from;
+    params.origin = from;
+    params.gas = gas;
+    params.gas_price = gas_price;
+    params.code = code.map(Arc::new);
+    params.data = data;
+
+    let mut sink = informant.clone_sink();
+    let result = if args.flag_std_dump_json {
+        info::run_action(&spec, params, informant, TrieSpec::Fat)
+    } else {
+        info::run_action(&spec, params, informant, TrieSpec::Secure)
+    };
+    T::finish(result, &mut sink);
+}
+
+#[derive(Debug, Deserialize)]
+struct Args {
+    cmd_stats: bool,
+    cmd_state_test: bool,
+    cmd_stats_jsontests_vm: bool,
+    arg_file: Option<PathBuf>,
+    flag_only: Option<String>,
+    flag_from: Option<String>,
+    flag_to: Option<String>,
+    flag_code: Option<String>,
+    flag_gas: Option<String>,
+    flag_gas_price: Option<String>,
+    flag_input: Option<String>,
+    flag_chain: Option<String>,
+    flag_json: bool,
+    flag_std_json: bool,
+    flag_std_dump_json: bool,
+    flag_std_err_only: bool,
+    flag_std_out_only: bool,
+    flag_omit_storage_output: bool,
+    flag_omit_memory_output: bool,
+}
+
+impl Args {
+    pub fn gas(&self) -> Result<U256, String> {
+        match self.flag_gas {
+            Some(ref gas) => gas.parse().map_err(to_string),
+            None => Ok(U256::from(u64::max_value())),
+        }
+    }
+
+    pub fn gas_price(&self) -> Result<U256, String> {
+        match self.flag_gas_price {
+            Some(ref gas_price) => gas_price.parse().map_err(to_string),
+            None => Ok(U256::zero()),
+        }
+    }
+
+    pub fn from(&self) -> Result<Address, String> {
+        match self.flag_from {
+            Some(ref from) => from.parse().map_err(to_string),
+            None => Ok(Address::default()),
+        }
+    }
+
+    pub fn to(&self) -> Result<Address, String> {
+        match self.flag_to {
+            Some(ref to) => to.parse().map_err(to_string),
+            None => Ok(Address::default()),
+        }
+    }
+
+    pub fn code(&self) -> Result<Option<Bytes>, String> {
+        match self.flag_code {
+            Some(ref code) => code.from_hex().map(Some).map_err(to_string),
+            None => Ok(None),
+        }
+    }
+
+    pub fn data(&self) -> Result<Option<Bytes>, String> {
+        match self.flag_input {
+            Some(ref input) => input.from_hex().map_err(to_string).map(Some),
+            None => Ok(None),
+        }
+    }
+
+    pub fn spec(&self) -> Result<spec::Spec, String> {
+        Ok(match self.flag_chain {
+            Some(ref spec_name) => {
+                let fork_spec: Result<ethjson::spec::ForkSpec, _> =
+                    serde_json::from_str(&format!("{:?}", spec_name));
+                if let Ok(fork_spec) = fork_spec {
+                    ethcore::client::EvmTestClient::spec_from_json(&fork_spec)
+                        .expect("this forkspec is not defined")
+                } else {
+                    let file = fs::File::open(spec_name).map_err(|e| format!("{}", e))?;
+                    spec::Spec::load(&::std::env::temp_dir(), file)?
+                }
+            }
+            None => ethcore::ethereum::new_foundation(&::std::env::temp_dir()),
+        })
+    }
+
+    pub fn config(&self) -> display::config::Config {
+        display::config::Config::new(self.flag_omit_storage_output, self.flag_omit_memory_output)
+    }
+}
+
+fn arg<T>(v: Result<T, String>, param: &str) -> T {
+    v.unwrap_or_else(|e| die(format!("Invalid {}: {}", param, e)))
+}
+
+fn to_string<T: fmt::Display>(msg: T) -> String {
+    format!("{}", msg)
+}
+
+fn die<T: fmt::Display>(msg: T) -> ! {
+    println!("{}", msg);
+    ::std::process::exit(-1)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::{Args, USAGE};
+    use docopt::Docopt;
+    use ethereum_types::Address;
+
+    fn run<T: AsRef<str>>(args: &[T]) -> Args {
+        Docopt::new(USAGE)
+            .and_then(|d| d.argv(args.into_iter()).deserialize())
+            .unwrap()
+    }
+
+    #[test]
+    fn should_parse_all_the_options() {
+        let args = run(&[
+            "openethereum-evm",
+            "--json",
+            "--std-json",
+            "--std-dump-json",
+            "--gas",
+            "1",
+            "--gas-price",
+            "2",
+            "--from",
+            "0000000000000000000000000000000000000003",
+            "--to",
+            "0000000000000000000000000000000000000004",
+            "--code",
+            "05",
+            "--input",
+            "06",
+            "--chain",
+            "./testfile",
+            "--std-err-only",
+            "--std-out-only",
+        ]);
+
+        assert_eq!(args.flag_json, true);
+        assert_eq!(args.flag_std_json, true);
+        assert_eq!(args.flag_std_dump_json, true);
+        assert_eq!(args.flag_std_err_only, true);
+        assert_eq!(args.flag_std_out_only, true);
+        assert_eq!(args.gas(), Ok(1.into()));
+        assert_eq!(args.gas_price(), Ok(2.into()));
+        assert_eq!(args.from(), Ok(Address::from_low_u64_be(3)));
+        assert_eq!(args.to(), Ok(Address::from_low_u64_be(4)));
+        assert_eq!(args.code(), Ok(Some(vec![05])));
+        assert_eq!(args.data(), Ok(Some(vec![06])));
+        assert_eq!(args.flag_chain, Some("./testfile".to_owned()));
+    }
+
+    #[test]
+    fn should_parse_state_test_command() {
+        let args = run(&[
+            "openethereum-evm",
+            "state-test",
+            "./file.json",
+            "--chain",
+            "homestead",
+            "--only=add11",
+            "--json",
+            "--std-json",
+            "--std-dump-json",
+        ]);
+
+        assert_eq!(args.cmd_state_test, true);
+        assert!(args.arg_file.is_some());
+        assert_eq!(args.flag_json, true);
+        assert_eq!(args.flag_std_json, true);
+        assert_eq!(args.flag_std_dump_json, true);
+        assert_eq!(args.flag_chain, Some("homestead".to_owned()));
+        assert_eq!(args.flag_only, Some("add11".to_owned()));
+    }
+}

bin/oe/account.rs

@@ -0,0 +1,141 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use crate::params::SpecType;
+use std::num::NonZeroU32;
+
+#[derive(Debug, PartialEq)]
+pub enum AccountCmd {
+    New(NewAccount),
+    List(ListAccounts),
+    Import(ImportAccounts),
+}
+
+#[derive(Debug, PartialEq)]
+pub struct ListAccounts {
+    pub path: String,
+    pub spec: SpecType,
+}
+
+#[derive(Debug, PartialEq)]
+pub struct NewAccount {
+    pub iterations: NonZeroU32,
+    pub path: String,
+    pub spec: SpecType,
+    pub password_file: Option<String>,
+}
+
+#[derive(Debug, PartialEq)]
+pub struct ImportAccounts {
+    pub from: Vec<String>,
+    pub to: String,
+    pub spec: SpecType,
+}
+
+#[cfg(not(feature = "accounts"))]
+pub fn execute(_cmd: AccountCmd) -> Result<String, String> {
+    Err("Account management is deprecated. Please see #9997 for alternatives:\nhttps://github.com/openethereum/openethereum/issues/9997".into())
+}
+
+#[cfg(feature = "accounts")]
+mod command {
+    use super::*;
+    use crate::{
+        accounts::{AccountProvider, AccountProviderSettings},
+        helpers::{password_from_file, password_prompt},
+    };
+    use ethstore::{accounts_dir::RootDiskDirectory, import_account, import_accounts, EthStore};
+    use std::path::PathBuf;
+
+    pub fn execute(cmd: AccountCmd) -> Result<String, String> {
+        match cmd {
+            AccountCmd::New(new_cmd) => new(new_cmd),
+            AccountCmd::List(list_cmd) => list(list_cmd),
+            AccountCmd::Import(import_cmd) => import(import_cmd),
+        }
+    }
+
+    fn keys_dir(path: String, spec: SpecType) -> Result<RootDiskDirectory, String> {
+        let spec = spec.spec(&::std::env::temp_dir())?;
+        let mut path = PathBuf::from(&path);
+        path.push(spec.data_dir);
+        RootDiskDirectory::create(path).map_err(|e| format!("Could not open keys directory: {}", e))
+    }
+
+    fn secret_store(
+        dir: Box<RootDiskDirectory>,
+        iterations: Option<NonZeroU32>,
+    ) -> Result<EthStore, String> {
+        match iterations {
+            Some(i) => EthStore::open_with_iterations(dir, i),
+            _ => EthStore::open(dir),
+        }
+        .map_err(|e| format!("Could not open keys store: {}", e))
+    }
+
+    fn new(n: NewAccount) -> Result<String, String> {
+        let password = match n.password_file {
+            Some(file) => password_from_file(file)?,
+            None => password_prompt()?,
+        };
+
+        let dir = Box::new(keys_dir(n.path, n.spec)?);
+        let secret_store = Box::new(secret_store(dir, Some(n.iterations))?);
+        let acc_provider = AccountProvider::new(secret_store, AccountProviderSettings::default());
+        let new_account = acc_provider
+            .new_account(&password)
+            .map_err(|e| format!("Could not create new account: {}", e))?;
+        Ok(format!("0x{:x}", new_account))
+    }
+
+    fn list(list_cmd: ListAccounts) -> Result<String, String> {
+        let dir = Box::new(keys_dir(list_cmd.path, list_cmd.spec)?);
+        let secret_store = Box::new(secret_store(dir, None)?);
+        let acc_provider = AccountProvider::new(secret_store, AccountProviderSettings::default());
+        let accounts = acc_provider.accounts().map_err(|e| format!("{}", e))?;
+        let result = accounts
+            .into_iter()
+            .map(|a| format!("0x{:x}", a))
+            .collect::<Vec<String>>()
+            .join("\n");
+
+        Ok(result)
+    }
+
+    fn import(i: ImportAccounts) -> Result<String, String> {
+        let to = keys_dir(i.to, i.spec)?;
+        let mut imported = 0;
+
+        for path in &i.from {
+            let path = PathBuf::from(path);
+            if path.is_dir() {
+                let from = RootDiskDirectory::at(&path);
+                imported += import_accounts(&from, &to)
+                    .map_err(|e| format!("Importing accounts from {:?} failed: {}", path, e))?
+                    .len();
+            } else if path.is_file() {
+                import_account(&path, &to)
+                    .map_err(|e| format!("Importing account from {:?} failed: {}", path, e))?;
+                imported += 1;
+            }
+        }
+
+        Ok(format!("{} account(s) imported", imported))
+    }
+}
+
+#[cfg(feature = "accounts")]
+pub use self::command::execute;

bin/oe/account_utils.rs

@@ -0,0 +1,263 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::sync::Arc;
+
+use crypto::publickey;
+use dir::Directories;
+use ethereum_types::{Address, H160};
+use ethkey::Password;
+
+use crate::params::{AccountsConfig, SpecType};
+
+#[cfg(not(feature = "accounts"))]
+mod accounts {
+    use super::*;
+
+    /// Dummy AccountProvider
+    pub struct AccountProvider;
+
+    impl ::ethcore::miner::LocalAccounts for AccountProvider {
+        fn is_local(&self, _address: &Address) -> bool {
+            false
+        }
+    }
+
+    pub fn prepare_account_provider(
+        _spec: &SpecType,
+        _dirs: &Directories,
+        _data_dir: &str,
+        _cfg: AccountsConfig,
+        _passwords: &[Password],
+    ) -> Result<AccountProvider, String> {
+        warn!("Note: Your instance of OpenEthereum is running without account support. Some CLI options are ignored.");
+        Ok(AccountProvider)
+    }
+
+    pub fn miner_local_accounts(_: Arc<AccountProvider>) -> AccountProvider {
+        AccountProvider
+    }
+
+    pub fn miner_author(
+        _spec: &SpecType,
+        _dirs: &Directories,
+        _account_provider: &Arc<AccountProvider>,
+        _engine_signer: Address,
+        _passwords: &[Password],
+    ) -> Result<Option<::ethcore::miner::Author>, String> {
+        Ok(None)
+    }
+
+    pub fn accounts_list(
+        _account_provider: Arc<AccountProvider>,
+    ) -> Arc<dyn Fn() -> Vec<Address> + Send + Sync> {
+        Arc::new(|| vec![])
+    }
+}
+
+#[cfg(feature = "accounts")]
+mod accounts {
+    use super::*;
+    use crate::{ethereum_types::H256, upgrade::upgrade_key_location};
+    use std::str::FromStr;
+
+    pub use crate::accounts::AccountProvider;
+
+    /// Pops along with error messages when a password is missing or invalid.
+    const VERIFY_PASSWORD_HINT: &str = "Make sure valid password is present in files passed using `--password` or in the configuration file.";
+
+    /// Initialize account provider
+    pub fn prepare_account_provider(
+        spec: &SpecType,
+        dirs: &Directories,
+        data_dir: &str,
+        cfg: AccountsConfig,
+        passwords: &[Password],
+    ) -> Result<AccountProvider, String> {
+        use crate::accounts::AccountProviderSettings;
+        use ethstore::{accounts_dir::RootDiskDirectory, EthStore};
+
+        let path = dirs.keys_path(data_dir);
+        upgrade_key_location(&dirs.legacy_keys_path(cfg.testnet), &path);
+        let dir = Box::new(
+            RootDiskDirectory::create(&path)
+                .map_err(|e| format!("Could not open keys directory: {}", e))?,
+        );
+        let account_settings = AccountProviderSettings {
+            unlock_keep_secret: cfg.enable_fast_unlock,
+            blacklisted_accounts: match *spec {
+                SpecType::Morden
+                | SpecType::Ropsten
+                | SpecType::Kovan
+                | SpecType::Goerli
+                | SpecType::Sokol
+                | SpecType::Dev => vec![],
+                _ => vec![H160::from_str("00a329c0648769a73afac7f9381e08fb43dbea72")
+                    .expect("the string is valid hex; qed")],
+            },
+        };
+
+        let ethstore = EthStore::open_with_iterations(dir, cfg.iterations)
+            .map_err(|e| format!("Could not open keys directory: {}", e))?;
+        if cfg.refresh_time > 0 {
+            ethstore.set_refresh_time(::std::time::Duration::from_secs(cfg.refresh_time));
+        }
+        let account_provider = AccountProvider::new(Box::new(ethstore), account_settings);
+
+        // Add development account if running dev chain:
+        if let SpecType::Dev = *spec {
+            insert_dev_account(&account_provider);
+        }
+
+        for a in cfg.unlocked_accounts {
+            // Check if the account exists
+            if !account_provider.has_account(a) {
+                return Err(format!(
+                    "Account {} not found for the current chain. {}",
+                    a,
+                    build_create_account_hint(spec, &dirs.keys)
+                ));
+            }
+
+            // Check if any passwords have been read from the password file(s)
+            if passwords.is_empty() {
+                return Err(format!(
+                    "No password found to unlock account {}. {}",
+                    a, VERIFY_PASSWORD_HINT
+                ));
+            }
+
+            if !passwords.iter().any(|p| {
+                account_provider
+                    .unlock_account_permanently(a, (*p).clone())
+                    .is_ok()
+            }) {
+                return Err(format!(
+                    "No valid password to unlock account {}. {}",
+                    a, VERIFY_PASSWORD_HINT
+                ));
+            }
+        }
+
+        Ok(account_provider)
+    }
+
+    pub struct LocalAccounts(Arc<AccountProvider>);
+    impl ::ethcore::miner::LocalAccounts for LocalAccounts {
+        fn is_local(&self, address: &Address) -> bool {
+            self.0.has_account(*address)
+        }
+    }
+
+    pub fn miner_local_accounts(account_provider: Arc<AccountProvider>) -> LocalAccounts {
+        LocalAccounts(account_provider)
+    }
+
+    pub fn miner_author(
+        spec: &SpecType,
+        dirs: &Directories,
+        account_provider: &Arc<AccountProvider>,
+        engine_signer: Address,
+        passwords: &[Password],
+    ) -> Result<Option<::ethcore::miner::Author>, String> {
+        use ethcore::engines::EngineSigner;
+
+        // Check if engine signer exists
+        if !account_provider.has_account(engine_signer) {
+            return Err(format!(
+                "Consensus signer account not found for the current chain. {}",
+                build_create_account_hint(spec, &dirs.keys)
+            ));
+        }
+
+        // Check if any passwords have been read from the password file(s)
+        if passwords.is_empty() {
+            return Err(format!(
+                "No password found for the consensus signer {}. {}",
+                engine_signer, VERIFY_PASSWORD_HINT
+            ));
+        }
+
+        let mut author = None;
+        for password in passwords {
+            let signer = parity_rpc::signer::EngineSigner::new(
+                account_provider.clone(),
+                engine_signer,
+                password.clone(),
+            );
+            // sign dummy msg to check if password and account can be used.
+            if signer.sign(H256::from_low_u64_be(1)).is_ok() {
+                author = Some(::ethcore::miner::Author::Sealer(Box::new(signer)));
+            }
+        }
+        if author.is_none() {
+            return Err(format!(
+                "No valid password for the consensus signer {}. {}",
+                engine_signer, VERIFY_PASSWORD_HINT
+            ));
+        }
+
+        Ok(author)
+    }
+
+    pub fn accounts_list(
+        account_provider: Arc<AccountProvider>,
+    ) -> Arc<dyn Fn() -> Vec<Address> + Send + Sync> {
+        Arc::new(move || account_provider.accounts().unwrap_or_default())
+    }
+
+    fn insert_dev_account(account_provider: &AccountProvider) {
+        let secret = publickey::Secret::from_str(
+            "4d5db4107d237df6a3d58ee5f70ae63d73d7658d4026f2eefd2f204c81682cb7",
+        )
+        .expect("Valid account;qed");
+        let dev_account = publickey::KeyPair::from_secret(secret.clone())
+            .expect("Valid secret produces valid key;qed");
+        if !account_provider.has_account(dev_account.address()) {
+            match account_provider.insert_account(secret, &Password::from(String::new())) {
+                Err(e) => warn!("Unable to add development account: {}", e),
+                Ok(address) => {
+                    let _ = account_provider
+                        .set_account_name(address.clone(), "Development Account".into());
+                    let _ = account_provider.set_account_meta(
+                        address,
+                        ::serde_json::to_string(
+                            &(vec![
+                                (
+                                    "description",
+                                    "Never use this account outside of development chain!",
+                                ),
+                                ("passwordHint", "Password is empty string"),
+                            ]
+                            .into_iter()
+                            .collect::<::std::collections::HashMap<_, _>>()),
+                        )
+                        .expect("Serialization of hashmap does not fail."),
+                    );
+                }
+            }
+        }
+    }
+
+    // Construct an error `String` with an adaptive hint on how to create an account.
+    fn build_create_account_hint(spec: &SpecType, keys: &str) -> String {
+        format!("You can create an account via RPC, UI or `openethereum account new --chain {} --keys-path {}`.", spec, keys)
+    }
+}
+
+pub use self::accounts::{
+    accounts_list, miner_author, miner_local_accounts, prepare_account_provider, AccountProvider,
+};

bin/oe/blockchain.rs

@@ -0,0 +1,551 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::{fs, io, sync::Arc, time::Instant};
+
+use crate::{
+    bytes::ToPretty,
+    cache::CacheConfig,
+    db,
+    hash::{keccak, KECCAK_NULL_RLP},
+    helpers::{execute_upgrades, to_client_config},
+    informant::{FullNodeInformantData, Informant, MillisecondDuration},
+    params::{fatdb_switch_to_bool, tracing_switch_to_bool, Pruning, SpecType, Switch},
+    types::data_format::DataFormat,
+    user_defaults::UserDefaults,
+};
+use ansi_term::Colour;
+use dir::Directories;
+use ethcore::{
+    client::{
+        Balance, BlockChainClient, BlockChainReset, BlockId, DatabaseCompactionProfile,
+        ImportExportBlocks, Mode, Nonce, VMType,
+    },
+    miner::Miner,
+    verification::queue::VerifierSettings,
+};
+use ethcore_service::ClientService;
+use ethereum_types::{Address, H256, U256};
+
+#[derive(Debug, PartialEq)]
+pub enum BlockchainCmd {
+    Kill(KillBlockchain),
+    Import(ImportBlockchain),
+    Export(ExportBlockchain),
+    ExportState(ExportState),
+    Reset(ResetBlockchain),
+}
+
+#[derive(Debug, PartialEq)]
+pub struct ResetBlockchain {
+    pub dirs: Directories,
+    pub spec: SpecType,
+    pub pruning: Pruning,
+    pub pruning_history: u64,
+    pub pruning_memory: usize,
+    pub tracing: Switch,
+    pub fat_db: Switch,
+    pub compaction: DatabaseCompactionProfile,
+    pub cache_config: CacheConfig,
+    pub num: u32,
+}
+
+#[derive(Debug, PartialEq)]
+pub struct KillBlockchain {
+    pub spec: SpecType,
+    pub dirs: Directories,
+    pub pruning: Pruning,
+}
+
+#[derive(Debug, PartialEq)]
+pub struct ImportBlockchain {
+    pub spec: SpecType,
+    pub cache_config: CacheConfig,
+    pub dirs: Directories,
+    pub file_path: Option<String>,
+    pub format: Option<DataFormat>,
+    pub pruning: Pruning,
+    pub pruning_history: u64,
+    pub pruning_memory: usize,
+    pub compaction: DatabaseCompactionProfile,
+    pub tracing: Switch,
+    pub fat_db: Switch,
+    pub vm_type: VMType,
+    pub check_seal: bool,
+    pub with_color: bool,
+    pub verifier_settings: VerifierSettings,
+    pub max_round_blocks_to_import: usize,
+}
+
+#[derive(Debug, PartialEq)]
+pub struct ExportBlockchain {
+    pub spec: SpecType,
+    pub cache_config: CacheConfig,
+    pub dirs: Directories,
+    pub file_path: Option<String>,
+    pub format: Option<DataFormat>,
+    pub pruning: Pruning,
+    pub pruning_history: u64,
+    pub pruning_memory: usize,
+    pub compaction: DatabaseCompactionProfile,
+    pub fat_db: Switch,
+    pub tracing: Switch,
+    pub from_block: BlockId,
+    pub to_block: BlockId,
+    pub check_seal: bool,
+    pub max_round_blocks_to_import: usize,
+}
+
+#[derive(Debug, PartialEq)]
+pub struct ExportState {
+    pub spec: SpecType,
+    pub cache_config: CacheConfig,
+    pub dirs: Directories,
+    pub file_path: Option<String>,
+    pub format: Option<DataFormat>,
+    pub pruning: Pruning,
+    pub pruning_history: u64,
+    pub pruning_memory: usize,
+    pub compaction: DatabaseCompactionProfile,
+    pub fat_db: Switch,
+    pub tracing: Switch,
+    pub at: BlockId,
+    pub storage: bool,
+    pub code: bool,
+    pub min_balance: Option<U256>,
+    pub max_balance: Option<U256>,
+    pub max_round_blocks_to_import: usize,
+}
+
+pub fn execute(cmd: BlockchainCmd) -> Result<(), String> {
+    match cmd {
+        BlockchainCmd::Kill(kill_cmd) => kill_db(kill_cmd),
+        BlockchainCmd::Import(import_cmd) => execute_import(import_cmd),
+        BlockchainCmd::Export(export_cmd) => execute_export(export_cmd),
+        BlockchainCmd::ExportState(export_cmd) => execute_export_state(export_cmd),
+        BlockchainCmd::Reset(reset_cmd) => execute_reset(reset_cmd),
+    }
+}
+
+fn execute_import(cmd: ImportBlockchain) -> Result<(), String> {
+    let timer = Instant::now();
+
+    // load spec file
+    let spec = cmd.spec.spec(&cmd.dirs.cache)?;
+
+    // load genesis hash
+    let genesis_hash = spec.genesis_header().hash();
+
+    // database paths
+    let db_dirs = cmd.dirs.database(genesis_hash, None, spec.data_dir.clone());
+
+    // user defaults path
+    let user_defaults_path = db_dirs.user_defaults_path();
+
+    // load user defaults
+    let mut user_defaults = UserDefaults::load(&user_defaults_path)?;
+
+    // select pruning algorithm
+    let algorithm = cmd.pruning.to_algorithm(&user_defaults);
+
+    // check if tracing is on
+    let tracing = tracing_switch_to_bool(cmd.tracing, &user_defaults)?;
+
+    // check if fatdb is on
+    let fat_db = fatdb_switch_to_bool(cmd.fat_db, &user_defaults, algorithm)?;
+
+    // prepare client and snapshot paths.
+    let client_path = db_dirs.client_path(algorithm);
+    let snapshot_path = db_dirs.snapshot_path();
+
+    // execute upgrades
+    execute_upgrades(&cmd.dirs.base, &db_dirs, algorithm, &cmd.compaction)?;
+
+    // create dirs used by parity
+    cmd.dirs.create_dirs(false, false)?;
+
+    // prepare client config
+    let mut client_config = to_client_config(
+        &cmd.cache_config,
+        spec.name.to_lowercase(),
+        Mode::Active,
+        tracing,
+        fat_db,
+        cmd.compaction,
+        cmd.vm_type,
+        "".into(),
+        algorithm,
+        cmd.pruning_history,
+        cmd.pruning_memory,
+        cmd.check_seal,
+        12,
+    );
+
+    client_config.queue.verifier_settings = cmd.verifier_settings;
+
+    let restoration_db_handler = db::restoration_db_handler(&client_path, &client_config);
+    let client_db = restoration_db_handler
+        .open(&client_path)
+        .map_err(|e| format!("Failed to open database {:?}", e))?;
+
+    // build client
+    let service = ClientService::start(
+        client_config,
+        &spec,
+        client_db,
+        &snapshot_path,
+        restoration_db_handler,
+        &cmd.dirs.ipc_path(),
+        // TODO [ToDr] don't use test miner here
+        // (actually don't require miner at all)
+        Arc::new(Miner::new_for_tests(&spec, None)),
+    )
+    .map_err(|e| format!("Client service error: {:?}", e))?;
+
+    // free up the spec in memory.
+    drop(spec);
+
+    let client = service.client();
+
+    let instream: Box<dyn io::Read> = match cmd.file_path {
+        Some(f) => {
+            Box::new(fs::File::open(&f).map_err(|_| format!("Cannot open given file: {}", f))?)
+        }
+        None => Box::new(io::stdin()),
+    };
+
+    let informant = Arc::new(Informant::new(
+        FullNodeInformantData {
+            client: client.clone(),
+            sync: None,
+            net: None,
+        },
+        None,
+        None,
+        cmd.with_color,
+    ));
+
+    service
+        .register_io_handler(informant)
+        .map_err(|_| "Unable to register informant handler".to_owned())?;
+
+    client.import_blocks(instream, cmd.format)?;
+
+    // save user defaults
+    user_defaults.pruning = algorithm;
+    user_defaults.tracing = tracing;
+    user_defaults.fat_db = fat_db;
+    user_defaults.save(&user_defaults_path)?;
+
+    let report = client.report();
+
+    let ms = timer.elapsed().as_milliseconds();
+    info!("Import completed in {} seconds, {} blocks, {} blk/s, {} transactions, {} tx/s, {} Mgas, {} Mgas/s",
+		ms / 1000,
+		report.blocks_imported,
+		(report.blocks_imported * 1000) as u64 / ms,
+		report.transactions_applied,
+		(report.transactions_applied * 1000) as u64 / ms,
+		report.gas_processed / 1_000_000,
+		(report.gas_processed / (ms * 1000)).low_u64(),
+	);
+    Ok(())
+}
+
+fn start_client(
+    dirs: Directories,
+    spec: SpecType,
+    pruning: Pruning,
+    pruning_history: u64,
+    pruning_memory: usize,
+    tracing: Switch,
+    fat_db: Switch,
+    compaction: DatabaseCompactionProfile,
+    cache_config: CacheConfig,
+    require_fat_db: bool,
+    max_round_blocks_to_import: usize,
+) -> Result<ClientService, String> {
+    // load spec file
+    let spec = spec.spec(&dirs.cache)?;
+
+    // load genesis hash
+    let genesis_hash = spec.genesis_header().hash();
+
+    // database paths
+    let db_dirs = dirs.database(genesis_hash, None, spec.data_dir.clone());
+
+    // user defaults path
+    let user_defaults_path = db_dirs.user_defaults_path();
+
+    // load user defaults
+    let user_defaults = UserDefaults::load(&user_defaults_path)?;
+
+    // select pruning algorithm
+    let algorithm = pruning.to_algorithm(&user_defaults);
+
+    // check if tracing is on
+    let tracing = tracing_switch_to_bool(tracing, &user_defaults)?;
+
+    // check if fatdb is on
+    let fat_db = fatdb_switch_to_bool(fat_db, &user_defaults, algorithm)?;
+    if !fat_db && require_fat_db {
+        return Err("This command requires OpenEthereum to be synced with --fat-db on.".to_owned());
+    }
+
+    // prepare client and snapshot paths.
+    let client_path = db_dirs.client_path(algorithm);
+    let snapshot_path = db_dirs.snapshot_path();
+
+    // execute upgrades
+    execute_upgrades(&dirs.base, &db_dirs, algorithm, &compaction)?;
+
+    // create dirs used by OpenEthereum.
+    dirs.create_dirs(false, false)?;
+
+    // prepare client config
+    let client_config = to_client_config(
+        &cache_config,
+        spec.name.to_lowercase(),
+        Mode::Active,
+        tracing,
+        fat_db,
+        compaction,
+        VMType::default(),
+        "".into(),
+        algorithm,
+        pruning_history,
+        pruning_memory,
+        true,
+        max_round_blocks_to_import,
+    );
+
+    let restoration_db_handler = db::restoration_db_handler(&client_path, &client_config);
+    let client_db = restoration_db_handler
+        .open(&client_path)
+        .map_err(|e| format!("Failed to open database {:?}", e))?;
+
+    let service = ClientService::start(
+        client_config,
+        &spec,
+        client_db,
+        &snapshot_path,
+        restoration_db_handler,
+        &dirs.ipc_path(),
+        // It's fine to use test version here,
+        // since we don't care about miner parameters at all
+        Arc::new(Miner::new_for_tests(&spec, None)),
+    )
+    .map_err(|e| format!("Client service error: {:?}", e))?;
+
+    drop(spec);
+    Ok(service)
+}
+
+fn execute_export(cmd: ExportBlockchain) -> Result<(), String> {
+    let service = start_client(
+        cmd.dirs,
+        cmd.spec,
+        cmd.pruning,
+        cmd.pruning_history,
+        cmd.pruning_memory,
+        cmd.tracing,
+        cmd.fat_db,
+        cmd.compaction,
+        cmd.cache_config,
+        false,
+        cmd.max_round_blocks_to_import,
+    )?;
+    let client = service.client();
+
+    let out: Box<dyn io::Write> = match cmd.file_path {
+        Some(f) => Box::new(
+            fs::File::create(&f).map_err(|_| format!("Cannot write to file given: {}", f))?,
+        ),
+        None => Box::new(io::stdout()),
+    };
+
+    client.export_blocks(out, cmd.from_block, cmd.to_block, cmd.format)?;
+
+    info!("Export completed.");
+    Ok(())
+}
+
+fn execute_export_state(cmd: ExportState) -> Result<(), String> {
+    let service = start_client(
+        cmd.dirs,
+        cmd.spec,
+        cmd.pruning,
+        cmd.pruning_history,
+        cmd.pruning_memory,
+        cmd.tracing,
+        cmd.fat_db,
+        cmd.compaction,
+        cmd.cache_config,
+        true,
+        cmd.max_round_blocks_to_import,
+    )?;
+
+    let client = service.client();
+
+    let mut out: Box<dyn io::Write> = match cmd.file_path {
+        Some(f) => Box::new(
+            fs::File::create(&f).map_err(|_| format!("Cannot write to file given: {}", f))?,
+        ),
+        None => Box::new(io::stdout()),
+    };
+
+    let mut last: Option<Address> = None;
+    let at = cmd.at;
+    let mut i = 0usize;
+
+    out.write_fmt(format_args!("{{ \"state\": {{",))
+        .expect("Couldn't write to stream.");
+    loop {
+        let accounts = client
+            .list_accounts(at, last.as_ref(), 1000)
+            .ok_or("Specified block not found")?;
+        if accounts.is_empty() {
+            break;
+        }
+
+        for account in accounts.into_iter() {
+            let balance = client
+                .balance(&account, at.into())
+                .unwrap_or_else(U256::zero);
+            if cmd.min_balance.map_or(false, |m| balance < m)
+                || cmd.max_balance.map_or(false, |m| balance > m)
+            {
+                last = Some(account);
+                continue; //filtered out
+            }
+
+            if i != 0 {
+                out.write(b",").expect("Write error");
+            }
+            out.write_fmt(format_args!(
+                "\n\"0x{:x}\": {{\"balance\": \"{:x}\", \"nonce\": \"{:x}\"",
+                account,
+                balance,
+                client.nonce(&account, at).unwrap_or_else(U256::zero)
+            ))
+            .expect("Write error");
+            let code = client
+                .code(&account, at.into())
+                .unwrap_or(None)
+                .unwrap_or_else(Vec::new);
+            if !code.is_empty() {
+                out.write_fmt(format_args!(", \"code_hash\": \"0x{:x}\"", keccak(&code)))
+                    .expect("Write error");
+                if cmd.code {
+                    out.write_fmt(format_args!(", \"code\": \"{}\"", code.to_hex()))
+                        .expect("Write error");
+                }
+            }
+            let storage_root = client.storage_root(&account, at).unwrap_or(KECCAK_NULL_RLP);
+            if storage_root != KECCAK_NULL_RLP {
+                out.write_fmt(format_args!(", \"storage_root\": \"0x{:x}\"", storage_root))
+                    .expect("Write error");
+                if cmd.storage {
+                    out.write_fmt(format_args!(", \"storage\": {{"))
+                        .expect("Write error");
+                    let mut last_storage: Option<H256> = None;
+                    loop {
+                        let keys = client
+                            .list_storage(at, &account, last_storage.as_ref(), 1000)
+                            .ok_or("Specified block not found")?;
+                        if keys.is_empty() {
+                            break;
+                        }
+
+                        for key in keys.into_iter() {
+                            if last_storage.is_some() {
+                                out.write(b",").expect("Write error");
+                            }
+                            out.write_fmt(format_args!(
+                                "\n\t\"0x{:x}\": \"0x{:x}\"",
+                                key,
+                                client
+                                    .storage_at(&account, &key, at.into())
+                                    .unwrap_or_else(Default::default)
+                            ))
+                            .expect("Write error");
+                            last_storage = Some(key);
+                        }
+                    }
+                    out.write(b"\n}").expect("Write error");
+                }
+            }
+            out.write(b"}").expect("Write error");
+            i += 1;
+            if i % 10000 == 0 {
+                info!("Account #{}", i);
+            }
+            last = Some(account);
+        }
+    }
+    out.write_fmt(format_args!("\n}}}}")).expect("Write error");
+    info!("Export completed.");
+    Ok(())
+}
+
+fn execute_reset(cmd: ResetBlockchain) -> Result<(), String> {
+    let service = start_client(
+        cmd.dirs,
+        cmd.spec,
+        cmd.pruning,
+        cmd.pruning_history,
+        cmd.pruning_memory,
+        cmd.tracing,
+        cmd.fat_db,
+        cmd.compaction,
+        cmd.cache_config,
+        false,
+        0,
+    )?;
+
+    let client = service.client();
+    client.reset(cmd.num)?;
+    info!("{}", Colour::Green.bold().paint("Successfully reset db!"));
+
+    Ok(())
+}
+
+pub fn kill_db(cmd: KillBlockchain) -> Result<(), String> {
+    let spec = cmd.spec.spec(&cmd.dirs.cache)?;
+    let genesis_hash = spec.genesis_header().hash();
+    let db_dirs = cmd.dirs.database(genesis_hash, None, spec.data_dir);
+    let user_defaults_path = db_dirs.user_defaults_path();
+    let mut user_defaults = UserDefaults::load(&user_defaults_path)?;
+    let algorithm = cmd.pruning.to_algorithm(&user_defaults);
+    let dir = db_dirs.db_path(algorithm);
+    fs::remove_dir_all(&dir).map_err(|e| format!("Error removing database: {:?}", e))?;
+    user_defaults.is_first_launch = true;
+    user_defaults.save(&user_defaults_path)?;
+    info!("Database deleted.");
+    Ok(())
+}
+
+#[cfg(test)]
+mod test {
+    use super::DataFormat;
+
+    #[test]
+    fn test_data_format_parsing() {
+        assert_eq!(DataFormat::Binary, "binary".parse().unwrap());
+        assert_eq!(DataFormat::Binary, "bin".parse().unwrap());
+        assert_eq!(DataFormat::Hex, "hex".parse().unwrap());
+    }
+}

bin/oe/cache.rs

@@ -0,0 +1,142 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::cmp::max;
+
+const MIN_BC_CACHE_MB: u32 = 4;
+const MIN_DB_CACHE_MB: u32 = 8;
+const MIN_BLOCK_QUEUE_SIZE_LIMIT_MB: u32 = 16;
+const DEFAULT_DB_CACHE_SIZE: u32 = 128;
+const DEFAULT_BC_CACHE_SIZE: u32 = 8;
+const DEFAULT_BLOCK_QUEUE_SIZE_LIMIT_MB: u32 = 40;
+const DEFAULT_TRACE_CACHE_SIZE: u32 = 20;
+const DEFAULT_STATE_CACHE_SIZE: u32 = 25;
+
+/// Configuration for application cache sizes.
+/// All	values are represented in MB.
+#[derive(Debug, PartialEq)]
+pub struct CacheConfig {
+    /// Size of rocksDB cache. Almost all goes to the state column.
+    db: u32,
+    /// Size of blockchain cache.
+    blockchain: u32,
+    /// Size of transaction queue cache.
+    queue: u32,
+    /// Size of traces cache.
+    traces: u32,
+    /// Size of the state cache.
+    state: u32,
+}
+
+impl Default for CacheConfig {
+    fn default() -> Self {
+        CacheConfig::new(
+            DEFAULT_DB_CACHE_SIZE,
+            DEFAULT_BC_CACHE_SIZE,
+            DEFAULT_BLOCK_QUEUE_SIZE_LIMIT_MB,
+            DEFAULT_STATE_CACHE_SIZE,
+        )
+    }
+}
+
+impl CacheConfig {
+    /// Creates new cache config with cumulative size equal `total`.
+    pub fn new_with_total_cache_size(total: u32) -> Self {
+        CacheConfig {
+            db: total * 7 / 10,
+            blockchain: total / 10,
+            queue: DEFAULT_BLOCK_QUEUE_SIZE_LIMIT_MB,
+            traces: DEFAULT_TRACE_CACHE_SIZE,
+            state: total * 2 / 10,
+        }
+    }
+
+    /// Creates new cache config with gitven details.
+    pub fn new(db: u32, blockchain: u32, queue: u32, state: u32) -> Self {
+        CacheConfig {
+            db: db,
+            blockchain: blockchain,
+            queue: queue,
+            traces: DEFAULT_TRACE_CACHE_SIZE,
+            state: state,
+        }
+    }
+
+    /// Size of db cache.
+    pub fn db_cache_size(&self) -> u32 {
+        max(MIN_DB_CACHE_MB, self.db)
+    }
+
+    /// Size of block queue size limit
+    pub fn queue(&self) -> u32 {
+        max(self.queue, MIN_BLOCK_QUEUE_SIZE_LIMIT_MB)
+    }
+
+    /// Size of the blockchain cache.
+    pub fn blockchain(&self) -> u32 {
+        max(self.blockchain, MIN_BC_CACHE_MB)
+    }
+
+    /// Size of the traces cache.
+    pub fn traces(&self) -> u32 {
+        self.traces
+    }
+
+    /// Size of the state cache.
+    pub fn state(&self) -> u32 {
+        self.state * 3 / 4
+    }
+
+    /// Size of the jump-tables cache.
+    pub fn jump_tables(&self) -> u32 {
+        self.state / 4
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::CacheConfig;
+
+    #[test]
+    fn test_cache_config_constructor() {
+        let config = CacheConfig::new_with_total_cache_size(200);
+        assert_eq!(config.db, 140);
+        assert_eq!(config.blockchain(), 20);
+        assert_eq!(config.queue(), 40);
+        assert_eq!(config.state(), 30);
+        assert_eq!(config.jump_tables(), 10);
+    }
+
+    #[test]
+    fn test_cache_config_db_cache_sizes() {
+        let config = CacheConfig::new_with_total_cache_size(400);
+        assert_eq!(config.db, 280);
+        assert_eq!(config.db_cache_size(), 280);
+    }
+
+    #[test]
+    fn test_cache_config_default() {
+        assert_eq!(
+            CacheConfig::default(),
+            CacheConfig::new(
+                super::DEFAULT_DB_CACHE_SIZE,
+                super::DEFAULT_BC_CACHE_SIZE,
+                super::DEFAULT_BLOCK_QUEUE_SIZE_LIMIT_MB,
+                super::DEFAULT_STATE_CACHE_SIZE
+            )
+        );
+    }
+}

bin/oe/cli/presets/config.dev-insecure.toml

@@ -0,0 +1,11 @@
+[parity]
+chain = "dev"
+
+[mining]
+reseal_min_period = 0
+min_gas_price = 0
+
+[rpc]
+interface = "all"
+apis = ["all"]
+hosts = ["all"]

bin/oe/cli/presets/config.dev.toml

@@ -0,0 +1,6 @@
+[parity]
+chain = "dev"
+
+[mining]
+reseal_min_period = 0
+min_gas_price = 0

bin/oe/cli/presets/config.insecure.toml

@@ -0,0 +1,4 @@
+[rpc]
+interface = "all"
+apis = ["all"]
+hosts = ["all"]

bin/oe/cli/presets/config.mining.toml

@@ -0,0 +1,28 @@
+[network]
+# OpenEthereum will try to maintain connection to at least 50 peers.
+min_peers = 50
+# OpenEthereum will maintain at most 100 peers.
+max_peers = 100
+
+[ipc]
+# You won't be able to use IPC to interact with OpenEthereum.
+disable = true
+
+[mining]
+# Prepare a block to seal even when there are no miners connected.
+force_sealing = true
+# New pending block will be created for all transactions (both local and external).
+reseal_on_txs = "all"
+# New pending block will be created only once per 4000 milliseconds.
+reseal_min_period = 4000
+# OpenEthereum will keep/relay at most 8192 transactions in queue.
+tx_queue_size = 8192
+tx_queue_per_sender = 128
+
+[footprint]
+# If defined will never use more then 1024MB for all caches. (Overrides other cache settings).
+cache_size = 1024
+
+[misc]
+# Logging pattern (`<module>=<level>`, e.g. `own_tx=trace`).
+logging = "miner=trace,own_tx=trace"

bin/oe/cli/presets/config.non-standard-ports.toml

@@ -0,0 +1,7 @@
+[network]
+# OpenEthereum will listen for connections on port 30305.
+port = 30305
+
+[rpc]
+# JSON-RPC over HTTP will be accessible on port 8645.
+port = 8645

bin/oe/cli/presets/mod.rs

@@ -0,0 +1,28 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::io::{Error, ErrorKind};
+
+pub fn preset_config_string(arg: &str) -> Result<&'static str, Error> {
+    match arg.to_lowercase().as_ref() {
+        "dev" => Ok(include_str!("./config.dev.toml")),
+        "mining" => Ok(include_str!("./config.mining.toml")),
+        "non-standard-ports" => Ok(include_str!("./config.non-standard-ports.toml")),
+        "insecure" => Ok(include_str!("./config.insecure.toml")),
+        "dev-insecure" => Ok(include_str!("./config.dev-insecure.toml")),
+        _ => Err(Error::new(ErrorKind::InvalidInput, "Config doesn't match any presets [dev, mining, non-standard-ports, insecure, dev-insecure]"))
+    }
+}

bin/oe/cli/tests/config.full.toml

@@ -0,0 +1,126 @@
+[parity]
+mode = "last"
+mode_timeout = 300
+mode_alarm = 3600
+no_persistent_txqueue = false
+
+chain = "homestead"
+base_path = "$HOME/.parity"
+db_path = "$HOME/.parity/chains"
+keys_path = "$HOME/.parity/keys"
+identity = ""
+
+[account]
+unlock = ["0xdeadbeefcafe0000000000000000000000000000"]
+password = ["~/.safe/password.file"]
+keys_iterations = 10240
+
+[ui]
+path = "$HOME/.parity/signer"
+
+[network]
+port = 30303
+min_peers = 25
+max_peers = 50
+nat = "any"
+id = 1
+bootnodes = []
+discovery = true
+warp = true
+allow_ips = "all"
+snapshot_peers = 0
+max_pending_peers = 64
+
+reserved_only = false
+reserved_peers = "./path_to_file"
+
+[rpc]
+disable = false
+port = 8545
+interface = "local"
+cors = ["null"]
+apis = ["web3", "eth", "net", "parity", "traces", "rpc", "secretstore"]
+hosts = ["none"]
+allow_missing_blocks = false
+
+[websockets]
+disable = false
+port = 8546
+interface = "local"
+origins = ["none"]
+apis = ["web3", "eth", "net", "parity", "traces", "rpc", "secretstore"]
+hosts = ["none"]
+
+[ipc]
+disable = false
+path = "$HOME/.parity/jsonrpc.ipc"
+apis = ["web3", "eth", "net", "parity", "parity_accounts", "personal", "traces", "rpc", "secretstore"]
+
+[secretstore]
+disable = false
+disable_http = false
+acl_contract = "registry"
+service_contract = "none"
+service_contract_srv_gen = "none"
+service_contract_srv_retr = "none"
+service_contract_doc_store = "none"
+service_contract_doc_sretr = "none"
+server_set_contract = "registry"
+nodes = []
+http_interface = "local"
+http_port = 8082
+interface = "local"
+port = 8083
+path = "$HOME/.parity/secretstore"
+
+[mining]
+author = "0xdeadbeefcafe0000000000000000000000000001"
+engine_signer = "0xdeadbeefcafe0000000000000000000000000001"
+force_sealing = true
+reseal_on_txs = "all"
+reseal_min_period = 4000
+reseal_max_period = 60000
+work_queue_size = 20
+relay_set = "cheap"
+min_gas_price = 0
+usd_per_tx = "0.0001"
+usd_per_eth = "auto"
+price_update_period = "hourly"
+gas_floor_target = "8000000"
+gas_cap = "10000000"
+tx_queue_size = 8192
+tx_queue_locals = ["0xdeadbeefcafe0000000000000000000000000000"]
+tx_queue_strategy = "gas_factor"
+tx_queue_ban_count = 1
+tx_queue_ban_time = 180 #s
+tx_gas_limit = "10000000"
+tx_time_limit = 100 #ms
+tx_queue_no_unfamiliar_locals = false
+tx_queue_no_early_reject = false
+extra_data = "Parity"
+remove_solved = false
+notify_work = ["http://localhost:3001"]
+refuse_service_transactions = false
+
+[footprint]
+tracing = "auto"
+pruning = "auto"
+pruning_history = 64
+pruning_memory = 500
+cache_size_db = 64
+cache_size_blocks = 8
+cache_size_queue = 50
+cache_size_state = 25
+cache_size = 128 # Overrides above caches with total size
+db_compaction = "ssd"
+fat_db = "auto"
+scale_verifiers = true
+num_verifiers = 6
+
+[snapshots]
+enable = false
+
+[misc]
+logging = "own_tx=trace"
+log_file = "/var/log/openethereum.log"
+color = true

bin/oe/cli/tests/config.invalid4.toml

@@ -0,0 +1,2 @@
+[account]
+invalid = 5

bin/oe/cli/tests/config.toml

@@ -8,11 +8,7 @@ chain = "./chain.json"
 unlock = ["0x1", "0x2", "0x3"]
 password = ["passwdfile path"]
 
-[ui]
-disable = true
-
 [network]
-disable = false
 warp = false
 discovery = true
 nat = "any"
@@ -25,6 +21,9 @@ allow_ips = "public"
 reserved_only = true
 reserved_peers = "./path/to/reserved_peers"
 
+[websockets]
+disable = true
+origins = ["none"]
 
 [rpc]
 disable = true
@@ -33,10 +32,15 @@ port = 8180
 [ipc]
 apis = ["rpc", "eth"]
 
-[dapps]
-port = 8080
-user = "username"
-pass = "password"
+[metrics]
+enable = true
+interface = "local"
+port = 4000
+prefix = "oe"
+
+[secretstore]
+http_port = 8082
+port = 8083
 
 [mining]
 author = "0xdeadbeefcafe0000000000000000000000000001"
@@ -44,15 +48,15 @@ engine_signer = "0xdeadbeefcafe0000000000000000000000000001"
 force_sealing = true
 reseal_on_txs = "all"
 reseal_min_period = 4000
+reseal_max_period = 60000
 price_update_period = "hourly"
-tx_queue_size = 1024
-tx_queue_gas = "auto"
+tx_queue_size = 8192
 
 [footprint]
 tracing = "on"
 pruning = "fast"
 pruning_history = 64
-cache_size_db = 128
+cache_size_db = 256
 cache_size_blocks = 16
 cache_size_queue = 100
 cache_size_state = 25
@@ -61,12 +65,11 @@ fat_db = "off"
 scale_verifiers = false
 
 [snapshots]
-disable_periodic = true
-
-[vm]
-jit = false
+enable = false
 
 [misc]
 logging = "own_tx=trace"
-log_file = "/var/log/parity.log"
+log_file = "/var/log/openethereum.log"
 color = true
+ports_shift = 0
+unsafe_expose = false

bin/oe/cli/usage.rs

@@ -0,0 +1,781 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+macro_rules! return_if_parse_error {
+    ($e:expr) => {
+        match $e {
+            Err(
+                clap_error
+                @
+                ClapError {
+                    kind: ClapErrorKind::ValueValidation,
+                    ..
+                },
+            ) => {
+                return Err(clap_error);
+            }
+
+            // Otherwise, if $e is ClapErrorKind::ArgumentNotFound or Ok(),
+            // then convert to Option
+            _ => $e.ok(),
+        }
+    };
+}
+
+macro_rules! if_option {
+	(Option<$type:ty>, THEN {$($then:tt)*} ELSE {$($otherwise:tt)*}) => (
+		$($then)*
+	);
+	($type:ty, THEN {$($then:tt)*} ELSE {$($otherwise:tt)*}) => (
+		$($otherwise)*
+	);
+}
+
+macro_rules! if_vec {
+	(Vec<$type:ty>, THEN {$($then:tt)*} ELSE {$($otherwise:tt)*}) => (
+		$($then)*
+	);
+	($type:ty, THEN {$($then:tt)*} ELSE {$($otherwise:tt)*}) => (
+		$($otherwise)*
+	);
+}
+
+macro_rules! if_option_vec {
+    (Option<Vec<String>>, THEN {$then:expr} ELSE {$otherwise:expr}) => {
+        $then
+    };
+    (Option<$type:ty>, THEN {$then:expr} ELSE {$otherwise:expr}) => {
+        $otherwise
+    };
+}
+
+macro_rules! inner_option_type {
+    (Option<$type:ty>) => {
+        $type
+    };
+}
+
+macro_rules! inner_vec_type {
+    (Vec<$type:ty>) => {
+        $type
+    };
+}
+
+macro_rules! inner_option_vec_type {
+    (Option<Vec<String>>) => {
+        String
+    };
+}
+
+macro_rules! usage_with_ident {
+    ($name:expr, $usage:expr, $help:expr) => {
+        if $usage.contains("<") {
+            format!("<{}> {} '{}'", $name, $usage, $help)
+        } else {
+            format!("[{}] {} '{}'", $name, $usage, $help)
+        }
+    };
+}
+
+macro_rules! underscore_to_hyphen {
+    ($e:expr) => {
+        str::replace($e, "_", "-")
+    };
+}
+
+macro_rules! usage {
+	(
+		{
+			$(
+				CMD $subc:ident
+				{
+					$subc_help:expr,
+
+					$(
+						CMD $subc_subc:ident
+						{
+							$subc_subc_help:expr,
+							$(
+								FLAG $subc_subc_flag:ident : (bool) = false, $subc_subc_flag_usage:expr, $subc_subc_flag_help:expr,
+							)*
+							$(
+								ARG $subc_subc_arg:ident : ($($subc_subc_arg_type_tt:tt)+) = $subc_subc_arg_default:expr, $subc_subc_arg_usage:expr, $subc_subc_arg_help:expr,
+							)*
+						}
+					)*
+
+					$(
+						FLAG $subc_flag:ident : (bool) = false, $subc_flag_usage:expr, $subc_flag_help:expr,
+					)*
+					$(
+						ARG $subc_arg:ident : ($($subc_arg_type_tt:tt)+) = $subc_arg_default:expr, $subc_arg_usage:expr, $subc_arg_help:expr,
+					)*
+				}
+			)*
+		}
+		{
+			$(
+			[$group_name:expr]
+				$(
+					FLAG $flag:ident : (bool) = false, or $flag_from_config:expr, $flag_usage:expr, $flag_help:expr,
+				)*
+				$(
+					ARG $arg:ident : ($($arg_type_tt:tt)+) = $arg_default:expr, or $arg_from_config:expr, $arg_usage:expr, $arg_help:expr,
+				)*
+				$(
+					CHECK $check:expr,
+				)*
+			)*
+		}
+	) => {
+		use toml;
+		use std::{fs, io, process, cmp};
+		use std::io::Read;
+		use parity_version::version;
+		use clap::{Arg, App, SubCommand, AppSettings, ArgSettings, Error as ClapError, ErrorKind as ClapErrorKind};
+		use dir::helpers::replace_home;
+		use std::ffi::OsStr;
+		use std::collections::HashMap;
+
+		extern crate textwrap;
+		extern crate term_size;
+		use self::textwrap::{Wrapper};
+
+		const MAX_TERM_WIDTH: usize = 120;
+
+		#[cfg(test)]
+		use regex::Regex;
+
+		#[derive(Debug)]
+		pub enum ArgsError {
+			Clap(ClapError),
+			Decode(toml::de::Error),
+			Config(String, io::Error),
+			PeerConfiguration,
+		}
+
+		impl ArgsError {
+			pub fn exit(self) -> ! {
+				match self {
+					ArgsError::Clap(e) => e.exit(),
+					ArgsError::Decode(e) => {
+						eprintln!("You might have supplied invalid parameters in config file.");
+						eprintln!("{}", e);
+						process::exit(2)
+					},
+					ArgsError::Config(path, e) => {
+						eprintln!("There was an error reading your config file at: {}", path);
+						eprintln!("{}", e);
+						process::exit(2)
+					},
+					ArgsError::PeerConfiguration => {
+						eprintln!("You have supplied `min_peers` > `max_peers`");
+						process::exit(2)
+					}
+				}
+			}
+		}
+
+		impl From<ClapError> for ArgsError {
+			fn from(e: ClapError) -> Self {
+				ArgsError::Clap(e)
+			}
+		}
+
+		impl From<toml::de::Error> for ArgsError {
+			fn from(e: toml::de::Error) -> Self {
+				ArgsError::Decode(e)
+			}
+		}
+
+		/// Parsed command line arguments.
+		#[derive(Debug, PartialEq)]
+		pub struct Args {
+			$(
+				pub $subc: bool,
+
+				$(
+					pub $subc_subc: bool,
+					$(
+						pub $subc_subc_flag: bool,
+					)*
+					$(
+						pub $subc_subc_arg: $($subc_subc_arg_type_tt)+,
+					)*
+				)*
+
+				$(
+					pub $subc_flag: bool,
+				)*
+				$(
+					pub $subc_arg: $($subc_arg_type_tt)+,
+				)*
+			)*
+
+			$(
+				$(
+					pub $flag: bool,
+				)*
+				$(
+					pub $arg: $($arg_type_tt)+,
+				)*
+			)*
+		}
+
+		impl Default for Args {
+			fn default() -> Self {
+				Args {
+					$(
+						$subc: Default::default(),
+						$(
+							$subc_subc: Default::default(),
+							$(
+								$subc_subc_flag: Default::default(),
+							)*
+							$(
+								$subc_subc_arg: Default::default(),
+							)*
+						)*
+
+						$(
+							$subc_flag: Default::default(),
+						)*
+						$(
+							$subc_arg: Default::default(),
+						)*
+					)*
+
+					$(
+						$(
+							$flag: Default::default(),
+						)*
+						$(
+							$arg: Default::default(),
+						)*
+					)*
+				}
+			}
+		}
+
+		#[derive(Default, Debug, PartialEq, Clone, Deserialize)]
+		struct RawArgs {
+			$(
+				$subc: bool,
+
+				$(
+					$subc_subc: bool,
+					$(
+						$subc_subc_flag: bool,
+					)*
+					$(
+						$subc_subc_arg: if_option!(
+							$($subc_subc_arg_type_tt)+,
+							THEN { $($subc_subc_arg_type_tt)+ }
+							ELSE { Option<$($subc_subc_arg_type_tt)+> }
+						),
+					)*
+				)*
+
+				$(
+					$subc_flag: bool,
+				)*
+				$(
+					$subc_arg: if_option!(
+						$($subc_arg_type_tt)+,
+						THEN { $($subc_arg_type_tt)+ }
+						ELSE { Option<$($subc_arg_type_tt)+> }
+					),
+				)*
+
+			)*
+			$(
+				$(
+					$flag: bool,
+				)*
+
+				$(
+					$arg: if_option!(
+						$($arg_type_tt)+,
+						THEN { $($arg_type_tt)+ }
+						ELSE { Option<$($arg_type_tt)+> }
+					),
+				)*
+			)*
+		}
+
+		impl Args {
+
+			pub fn parse<S: AsRef<str>>(command: &[S]) -> Result<Self, ArgsError> {
+				let raw_args = RawArgs::parse(command)?;
+
+				// Skip loading config file if no_config flag is specified
+				if raw_args.flag_no_config {
+					return Ok(raw_args.into_args(Config::default()));
+				}
+
+				let config_file = raw_args.arg_config.clone().unwrap_or_else(|| raw_args.clone().into_args(Config::default()).arg_config);
+				let config_file = replace_home(&::dir::default_data_path(), &config_file);
+
+				let args = match (fs::File::open(&config_file), raw_args.arg_config.clone()) {
+					// Load config file
+					(Ok(mut file), _) => {
+						eprintln!("Loading config file from {}", &config_file);
+						let mut config = String::new();
+						file.read_to_string(&mut config).map_err(|e| ArgsError::Config(config_file, e))?;
+						Ok(raw_args.into_args(Self::parse_config(&config)?))
+					},
+					// Don't display error in case default config cannot be loaded.
+					(Err(_), None) => Ok(raw_args.into_args(Config::default())),
+					// Config set from CLI (fail with error)
+					(Err(_), Some(ref config_arg)) => {
+						match presets::preset_config_string(config_arg) {
+							Ok(s) => Ok(raw_args.into_args(Self::parse_config(&s)?)),
+							Err(e) => Err(ArgsError::Config(config_file, e))
+						}
+					},
+				}?;
+
+				$(
+					$(
+						$check(&args)?;
+					)*
+				)*
+
+				Ok(args)
+			}
+
+			#[cfg(test)]
+			pub fn parse_without_config<S: AsRef<str>>(command: &[S]) -> Result<Self, ArgsError> {
+				Self::parse_with_config(command, Config::default())
+			}
+
+			#[cfg(test)]
+			fn parse_with_config<S: AsRef<str>>(command: &[S], config: Config) -> Result<Self, ArgsError> {
+				RawArgs::parse(command).map(|raw| raw.into_args(config)).map_err(ArgsError::Clap)
+			}
+
+			fn parse_config(config: &str) -> Result<Config, ArgsError> {
+				Ok(toml::from_str(config)?)
+			}
+
+			pub fn print_version() -> String {
+				format!(include_str!("./version.txt"), version())
+			}
+
+			#[allow(unused_mut)] // subc_subc_exist may be assigned true by the macro
+			#[allow(unused_assignments)] // Rust issue #22630
+			pub fn print_help() -> String {
+
+				const TAB: &str = "    ";
+				const TAB_TAB: &str = "        ";
+
+				let term_width = match term_size::dimensions() {
+					None => MAX_TERM_WIDTH,
+					Some((w, _)) => {
+						cmp::min(w, MAX_TERM_WIDTH)
+					}
+				};
+
+				let mut help : String = include_str!("./usage_header.txt").to_owned();
+
+				help.push_str("\n");
+
+				// Subcommands
+				let mut subcommands_wrapper = Wrapper::new(term_width).subsequent_indent(TAB);
+				help.push_str("openethereum [options]\n");
+				$(
+					{
+						let mut subc_subc_exist = false;
+
+						$(
+							subc_subc_exist = true;
+							let subc_subc_usages : Vec<&str> = vec![
+								$(
+									concat!("[",$subc_subc_flag_usage,"]"),
+								)*
+								$(
+									$subc_subc_arg_usage,
+								)*
+							];
+
+							help.push_str(&subcommands_wrapper.fill(
+								format!(
+									"openethereum [options] {} {} {}\n",
+									underscore_to_hyphen!(&stringify!($subc)[4..]),
+									underscore_to_hyphen!(&stringify!($subc_subc)[stringify!($subc).len()+1..]),
+									subc_subc_usages.join(" ")
+								).as_ref())
+							);
+						)*
+
+						// Print the subcommand on its own only if it has no subsubcommands
+						if !subc_subc_exist {
+							let subc_usages : Vec<&str> = vec![
+								$(
+									concat!("[",$subc_flag_usage,"]"),
+								)*
+								$(
+									$subc_arg_usage,
+								)*
+							];
+
+							help.push_str(&subcommands_wrapper.fill(
+								format!(
+									"openethereum [options] {} {}\n",
+									underscore_to_hyphen!(&stringify!($subc)[4..]),
+									subc_usages.join(" ")
+								).as_ref())
+							);
+						}
+					}
+				)*
+
+				help.push_str("\n");
+
+				// Arguments and flags
+				let args_wrapper = Wrapper::new(term_width).initial_indent(TAB_TAB).subsequent_indent(TAB_TAB);
+				$(
+					if $group_name != "Legacy Options" {
+						help.push_str($group_name); help.push_str(":\n");
+						$(
+							help.push_str(&format!("{}{}\n{}\n",
+								TAB, $flag_usage,
+								args_wrapper.fill($flag_help)
+							));
+							help.push_str("\n");
+						)*
+						$(
+							if_option!(
+								$($arg_type_tt)+,
+								THEN {
+									if_option_vec!(
+										$($arg_type_tt)+,
+										THEN {
+											help.push_str(&format!("{}{}\n{}\n",
+												TAB, $arg_usage,
+												args_wrapper.fill(format!(
+													"{} (default: {:?})",
+													$arg_help,
+													{let x : inner_option_type!($($arg_type_tt)+)> = $arg_default; x}
+												).as_ref())
+											))
+										}
+										ELSE {
+											help.push_str(&format!("{}{}\n{}\n",
+												TAB, $arg_usage,
+												args_wrapper.fill(format!(
+													"{}{}",
+													$arg_help,
+													$arg_default.map(|x: inner_option_type!($($arg_type_tt)+)| format!(" (default: {})",x)).unwrap_or("".to_owned())
+												).as_ref())
+											))
+										}
+									)
+								}
+								ELSE {
+									if_vec!(
+										$($arg_type_tt)+,
+										THEN {
+											help.push_str(&format!("{}{}\n{}\n", TAB, $arg_usage,
+												args_wrapper.fill(format!(
+													"{} (default: {:?})",
+													$arg_help,
+													{let x : $($arg_type_tt)+ = $arg_default; x}
+												).as_ref())
+											))
+										}
+										ELSE {
+											help.push_str(&format!("{}{}\n{}\n", TAB, $arg_usage,
+												args_wrapper.fill(format!(
+													"{} (default: {})",
+													$arg_help,
+													$arg_default
+												).as_ref())
+											))
+										}
+									)
+								}
+							);
+							help.push_str("\n");
+						)*
+					}
+				)*
+				help
+			}
+		}
+
+		impl RawArgs {
+			fn into_args(self, config: Config) -> Args {
+				let mut args = Args::default();
+				$(
+					args.$subc = self.$subc;
+
+					$(
+						args.$subc_subc = self.$subc_subc;
+						$(
+							args.$subc_subc_flag = self.$subc_subc_flag;
+						)*
+						$(
+							args.$subc_subc_arg = if_option!(
+								$($subc_subc_arg_type_tt)+,
+								THEN { self.$subc_subc_arg.or($subc_subc_arg_default) }
+								ELSE { self.$subc_subc_arg.unwrap_or($subc_subc_arg_default.into()) }
+							);
+						)*
+					)*
+
+					$(
+						args.$subc_flag = self.$subc_flag;
+					)*
+					$(
+						args.$subc_arg = if_option!(
+							$($subc_arg_type_tt)+,
+							THEN { self.$subc_arg.or($subc_arg_default) }
+							ELSE { self.$subc_arg.unwrap_or($subc_arg_default.into()) }
+						);
+					)*
+				)*
+
+				$(
+					$(
+						args.$flag = self.$flag || $flag_from_config(&config).unwrap_or(false);
+					)*
+					$(
+						args.$arg = if_option!(
+							$($arg_type_tt)+,
+							THEN { self.$arg.or_else(|| $arg_from_config(&config)).or_else(|| $arg_default.into()) }
+							ELSE { self.$arg.or_else(|| $arg_from_config(&config)).unwrap_or_else(|| $arg_default.into()) }
+						);
+					)*
+				)*
+				args
+			}
+
+			#[allow(unused_variables)] // the submatches of arg-less subcommands aren't used
+			pub fn parse<S: AsRef<str>>(command: &[S]) -> Result<Self, ClapError> {
+
+				let usages = vec![
+					$(
+						$(
+							usage_with_ident!(stringify!($arg), $arg_usage, $arg_help),
+						)*
+						$(
+							usage_with_ident!(stringify!($flag), $flag_usage, $flag_help),
+						)*
+					)*
+				];
+
+				// Hash of subc|subc_subc => Vec<String>
+				let mut subc_usages = HashMap::new();
+				$(
+					{
+						let this_subc_usages = vec![
+							$(
+								usage_with_ident!(stringify!($subc_flag), $subc_flag_usage, $subc_flag_help),
+							)*
+							$(
+								usage_with_ident!(stringify!($subc_arg), $subc_arg_usage, $subc_arg_help),
+							)*
+						];
+
+						subc_usages.insert(stringify!($subc),this_subc_usages);
+
+						$(
+							{
+								let this_subc_subc_usages = vec![
+									$(
+										usage_with_ident!(stringify!($subc_subc_flag), $subc_subc_flag_usage, $subc_subc_flag_help),
+									)*
+									$(
+										usage_with_ident!(stringify!($subc_subc_arg), $subc_subc_arg_usage, $subc_subc_arg_help),
+									)*
+								];
+
+								subc_usages.insert(stringify!($subc_subc), this_subc_subc_usages);
+							}
+						)*
+					}
+				)*
+
+				let matches = App::new("OpenEthereum")
+				    	.global_setting(AppSettings::VersionlessSubcommands)
+						.global_setting(AppSettings::DisableHelpSubcommand)
+						.max_term_width(MAX_TERM_WIDTH)
+						.help(Args::print_help().as_ref())
+						.args(&usages.iter().map(|u| {
+							let mut arg = Arg::from_usage(u)
+								.allow_hyphen_values(true) // Allow for example --allow-ips -10.0.0.0/8
+								.global(true) // Argument doesn't have to come before the first subcommand
+								.hidden(true); // Hide global arguments from the (subcommand) help messages generated by Clap
+
+							if arg.is_set(ArgSettings::Multiple) {
+								arg = arg.require_delimiter(true); // Multiple values can only be separated by commas, not spaces (#7428)
+							}
+
+							arg
+						}).collect::<Vec<Arg>>())
+						$(
+							.subcommand(
+								SubCommand::with_name(&underscore_to_hyphen!(&stringify!($subc)[4..]))
+								.about($subc_help)
+								.args(&subc_usages.get(stringify!($subc)).unwrap().iter().map(|u| Arg::from_usage(u).use_delimiter(false).allow_hyphen_values(true)).collect::<Vec<Arg>>())
+								$(
+									.setting(AppSettings::SubcommandRequired) // prevent from running `openethereum account`
+									.subcommand(
+										SubCommand::with_name(&underscore_to_hyphen!(&stringify!($subc_subc)[stringify!($subc).len()+1..]))
+										.about($subc_subc_help)
+										.args(&subc_usages.get(stringify!($subc_subc)).unwrap().iter().map(|u| Arg::from_usage(u).use_delimiter(false).allow_hyphen_values(true)).collect::<Vec<Arg>>())
+									)
+								)*
+							)
+						)*
+						.get_matches_from_safe(command.iter().map(|x| OsStr::new(x.as_ref())))?;
+
+				let mut raw_args : RawArgs = Default::default();
+
+				// Globals
+				$(
+					$(
+						raw_args.$flag = raw_args.$flag || matches.is_present(stringify!($flag));
+					)*
+					$(
+						if let some @ Some(_) = return_if_parse_error!(if_option!(
+							$($arg_type_tt)+,
+							THEN {
+								if_option_vec!(
+									$($arg_type_tt)+,
+									THEN { values_t!(matches, stringify!($arg), inner_option_vec_type!($($arg_type_tt)+)) }
+									ELSE { value_t!(matches, stringify!($arg), inner_option_type!($($arg_type_tt)+)) }
+								)
+							}
+							ELSE {
+								if_vec!(
+									$($arg_type_tt)+,
+									THEN { values_t!(matches, stringify!($arg), inner_vec_type!($($arg_type_tt)+)) }
+									ELSE { value_t!(matches, stringify!($arg), $($arg_type_tt)+) }
+								)
+							}
+						)) {
+							raw_args.$arg = some;
+						}
+					)*
+				)*
+
+				// Subcommands
+				$(
+					if let Some(submatches) = matches.subcommand_matches(&underscore_to_hyphen!(&stringify!($subc)[4..])) {
+						raw_args.$subc = true;
+
+						// Subcommand flags
+						$(
+							raw_args.$subc_flag = submatches.is_present(&stringify!($subc_flag));
+						)*
+						// Subcommand arguments
+						$(
+							raw_args.$subc_arg = return_if_parse_error!(if_option!(
+										$($subc_arg_type_tt)+,
+										THEN {
+											if_option_vec!(
+												$($subc_arg_type_tt)+,
+												THEN { values_t!(submatches, stringify!($subc_arg), inner_option_vec_type!($($subc_arg_type_tt)+)) }
+												ELSE { value_t!(submatches, stringify!($subc_arg), inner_option_type!($($subc_arg_type_tt)+)) }
+											)
+										}
+										ELSE {
+											if_vec!(
+												$($subc_arg_type_tt)+,
+												THEN { values_t!(submatches, stringify!($subc_arg), inner_vec_type!($($subc_arg_type_tt)+)) }
+												ELSE { value_t!(submatches, stringify!($subc_arg), $($subc_arg_type_tt)+) }
+											)
+										}
+							));
+						)*
+						// Sub-subcommands
+						$(
+							if let Some(subsubmatches) = submatches.subcommand_matches(&underscore_to_hyphen!(&stringify!($subc_subc)[stringify!($subc).len()+1..])) {
+								raw_args.$subc_subc = true;
+
+								// Sub-subcommand flags
+								$(
+									raw_args.$subc_subc_flag = subsubmatches.is_present(&stringify!($subc_subc_flag));
+								)*
+								// Sub-subcommand arguments
+								$(
+									raw_args.$subc_subc_arg = return_if_parse_error!(if_option!(
+										$($subc_subc_arg_type_tt)+,
+										THEN {
+											if_option_vec!(
+												$($subc_subc_arg_type_tt)+,
+												THEN { values_t!(subsubmatches, stringify!($subc_subc_arg), inner_option_vec_type!($($subc_subc_arg_type_tt)+)) }
+												ELSE { value_t!(subsubmatches, stringify!($subc_subc_arg), inner_option_type!($($subc_subc_arg_type_tt)+)) }
+											)
+										}
+										ELSE {
+											if_vec!(
+												$($subc_subc_arg_type_tt)+,
+												THEN { values_t!(subsubmatches, stringify!($subc_subc_arg), inner_vec_type!($($subc_subc_arg_type_tt)+)) }
+												ELSE { value_t!(subsubmatches, stringify!($subc_subc_arg), $($subc_subc_arg_type_tt)+) }
+											)
+										}
+									));
+								)*
+							}
+							else {
+								raw_args.$subc_subc = false;
+							}
+						)*
+					}
+					else {
+						raw_args.$subc = false;
+					}
+				)*
+
+				Ok(raw_args)
+			}
+
+		}
+
+		#[test]
+		fn usages_valid() {
+			let re = Regex::new(r"^(?:(-[a-zA-Z-]+, )?--[a-z-]+(=\[[a-zA-Z]+\](\.\.\.)?|=<[a-zA-Z]+>(\.\.\.)?)?)|(?:\[[a-zA-Z-]+\])(\.\.\.)?|(?:<[a-zA-Z-]+>)(\.\.\.)?$").unwrap();
+
+			let usages = vec![
+				$(
+					$(
+						$(
+							$subc_subc_arg_usage,
+						)*
+					)*
+					$(
+						$subc_arg_usage,
+					)*
+				)*
+				$(
+					$(
+						$flag_usage,
+					)*
+					$(
+						$arg_usage,
+					)*
+				)*
+			];
+
+			for usage in &usages {
+				assert!(re.is_match(usage));
+			}
+		}
+	}
+}

bin/oe/cli/usage_header.txt

@@ -0,0 +1,6 @@
+OpenEthereum Client.
+    By Wood/Paronyan/Kotewicz/Drwięga/Volf/Greeff
+       Habermeier/Czaban/Gotchac/Redman/Nikolsky
+       Schoedon/Tang/Adolfsson/Silva/Palm/Hirsz et al.
+    Copyright 2015-2020 Parity Technologies (UK) Ltd.
+    License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.

bin/oe/cli/version.txt

@@ -0,0 +1,10 @@
+OpenEthereum Client.
+  version {}
+Copyright 2015-2020 Parity Technologies (UK) Ltd.
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+
+By Wood/Paronyan/Kotewicz/Drwięga/Volf/Greeff
+   Habermeier/Czaban/Gotchac/Redman/Nikolsky
+   Schoedon/Tang/Adolfsson/Silva/Palm/Hirsz et al.

bin/oe/db/mod.rs

@@ -0,0 +1,25 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Database-related operations.
+
+#[path = "rocksdb/mod.rs"]
+mod impls;
+
+pub use self::impls::{migrate, restoration_db_handler};
+
+#[cfg(feature = "secretstore")]
+pub use self::impls::open_secretstore_db;

bin/oe/db/rocksdb/blooms.rs

@@ -0,0 +1,83 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Blooms migration from rocksdb to blooms-db
+
+use super::{kvdb_rocksdb::DatabaseConfig, open_database};
+use ethcore::error::Error;
+use ethereum_types::Bloom;
+use rlp;
+use std::path::Path;
+
+const LOG_BLOOMS_ELEMENTS_PER_INDEX: u64 = 16;
+
+pub fn migrate_blooms<P: AsRef<Path>>(path: P, config: &DatabaseConfig) -> Result<(), Error> {
+    // init
+    let db = open_database(&path.as_ref().to_string_lossy(), config)?;
+
+    // possible optimization:
+    // pre-allocate space on disk for faster migration
+
+    // iterate over header blooms and insert them in blooms-db
+    // Some(3) -> COL_EXTRA
+    // 3u8 -> ExtrasIndex::BlocksBlooms
+    // 0u8 -> level 0
+    let blooms_iterator = db
+        .key_value()
+        .iter_from_prefix(Some(3), &[3u8, 0u8])
+        .filter(|(key, _)| key.len() == 6)
+        .take_while(|(key, _)| key[0] == 3u8 && key[1] == 0u8)
+        .map(|(key, group)| {
+            let index = (key[2] as u64) << 24
+                | (key[3] as u64) << 16
+                | (key[4] as u64) << 8
+                | (key[5] as u64);
+            let number = index * LOG_BLOOMS_ELEMENTS_PER_INDEX;
+
+            let blooms = rlp::decode_list::<Bloom>(&group);
+            (number, blooms)
+        });
+
+    for (number, blooms) in blooms_iterator {
+        db.blooms().insert_blooms(number, blooms.iter())?;
+    }
+
+    // iterate over trace blooms and insert them in blooms-db
+    // Some(4) -> COL_TRACE
+    // 1u8 -> TraceDBIndex::BloomGroups
+    // 0u8 -> level 0
+    let trace_blooms_iterator = db
+        .key_value()
+        .iter_from_prefix(Some(4), &[1u8, 0u8])
+        .filter(|(key, _)| key.len() == 6)
+        .take_while(|(key, _)| key[0] == 1u8 && key[1] == 0u8)
+        .map(|(key, group)| {
+            let index = (key[2] as u64)
+                | (key[3] as u64) << 8
+                | (key[4] as u64) << 16
+                | (key[5] as u64) << 24;
+            let number = index * LOG_BLOOMS_ELEMENTS_PER_INDEX;
+
+            let blooms = rlp::decode_list::<Bloom>(&group);
+            (number, blooms)
+        });
+
+    for (number, blooms) in trace_blooms_iterator {
+        db.trace_blooms().insert_blooms(number, blooms.iter())?;
+    }
+
+    Ok(())
+}

bin/oe/db/rocksdb/helpers.rs

@@ -0,0 +1,40 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use super::kvdb_rocksdb::{CompactionProfile, DatabaseConfig};
+use ethcore::client::{ClientConfig, DatabaseCompactionProfile};
+use ethcore_db::NUM_COLUMNS;
+use std::path::Path;
+
+pub fn compaction_profile(
+    profile: &DatabaseCompactionProfile,
+    db_path: &Path,
+) -> CompactionProfile {
+    match profile {
+        &DatabaseCompactionProfile::Auto => CompactionProfile::auto(db_path),
+        &DatabaseCompactionProfile::SSD => CompactionProfile::ssd(),
+        &DatabaseCompactionProfile::HDD => CompactionProfile::hdd(),
+    }
+}
+
+pub fn client_db_config(client_path: &Path, client_config: &ClientConfig) -> DatabaseConfig {
+    let mut client_db_config = DatabaseConfig::with_columns(NUM_COLUMNS);
+
+    client_db_config.memory_budget = client_config.db_cache_size;
+    client_db_config.compaction = compaction_profile(&client_config.db_compaction, &client_path);
+
+    client_db_config
+}

bin/oe/db/rocksdb/migration.rs

@@ -0,0 +1,262 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use super::{
+    kvdb_rocksdb::{CompactionProfile, DatabaseConfig},
+    migration_rocksdb::{ChangeColumns, Config as MigrationConfig, Manager as MigrationManager},
+};
+use ethcore::{self, client::DatabaseCompactionProfile};
+use std::{
+    fmt::{Display, Error as FmtError, Formatter},
+    fs,
+    io::{Error as IoError, ErrorKind, Read, Write},
+    path::{Path, PathBuf},
+};
+
+use super::{blooms::migrate_blooms, helpers};
+
+/// The migration from v10 to v11.
+/// Adds a column for node info.
+pub const TO_V11: ChangeColumns = ChangeColumns {
+    pre_columns: Some(6),
+    post_columns: Some(7),
+    version: 11,
+};
+
+/// The migration from v11 to v12.
+/// Adds a column for light chain storage.
+pub const TO_V12: ChangeColumns = ChangeColumns {
+    pre_columns: Some(7),
+    post_columns: Some(8),
+    version: 12,
+};
+
+/// Database is assumed to be at default version, when no version file is found.
+const DEFAULT_VERSION: u32 = 5;
+/// Current version of database models.
+const CURRENT_VERSION: u32 = 16;
+/// Until this version please use upgrade tool.
+const USE_MIGRATION_TOOL: u32 = 15;
+/// A version of database at which blooms-db was introduced
+const BLOOMS_DB_VERSION: u32 = 13;
+/// Defines how many items are migrated to the new version of database at once.
+const BATCH_SIZE: usize = 1024;
+/// Version file name.
+const VERSION_FILE_NAME: &'static str = "db_version";
+
+/// Migration related erorrs.
+#[derive(Debug)]
+pub enum Error {
+    /// Returned when current version cannot be read or guessed.
+    UnknownDatabaseVersion,
+    /// Existing DB is newer than the known one.
+    FutureDBVersion,
+    /// Migration is not possible.
+    MigrationImpossible,
+    /// For old versions use external migration tool
+    UseMigrationTool,
+    /// Blooms-db migration error.
+    BloomsDB(ethcore::error::Error),
+    /// Migration was completed succesfully,
+    /// but there was a problem with io.
+    Io(IoError),
+}
+
+impl Display for Error {
+    fn fmt(&self, f: &mut Formatter) -> Result<(), FmtError> {
+        let out = match *self {
+			Error::UnknownDatabaseVersion => "Current database version cannot be read".into(),
+			Error::FutureDBVersion => "Database was created with newer client version. Upgrade your client or delete DB and resync.".into(),
+			Error::MigrationImpossible => format!("Database migration to version {} is not possible.", CURRENT_VERSION),
+            Error::BloomsDB(ref err) => format!("blooms-db migration error: {}", err),
+            Error::UseMigrationTool => "For db versions 15 and lower (v2.5.13=>13, 2.7.2=>14, v3.0.1=>15) please use upgrade db tool to manually upgrade db: https://github.com/openethereum/3.1-db-upgrade-tool".into(),
+			Error::Io(ref err) => format!("Unexpected io error on DB migration: {}.", err),
+		};
+
+        write!(f, "{}", out)
+    }
+}
+
+impl From<IoError> for Error {
+    fn from(err: IoError) -> Self {
+        Error::Io(err)
+    }
+}
+
+/// Returns the version file path.
+fn version_file_path(path: &Path) -> PathBuf {
+    let mut file_path = path.to_owned();
+    file_path.push(VERSION_FILE_NAME);
+    file_path
+}
+
+/// Reads current database version from the file at given path.
+/// If the file does not exist returns `DEFAULT_VERSION`.
+fn current_version(path: &Path) -> Result<u32, Error> {
+    match fs::File::open(version_file_path(path)) {
+        Err(ref err) if err.kind() == ErrorKind::NotFound => Ok(DEFAULT_VERSION),
+        Err(_) => Err(Error::UnknownDatabaseVersion),
+        Ok(mut file) => {
+            let mut s = String::new();
+            file.read_to_string(&mut s)
+                .map_err(|_| Error::UnknownDatabaseVersion)?;
+            u32::from_str_radix(&s, 10).map_err(|_| Error::UnknownDatabaseVersion)
+        }
+    }
+}
+
+/// Writes current database version to the file.
+/// Creates a new file if the version file does not exist yet.
+fn update_version(path: &Path) -> Result<(), Error> {
+    fs::create_dir_all(path)?;
+    let mut file = fs::File::create(version_file_path(path))?;
+    file.write_all(format!("{}", CURRENT_VERSION).as_bytes())?;
+    Ok(())
+}
+
+/// Consolidated database path
+fn consolidated_database_path(path: &Path) -> PathBuf {
+    let mut state_path = path.to_owned();
+    state_path.push("db");
+    state_path
+}
+
+/// Database backup
+fn backup_database_path(path: &Path) -> PathBuf {
+    let mut backup_path = path.to_owned();
+    backup_path.pop();
+    backup_path.push("temp_backup");
+    backup_path
+}
+
+/// Default migration settings.
+pub fn default_migration_settings(compaction_profile: &CompactionProfile) -> MigrationConfig {
+    MigrationConfig {
+        batch_size: BATCH_SIZE,
+        compaction_profile: *compaction_profile,
+    }
+}
+
+/// Migrations on the consolidated database.
+fn consolidated_database_migrations(
+    compaction_profile: &CompactionProfile,
+) -> Result<MigrationManager, Error> {
+    let mut manager = MigrationManager::new(default_migration_settings(compaction_profile));
+    manager
+        .add_migration(TO_V11)
+        .map_err(|_| Error::MigrationImpossible)?;
+    manager
+        .add_migration(TO_V12)
+        .map_err(|_| Error::MigrationImpossible)?;
+    Ok(manager)
+}
+
+/// Migrates database at given position with given migration rules.
+fn migrate_database(
+    version: u32,
+    db_path: &Path,
+    mut migrations: MigrationManager,
+) -> Result<(), Error> {
+    // check if migration is needed
+    if !migrations.is_needed(version) {
+        return Ok(());
+    }
+
+    let backup_path = backup_database_path(&db_path);
+    // remove the backup dir if it exists
+    let _ = fs::remove_dir_all(&backup_path);
+
+    // migrate old database to the new one
+    let temp_path = migrations.execute(&db_path, version)?;
+
+    // completely in-place migration leads to the paths being equal.
+    // in that case, no need to shuffle directories.
+    if temp_path == db_path {
+        return Ok(());
+    }
+
+    // create backup
+    fs::rename(&db_path, &backup_path)?;
+
+    // replace the old database with the new one
+    if let Err(err) = fs::rename(&temp_path, &db_path) {
+        // if something went wrong, bring back backup
+        fs::rename(&backup_path, &db_path)?;
+        return Err(err.into());
+    }
+
+    // remove backup
+    fs::remove_dir_all(&backup_path).map_err(Into::into)
+}
+
+fn exists(path: &Path) -> bool {
+    fs::metadata(path).is_ok()
+}
+
+/// Migrates the database.
+pub fn migrate(path: &Path, compaction_profile: &DatabaseCompactionProfile) -> Result<(), Error> {
+    let compaction_profile = helpers::compaction_profile(&compaction_profile, path);
+
+    // read version file.
+    let version = current_version(path)?;
+
+    // migrate the databases.
+    // main db directory may already exists, so let's check if we have blocks dir
+    if version > CURRENT_VERSION {
+        return Err(Error::FutureDBVersion);
+    }
+
+    // We are in the latest version, yay!
+    if version == CURRENT_VERSION {
+        return Ok(());
+    }
+
+    if version != DEFAULT_VERSION && version <= USE_MIGRATION_TOOL {
+        return Err(Error::UseMigrationTool);
+    }
+
+    let db_path = consolidated_database_path(path);
+
+    // Further migrations
+    if version < CURRENT_VERSION && exists(&db_path) {
+        println!(
+            "Migrating database from version {} to {}",
+            version, CURRENT_VERSION
+        );
+        migrate_database(
+            version,
+            &db_path,
+            consolidated_database_migrations(&compaction_profile)?,
+        )?;
+
+        if version < BLOOMS_DB_VERSION {
+            println!("Migrating blooms to blooms-db...");
+            let db_config = DatabaseConfig {
+                max_open_files: 64,
+                memory_budget: None,
+                compaction: compaction_profile,
+                columns: ethcore_db::NUM_COLUMNS,
+            };
+
+            migrate_blooms(&db_path, &db_config).map_err(Error::BloomsDB)?;
+        }
+
+        println!("Migration finished");
+    }
+
+    // update version file.
+    update_version(path)
+}

bin/oe/db/rocksdb/mod.rs

@@ -0,0 +1,119 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+extern crate ethcore_blockchain;
+extern crate kvdb_rocksdb;
+extern crate migration_rocksdb;
+
+use self::{
+    ethcore_blockchain::{BlockChainDB, BlockChainDBHandler},
+    kvdb_rocksdb::{Database, DatabaseConfig},
+};
+use blooms_db;
+use ethcore::client::ClientConfig;
+use ethcore_db::KeyValueDB;
+use stats::PrometheusMetrics;
+use std::{fs, io, path::Path, sync::Arc};
+
+mod blooms;
+mod helpers;
+mod migration;
+
+pub use self::migration::migrate;
+
+struct AppDB {
+    key_value: Arc<dyn KeyValueDB>,
+    blooms: blooms_db::Database,
+    trace_blooms: blooms_db::Database,
+}
+
+impl BlockChainDB for AppDB {
+    fn key_value(&self) -> &Arc<dyn KeyValueDB> {
+        &self.key_value
+    }
+
+    fn blooms(&self) -> &blooms_db::Database {
+        &self.blooms
+    }
+
+    fn trace_blooms(&self) -> &blooms_db::Database {
+        &self.trace_blooms
+    }
+}
+
+impl PrometheusMetrics for AppDB {
+    fn prometheus_metrics(&self, _: &mut stats::PrometheusRegistry) {}
+}
+
+/// Open a secret store DB using the given secret store data path. The DB path is one level beneath the data path.
+#[cfg(feature = "secretstore")]
+pub fn open_secretstore_db(data_path: &str) -> Result<Arc<dyn KeyValueDB>, String> {
+    use std::path::PathBuf;
+
+    let mut db_path = PathBuf::from(data_path);
+    db_path.push("db");
+    let db_path = db_path
+        .to_str()
+        .ok_or_else(|| "Invalid secretstore path".to_string())?;
+    Ok(Arc::new(
+        Database::open_default(&db_path).map_err(|e| format!("Error opening database: {:?}", e))?,
+    ))
+}
+
+/// Create a restoration db handler using the config generated by `client_path` and `client_config`.
+pub fn restoration_db_handler(
+    client_path: &Path,
+    client_config: &ClientConfig,
+) -> Box<dyn BlockChainDBHandler> {
+    let client_db_config = helpers::client_db_config(client_path, client_config);
+
+    struct RestorationDBHandler {
+        config: DatabaseConfig,
+    }
+
+    impl BlockChainDBHandler for RestorationDBHandler {
+        fn open(&self, db_path: &Path) -> io::Result<Arc<dyn BlockChainDB>> {
+            open_database(&db_path.to_string_lossy(), &self.config)
+        }
+    }
+
+    Box::new(RestorationDBHandler {
+        config: client_db_config,
+    })
+}
+
+pub fn open_database(
+    client_path: &str,
+    config: &DatabaseConfig,
+) -> io::Result<Arc<dyn BlockChainDB>> {
+    let path = Path::new(client_path);
+
+    let blooms_path = path.join("blooms");
+    let trace_blooms_path = path.join("trace_blooms");
+    fs::create_dir_all(&blooms_path)?;
+    fs::create_dir_all(&trace_blooms_path)?;
+
+    let db = Database::open(&config, client_path)?;
+    let db_with_metrics = ethcore_db::DatabaseWithMetrics::new(db);
+
+    let db = AppDB {
+        key_value: Arc::new(db_with_metrics),
+        blooms: blooms_db::Database::open(blooms_path)?,
+        trace_blooms: blooms_db::Database::open(trace_blooms_path)?,
+    };
+
+    Ok(Arc::new(db))
+}

bin/oe/helpers.rs

@@ -0,0 +1,600 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use crate::{
+    cache::CacheConfig,
+    db::migrate,
+    miner::pool::PrioritizationStrategy,
+    sync::{self, validate_node_url},
+    upgrade::{upgrade, upgrade_data_paths},
+};
+use dir::{helpers::replace_home, DatabaseDirectories};
+use ethcore::{
+    client::{BlockId, ClientConfig, DatabaseCompactionProfile, Mode, VMType, VerifierType},
+    miner::{Penalization, PendingSet},
+};
+use ethereum_types::{Address, U256};
+use ethkey::Password;
+use journaldb::Algorithm;
+use std::{
+    collections::HashSet,
+    fs::File,
+    io,
+    io::{BufRead, BufReader, Write},
+    time::Duration,
+};
+
+pub fn to_duration(s: &str) -> Result<Duration, String> {
+    to_seconds(s).map(Duration::from_secs)
+}
+
+fn clean_0x(s: &str) -> &str {
+    if s.starts_with("0x") {
+        &s[2..]
+    } else {
+        s
+    }
+}
+
+fn to_seconds(s: &str) -> Result<u64, String> {
+    let bad = |_| {
+        format!(
+            "{}: Invalid duration given. See openethereum --help for more information.",
+            s
+        )
+    };
+
+    match s {
+        "twice-daily" => Ok(12 * 60 * 60),
+        "half-hourly" => Ok(30 * 60),
+        "1second" | "1 second" | "second" => Ok(1),
+        "1minute" | "1 minute" | "minute" => Ok(60),
+        "hourly" | "1hour" | "1 hour" | "hour" => Ok(60 * 60),
+        "daily" | "1day" | "1 day" | "day" => Ok(24 * 60 * 60),
+        x if x.ends_with("seconds") => x[0..x.len() - 7].trim().parse().map_err(bad),
+        x if x.ends_with("minutes") => x[0..x.len() - 7]
+            .trim()
+            .parse::<u64>()
+            .map_err(bad)
+            .map(|x| x * 60),
+        x if x.ends_with("hours") => x[0..x.len() - 5]
+            .trim()
+            .parse::<u64>()
+            .map_err(bad)
+            .map(|x| x * 60 * 60),
+        x if x.ends_with("days") => x[0..x.len() - 4]
+            .trim()
+            .parse::<u64>()
+            .map_err(bad)
+            .map(|x| x * 24 * 60 * 60),
+        x => x.trim().parse().map_err(bad),
+    }
+}
+
+pub fn to_mode(s: &str, timeout: u64, alarm: u64) -> Result<Mode, String> {
+    match s {
+        "active" => Ok(Mode::Active),
+        "passive" => Ok(Mode::Passive(
+            Duration::from_secs(timeout),
+            Duration::from_secs(alarm),
+        )),
+        "dark" => Ok(Mode::Dark(Duration::from_secs(timeout))),
+        "offline" => Ok(Mode::Off),
+        _ => Err(format!(
+            "{}: Invalid value for --mode. Must be one of active, passive, dark or offline.",
+            s
+        )),
+    }
+}
+
+pub fn to_block_id(s: &str) -> Result<BlockId, String> {
+    if s == "latest" {
+        Ok(BlockId::Latest)
+    } else if let Ok(num) = s.parse() {
+        Ok(BlockId::Number(num))
+    } else if let Ok(hash) = s.parse() {
+        Ok(BlockId::Hash(hash))
+    } else {
+        Err("Invalid block.".into())
+    }
+}
+
+pub fn to_u256(s: &str) -> Result<U256, String> {
+    if let Ok(decimal) = U256::from_dec_str(s) {
+        Ok(decimal)
+    } else {
+        clean_0x(s)
+            .parse()
+            .map_err(|_| format!("Invalid numeric value: {}", s))
+    }
+}
+
+pub fn to_pending_set(s: &str) -> Result<PendingSet, String> {
+    match s {
+        "cheap" => Ok(PendingSet::AlwaysQueue),
+        "strict" => Ok(PendingSet::AlwaysSealing),
+        "lenient" => Ok(PendingSet::SealingOrElseQueue),
+        other => Err(format!("Invalid pending set value: {:?}", other)),
+    }
+}
+
+pub fn to_queue_strategy(s: &str) -> Result<PrioritizationStrategy, String> {
+    match s {
+        "gas_price" => Ok(PrioritizationStrategy::GasPriceOnly),
+        other => Err(format!("Invalid queue strategy: {}", other)),
+    }
+}
+
+pub fn to_queue_penalization(time: Option<u64>) -> Result<Penalization, String> {
+    Ok(match time {
+        Some(threshold_ms) => Penalization::Enabled {
+            offend_threshold: Duration::from_millis(threshold_ms),
+        },
+        None => Penalization::Disabled,
+    })
+}
+
+pub fn to_address(s: Option<String>) -> Result<Address, String> {
+    match s {
+        Some(ref a) => clean_0x(a)
+            .parse()
+            .map_err(|_| format!("Invalid address: {:?}", a)),
+        None => Ok(Address::default()),
+    }
+}
+
+pub fn to_addresses(s: &Option<String>) -> Result<Vec<Address>, String> {
+    match *s {
+        Some(ref adds) if !adds.is_empty() => adds
+            .split(',')
+            .map(|a| {
+                clean_0x(a)
+                    .parse()
+                    .map_err(|_| format!("Invalid address: {:?}", a))
+            })
+            .collect(),
+        _ => Ok(Vec::new()),
+    }
+}
+
+/// Tries to parse string as a price.
+pub fn to_price(s: &str) -> Result<f32, String> {
+    s.parse::<f32>().map_err(|_| {
+        format!(
+            "Invalid transaction price {:?} given. Must be a decimal number.",
+            s
+        )
+    })
+}
+
+pub fn join_set(set: Option<&HashSet<String>>) -> Option<String> {
+    set.map(|s| {
+        s.iter()
+            .map(|s| s.as_str())
+            .collect::<Vec<&str>>()
+            .join(",")
+    })
+}
+
+/// Flush output buffer.
+pub fn flush_stdout() {
+    io::stdout().flush().expect("stdout is flushable; qed");
+}
+
+/// Formats and returns parity ipc path.
+pub fn parity_ipc_path(base: &str, path: &str, shift: u16) -> String {
+    let mut path = path.to_owned();
+    if shift != 0 {
+        path = path.replace("jsonrpc.ipc", &format!("jsonrpc-{}.ipc", shift));
+    }
+    replace_home(base, &path)
+}
+
+/// Validates and formats bootnodes option.
+pub fn to_bootnodes(bootnodes: &Option<String>) -> Result<Vec<String>, String> {
+    match *bootnodes {
+        Some(ref x) if !x.is_empty() => x
+            .split(',')
+            .map(|s| match validate_node_url(s).map(Into::into) {
+                None => Ok(s.to_owned()),
+                Some(sync::ErrorKind::AddressResolve(_)) => {
+                    Err(format!("Failed to resolve hostname of a boot node: {}", s))
+                }
+                Some(_) => Err(format!(
+                    "Invalid node address format given for a boot node: {}",
+                    s
+                )),
+            })
+            .collect(),
+        Some(_) => Ok(vec![]),
+        None => Ok(vec![]),
+    }
+}
+
+#[cfg(test)]
+pub fn default_network_config() -> crate::sync::NetworkConfiguration {
+    use super::network::IpFilter;
+    use crate::sync::NetworkConfiguration;
+    NetworkConfiguration {
+        config_path: Some(replace_home(&::dir::default_data_path(), "$BASE/network")),
+        net_config_path: None,
+        listen_address: Some("0.0.0.0:30303".into()),
+        public_address: None,
+        udp_port: None,
+        nat_enabled: true,
+        discovery_enabled: true,
+        boot_nodes: Vec::new(),
+        use_secret: None,
+        max_peers: 50,
+        min_peers: 25,
+        snapshot_peers: 0,
+        max_pending_peers: 64,
+        ip_filter: IpFilter::default(),
+        reserved_nodes: Vec::new(),
+        allow_non_reserved: true,
+        client_version: ::parity_version::version(),
+    }
+}
+
+pub fn to_client_config(
+    cache_config: &CacheConfig,
+    spec_name: String,
+    mode: Mode,
+    tracing: bool,
+    fat_db: bool,
+    compaction: DatabaseCompactionProfile,
+    vm_type: VMType,
+    name: String,
+    pruning: Algorithm,
+    pruning_history: u64,
+    pruning_memory: usize,
+    check_seal: bool,
+    max_round_blocks_to_import: usize,
+) -> ClientConfig {
+    let mut client_config = ClientConfig::default();
+
+    let mb = 1024 * 1024;
+    // in bytes
+    client_config.blockchain.max_cache_size = cache_config.blockchain() as usize * mb;
+    // in bytes
+    client_config.blockchain.pref_cache_size = cache_config.blockchain() as usize * 3 / 4 * mb;
+    // db cache size, in megabytes
+    client_config.db_cache_size = Some(cache_config.db_cache_size() as usize);
+    // db queue cache size, in bytes
+    client_config.queue.max_mem_use = cache_config.queue() as usize * mb;
+    // in bytes
+    client_config.tracing.max_cache_size = cache_config.traces() as usize * mb;
+    // in bytes
+    client_config.tracing.pref_cache_size = cache_config.traces() as usize * 3 / 4 * mb;
+    // in bytes
+    client_config.state_cache_size = cache_config.state() as usize * mb;
+    // in bytes
+    client_config.jump_table_size = cache_config.jump_tables() as usize * mb;
+    // in bytes
+    client_config.history_mem = pruning_memory * mb;
+
+    client_config.mode = mode;
+    client_config.tracing.enabled = tracing;
+    client_config.fat_db = fat_db;
+    client_config.pruning = pruning;
+    client_config.history = pruning_history;
+    client_config.db_compaction = compaction;
+    client_config.vm_type = vm_type;
+    client_config.name = name;
+    client_config.verifier_type = if check_seal {
+        VerifierType::Canon
+    } else {
+        VerifierType::CanonNoSeal
+    };
+    client_config.spec_name = spec_name;
+    client_config.max_round_blocks_to_import = max_round_blocks_to_import;
+    client_config
+}
+
+pub fn execute_upgrades(
+    base_path: &str,
+    dirs: &DatabaseDirectories,
+    pruning: Algorithm,
+    compaction_profile: &DatabaseCompactionProfile,
+) -> Result<(), String> {
+    upgrade_data_paths(base_path, dirs, pruning);
+
+    match upgrade(&dirs.path) {
+        Ok(upgrades_applied) if upgrades_applied > 0 => {
+            debug!("Executed {} upgrade scripts - ok", upgrades_applied);
+        }
+        Err(e) => {
+            return Err(format!("Error upgrading OpenEthereum data: {:?}", e));
+        }
+        _ => {}
+    }
+
+    let client_path = dirs.db_path(pruning);
+    migrate(&client_path, compaction_profile).map_err(|e| format!("{}", e))
+}
+
+/// Prompts user asking for password.
+pub fn password_prompt() -> Result<Password, String> {
+    use rpassword::read_password;
+    const STDIN_ERROR: &'static str = "Unable to ask for password on non-interactive terminal.";
+
+    println!("Please note that password is NOT RECOVERABLE.");
+    print!("Type password: ");
+    flush_stdout();
+
+    let password = read_password().map_err(|_| STDIN_ERROR.to_owned())?.into();
+
+    print!("Repeat password: ");
+    flush_stdout();
+
+    let password_repeat = read_password().map_err(|_| STDIN_ERROR.to_owned())?.into();
+
+    if password != password_repeat {
+        return Err("Passwords do not match!".into());
+    }
+
+    Ok(password)
+}
+
+/// Read a password from password file.
+pub fn password_from_file(path: String) -> Result<Password, String> {
+    let passwords = passwords_from_files(&[path])?;
+    // use only first password from the file
+    passwords
+        .get(0)
+        .map(Password::clone)
+        .ok_or_else(|| "Password file seems to be empty.".to_owned())
+}
+
+/// Reads passwords from files. Treats each line as a separate password.
+pub fn passwords_from_files(files: &[String]) -> Result<Vec<Password>, String> {
+    let passwords = files.iter().map(|filename| {
+		let file = File::open(filename).map_err(|_| format!("{} Unable to read password file. Ensure it exists and permissions are correct.", filename))?;
+		let reader = BufReader::new(&file);
+		let lines = reader.lines()
+			.filter_map(|l| l.ok())
+			.map(|pwd| pwd.trim().to_owned().into())
+			.collect::<Vec<Password>>();
+		Ok(lines)
+	}).collect::<Result<Vec<Vec<Password>>, String>>();
+    Ok(passwords?.into_iter().flat_map(|x| x).collect())
+}
+
+#[cfg(test)]
+mod tests {
+    use super::{
+        join_set, password_from_file, to_address, to_addresses, to_block_id, to_bootnodes,
+        to_duration, to_mode, to_pending_set, to_price, to_u256,
+    };
+    use ethcore::{
+        client::{BlockId, Mode},
+        miner::PendingSet,
+    };
+    use ethereum_types::U256;
+    use ethkey::Password;
+    use std::{collections::HashSet, fs::File, io::Write, time::Duration};
+    use tempdir::TempDir;
+
+    #[test]
+    fn test_to_duration() {
+        assert_eq!(
+            to_duration("twice-daily").unwrap(),
+            Duration::from_secs(12 * 60 * 60)
+        );
+        assert_eq!(
+            to_duration("half-hourly").unwrap(),
+            Duration::from_secs(30 * 60)
+        );
+        assert_eq!(to_duration("1second").unwrap(), Duration::from_secs(1));
+        assert_eq!(to_duration("2seconds").unwrap(), Duration::from_secs(2));
+        assert_eq!(to_duration("15seconds").unwrap(), Duration::from_secs(15));
+        assert_eq!(to_duration("1minute").unwrap(), Duration::from_secs(1 * 60));
+        assert_eq!(
+            to_duration("2minutes").unwrap(),
+            Duration::from_secs(2 * 60)
+        );
+        assert_eq!(
+            to_duration("15minutes").unwrap(),
+            Duration::from_secs(15 * 60)
+        );
+        assert_eq!(to_duration("hourly").unwrap(), Duration::from_secs(60 * 60));
+        assert_eq!(
+            to_duration("daily").unwrap(),
+            Duration::from_secs(24 * 60 * 60)
+        );
+        assert_eq!(
+            to_duration("1hour").unwrap(),
+            Duration::from_secs(1 * 60 * 60)
+        );
+        assert_eq!(
+            to_duration("2hours").unwrap(),
+            Duration::from_secs(2 * 60 * 60)
+        );
+        assert_eq!(
+            to_duration("15hours").unwrap(),
+            Duration::from_secs(15 * 60 * 60)
+        );
+        assert_eq!(
+            to_duration("1day").unwrap(),
+            Duration::from_secs(1 * 24 * 60 * 60)
+        );
+        assert_eq!(
+            to_duration("2days").unwrap(),
+            Duration::from_secs(2 * 24 * 60 * 60)
+        );
+        assert_eq!(
+            to_duration("15days").unwrap(),
+            Duration::from_secs(15 * 24 * 60 * 60)
+        );
+        assert_eq!(
+            to_duration("15 days").unwrap(),
+            Duration::from_secs(15 * 24 * 60 * 60)
+        );
+        assert_eq!(to_duration("2  seconds").unwrap(), Duration::from_secs(2));
+    }
+
+    #[test]
+    fn test_to_mode() {
+        assert_eq!(to_mode("active", 0, 0).unwrap(), Mode::Active);
+        assert_eq!(
+            to_mode("passive", 10, 20).unwrap(),
+            Mode::Passive(Duration::from_secs(10), Duration::from_secs(20))
+        );
+        assert_eq!(
+            to_mode("dark", 20, 30).unwrap(),
+            Mode::Dark(Duration::from_secs(20))
+        );
+        assert!(to_mode("other", 20, 30).is_err());
+    }
+
+    #[test]
+    fn test_to_block_id() {
+        assert_eq!(to_block_id("latest").unwrap(), BlockId::Latest);
+        assert_eq!(to_block_id("0").unwrap(), BlockId::Number(0));
+        assert_eq!(to_block_id("2").unwrap(), BlockId::Number(2));
+        assert_eq!(to_block_id("15").unwrap(), BlockId::Number(15));
+        assert_eq!(
+            to_block_id("9fc84d84f6a785dc1bd5abacfcf9cbdd3b6afb80c0f799bfb2fd42c44a0c224e")
+                .unwrap(),
+            BlockId::Hash(
+                "9fc84d84f6a785dc1bd5abacfcf9cbdd3b6afb80c0f799bfb2fd42c44a0c224e"
+                    .parse()
+                    .unwrap()
+            )
+        );
+    }
+
+    #[test]
+    fn test_to_u256() {
+        assert_eq!(to_u256("0").unwrap(), U256::from(0));
+        assert_eq!(to_u256("11").unwrap(), U256::from(11));
+        assert_eq!(to_u256("0x11").unwrap(), U256::from(17));
+        assert!(to_u256("u").is_err())
+    }
+
+    #[test]
+    fn test_pending_set() {
+        assert_eq!(to_pending_set("cheap").unwrap(), PendingSet::AlwaysQueue);
+        assert_eq!(to_pending_set("strict").unwrap(), PendingSet::AlwaysSealing);
+        assert_eq!(
+            to_pending_set("lenient").unwrap(),
+            PendingSet::SealingOrElseQueue
+        );
+        assert!(to_pending_set("othe").is_err());
+    }
+
+    #[test]
+    fn test_to_address() {
+        assert_eq!(
+            to_address(Some("0xD9A111feda3f362f55Ef1744347CDC8Dd9964a41".into())).unwrap(),
+            "D9A111feda3f362f55Ef1744347CDC8Dd9964a41".parse().unwrap()
+        );
+        assert_eq!(
+            to_address(Some("D9A111feda3f362f55Ef1744347CDC8Dd9964a41".into())).unwrap(),
+            "D9A111feda3f362f55Ef1744347CDC8Dd9964a41".parse().unwrap()
+        );
+        assert_eq!(to_address(None).unwrap(), Default::default());
+    }
+
+    #[test]
+    fn test_to_addresses() {
+        let addresses = to_addresses(&Some(
+            "0xD9A111feda3f362f55Ef1744347CDC8Dd9964a41,D9A111feda3f362f55Ef1744347CDC8Dd9964a42"
+                .into(),
+        ))
+        .unwrap();
+        assert_eq!(
+            addresses,
+            vec![
+                "D9A111feda3f362f55Ef1744347CDC8Dd9964a41".parse().unwrap(),
+                "D9A111feda3f362f55Ef1744347CDC8Dd9964a42".parse().unwrap(),
+            ]
+        );
+    }
+
+    #[test]
+    fn test_password() {
+        let tempdir = TempDir::new("").unwrap();
+        let path = tempdir.path().join("file");
+        let mut file = File::create(&path).unwrap();
+        file.write_all(b"a bc ").unwrap();
+        assert_eq!(
+            password_from_file(path.to_str().unwrap().into())
+                .unwrap()
+                .as_bytes(),
+            b"a bc"
+        );
+    }
+
+    #[test]
+    fn test_password_multiline() {
+        let tempdir = TempDir::new("").unwrap();
+        let path = tempdir.path().join("file");
+        let mut file = File::create(path.as_path()).unwrap();
+        file.write_all(
+            br#"    password with trailing whitespace
+those passwords should be
+ignored
+but the first password is trimmed
+
+"#,
+        )
+        .unwrap();
+        assert_eq!(
+            password_from_file(path.to_str().unwrap().into()).unwrap(),
+            Password::from("password with trailing whitespace")
+        );
+    }
+
+    #[test]
+    fn test_to_price() {
+        assert_eq!(to_price("1").unwrap(), 1.0);
+        assert_eq!(to_price("2.3").unwrap(), 2.3);
+        assert_eq!(to_price("2.33").unwrap(), 2.33);
+    }
+
+    #[test]
+    fn test_to_bootnodes() {
+        let one_bootnode = "enode://e731347db0521f3476e6bbbb83375dcd7133a1601425ebd15fd10f3835fd4c304fba6282087ca5a0deeafadf0aa0d4fd56c3323331901c1f38bd181c283e3e35@128.199.55.137:30303";
+        let two_bootnodes = "enode://e731347db0521f3476e6bbbb83375dcd7133a1601425ebd15fd10f3835fd4c304fba6282087ca5a0deeafadf0aa0d4fd56c3323331901c1f38bd181c283e3e35@128.199.55.137:30303,enode://e731347db0521f3476e6bbbb83375dcd7133a1601425ebd15fd10f3835fd4c304fba6282087ca5a0deeafadf0aa0d4fd56c3323331901c1f38bd181c283e3e35@128.199.55.137:30303";
+
+        assert_eq!(to_bootnodes(&Some("".into())), Ok(vec![]));
+        assert_eq!(to_bootnodes(&None), Ok(vec![]));
+        assert_eq!(
+            to_bootnodes(&Some(one_bootnode.into())),
+            Ok(vec![one_bootnode.into()])
+        );
+        assert_eq!(
+            to_bootnodes(&Some(two_bootnodes.into())),
+            Ok(vec![one_bootnode.into(), one_bootnode.into()])
+        );
+    }
+
+    #[test]
+    fn test_join_set() {
+        let mut test_set = HashSet::new();
+        test_set.insert("0x1111111111111111111111111111111111111111".to_string());
+        test_set.insert("0x0000000000000000000000000000000000000000".to_string());
+
+        let res = join_set(Some(&test_set)).unwrap();
+
+        assert!(
+			res == "0x1111111111111111111111111111111111111111,0x0000000000000000000000000000000000000000"
+			||
+			res == "0x0000000000000000000000000000000000000000,0x1111111111111111111111111111111111111111"
+		);
+    }
+}

bin/oe/informant.rs

@@ -0,0 +1,429 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+extern crate ansi_term;
+use self::ansi_term::{
+    Colour,
+    Colour::{Blue, Cyan, Green, White, Yellow},
+    Style,
+};
+
+use std::{
+    sync::{
+        atomic::{AtomicBool, AtomicUsize, Ordering as AtomicOrdering},
+        Arc,
+    },
+    time::{Duration, Instant},
+};
+
+use crate::{
+    io::{IoContext, IoHandler, TimerToken},
+    sync::{ManageNetwork, SyncProvider},
+    types::BlockNumber,
+};
+use atty;
+use ethcore::{
+    client::{
+        BlockChainClient, BlockChainInfo, BlockId, BlockInfo, BlockQueueInfo, ChainInfo,
+        ChainNotify, Client, ClientIoMessage, ClientReport, NewBlocks,
+    },
+    snapshot::{service::Service as SnapshotService, RestorationStatus, SnapshotService as SS},
+};
+use number_prefix::{binary_prefix, Prefixed, Standalone};
+use parity_rpc::{informant::RpcStats, is_major_importing_or_waiting};
+use parking_lot::{Mutex, RwLock};
+
+/// Format byte counts to standard denominations.
+pub fn format_bytes(b: usize) -> String {
+    match binary_prefix(b as f64) {
+        Standalone(bytes) => format!("{} bytes", bytes),
+        Prefixed(prefix, n) => format!("{:.0} {}B", n, prefix),
+    }
+}
+
+/// Something that can be converted to milliseconds.
+pub trait MillisecondDuration {
+    /// Get the value in milliseconds.
+    fn as_milliseconds(&self) -> u64;
+}
+
+impl MillisecondDuration for Duration {
+    fn as_milliseconds(&self) -> u64 {
+        self.as_secs() * 1000 + self.subsec_nanos() as u64 / 1_000_000
+    }
+}
+
+#[derive(Default)]
+struct CacheSizes {
+    sizes: ::std::collections::BTreeMap<&'static str, usize>,
+}
+
+impl CacheSizes {
+    fn insert(&mut self, key: &'static str, bytes: usize) {
+        self.sizes.insert(key, bytes);
+    }
+
+    fn display<F>(&self, style: Style, paint: F) -> String
+    where
+        F: Fn(Style, String) -> String,
+    {
+        use std::fmt::Write;
+
+        let mut buf = String::new();
+        for (name, &size) in &self.sizes {
+            write!(buf, " {:>8} {}", paint(style, format_bytes(size)), name)
+                .expect("writing to string won't fail unless OOM; qed")
+        }
+
+        buf
+    }
+}
+
+pub struct SyncInfo {
+    last_imported_block_number: BlockNumber,
+    last_imported_ancient_number: Option<BlockNumber>,
+    num_peers: usize,
+    max_peers: u32,
+    snapshot_sync: bool,
+}
+
+pub struct Report {
+    importing: bool,
+    chain_info: BlockChainInfo,
+    client_report: ClientReport,
+    queue_info: BlockQueueInfo,
+    cache_sizes: CacheSizes,
+    sync_info: Option<SyncInfo>,
+}
+
+/// Something which can provide data to the informant.
+pub trait InformantData: Send + Sync {
+    /// Whether it executes transactions
+    fn executes_transactions(&self) -> bool;
+
+    /// Whether it is currently importing (also included in `Report`)
+    fn is_major_importing(&self) -> bool;
+
+    /// Generate a report of blockchain status, memory usage, and sync info.
+    fn report(&self) -> Report;
+}
+
+/// Informant data for a full node.
+pub struct FullNodeInformantData {
+    pub client: Arc<Client>,
+    pub sync: Option<Arc<dyn SyncProvider>>,
+    pub net: Option<Arc<dyn ManageNetwork>>,
+}
+
+impl InformantData for FullNodeInformantData {
+    fn executes_transactions(&self) -> bool {
+        true
+    }
+
+    fn is_major_importing(&self) -> bool {
+        let state = self.sync.as_ref().map(|sync| sync.status().state);
+        is_major_importing_or_waiting(state, self.client.queue_info(), false)
+    }
+
+    fn report(&self) -> Report {
+        let (client_report, queue_info, blockchain_cache_info) = (
+            self.client.report(),
+            self.client.queue_info(),
+            self.client.blockchain_cache_info(),
+        );
+
+        let chain_info = self.client.chain_info();
+
+        let mut cache_sizes = CacheSizes::default();
+        cache_sizes.insert("queue", queue_info.mem_used);
+        cache_sizes.insert("chain", blockchain_cache_info.total());
+
+        let importing = self.is_major_importing();
+        let sync_info = match (self.sync.as_ref(), self.net.as_ref()) {
+            (Some(sync), Some(net)) => {
+                let status = sync.status();
+                let num_peers_range = net.num_peers_range();
+                debug_assert!(num_peers_range.end() >= num_peers_range.start());
+
+                Some(SyncInfo {
+                    last_imported_block_number: status
+                        .last_imported_block_number
+                        .unwrap_or(chain_info.best_block_number),
+                    last_imported_ancient_number: status.last_imported_old_block_number,
+                    num_peers: status.num_peers,
+                    max_peers: status
+                        .current_max_peers(*num_peers_range.start(), *num_peers_range.end()),
+                    snapshot_sync: status.is_snapshot_syncing(),
+                })
+            }
+            _ => None,
+        };
+
+        Report {
+            importing,
+            chain_info,
+            client_report,
+            queue_info,
+            cache_sizes,
+            sync_info,
+        }
+    }
+}
+
+pub struct Informant<T> {
+    last_tick: RwLock<Instant>,
+    with_color: bool,
+    target: T,
+    snapshot: Option<Arc<SnapshotService>>,
+    rpc_stats: Option<Arc<RpcStats>>,
+    last_import: Mutex<Instant>,
+    skipped: AtomicUsize,
+    skipped_txs: AtomicUsize,
+    in_shutdown: AtomicBool,
+    last_report: Mutex<ClientReport>,
+}
+
+impl<T: InformantData> Informant<T> {
+    /// Make a new instance potentially `with_color` output.
+    pub fn new(
+        target: T,
+        snapshot: Option<Arc<SnapshotService>>,
+        rpc_stats: Option<Arc<RpcStats>>,
+        with_color: bool,
+    ) -> Self {
+        Informant {
+            last_tick: RwLock::new(Instant::now()),
+            with_color: with_color,
+            target: target,
+            snapshot: snapshot,
+            rpc_stats: rpc_stats,
+            last_import: Mutex::new(Instant::now()),
+            skipped: AtomicUsize::new(0),
+            skipped_txs: AtomicUsize::new(0),
+            in_shutdown: AtomicBool::new(false),
+            last_report: Mutex::new(Default::default()),
+        }
+    }
+
+    /// Signal that we're shutting down; no more output necessary.
+    pub fn shutdown(&self) {
+        self.in_shutdown
+            .store(true, ::std::sync::atomic::Ordering::SeqCst);
+    }
+
+    pub fn tick(&self) {
+        let now = Instant::now();
+        let elapsed;
+        {
+            let last_tick = self.last_tick.read();
+            if now < *last_tick + Duration::from_millis(1500) {
+                return;
+            }
+            elapsed = now - *last_tick;
+        }
+
+        let (client_report, full_report) = {
+            let last_report = self.last_report.lock();
+            let full_report = self.target.report();
+            let diffed = full_report.client_report.clone() - &*last_report;
+            (diffed, full_report)
+        };
+
+        let Report {
+            importing,
+            chain_info,
+            queue_info,
+            cache_sizes,
+            sync_info,
+            ..
+        } = full_report;
+
+        let rpc_stats = self.rpc_stats.as_ref();
+        let snapshot_sync = sync_info.as_ref().map_or(false, |s| s.snapshot_sync)
+            && self
+                .snapshot
+                .as_ref()
+                .map_or(false, |s| match s.restoration_status() {
+                    RestorationStatus::Ongoing { .. } | RestorationStatus::Initializing { .. } => {
+                        true
+                    }
+                    _ => false,
+                });
+        if !importing && !snapshot_sync && elapsed < Duration::from_secs(30) {
+            return;
+        }
+
+        *self.last_tick.write() = now;
+        *self.last_report.lock() = full_report.client_report.clone();
+
+        let paint = |c: Style, t: String| match self.with_color && atty::is(atty::Stream::Stdout) {
+            true => format!("{}", c.paint(t)),
+            false => t,
+        };
+
+        info!(target: "import", "{}{} {}  {}  {}",
+            match importing {
+                true => match snapshot_sync {
+                    false => format!("Syncing {} {}  {}  {}+{} Qed",
+                        paint(White.bold(), format!("{:>8}", format!("#{}", chain_info.best_block_number))),
+                        paint(White.bold(), format!("{}", chain_info.best_block_hash)),
+                        if self.target.executes_transactions() {
+                            format!("{} blk/s {} tx/s {} Mgas/s",
+                                paint(Yellow.bold(), format!("{:7.2}", (client_report.blocks_imported * 1000) as f64 / elapsed.as_milliseconds() as f64)),
+                                paint(Yellow.bold(), format!("{:6.1}", (client_report.transactions_applied * 1000) as f64 / elapsed.as_milliseconds() as f64)),
+                                paint(Yellow.bold(), format!("{:6.1}", (client_report.gas_processed / 1000).low_u64() as f64 / elapsed.as_milliseconds() as f64))
+                            )
+                        } else {
+                            format!("{} hdr/s",
+                                paint(Yellow.bold(), format!("{:6.1}", (client_report.blocks_imported * 1000) as f64 / elapsed.as_milliseconds() as f64))
+                            )
+                        },
+                        paint(Green.bold(), format!("{:5}", queue_info.unverified_queue_size)),
+                        paint(Green.bold(), format!("{:5}", queue_info.verified_queue_size))
+                    ),
+                    true => {
+                        self.snapshot.as_ref().map_or(String::new(), |s|
+                            match s.restoration_status() {
+                                RestorationStatus::Ongoing { state_chunks, block_chunks, state_chunks_done, block_chunks_done, .. } => {
+                                    format!("Syncing snapshot {}/{}", state_chunks_done + block_chunks_done, state_chunks + block_chunks)
+                                },
+                                RestorationStatus::Initializing { chunks_done } => {
+                                    format!("Snapshot initializing ({} chunks restored)", chunks_done)
+                                },
+                                _ => String::new(),
+                            }
+                        )
+                    },
+                },
+                false => String::new(),
+            },
+            match chain_info.ancient_block_number {
+                Some(ancient_number) => format!(" Ancient:#{}", ancient_number),
+                None => String::new(),
+            },
+            match sync_info.as_ref() {
+                Some(ref sync_info) => format!("{}{}/{} peers",
+                    match importing {
+                        true => format!("{}",
+                            if self.target.executes_transactions() {
+                                paint(Green.bold(), format!("{:>8}   ", format!("LI:#{}", sync_info.last_imported_block_number)))
+                            } else {
+                                String::new()
+                            }
+                        ),
+                        false => match sync_info.last_imported_ancient_number {
+                            Some(number) => format!("{}   ", paint(Yellow.bold(), format!("{:>8}", format!("AB:#{}", number)))),
+                            None => String::new(),
+                        }
+                    },
+                    paint(Cyan.bold(), format!("{:2}", sync_info.num_peers)),
+                    paint(Cyan.bold(), format!("{:2}", sync_info.max_peers)),
+                ),
+                _ => String::new(),
+            },
+            cache_sizes.display(Blue.bold(), &paint),
+            match rpc_stats {
+                Some(ref rpc_stats) => format!(
+                    "RPC: {} conn, {} req/s, {} µs",
+                    paint(Blue.bold(), format!("{:2}", rpc_stats.sessions())),
+                    paint(Blue.bold(), format!("{:4}", rpc_stats.requests_rate())),
+                    paint(Blue.bold(), format!("{:4}", rpc_stats.approximated_roundtrip())),
+                ),
+                _ => String::new(),
+            },
+        );
+    }
+}
+
+impl ChainNotify for Informant<FullNodeInformantData> {
+    // t_nb 11.2 Informant. Prints new block inclusiong to console/log.
+    fn new_blocks(&self, new_blocks: NewBlocks) {
+        if new_blocks.has_more_blocks_to_import {
+            return;
+        }
+        let mut last_import = self.last_import.lock();
+        let client = &self.target.client;
+
+        let importing = self.target.is_major_importing();
+        let ripe = Instant::now() > *last_import + Duration::from_secs(1) && !importing;
+        let txs_imported = new_blocks
+            .imported
+            .iter()
+            .take(
+                new_blocks
+                    .imported
+                    .len()
+                    .saturating_sub(if ripe { 1 } else { 0 }),
+            )
+            .filter_map(|h| client.block(BlockId::Hash(*h)))
+            .map(|b| b.transactions_count())
+            .sum();
+
+        if ripe {
+            if let Some(block) = new_blocks
+                .imported
+                .last()
+                .and_then(|h| client.block(BlockId::Hash(*h)))
+            {
+                let header_view = block.header_view();
+                let size = block.rlp().as_raw().len();
+                let (skipped, skipped_txs) = (
+                    self.skipped.load(AtomicOrdering::Relaxed) + new_blocks.imported.len() - 1,
+                    self.skipped_txs.load(AtomicOrdering::Relaxed) + txs_imported,
+                );
+                info!(target: "import", "Imported {} {} ({} txs, {} Mgas, {} ms, {} KiB){}",
+                    Colour::White.bold().paint(format!("#{}", header_view.number())),
+                    Colour::White.bold().paint(format!("{}", header_view.hash())),
+                    Colour::Yellow.bold().paint(format!("{}", block.transactions_count())),
+                    Colour::Yellow.bold().paint(format!("{:.2}", header_view.gas_used().low_u64() as f32 / 1000000f32)),
+                    Colour::Purple.bold().paint(format!("{}", new_blocks.duration.as_milliseconds())),
+                    Colour::Blue.bold().paint(format!("{:.2}", size as f32 / 1024f32)),
+                    if skipped > 0 {
+                        format!(" + another {} block(s) containing {} tx(s)",
+                            Colour::Red.bold().paint(format!("{}", skipped)),
+                            Colour::Red.bold().paint(format!("{}", skipped_txs))
+                        )
+                    } else {
+                        String::new()
+                    }
+                );
+                self.skipped.store(0, AtomicOrdering::Relaxed);
+                self.skipped_txs.store(0, AtomicOrdering::Relaxed);
+                *last_import = Instant::now();
+            }
+        } else {
+            self.skipped
+                .fetch_add(new_blocks.imported.len(), AtomicOrdering::Relaxed);
+            self.skipped_txs
+                .fetch_add(txs_imported, AtomicOrdering::Relaxed);
+        }
+    }
+}
+
+const INFO_TIMER: TimerToken = 0;
+
+impl<T: InformantData> IoHandler<ClientIoMessage> for Informant<T> {
+    fn initialize(&self, io: &IoContext<ClientIoMessage>) {
+        io.register_timer(INFO_TIMER, Duration::from_secs(5))
+            .expect("Error registering timer");
+    }
+
+    fn timeout(&self, _io: &IoContext<ClientIoMessage>, timer: TimerToken) {
+        if timer == INFO_TIMER && !self.in_shutdown.load(AtomicOrdering::SeqCst) {
+            self.tick();
+        }
+    }
+}

bin/oe/lib.rs

@@ -0,0 +1,240 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Ethcore client application.
+#![warn(missing_docs)]
+
+extern crate ansi_term;
+extern crate docopt;
+#[macro_use]
+extern crate clap;
+extern crate atty;
+extern crate dir;
+extern crate futures;
+extern crate jsonrpc_core;
+extern crate num_cpus;
+extern crate number_prefix;
+extern crate parking_lot;
+extern crate regex;
+extern crate rlp;
+extern crate rpassword;
+extern crate rustc_hex;
+extern crate semver;
+extern crate serde;
+extern crate serde_json;
+#[macro_use]
+extern crate serde_derive;
+extern crate toml;
+
+extern crate blooms_db;
+extern crate cli_signer;
+extern crate common_types as types;
+extern crate ethcore;
+extern crate ethcore_call_contract as call_contract;
+extern crate ethcore_db;
+extern crate ethcore_io as io;
+extern crate ethcore_logger;
+extern crate ethcore_miner as miner;
+extern crate ethcore_network as network;
+extern crate ethcore_service;
+extern crate ethcore_sync as sync;
+extern crate ethereum_types;
+extern crate ethkey;
+extern crate ethstore;
+extern crate fetch;
+extern crate hyper;
+extern crate journaldb;
+extern crate keccak_hash as hash;
+extern crate kvdb;
+extern crate node_filter;
+extern crate parity_bytes as bytes;
+extern crate parity_crypto as crypto;
+extern crate parity_local_store as local_store;
+extern crate parity_path as path;
+extern crate parity_rpc;
+extern crate parity_runtime;
+extern crate parity_version;
+extern crate prometheus;
+extern crate stats;
+
+#[macro_use]
+extern crate log as rlog;
+
+#[cfg(feature = "ethcore-accounts")]
+extern crate ethcore_accounts as accounts;
+
+#[cfg(feature = "secretstore")]
+extern crate ethcore_secretstore;
+
+#[cfg(test)]
+#[macro_use]
+extern crate pretty_assertions;
+
+#[cfg(test)]
+extern crate tempdir;
+
+#[cfg(test)]
+#[macro_use]
+extern crate lazy_static;
+
+mod account;
+mod account_utils;
+mod blockchain;
+mod cache;
+mod cli;
+mod configuration;
+mod db;
+mod helpers;
+mod informant;
+mod metrics;
+mod modules;
+mod params;
+mod presale;
+mod rpc;
+mod rpc_apis;
+mod run;
+mod secretstore;
+mod signer;
+mod snapshot;
+mod upgrade;
+mod user_defaults;
+
+use std::{fs::File, io::BufReader, sync::Arc};
+
+use crate::{
+    cli::Args,
+    configuration::{Cmd, Execute},
+    hash::keccak_buffer,
+};
+
+#[cfg(feature = "memory_profiling")]
+use std::alloc::System;
+
+pub use self::{configuration::Configuration, run::RunningClient};
+pub use ethcore_logger::{setup_log, Config as LoggerConfig, RotatingLogger};
+pub use parity_rpc::PubSubSession;
+
+#[cfg(feature = "memory_profiling")]
+#[global_allocator]
+static A: System = System;
+
+fn print_hash_of(maybe_file: Option<String>) -> Result<String, String> {
+    if let Some(file) = maybe_file {
+        let mut f =
+            BufReader::new(File::open(&file).map_err(|_| "Unable to open file".to_owned())?);
+        let hash = keccak_buffer(&mut f).map_err(|_| "Unable to read from file".to_owned())?;
+        Ok(format!("{:x}", hash))
+    } else {
+        Err("Streaming from standard input not yet supported. Specify a file.".to_owned())
+    }
+}
+
+#[cfg(feature = "deadlock_detection")]
+fn run_deadlock_detection_thread() {
+    use ansi_term::Style;
+    use parking_lot::deadlock;
+    use std::{thread, time::Duration};
+
+    info!("Starting deadlock detection thread.");
+    // Create a background thread which checks for deadlocks every 10s
+    thread::spawn(move || loop {
+        thread::sleep(Duration::from_secs(10));
+        let deadlocks = deadlock::check_deadlock();
+        if deadlocks.is_empty() {
+            continue;
+        }
+
+        warn!(
+            "{} {} detected",
+            deadlocks.len(),
+            Style::new().bold().paint("deadlock(s)")
+        );
+        for (i, threads) in deadlocks.iter().enumerate() {
+            warn!("{} #{}", Style::new().bold().paint("Deadlock"), i);
+            for t in threads {
+                warn!("Thread Id {:#?}", t.thread_id());
+                warn!("{:#?}", t.backtrace());
+            }
+        }
+    });
+}
+
+/// Action that OpenEthereum performed when running `start`.
+pub enum ExecutionAction {
+    /// The execution didn't require starting a node, and thus has finished.
+    /// Contains the string to print on stdout, if any.
+    Instant(Option<String>),
+
+    /// The client has started running and must be shut down manually by calling `shutdown`.
+    ///
+    /// If you don't call `shutdown()`, execution will continue in the background.
+    Running(RunningClient),
+}
+
+fn execute(command: Execute, logger: Arc<RotatingLogger>) -> Result<ExecutionAction, String> {
+    #[cfg(feature = "deadlock_detection")]
+    run_deadlock_detection_thread();
+
+    match command.cmd {
+        Cmd::Run(run_cmd) => {
+            let outcome = run::execute(run_cmd, logger)?;
+            Ok(ExecutionAction::Running(outcome))
+        }
+        Cmd::Version => Ok(ExecutionAction::Instant(Some(Args::print_version()))),
+        Cmd::Hash(maybe_file) => {
+            print_hash_of(maybe_file).map(|s| ExecutionAction::Instant(Some(s)))
+        }
+        Cmd::Account(account_cmd) => {
+            account::execute(account_cmd).map(|s| ExecutionAction::Instant(Some(s)))
+        }
+        Cmd::ImportPresaleWallet(presale_cmd) => {
+            presale::execute(presale_cmd).map(|s| ExecutionAction::Instant(Some(s)))
+        }
+        Cmd::Blockchain(blockchain_cmd) => {
+            blockchain::execute(blockchain_cmd).map(|_| ExecutionAction::Instant(None))
+        }
+        Cmd::SignerToken(ws_conf, logger_config) => {
+            signer::execute(ws_conf, logger_config).map(|s| ExecutionAction::Instant(Some(s)))
+        }
+        Cmd::SignerSign {
+            id,
+            pwfile,
+            port,
+            authfile,
+        } => cli_signer::signer_sign(id, pwfile, port, authfile)
+            .map(|s| ExecutionAction::Instant(Some(s))),
+        Cmd::SignerList { port, authfile } => {
+            cli_signer::signer_list(port, authfile).map(|s| ExecutionAction::Instant(Some(s)))
+        }
+        Cmd::SignerReject { id, port, authfile } => {
+            cli_signer::signer_reject(id, port, authfile).map(|s| ExecutionAction::Instant(Some(s)))
+        }
+        Cmd::Snapshot(snapshot_cmd) => {
+            snapshot::execute(snapshot_cmd).map(|s| ExecutionAction::Instant(Some(s)))
+        }
+    }
+}
+
+/// Starts the OpenEthereum client.
+///
+/// The first parameter is the command line arguments that you would pass when running the openethereum
+/// binary.
+///
+/// On error, returns what to print on stderr.
+// FIXME: totally independent logging capability, see https://github.com/openethereum/openethereum/issues/10252
+pub fn start(conf: Configuration, logger: Arc<RotatingLogger>) -> Result<ExecutionAction, String> {
+    execute(conf.into_command()?, logger)
+}

bin/oe/logger/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+description = "Parity Ethereum Logger Implementation"
+name = "ethcore-logger"
+version = "1.12.0"
+license = "GPL-3.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+
+[dependencies]
+log = "0.4"
+env_logger = "0.5"
+atty = "0.2"
+lazy_static = "1.0"
+regex = "1.0"
+time = "0.1"
+parking_lot = "0.11.1"
+arrayvec = "0.4"
+ansi_term = "0.10"

bin/oe/logger/src/lib.rs

@@ -0,0 +1,191 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Logger for OpenEthereum executables
+
+extern crate ansi_term;
+extern crate arrayvec;
+extern crate atty;
+extern crate env_logger;
+extern crate log as rlog;
+extern crate parking_lot;
+extern crate regex;
+extern crate time;
+
+#[macro_use]
+extern crate lazy_static;
+
+mod rotating;
+
+use ansi_term::Colour;
+use env_logger::{Builder as LogBuilder, Formatter};
+use parking_lot::Mutex;
+use regex::Regex;
+use std::{
+    env, fs,
+    io::Write,
+    sync::{Arc, Weak},
+    thread,
+};
+
+pub use rotating::{init_log, RotatingLogger};
+
+#[derive(Debug, PartialEq, Clone)]
+pub struct Config {
+    pub mode: Option<String>,
+    pub color: bool,
+    pub file: Option<String>,
+}
+
+impl Default for Config {
+    fn default() -> Self {
+        Config {
+            mode: None,
+            color: !cfg!(windows),
+            file: None,
+        }
+    }
+}
+
+lazy_static! {
+    static ref ROTATING_LOGGER: Mutex<Weak<RotatingLogger>> = Mutex::new(Default::default());
+}
+
+/// Sets up the logger
+pub fn setup_log(config: &Config) -> Result<Arc<RotatingLogger>, String> {
+    use rlog::*;
+
+    let mut levels = String::new();
+    let mut builder = LogBuilder::new();
+    // Disable info logging by default for some modules:
+    builder.filter(Some("ws"), LevelFilter::Warn);
+    builder.filter(Some("hyper"), LevelFilter::Warn);
+    builder.filter(Some("rustls"), LevelFilter::Error);
+    // Enable info for others.
+    builder.filter(None, LevelFilter::Info);
+
+    if let Ok(lvl) = env::var("RUST_LOG") {
+        levels.push_str(&lvl);
+        levels.push_str(",");
+        builder.parse(&lvl);
+    }
+
+    if let Some(ref s) = config.mode {
+        levels.push_str(s);
+        builder.parse(s);
+    }
+
+    let isatty = atty::is(atty::Stream::Stderr);
+    let enable_color = config.color && isatty;
+    let logs = Arc::new(RotatingLogger::new(levels));
+    let logger = logs.clone();
+    let mut open_options = fs::OpenOptions::new();
+
+    let maybe_file = match config.file.as_ref() {
+        Some(f) => Some(
+            open_options
+                .append(true)
+                .create(true)
+                .open(f)
+                .map_err(|e| format!("Cannot write to log file given: {}, {}", f, e))?,
+        ),
+        None => None,
+    };
+
+    let format = move |buf: &mut Formatter, record: &Record| {
+        let timestamp = time::strftime("%Y-%m-%d %H:%M:%S %Z", &time::now()).unwrap();
+
+        let with_color = if max_level() <= LevelFilter::Info {
+            format!(
+                "{} {}",
+                Colour::Black.bold().paint(timestamp),
+                record.args()
+            )
+        } else {
+            let name = thread::current().name().map_or_else(Default::default, |x| {
+                format!("{}", Colour::Blue.bold().paint(x))
+            });
+            format!(
+                "{} {} {} {}  {}",
+                Colour::Black.bold().paint(timestamp),
+                name,
+                record.level(),
+                record.target(),
+                record.args()
+            )
+        };
+
+        let removed_color = kill_color(with_color.as_ref());
+
+        let ret = match enable_color {
+            true => with_color,
+            false => removed_color.clone(),
+        };
+
+        if let Some(mut file) = maybe_file.as_ref() {
+            // ignore errors - there's nothing we can do
+            let _ = file.write_all(removed_color.as_bytes());
+            let _ = file.write_all(b"\n");
+        }
+        logger.append(removed_color);
+        if !isatty && record.level() <= Level::Info && atty::is(atty::Stream::Stdout) {
+            // duplicate INFO/WARN output to console
+            println!("{}", ret);
+        }
+
+        writeln!(buf, "{}", ret)
+    };
+
+    builder.format(format);
+    builder
+        .try_init()
+        .and_then(|_| {
+            *ROTATING_LOGGER.lock() = Arc::downgrade(&logs);
+            Ok(logs)
+        })
+        // couldn't create new logger - try to fall back on previous logger.
+        .or_else(|err| {
+            ROTATING_LOGGER
+                .lock()
+                .upgrade()
+                .ok_or_else(|| format!("{:?}", err))
+        })
+}
+
+fn kill_color(s: &str) -> String {
+    lazy_static! {
+        static ref RE: Regex = Regex::new("\x1b\\[[^m]+m").unwrap();
+    }
+    RE.replace_all(s, "").to_string()
+}
+
+#[test]
+fn should_remove_colour() {
+    let before = "test";
+    let after = kill_color(&Colour::Red.bold().paint(before));
+    assert_eq!(after, "test");
+}
+
+#[test]
+fn should_remove_multiple_colour() {
+    let t = format!(
+        "{} {}",
+        Colour::Red.bold().paint("test"),
+        Colour::White.normal().paint("again")
+    );
+    let after = kill_color(&t);
+    assert_eq!(after, "test again");
+}

bin/oe/logger/src/rotating.rs

@@ -0,0 +1,121 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Common log helper functions
+
+use arrayvec::ArrayVec;
+use env_logger::Builder as LogBuilder;
+use rlog::LevelFilter;
+use std::env;
+
+use parking_lot::{RwLock, RwLockReadGuard};
+
+lazy_static! {
+    static ref LOG_DUMMY: () = {
+        let mut builder = LogBuilder::new();
+        builder.filter(None, LevelFilter::Info);
+
+        if let Ok(log) = env::var("RUST_LOG") {
+            builder.parse(&log);
+        }
+
+        if !builder.try_init().is_ok() {
+            println!("logger initialization failed!");
+        }
+    };
+}
+
+/// Intialize log with default settings
+pub fn init_log() {
+    *LOG_DUMMY
+}
+
+const LOG_SIZE: usize = 128;
+
+/// Logger implementation that keeps up to `LOG_SIZE` log elements.
+pub struct RotatingLogger {
+    /// Defined logger levels
+    levels: String,
+    /// Logs array. Latest log is always at index 0
+    logs: RwLock<ArrayVec<[String; LOG_SIZE]>>,
+}
+
+impl RotatingLogger {
+    /// Creates new `RotatingLogger` with given levels.
+    /// It does not enforce levels - it's just read only.
+    pub fn new(levels: String) -> Self {
+        RotatingLogger {
+            levels: levels,
+            logs: RwLock::new(ArrayVec::<[_; LOG_SIZE]>::new()),
+        }
+    }
+
+    /// Append new log entry
+    pub fn append(&self, log: String) {
+        let mut logs = self.logs.write();
+        if logs.is_full() {
+            logs.pop();
+        }
+        logs.insert(0, log);
+    }
+
+    /// Return levels
+    pub fn levels(&self) -> &str {
+        &self.levels
+    }
+
+    /// Return logs
+    pub fn logs(&self) -> RwLockReadGuard<ArrayVec<[String; LOG_SIZE]>> {
+        self.logs.read()
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use super::RotatingLogger;
+
+    fn logger() -> RotatingLogger {
+        RotatingLogger::new("test".to_owned())
+    }
+
+    #[test]
+    fn should_return_log_levels() {
+        // given
+        let logger = logger();
+
+        // when
+        let levels = logger.levels();
+
+        // then
+        assert_eq!(levels, "test");
+    }
+
+    #[test]
+    fn should_return_latest_logs() {
+        // given
+        let logger = logger();
+
+        // when
+        logger.append("a".to_owned());
+        logger.append("b".to_owned());
+
+        // then
+        let logs = logger.logs();
+        assert_eq!(logs[0], "b".to_owned());
+        assert_eq!(logs[1], "a".to_owned());
+        assert_eq!(logs.len(), 2);
+    }
+}

bin/oe/main.rs

@@ -0,0 +1,180 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Ethcore client application.
+
+#![warn(missing_docs)]
+
+extern crate ctrlc;
+extern crate dir;
+extern crate fdlimit;
+#[macro_use]
+extern crate log;
+extern crate ansi_term;
+extern crate openethereum;
+extern crate panic_hook;
+extern crate parity_daemonize;
+extern crate parking_lot;
+
+extern crate ethcore_logger;
+#[cfg(windows)]
+extern crate winapi;
+
+use std::{
+    io::Write,
+    process,
+    sync::{
+        atomic::{AtomicBool, Ordering},
+        Arc,
+    },
+};
+
+use ansi_term::Colour;
+use ctrlc::CtrlC;
+use ethcore_logger::setup_log;
+use fdlimit::raise_fd_limit;
+use openethereum::{start, ExecutionAction};
+use parity_daemonize::AsHandle;
+use parking_lot::{Condvar, Mutex};
+
+#[derive(Debug)]
+/// Status used to exit or restart the program.
+struct ExitStatus {
+    /// Whether the program panicked.
+    panicking: bool,
+    /// Whether the program should exit.
+    should_exit: bool,
+}
+
+fn main() -> Result<(), i32> {
+    let conf = {
+        let args = std::env::args().collect::<Vec<_>>();
+        openethereum::Configuration::parse_cli(&args).unwrap_or_else(|e| e.exit())
+    };
+
+    let logger = setup_log(&conf.logger_config()).unwrap_or_else(|e| {
+        eprintln!("{}", e);
+        process::exit(2)
+    });
+
+    // FIXME: `pid_file` shouldn't need to cloned here
+    // see: `https://github.com/paritytech/parity-daemonize/pull/13` for more info
+    let handle = if let Some(pid) = conf.args.arg_daemon_pid_file.clone() {
+        info!(
+            "{}",
+            Colour::Blue.paint("starting in daemon mode").to_string()
+        );
+        let _ = std::io::stdout().flush();
+
+        match parity_daemonize::daemonize(pid) {
+            Ok(h) => Some(h),
+            Err(e) => {
+                error!("{}", Colour::Red.paint(format!("{}", e)));
+                return Err(1);
+            }
+        }
+    } else {
+        None
+    };
+
+    // increase max number of open files
+    raise_fd_limit();
+
+    let exit = Arc::new((
+        Mutex::new(ExitStatus {
+            panicking: false,
+            should_exit: false,
+        }),
+        Condvar::new(),
+    ));
+
+    // Double panic can happen. So when we lock `ExitStatus` after the main thread is notified, it cannot be locked
+    // again.
+    let exiting = Arc::new(AtomicBool::new(false));
+
+    trace!(target: "mode", "Not hypervised: not setting exit handlers.");
+    let exec = start(conf, logger);
+
+    match exec {
+        Ok(result) => match result {
+            ExecutionAction::Instant(output) => {
+                if let Some(s) = output {
+                    println!("{}", s);
+                }
+            }
+            ExecutionAction::Running(client) => {
+                panic_hook::set_with({
+                    let e = exit.clone();
+                    let exiting = exiting.clone();
+                    move |panic_msg| {
+                        warn!("Panic occured, see stderr for details");
+                        eprintln!("{}", panic_msg);
+                        if !exiting.swap(true, Ordering::SeqCst) {
+                            *e.0.lock() = ExitStatus {
+                                panicking: true,
+                                should_exit: true,
+                            };
+                            e.1.notify_all();
+                        }
+                    }
+                });
+
+                CtrlC::set_handler({
+                    let e = exit.clone();
+                    let exiting = exiting.clone();
+                    move || {
+                        if !exiting.swap(true, Ordering::SeqCst) {
+                            *e.0.lock() = ExitStatus {
+                                panicking: false,
+                                should_exit: true,
+                            };
+                            e.1.notify_all();
+                        }
+                    }
+                });
+
+                // so the client has started successfully
+                // if this is a daemon, detach from the parent process
+                if let Some(mut handle) = handle {
+                    handle.detach()
+                }
+
+                // Wait for signal
+                let mut lock = exit.0.lock();
+                if !lock.should_exit {
+                    let _ = exit.1.wait(&mut lock);
+                }
+
+                client.shutdown();
+
+                if lock.panicking {
+                    return Err(1);
+                }
+            }
+        },
+        Err(err) => {
+            // error occured during start up
+            // if this is a daemon, detach from the parent process
+            if let Some(mut handle) = handle {
+                handle.detach_with_msg(format!("{}", Colour::Red.paint(&err)))
+            }
+            eprintln!("{}", err);
+            return Err(1);
+        }
+    };
+
+    Ok(())
+}

bin/oe/metrics.rs

@@ -0,0 +1,117 @@
+use std::{sync::Arc, time::Instant};
+
+use crate::{futures::Future, rpc, rpc_apis};
+
+use parking_lot::Mutex;
+
+use hyper::{service::service_fn_ok, Body, Method, Request, Response, Server, StatusCode};
+
+use stats::{
+    prometheus::{self, Encoder},
+    PrometheusMetrics, PrometheusRegistry,
+};
+
+#[derive(Debug, Clone, PartialEq)]
+pub struct MetricsConfiguration {
+    /// Are metrics enabled (default is false)?
+    pub enabled: bool,
+    /// Prefix
+    pub prefix: String,
+    /// The IP of the network interface used (default is 127.0.0.1).
+    pub interface: String,
+    /// The network port (default is 3000).
+    pub port: u16,
+}
+
+impl Default for MetricsConfiguration {
+    fn default() -> Self {
+        MetricsConfiguration {
+            enabled: false,
+            prefix: "".into(),
+            interface: "127.0.0.1".into(),
+            port: 3000,
+        }
+    }
+}
+
+struct State {
+    rpc_apis: Arc<rpc_apis::FullDependencies>,
+}
+
+fn handle_request(
+    req: Request<Body>,
+    conf: Arc<MetricsConfiguration>,
+    state: Arc<Mutex<State>>,
+) -> Response<Body> {
+    let (parts, _body) = req.into_parts();
+    match (parts.method, parts.uri.path()) {
+        (Method::GET, "/metrics") => {
+            let start = Instant::now();
+
+            let mut reg = PrometheusRegistry::new(conf.prefix.clone());
+            let state = state.lock();
+            state.rpc_apis.client.prometheus_metrics(&mut reg);
+            state.rpc_apis.sync.prometheus_metrics(&mut reg);
+            let elapsed = start.elapsed();
+            reg.register_gauge(
+                "metrics_time",
+                "Time to perform rpc metrics",
+                elapsed.as_millis() as i64,
+            );
+
+            let mut buffer = vec![];
+            let encoder = prometheus::TextEncoder::new();
+            let metric_families = reg.registry().gather();
+
+            encoder
+                .encode(&metric_families, &mut buffer)
+                .expect("all source of metrics are static; qed");
+            let text = String::from_utf8(buffer).expect("metrics encoding is ASCII; qed");
+
+            Response::new(Body::from(text))
+        }
+        (_, _) => {
+            let mut res = Response::new(Body::from("not found"));
+            *res.status_mut() = StatusCode::NOT_FOUND;
+            res
+        }
+    }
+}
+
+/// Start the prometheus metrics server accessible via GET <host>:<port>/metrics
+pub fn start_prometheus_metrics(
+    conf: &MetricsConfiguration,
+    deps: &rpc::Dependencies<rpc_apis::FullDependencies>,
+) -> Result<(), String> {
+    if !conf.enabled {
+        return Ok(());
+    }
+
+    let addr = format!("{}:{}", conf.interface, conf.port);
+    let addr = addr
+        .parse()
+        .map_err(|err| format!("Failed to parse address '{}': {}", addr, err))?;
+
+    let state = State {
+        rpc_apis: deps.apis.clone(),
+    };
+    let state = Arc::new(Mutex::new(state));
+    let conf = Arc::new(conf.to_owned());
+    let server = Server::bind(&addr)
+        .serve(move || {
+            // This is the `Service` that will handle the connection.
+            // `service_fn_ok` is a helper to convert a function that
+            // returns a Response into a `Service`.
+            let state = state.clone();
+            let conf = conf.clone();
+            service_fn_ok(move |req: Request<Body>| {
+                handle_request(req, conf.clone(), state.clone())
+            })
+        })
+        .map_err(|e| eprintln!("server error: {}", e));
+    info!("Started prometeus metrics at http://{}/metrics", addr);
+
+    deps.executor.spawn(server);
+
+    Ok(())
+}

bin/oe/modules.rs

@@ -0,0 +1,63 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::sync::{mpsc, Arc};
+
+use crate::{
+    sync::{self, ConnectionFilter, NetworkConfiguration, Params, SyncConfig},
+    types::BlockNumber,
+};
+use ethcore::{client::BlockChainClient, snapshot::SnapshotService};
+use std::collections::BTreeSet;
+
+pub use crate::sync::{EthSync, ManageNetwork, SyncProvider};
+pub use ethcore::client::ChainNotify;
+use ethcore_logger::Config as LogConfig;
+
+pub type SyncModules = (
+    Arc<dyn SyncProvider>,
+    Arc<dyn ManageNetwork>,
+    Arc<dyn ChainNotify>,
+    mpsc::Sender<sync::PriorityTask>,
+);
+
+pub fn sync(
+    config: SyncConfig,
+    network_config: NetworkConfiguration,
+    chain: Arc<dyn BlockChainClient>,
+    forks: BTreeSet<BlockNumber>,
+    snapshot_service: Arc<dyn SnapshotService>,
+    _log_settings: &LogConfig,
+    connection_filter: Option<Arc<dyn ConnectionFilter>>,
+) -> Result<SyncModules, sync::Error> {
+    let eth_sync = EthSync::new(
+        Params {
+            config,
+            chain,
+            forks,
+            snapshot_service,
+            network_config,
+        },
+        connection_filter,
+    )?;
+
+    Ok((
+        eth_sync.clone() as Arc<dyn SyncProvider>,
+        eth_sync.clone() as Arc<dyn ManageNetwork>,
+        eth_sync.clone() as Arc<dyn ChainNotify>,
+        eth_sync.priority_tasks(),
+    ))
+}

bin/oe/params.rs

@@ -0,0 +1,542 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::{collections::HashSet, fmt, fs, num::NonZeroU32, str, time::Duration};
+
+use crate::{
+    miner::{
+        gas_price_calibrator::{GasPriceCalibrator, GasPriceCalibratorOptions},
+        gas_pricer::GasPricer,
+    },
+    user_defaults::UserDefaults,
+};
+use ethcore::{
+    client::Mode,
+    ethereum,
+    spec::{Spec, SpecParams},
+};
+use ethereum_types::{Address, U256};
+use fetch::Client as FetchClient;
+use journaldb::Algorithm;
+use parity_runtime::Executor;
+use parity_version::version_data;
+
+use crate::configuration;
+
+#[derive(Debug, PartialEq)]
+pub enum SpecType {
+    Foundation,
+    Poanet,
+    Xdai,
+    Volta,
+    Ewc,
+    Musicoin,
+    Ellaism,
+    Mix,
+    Callisto,
+    Morden,
+    Ropsten,
+    Kovan,
+    Rinkeby,
+    Goerli,
+    Sokol,
+    Yolo3,
+    Dev,
+    Custom(String),
+}
+
+impl Default for SpecType {
+    fn default() -> Self {
+        SpecType::Foundation
+    }
+}
+
+impl str::FromStr for SpecType {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let spec = match s {
+            "eth" | "ethereum" | "foundation" | "mainnet" => SpecType::Foundation,
+            "poanet" | "poacore" => SpecType::Poanet,
+            "xdai" => SpecType::Xdai,
+            "volta" => SpecType::Volta,
+            "ewc" | "energyweb" => SpecType::Ewc,
+            "musicoin" => SpecType::Musicoin,
+            "ellaism" => SpecType::Ellaism,
+            "mix" => SpecType::Mix,
+            "callisto" => SpecType::Callisto,
+            "morden" => SpecType::Morden,
+            "ropsten" => SpecType::Ropsten,
+            "kovan" => SpecType::Kovan,
+            "rinkeby" => SpecType::Rinkeby,
+            "goerli" | "görli" | "testnet" => SpecType::Goerli,
+            "sokol" | "poasokol" => SpecType::Sokol,
+            "yolo3" => SpecType::Yolo3,
+            "dev" => SpecType::Dev,
+            other => SpecType::Custom(other.into()),
+        };
+        Ok(spec)
+    }
+}
+
+impl fmt::Display for SpecType {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        f.write_str(match *self {
+            SpecType::Foundation => "foundation",
+            SpecType::Poanet => "poanet",
+            SpecType::Xdai => "xdai",
+            SpecType::Volta => "volta",
+            SpecType::Ewc => "energyweb",
+            SpecType::Musicoin => "musicoin",
+            SpecType::Ellaism => "ellaism",
+            SpecType::Mix => "mix",
+            SpecType::Callisto => "callisto",
+            SpecType::Morden => "morden",
+            SpecType::Ropsten => "ropsten",
+            SpecType::Kovan => "kovan",
+            SpecType::Rinkeby => "rinkeby",
+            SpecType::Goerli => "goerli",
+            SpecType::Sokol => "sokol",
+            SpecType::Yolo3 => "yolo3",
+            SpecType::Dev => "dev",
+            SpecType::Custom(ref custom) => custom,
+        })
+    }
+}
+
+impl SpecType {
+    pub fn spec<'a, T: Into<SpecParams<'a>>>(&self, params: T) -> Result<Spec, String> {
+        let params = params.into();
+        match *self {
+            SpecType::Foundation => Ok(ethereum::new_foundation(params)),
+            SpecType::Poanet => Ok(ethereum::new_poanet(params)),
+            SpecType::Xdai => Ok(ethereum::new_xdai(params)),
+            SpecType::Volta => Ok(ethereum::new_volta(params)),
+            SpecType::Ewc => Ok(ethereum::new_ewc(params)),
+            SpecType::Musicoin => Ok(ethereum::new_musicoin(params)),
+            SpecType::Ellaism => Ok(ethereum::new_ellaism(params)),
+            SpecType::Mix => Ok(ethereum::new_mix(params)),
+            SpecType::Callisto => Ok(ethereum::new_callisto(params)),
+            SpecType::Morden => Ok(ethereum::new_morden(params)),
+            SpecType::Ropsten => Ok(ethereum::new_ropsten(params)),
+            SpecType::Kovan => Ok(ethereum::new_kovan(params)),
+            SpecType::Rinkeby => Ok(ethereum::new_rinkeby(params)),
+            SpecType::Goerli => Ok(ethereum::new_goerli(params)),
+            SpecType::Sokol => Ok(ethereum::new_sokol(params)),
+            SpecType::Yolo3 => Ok(ethereum::new_yolo3(params)),
+            SpecType::Dev => Ok(Spec::new_instant()),
+            SpecType::Custom(ref filename) => {
+                let file = fs::File::open(filename).map_err(|e| {
+                    format!("Could not load specification file at {}: {}", filename, e)
+                })?;
+                Spec::load(params, file)
+            }
+        }
+    }
+
+    pub fn legacy_fork_name(&self) -> Option<String> {
+        match *self {
+            SpecType::Musicoin => Some("musicoin".to_owned()),
+            _ => None,
+        }
+    }
+}
+
+#[derive(Debug, PartialEq)]
+pub enum Pruning {
+    Specific(Algorithm),
+    Auto,
+}
+
+impl Default for Pruning {
+    fn default() -> Self {
+        Pruning::Auto
+    }
+}
+
+impl str::FromStr for Pruning {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "auto" => Ok(Pruning::Auto),
+            other => other.parse().map(Pruning::Specific),
+        }
+    }
+}
+
+impl Pruning {
+    pub fn to_algorithm(&self, user_defaults: &UserDefaults) -> Algorithm {
+        match *self {
+            Pruning::Specific(algo) => algo,
+            Pruning::Auto => user_defaults.pruning,
+        }
+    }
+}
+
+#[derive(Debug, PartialEq)]
+pub struct ResealPolicy {
+    pub own: bool,
+    pub external: bool,
+}
+
+impl Default for ResealPolicy {
+    fn default() -> Self {
+        ResealPolicy {
+            own: true,
+            external: true,
+        }
+    }
+}
+
+impl str::FromStr for ResealPolicy {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let (own, external) = match s {
+            "none" => (false, false),
+            "own" => (true, false),
+            "ext" => (false, true),
+            "all" => (true, true),
+            x => return Err(format!("Invalid reseal value: {}", x)),
+        };
+
+        let reseal = ResealPolicy {
+            own: own,
+            external: external,
+        };
+
+        Ok(reseal)
+    }
+}
+
+#[derive(Debug, PartialEq)]
+pub struct AccountsConfig {
+    pub iterations: NonZeroU32,
+    pub refresh_time: u64,
+    pub testnet: bool,
+    pub password_files: Vec<String>,
+    pub unlocked_accounts: Vec<Address>,
+    pub enable_fast_unlock: bool,
+}
+
+impl Default for AccountsConfig {
+    fn default() -> Self {
+        AccountsConfig {
+            iterations: NonZeroU32::new(10240).expect("10240 > 0; qed"),
+            refresh_time: 5,
+            testnet: false,
+            password_files: Vec::new(),
+            unlocked_accounts: Vec::new(),
+            enable_fast_unlock: false,
+        }
+    }
+}
+
+#[derive(Debug, PartialEq)]
+pub enum GasPricerConfig {
+    Fixed(U256),
+    Calibrated {
+        usd_per_tx: f32,
+        recalibration_period: Duration,
+        api_endpoint: String,
+    },
+}
+
+impl Default for GasPricerConfig {
+    fn default() -> Self {
+        GasPricerConfig::Calibrated {
+            usd_per_tx: 0.0001f32,
+            recalibration_period: Duration::from_secs(3600),
+            api_endpoint: configuration::ETHERSCAN_ETH_PRICE_ENDPOINT.to_string(),
+        }
+    }
+}
+
+impl GasPricerConfig {
+    pub fn to_gas_pricer(&self, fetch: FetchClient, p: Executor) -> GasPricer {
+        match *self {
+            GasPricerConfig::Fixed(u) => GasPricer::Fixed(u),
+            GasPricerConfig::Calibrated {
+                usd_per_tx,
+                recalibration_period,
+                ref api_endpoint,
+            } => GasPricer::new_calibrated(GasPriceCalibrator::new(
+                GasPriceCalibratorOptions {
+                    usd_per_tx: usd_per_tx,
+                    recalibration_period: recalibration_period,
+                },
+                fetch,
+                p,
+                api_endpoint.clone(),
+            )),
+        }
+    }
+}
+
+#[derive(Debug, PartialEq)]
+pub struct MinerExtras {
+    pub author: Address,
+    pub engine_signer: Address,
+    pub extra_data: Vec<u8>,
+    pub gas_range_target: (U256, U256),
+    pub work_notify: Vec<String>,
+    pub local_accounts: HashSet<Address>,
+}
+
+impl Default for MinerExtras {
+    fn default() -> Self {
+        MinerExtras {
+            author: Default::default(),
+            engine_signer: Default::default(),
+            extra_data: version_data(),
+            gas_range_target: (8_000_000.into(), 10_000_000.into()),
+            work_notify: Default::default(),
+            local_accounts: Default::default(),
+        }
+    }
+}
+
+/// 3-value enum.
+#[derive(Debug, Clone, Copy, PartialEq)]
+pub enum Switch {
+    /// True.
+    On,
+    /// False.
+    Off,
+    /// Auto.
+    Auto,
+}
+
+impl Default for Switch {
+    fn default() -> Self {
+        Switch::Auto
+    }
+}
+
+impl str::FromStr for Switch {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "on" => Ok(Switch::On),
+            "off" => Ok(Switch::Off),
+            "auto" => Ok(Switch::Auto),
+            other => Err(format!("Invalid switch value: {}", other)),
+        }
+    }
+}
+
+pub fn tracing_switch_to_bool(
+    switch: Switch,
+    user_defaults: &UserDefaults,
+) -> Result<bool, String> {
+    match (user_defaults.is_first_launch, switch, user_defaults.tracing) {
+        (false, Switch::On, false) => Err("TraceDB resync required".into()),
+        (_, Switch::On, _) => Ok(true),
+        (_, Switch::Off, _) => Ok(false),
+        (_, Switch::Auto, def) => Ok(def),
+    }
+}
+
+pub fn fatdb_switch_to_bool(
+    switch: Switch,
+    user_defaults: &UserDefaults,
+    _algorithm: Algorithm,
+) -> Result<bool, String> {
+    let result = match (user_defaults.is_first_launch, switch, user_defaults.fat_db) {
+        (false, Switch::On, false) => Err("FatDB resync required".into()),
+        (_, Switch::On, _) => Ok(true),
+        (_, Switch::Off, _) => Ok(false),
+        (_, Switch::Auto, def) => Ok(def),
+    };
+    result
+}
+
+pub fn mode_switch_to_bool(
+    switch: Option<Mode>,
+    user_defaults: &UserDefaults,
+) -> Result<Mode, String> {
+    Ok(switch.unwrap_or(user_defaults.mode().clone()))
+}
+
+#[cfg(test)]
+mod tests {
+    use super::{tracing_switch_to_bool, Pruning, ResealPolicy, SpecType, Switch};
+    use crate::user_defaults::UserDefaults;
+    use journaldb::Algorithm;
+
+    #[test]
+    fn test_spec_type_parsing() {
+        assert_eq!(SpecType::Foundation, "eth".parse().unwrap());
+        assert_eq!(SpecType::Foundation, "ethereum".parse().unwrap());
+        assert_eq!(SpecType::Foundation, "foundation".parse().unwrap());
+        assert_eq!(SpecType::Foundation, "mainnet".parse().unwrap());
+        assert_eq!(SpecType::Poanet, "poanet".parse().unwrap());
+        assert_eq!(SpecType::Poanet, "poacore".parse().unwrap());
+        assert_eq!(SpecType::Xdai, "xdai".parse().unwrap());
+        assert_eq!(SpecType::Volta, "volta".parse().unwrap());
+        assert_eq!(SpecType::Ewc, "ewc".parse().unwrap());
+        assert_eq!(SpecType::Ewc, "energyweb".parse().unwrap());
+        assert_eq!(SpecType::Musicoin, "musicoin".parse().unwrap());
+        assert_eq!(SpecType::Ellaism, "ellaism".parse().unwrap());
+        assert_eq!(SpecType::Mix, "mix".parse().unwrap());
+        assert_eq!(SpecType::Callisto, "callisto".parse().unwrap());
+        assert_eq!(SpecType::Morden, "morden".parse().unwrap());
+        assert_eq!(SpecType::Ropsten, "ropsten".parse().unwrap());
+        assert_eq!(SpecType::Kovan, "kovan".parse().unwrap());
+        assert_eq!(SpecType::Rinkeby, "rinkeby".parse().unwrap());
+        assert_eq!(SpecType::Goerli, "goerli".parse().unwrap());
+        assert_eq!(SpecType::Goerli, "görli".parse().unwrap());
+        assert_eq!(SpecType::Goerli, "testnet".parse().unwrap());
+        assert_eq!(SpecType::Sokol, "sokol".parse().unwrap());
+        assert_eq!(SpecType::Sokol, "poasokol".parse().unwrap());
+    }
+
+    #[test]
+    fn test_spec_type_default() {
+        assert_eq!(SpecType::Foundation, SpecType::default());
+    }
+
+    #[test]
+    fn test_spec_type_display() {
+        assert_eq!(format!("{}", SpecType::Foundation), "foundation");
+        assert_eq!(format!("{}", SpecType::Poanet), "poanet");
+        assert_eq!(format!("{}", SpecType::Xdai), "xdai");
+        assert_eq!(format!("{}", SpecType::Volta), "volta");
+        assert_eq!(format!("{}", SpecType::Ewc), "energyweb");
+        assert_eq!(format!("{}", SpecType::Musicoin), "musicoin");
+        assert_eq!(format!("{}", SpecType::Ellaism), "ellaism");
+        assert_eq!(format!("{}", SpecType::Mix), "mix");
+        assert_eq!(format!("{}", SpecType::Callisto), "callisto");
+        assert_eq!(format!("{}", SpecType::Morden), "morden");
+        assert_eq!(format!("{}", SpecType::Ropsten), "ropsten");
+        assert_eq!(format!("{}", SpecType::Kovan), "kovan");
+        assert_eq!(format!("{}", SpecType::Rinkeby), "rinkeby");
+        assert_eq!(format!("{}", SpecType::Goerli), "goerli");
+        assert_eq!(format!("{}", SpecType::Sokol), "sokol");
+        assert_eq!(format!("{}", SpecType::Dev), "dev");
+        assert_eq!(format!("{}", SpecType::Custom("foo/bar".into())), "foo/bar");
+    }
+
+    #[test]
+    fn test_pruning_parsing() {
+        assert_eq!(Pruning::Auto, "auto".parse().unwrap());
+        assert_eq!(
+            Pruning::Specific(Algorithm::Archive),
+            "archive".parse().unwrap()
+        );
+        assert_eq!(
+            Pruning::Specific(Algorithm::EarlyMerge),
+            "light".parse().unwrap()
+        );
+        assert_eq!(
+            Pruning::Specific(Algorithm::OverlayRecent),
+            "fast".parse().unwrap()
+        );
+        assert_eq!(
+            Pruning::Specific(Algorithm::RefCounted),
+            "basic".parse().unwrap()
+        );
+    }
+
+    #[test]
+    fn test_pruning_default() {
+        assert_eq!(Pruning::Auto, Pruning::default());
+    }
+
+    #[test]
+    fn test_reseal_policy_parsing() {
+        let none = ResealPolicy {
+            own: false,
+            external: false,
+        };
+        let own = ResealPolicy {
+            own: true,
+            external: false,
+        };
+        let ext = ResealPolicy {
+            own: false,
+            external: true,
+        };
+        let all = ResealPolicy {
+            own: true,
+            external: true,
+        };
+        assert_eq!(none, "none".parse().unwrap());
+        assert_eq!(own, "own".parse().unwrap());
+        assert_eq!(ext, "ext".parse().unwrap());
+        assert_eq!(all, "all".parse().unwrap());
+    }
+
+    #[test]
+    fn test_reseal_policy_default() {
+        let all = ResealPolicy {
+            own: true,
+            external: true,
+        };
+        assert_eq!(all, ResealPolicy::default());
+    }
+
+    #[test]
+    fn test_switch_parsing() {
+        assert_eq!(Switch::On, "on".parse().unwrap());
+        assert_eq!(Switch::Off, "off".parse().unwrap());
+        assert_eq!(Switch::Auto, "auto".parse().unwrap());
+    }
+
+    #[test]
+    fn test_switch_default() {
+        assert_eq!(Switch::default(), Switch::Auto);
+    }
+
+    fn user_defaults_with_tracing(first_launch: bool, tracing: bool) -> UserDefaults {
+        let mut ud = UserDefaults::default();
+        ud.is_first_launch = first_launch;
+        ud.tracing = tracing;
+        ud
+    }
+
+    #[test]
+    fn test_switch_to_bool() {
+        assert!(
+            !tracing_switch_to_bool(Switch::Off, &user_defaults_with_tracing(true, true)).unwrap()
+        );
+        assert!(
+            !tracing_switch_to_bool(Switch::Off, &user_defaults_with_tracing(true, false)).unwrap()
+        );
+        assert!(
+            !tracing_switch_to_bool(Switch::Off, &user_defaults_with_tracing(false, true)).unwrap()
+        );
+        assert!(
+            !tracing_switch_to_bool(Switch::Off, &user_defaults_with_tracing(false, false))
+                .unwrap()
+        );
+
+        assert!(
+            tracing_switch_to_bool(Switch::On, &user_defaults_with_tracing(true, true)).unwrap()
+        );
+        assert!(
+            tracing_switch_to_bool(Switch::On, &user_defaults_with_tracing(true, false)).unwrap()
+        );
+        assert!(
+            tracing_switch_to_bool(Switch::On, &user_defaults_with_tracing(false, true)).unwrap()
+        );
+        assert!(
+            tracing_switch_to_bool(Switch::On, &user_defaults_with_tracing(false, false)).is_err()
+        );
+    }
+}

bin/oe/presale.rs

@@ -0,0 +1,65 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use crate::{
+    helpers::{password_from_file, password_prompt},
+    params::SpecType,
+};
+use crypto::publickey;
+
+use ethkey::Password;
+use ethstore::PresaleWallet;
+use std::num::NonZeroU32;
+
+#[derive(Debug, PartialEq)]
+pub struct ImportWallet {
+    pub iterations: NonZeroU32,
+    pub path: String,
+    pub spec: SpecType,
+    pub wallet_path: String,
+    pub password_file: Option<String>,
+}
+
+pub fn execute(cmd: ImportWallet) -> Result<String, String> {
+    let password = match cmd.password_file.clone() {
+        Some(file) => password_from_file(file)?,
+        None => password_prompt()?,
+    };
+
+    let wallet = PresaleWallet::open(cmd.wallet_path.clone())
+        .map_err(|_| "Unable to open presale wallet.")?;
+    let kp = wallet.decrypt(&password).map_err(|_| "Invalid password.")?;
+    let address = kp.address();
+    import_account(&cmd, kp, password);
+    Ok(format!("{:?}", address))
+}
+
+#[cfg(feature = "accounts")]
+
+pub fn import_account(cmd: &ImportWallet, kp: publickey::KeyPair, password: Password) {
+    use accounts::{AccountProvider, AccountProviderSettings};
+    use ethstore::{accounts_dir::RootDiskDirectory, EthStore};
+
+    let dir = Box::new(RootDiskDirectory::create(cmd.path.clone()).unwrap());
+    let secret_store = Box::new(EthStore::open_with_iterations(dir, cmd.iterations).unwrap());
+    let acc_provider = AccountProvider::new(secret_store, AccountProviderSettings::default());
+    acc_provider
+        .insert_account(kp.secret().clone(), &password)
+        .unwrap();
+}
+
+#[cfg(not(feature = "accounts"))]
+pub fn import_account(_cmd: &ImportWallet, _kp: publickey::KeyPair, _password: Password) {}

bin/oe/rpc.rs

@@ -0,0 +1,364 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::{collections::HashSet, io, path::PathBuf, sync::Arc};
+
+use crate::{
+    helpers::parity_ipc_path,
+    rpc_apis::{self, ApiSet},
+};
+use dir::{default_data_path, helpers::replace_home};
+use jsonrpc_core::MetaIoHandler;
+use parity_rpc::{
+    self as rpc,
+    informant::{Middleware, RpcStats},
+    DomainsValidation, Metadata,
+};
+use parity_runtime::Executor;
+
+pub use parity_rpc::{HttpServer, IpcServer, RequestMiddleware};
+//pub use parity_rpc::ws::Server as WsServer;
+pub use parity_rpc::ws::{ws, Server as WsServer};
+
+pub const DAPPS_DOMAIN: &'static str = "web3.site";
+
+#[derive(Debug, Clone, PartialEq)]
+pub struct HttpConfiguration {
+    pub enabled: bool,
+    pub interface: String,
+    pub port: u16,
+    pub apis: ApiSet,
+    pub cors: Option<Vec<String>>,
+    pub hosts: Option<Vec<String>>,
+    pub server_threads: usize,
+    pub processing_threads: usize,
+    pub max_payload: usize,
+    pub keep_alive: bool,
+}
+
+impl Default for HttpConfiguration {
+    fn default() -> Self {
+        HttpConfiguration {
+            enabled: true,
+            interface: "127.0.0.1".into(),
+            port: 8545,
+            apis: ApiSet::UnsafeContext,
+            cors: Some(vec![]),
+            hosts: Some(vec![]),
+            server_threads: 1,
+            processing_threads: 4,
+            max_payload: 5,
+            keep_alive: true,
+        }
+    }
+}
+
+#[derive(Debug, PartialEq)]
+pub struct IpcConfiguration {
+    pub enabled: bool,
+    pub socket_addr: String,
+    pub apis: ApiSet,
+}
+
+impl Default for IpcConfiguration {
+    fn default() -> Self {
+        IpcConfiguration {
+            enabled: true,
+            socket_addr: if cfg!(windows) {
+                r"\\.\pipe\jsonrpc.ipc".into()
+            } else {
+                let data_dir = ::dir::default_data_path();
+                parity_ipc_path(&data_dir, "$BASE/jsonrpc.ipc", 0)
+            },
+            apis: ApiSet::IpcContext,
+        }
+    }
+}
+
+#[derive(Debug, Clone, PartialEq)]
+pub struct WsConfiguration {
+    pub enabled: bool,
+    pub interface: String,
+    pub port: u16,
+    pub apis: ApiSet,
+    pub max_connections: usize,
+    pub origins: Option<Vec<String>>,
+    pub hosts: Option<Vec<String>>,
+    pub signer_path: PathBuf,
+    pub support_token_api: bool,
+    pub max_payload: usize,
+}
+
+impl Default for WsConfiguration {
+    fn default() -> Self {
+        let data_dir = default_data_path();
+        WsConfiguration {
+            enabled: true,
+            interface: "127.0.0.1".into(),
+            port: 8546,
+            apis: ApiSet::UnsafeContext,
+            max_connections: 100,
+            origins: Some(vec![
+                "parity://*".into(),
+                "chrome-extension://*".into(),
+                "moz-extension://*".into(),
+            ]),
+            hosts: Some(Vec::new()),
+            signer_path: replace_home(&data_dir, "$BASE/signer").into(),
+            support_token_api: true,
+            max_payload: 5,
+        }
+    }
+}
+
+impl WsConfiguration {
+    pub fn address(&self) -> Option<rpc::Host> {
+        address(self.enabled, &self.interface, self.port, &self.hosts)
+    }
+}
+
+fn address(
+    enabled: bool,
+    bind_iface: &str,
+    bind_port: u16,
+    hosts: &Option<Vec<String>>,
+) -> Option<rpc::Host> {
+    if !enabled {
+        return None;
+    }
+
+    match *hosts {
+        Some(ref hosts) if !hosts.is_empty() => Some(hosts[0].clone().into()),
+        _ => Some(format!("{}:{}", bind_iface, bind_port).into()),
+    }
+}
+
+pub struct Dependencies<D: rpc_apis::Dependencies> {
+    pub apis: Arc<D>,
+    pub executor: Executor,
+    pub stats: Arc<RpcStats>,
+}
+
+pub fn new_ws<D: rpc_apis::Dependencies>(
+    conf: WsConfiguration,
+    deps: &Dependencies<D>,
+) -> Result<Option<WsServer>, String> {
+    if !conf.enabled {
+        return Ok(None);
+    }
+
+    let domain = DAPPS_DOMAIN;
+    let url = format!("{}:{}", conf.interface, conf.port);
+    let addr = url
+        .parse()
+        .map_err(|_| format!("Invalid WebSockets listen host/port given: {}", url))?;
+
+    let full_handler = setup_apis(rpc_apis::ApiSet::All, deps);
+    let handler = {
+        let mut handler = MetaIoHandler::with_middleware((
+            rpc::WsDispatcher::new(full_handler),
+            Middleware::new(deps.stats.clone(), deps.apis.activity_notifier()),
+        ));
+        let apis = conf.apis.list_apis();
+        deps.apis.extend_with_set(&mut handler, &apis);
+
+        handler
+    };
+
+    let allowed_origins = into_domains(with_domain(conf.origins, domain, &None));
+    let allowed_hosts = into_domains(with_domain(conf.hosts, domain, &Some(url.clone().into())));
+
+    let signer_path;
+    let path = match conf.support_token_api {
+        true => {
+            signer_path = crate::signer::codes_path(&conf.signer_path);
+            Some(signer_path.as_path())
+        }
+        false => None,
+    };
+    let start_result = rpc::start_ws(
+        &addr,
+        handler,
+        allowed_origins,
+        allowed_hosts,
+        conf.max_connections,
+        rpc::WsExtractor::new(path.clone()),
+        rpc::WsExtractor::new(path.clone()),
+        rpc::WsStats::new(deps.stats.clone()),
+        conf.max_payload,
+    );
+
+    //	match start_result {
+    //		Ok(server) => Ok(Some(server)),
+    //		Err(rpc::ws::Error::Io(rpc::ws::ErrorKind::Io(ref err), _)) if err.kind() == io::ErrorKind::AddrInUse => Err(
+    //			format!("WebSockets address {} is already in use, make sure that another instance of an Ethereum client is not running or change the address using the --ws-port and --ws-interface options.", url)
+    //		),
+    //		Err(e) => Err(format!("WebSockets error: {:?}", e)),
+    //	}
+    match start_result {
+		Ok(server) => Ok(Some(server)),
+		Err(rpc::ws::Error::WsError(ws::Error {
+			                            kind: ws::ErrorKind::Io(ref err), ..
+		                            })) if err.kind() == io::ErrorKind::AddrInUse => Err(
+			format!("WebSockets address {} is already in use, make sure that another instance of an Ethereum client is not running or change the address using the --ws-port and --ws-interface options.", url)
+		),
+		Err(e) => Err(format!("WebSockets error: {:?}", e)),
+	}
+}
+
+pub fn new_http<D: rpc_apis::Dependencies>(
+    id: &str,
+    options: &str,
+    conf: HttpConfiguration,
+    deps: &Dependencies<D>,
+) -> Result<Option<HttpServer>, String> {
+    if !conf.enabled {
+        return Ok(None);
+    }
+
+    let domain = DAPPS_DOMAIN;
+    let url = format!("{}:{}", conf.interface, conf.port);
+    let addr = url
+        .parse()
+        .map_err(|_| format!("Invalid {} listen host/port given: {}", id, url))?;
+    let handler = setup_apis(conf.apis, deps);
+
+    let cors_domains = into_domains(conf.cors);
+    let allowed_hosts = into_domains(with_domain(conf.hosts, domain, &Some(url.clone().into())));
+
+    let start_result = rpc::start_http(
+        &addr,
+        cors_domains,
+        allowed_hosts,
+        handler,
+        rpc::RpcExtractor,
+        conf.server_threads,
+        conf.max_payload,
+        conf.keep_alive,
+    );
+
+    match start_result {
+		Ok(server) => Ok(Some(server)),
+		Err(ref err) if err.kind() == io::ErrorKind::AddrInUse => Err(
+			format!("{} address {} is already in use, make sure that another instance of an Ethereum client is not running or change the address using the --{}-port and --{}-interface options.", id, url, options, options)
+		),
+		Err(e) => Err(format!("{} error: {:?}", id, e)),
+	}
+}
+
+pub fn new_ipc<D: rpc_apis::Dependencies>(
+    conf: IpcConfiguration,
+    dependencies: &Dependencies<D>,
+) -> Result<Option<IpcServer>, String> {
+    if !conf.enabled {
+        return Ok(None);
+    }
+
+    let handler = setup_apis(conf.apis, dependencies);
+    let path = PathBuf::from(&conf.socket_addr);
+    // Make sure socket file can be created on unix-like OS.
+    // Windows pipe paths are not on the FS.
+    if !cfg!(windows) {
+        if let Some(dir) = path.parent() {
+            ::std::fs::create_dir_all(&dir).map_err(|err| {
+                format!(
+                    "Unable to create IPC directory at {}: {}",
+                    dir.display(),
+                    err
+                )
+            })?;
+        }
+    }
+
+    match rpc::start_ipc(&conf.socket_addr, handler, rpc::RpcExtractor) {
+        Ok(server) => Ok(Some(server)),
+        Err(io_error) => Err(format!("IPC error: {}", io_error)),
+    }
+}
+
+fn into_domains<T: From<String>>(items: Option<Vec<String>>) -> DomainsValidation<T> {
+    items
+        .map(|vals| vals.into_iter().map(T::from).collect())
+        .into()
+}
+
+fn with_domain(
+    items: Option<Vec<String>>,
+    domain: &str,
+    dapps_address: &Option<rpc::Host>,
+) -> Option<Vec<String>> {
+    fn extract_port(s: &str) -> Option<u16> {
+        s.split(':').nth(1).and_then(|s| s.parse().ok())
+    }
+
+    items.map(move |items| {
+        let mut items = items.into_iter().collect::<HashSet<_>>();
+        {
+            let mut add_hosts = |address: &Option<rpc::Host>| {
+                if let Some(host) = address.clone() {
+                    items.insert(host.to_string());
+                    items.insert(host.replace("127.0.0.1", "localhost"));
+                    items.insert(format!("http://*.{}", domain)); //proxypac
+                    if let Some(port) = extract_port(&*host) {
+                        items.insert(format!("http://*.{}:{}", domain, port));
+                    }
+                }
+            };
+
+            add_hosts(dapps_address);
+        }
+        items.into_iter().collect()
+    })
+}
+
+pub fn setup_apis<D>(
+    apis: ApiSet,
+    deps: &Dependencies<D>,
+) -> MetaIoHandler<Metadata, Middleware<D::Notifier>>
+where
+    D: rpc_apis::Dependencies,
+{
+    let mut handler = MetaIoHandler::with_middleware(Middleware::new(
+        deps.stats.clone(),
+        deps.apis.activity_notifier(),
+    ));
+    let apis = apis.list_apis();
+    deps.apis.extend_with_set(&mut handler, &apis);
+
+    handler
+}
+
+#[cfg(test)]
+mod tests {
+    use super::address;
+
+    #[test]
+    fn should_return_proper_address() {
+        assert_eq!(address(false, "localhost", 8180, &None), None);
+        assert_eq!(
+            address(true, "localhost", 8180, &None),
+            Some("localhost:8180".into())
+        );
+        assert_eq!(
+            address(true, "localhost", 8180, &Some(vec!["host:443".into()])),
+            Some("host:443".into())
+        );
+        assert_eq!(
+            address(true, "localhost", 8180, &Some(vec!["host".into()])),
+            Some("host".into())
+        );
+    }
+}

bin/oe/rpc_apis.rs

@@ -0,0 +1,646 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::{
+    cmp::PartialEq,
+    collections::{BTreeMap, HashSet},
+    str::FromStr,
+    sync::Arc,
+};
+
+pub use parity_rpc::signer::SignerService;
+
+use crate::{
+    account_utils::{self, AccountProvider},
+    miner::external::ExternalMiner,
+    sync::{ManageNetwork, SyncProvider},
+};
+use ethcore::{client::Client, miner::Miner, snapshot::SnapshotService};
+use ethcore_logger::RotatingLogger;
+use fetch::Client as FetchClient;
+use jsonrpc_core::{self as core, MetaIoHandler};
+use parity_rpc::{
+    dispatch::FullDispatcher,
+    informant::{ActivityNotifier, ClientNotifier},
+    Host, Metadata, NetworkSettings,
+};
+use parity_runtime::Executor;
+use parking_lot::Mutex;
+
+#[derive(Debug, PartialEq, Clone, Eq, Hash)]
+pub enum Api {
+    /// Web3 (Safe)
+    Web3,
+    /// Net (Safe)
+    Net,
+    /// Eth (Safe)
+    Eth,
+    /// Eth Pub-Sub (Safe)
+    EthPubSub,
+    /// Geth-compatible "personal" API (DEPRECATED; only used in `--geth` mode.)
+    Personal,
+    /// Signer - Confirm transactions in Signer (UNSAFE: Passwords, List of transactions)
+    Signer,
+    /// Parity - Custom extensions (Safe)
+    Parity,
+    /// Traces (Safe)
+    Traces,
+    /// Rpc (Safe)
+    Rpc,
+    /// Parity PubSub - Generic Publish-Subscriber (Safety depends on other APIs exposed).
+    ParityPubSub,
+    /// Parity Accounts extensions (UNSAFE: Passwords, Side Effects (new account))
+    ParityAccounts,
+    /// Parity - Set methods (UNSAFE: Side Effects affecting node operation)
+    ParitySet,
+    /// SecretStore (UNSAFE: arbitrary hash signing)
+    SecretStore,
+    /// Geth-compatible (best-effort) debug API (Potentially UNSAFE)
+    /// NOTE We don't aim to support all methods, only the ones that are useful.
+    Debug,
+}
+
+impl FromStr for Api {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        use self::Api::*;
+
+        match s {
+            "debug" => Ok(Debug),
+            "eth" => Ok(Eth),
+            "net" => Ok(Net),
+            "parity" => Ok(Parity),
+            "parity_accounts" => Ok(ParityAccounts),
+            "parity_pubsub" => Ok(ParityPubSub),
+            "parity_set" => Ok(ParitySet),
+            "personal" => Ok(Personal),
+            "pubsub" => Ok(EthPubSub),
+            "rpc" => Ok(Rpc),
+            "secretstore" => Ok(SecretStore),
+            "signer" => Ok(Signer),
+            "traces" => Ok(Traces),
+            "web3" => Ok(Web3),
+            api => Err(format!("Unknown api: {}", api)),
+        }
+    }
+}
+
+#[derive(Debug, Clone)]
+pub enum ApiSet {
+    // Unsafe context (like jsonrpc over http)
+    UnsafeContext,
+    // All possible APIs (safe context like token-protected WS interface)
+    All,
+    // Local "unsafe" context and accounts access
+    IpcContext,
+    // APIs for Parity Generic Pub-Sub
+    PubSub,
+    // Fixed list of APis
+    List(HashSet<Api>),
+}
+
+impl Default for ApiSet {
+    fn default() -> Self {
+        ApiSet::UnsafeContext
+    }
+}
+
+impl PartialEq for ApiSet {
+    fn eq(&self, other: &Self) -> bool {
+        self.list_apis() == other.list_apis()
+    }
+}
+
+impl FromStr for ApiSet {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let mut apis = HashSet::new();
+
+        for api in s.split(',') {
+            match api {
+                "all" => {
+                    apis.extend(ApiSet::All.list_apis());
+                }
+                "safe" => {
+                    // Safe APIs are those that are safe even in UnsafeContext.
+                    apis.extend(ApiSet::UnsafeContext.list_apis());
+                }
+                // Remove the API
+                api if api.starts_with("-") => {
+                    let api = api[1..].parse()?;
+                    apis.remove(&api);
+                }
+                api => {
+                    let api = api.parse()?;
+                    apis.insert(api);
+                }
+            }
+        }
+
+        Ok(ApiSet::List(apis))
+    }
+}
+
+fn to_modules(apis: &HashSet<Api>) -> BTreeMap<String, String> {
+    let mut modules = BTreeMap::new();
+    for api in apis {
+        let (name, version) = match *api {
+            Api::Debug => ("debug", "1.0"),
+            Api::Eth => ("eth", "1.0"),
+            Api::EthPubSub => ("pubsub", "1.0"),
+            Api::Net => ("net", "1.0"),
+            Api::Parity => ("parity", "1.0"),
+            Api::ParityAccounts => ("parity_accounts", "1.0"),
+            Api::ParityPubSub => ("parity_pubsub", "1.0"),
+            Api::ParitySet => ("parity_set", "1.0"),
+            Api::Personal => ("personal", "1.0"),
+            Api::Rpc => ("rpc", "1.0"),
+            Api::SecretStore => ("secretstore", "1.0"),
+            Api::Signer => ("signer", "1.0"),
+            Api::Traces => ("traces", "1.0"),
+            Api::Web3 => ("web3", "1.0"),
+        };
+        modules.insert(name.into(), version.into());
+    }
+    modules
+}
+
+macro_rules! add_signing_methods {
+    ($namespace:ident, $handler:expr, $deps:expr, $dispatch:expr) => {{
+        let deps = &$deps;
+        let (dispatcher, accounts) = $dispatch;
+        if deps.signer_service.is_enabled() {
+            $handler.extend_with($namespace::to_delegate(SigningQueueClient::new(
+                &deps.signer_service,
+                dispatcher.clone(),
+                deps.executor.clone(),
+                accounts,
+            )))
+        } else {
+            $handler.extend_with($namespace::to_delegate(SigningUnsafeClient::new(
+                accounts,
+                dispatcher.clone(),
+            )))
+        }
+    }};
+}
+
+/// RPC dependencies can be used to initialize RPC endpoints from APIs.
+pub trait Dependencies {
+    type Notifier: ActivityNotifier;
+
+    /// Create the activity notifier.
+    fn activity_notifier(&self) -> Self::Notifier;
+
+    /// Extend the given I/O handler with endpoints for each API.
+    fn extend_with_set<S>(&self, handler: &mut MetaIoHandler<Metadata, S>, apis: &HashSet<Api>)
+    where
+        S: core::Middleware<Metadata>;
+}
+
+/// RPC dependencies for a full node.
+pub struct FullDependencies {
+    pub signer_service: Arc<SignerService>,
+    pub client: Arc<Client>,
+    pub snapshot: Arc<dyn SnapshotService>,
+    pub sync: Arc<dyn SyncProvider>,
+    pub net: Arc<dyn ManageNetwork>,
+    pub accounts: Arc<AccountProvider>,
+    pub miner: Arc<Miner>,
+    pub external_miner: Arc<ExternalMiner>,
+    pub logger: Arc<RotatingLogger>,
+    pub settings: Arc<NetworkSettings>,
+    pub net_service: Arc<dyn ManageNetwork>,
+    pub experimental_rpcs: bool,
+    pub ws_address: Option<Host>,
+    pub fetch: FetchClient,
+    pub executor: Executor,
+    pub gas_price_percentile: usize,
+    pub poll_lifetime: u32,
+    pub allow_missing_blocks: bool,
+    pub no_ancient_blocks: bool,
+}
+
+impl FullDependencies {
+    fn extend_api<S>(
+        &self,
+        handler: &mut MetaIoHandler<Metadata, S>,
+        apis: &HashSet<Api>,
+        for_generic_pubsub: bool,
+    ) where
+        S: core::Middleware<Metadata>,
+    {
+        use parity_rpc::v1::*;
+
+        let nonces = Arc::new(Mutex::new(dispatch::Reservations::new(
+            self.executor.clone(),
+        )));
+        let dispatcher = FullDispatcher::new(
+            self.client.clone(),
+            self.miner.clone(),
+            nonces.clone(),
+            self.gas_price_percentile,
+        );
+        let account_signer = Arc::new(dispatch::Signer::new(self.accounts.clone())) as _;
+        let accounts = account_utils::accounts_list(self.accounts.clone());
+
+        for api in apis {
+            match *api {
+                Api::Debug => {
+                    handler.extend_with(DebugClient::new(self.client.clone()).to_delegate());
+                }
+                Api::Web3 => {
+                    handler.extend_with(Web3Client::default().to_delegate());
+                }
+                Api::Net => {
+                    handler.extend_with(NetClient::new(&self.sync).to_delegate());
+                }
+                Api::Eth => {
+                    let client = EthClient::new(
+                        &self.client,
+                        &self.snapshot,
+                        &self.sync,
+                        &accounts,
+                        &self.miner,
+                        &self.external_miner,
+                        EthClientOptions {
+                            gas_price_percentile: self.gas_price_percentile,
+                            allow_missing_blocks: self.allow_missing_blocks,
+                            allow_experimental_rpcs: self.experimental_rpcs,
+                            no_ancient_blocks: self.no_ancient_blocks,
+                        },
+                    );
+                    handler.extend_with(client.to_delegate());
+
+                    if !for_generic_pubsub {
+                        let filter_client = EthFilterClient::new(
+                            self.client.clone(),
+                            self.miner.clone(),
+                            self.poll_lifetime,
+                        );
+                        handler.extend_with(filter_client.to_delegate());
+
+                        add_signing_methods!(
+                            EthSigning,
+                            handler,
+                            self,
+                            (&dispatcher, &account_signer)
+                        );
+                    }
+                }
+                Api::EthPubSub => {
+                    if !for_generic_pubsub {
+                        let client =
+                            EthPubSubClient::new(self.client.clone(), self.executor.clone());
+                        let h = client.handler();
+                        self.miner
+                            .add_transactions_listener(Box::new(move |hashes| {
+                                if let Some(h) = h.upgrade() {
+                                    h.notify_new_transactions(hashes);
+                                }
+                            }));
+
+                        if let Some(h) = client.handler().upgrade() {
+                            self.client.add_notify(h);
+                        }
+                        handler.extend_with(client.to_delegate());
+                    }
+                }
+                Api::Personal => {
+                    #[cfg(feature = "accounts")]
+                    handler.extend_with(
+                        PersonalClient::new(
+                            &self.accounts,
+                            dispatcher.clone(),
+                            self.experimental_rpcs,
+                        )
+                        .to_delegate(),
+                    );
+                }
+                Api::Signer => {
+                    handler.extend_with(
+                        SignerClient::new(
+                            account_signer.clone(),
+                            dispatcher.clone(),
+                            &self.signer_service,
+                            self.executor.clone(),
+                        )
+                        .to_delegate(),
+                    );
+                }
+                Api::Parity => {
+                    let signer = match self.signer_service.is_enabled() {
+                        true => Some(self.signer_service.clone()),
+                        false => None,
+                    };
+                    handler.extend_with(
+                        ParityClient::new(
+                            self.client.clone(),
+                            self.miner.clone(),
+                            self.sync.clone(),
+                            self.net_service.clone(),
+                            self.logger.clone(),
+                            self.settings.clone(),
+                            signer,
+                            self.ws_address.clone(),
+                            self.snapshot.clone().into(),
+                        )
+                        .to_delegate(),
+                    );
+                    #[cfg(feature = "accounts")]
+                    handler.extend_with(ParityAccountsInfo::to_delegate(
+                        ParityAccountsClient::new(&self.accounts),
+                    ));
+
+                    if !for_generic_pubsub {
+                        add_signing_methods!(
+                            ParitySigning,
+                            handler,
+                            self,
+                            (&dispatcher, &account_signer)
+                        );
+                    }
+                }
+                Api::ParityPubSub => {
+                    if !for_generic_pubsub {
+                        let mut rpc = MetaIoHandler::default();
+                        let apis = ApiSet::List(apis.clone())
+                            .retain(ApiSet::PubSub)
+                            .list_apis();
+                        self.extend_api(&mut rpc, &apis, true);
+                        handler.extend_with(
+                            PubSubClient::new(rpc, self.executor.clone()).to_delegate(),
+                        );
+                    }
+                }
+                Api::ParityAccounts => {
+                    #[cfg(feature = "accounts")]
+                    handler.extend_with(ParityAccounts::to_delegate(ParityAccountsClient::new(
+                        &self.accounts,
+                    )));
+                }
+                Api::ParitySet => {
+                    handler.extend_with(
+                        ParitySetClient::new(
+                            &self.client,
+                            &self.miner,
+                            &self.net_service,
+                            self.fetch.clone(),
+                        )
+                        .to_delegate(),
+                    );
+                    #[cfg(feature = "accounts")]
+                    handler.extend_with(
+                        ParitySetAccountsClient::new(&self.accounts, &self.miner).to_delegate(),
+                    );
+                }
+                Api::Traces => handler.extend_with(TracesClient::new(&self.client).to_delegate()),
+                Api::Rpc => {
+                    let modules = to_modules(&apis);
+                    handler.extend_with(RpcClient::new(modules).to_delegate());
+                }
+                Api::SecretStore => {
+                    #[cfg(feature = "accounts")]
+                    handler.extend_with(SecretStoreClient::new(&self.accounts).to_delegate());
+                }
+            }
+        }
+    }
+}
+
+impl Dependencies for FullDependencies {
+    type Notifier = ClientNotifier;
+
+    fn activity_notifier(&self) -> ClientNotifier {
+        ClientNotifier {
+            client: self.client.clone(),
+        }
+    }
+
+    fn extend_with_set<S>(&self, handler: &mut MetaIoHandler<Metadata, S>, apis: &HashSet<Api>)
+    where
+        S: core::Middleware<Metadata>,
+    {
+        self.extend_api(handler, apis, false)
+    }
+}
+
+impl ApiSet {
+    /// Retains only APIs in given set.
+    pub fn retain(self, set: Self) -> Self {
+        ApiSet::List(&self.list_apis() & &set.list_apis())
+    }
+
+    pub fn list_apis(&self) -> HashSet<Api> {
+        let mut public_list: HashSet<Api> = [
+            Api::Web3,
+            Api::Net,
+            Api::Eth,
+            Api::EthPubSub,
+            Api::Parity,
+            Api::Rpc,
+        ]
+        .iter()
+        .cloned()
+        .collect();
+
+        match *self {
+            ApiSet::List(ref apis) => apis.clone(),
+            ApiSet::UnsafeContext => {
+                public_list.insert(Api::Traces);
+                public_list.insert(Api::ParityPubSub);
+                public_list
+            }
+            ApiSet::IpcContext => {
+                public_list.insert(Api::Traces);
+                public_list.insert(Api::ParityPubSub);
+                public_list.insert(Api::ParityAccounts);
+                public_list
+            }
+            ApiSet::All => {
+                public_list.insert(Api::Debug);
+                public_list.insert(Api::Traces);
+                public_list.insert(Api::ParityPubSub);
+                public_list.insert(Api::ParityAccounts);
+                public_list.insert(Api::ParitySet);
+                public_list.insert(Api::Signer);
+                public_list.insert(Api::Personal);
+                public_list.insert(Api::SecretStore);
+                public_list
+            }
+            ApiSet::PubSub => [
+                Api::Eth,
+                Api::Parity,
+                Api::ParityAccounts,
+                Api::ParitySet,
+                Api::Traces,
+            ]
+            .iter()
+            .cloned()
+            .collect(),
+        }
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use super::{Api, ApiSet};
+
+    #[test]
+    fn test_api_parsing() {
+        assert_eq!(Api::Debug, "debug".parse().unwrap());
+        assert_eq!(Api::Web3, "web3".parse().unwrap());
+        assert_eq!(Api::Net, "net".parse().unwrap());
+        assert_eq!(Api::Eth, "eth".parse().unwrap());
+        assert_eq!(Api::EthPubSub, "pubsub".parse().unwrap());
+        assert_eq!(Api::Personal, "personal".parse().unwrap());
+        assert_eq!(Api::Signer, "signer".parse().unwrap());
+        assert_eq!(Api::Parity, "parity".parse().unwrap());
+        assert_eq!(Api::ParityAccounts, "parity_accounts".parse().unwrap());
+        assert_eq!(Api::ParitySet, "parity_set".parse().unwrap());
+        assert_eq!(Api::Traces, "traces".parse().unwrap());
+        assert_eq!(Api::Rpc, "rpc".parse().unwrap());
+        assert_eq!(Api::SecretStore, "secretstore".parse().unwrap());
+        assert!("rp".parse::<Api>().is_err());
+    }
+
+    #[test]
+    fn test_api_set_default() {
+        assert_eq!(ApiSet::UnsafeContext, ApiSet::default());
+    }
+
+    #[test]
+    fn test_api_set_parsing() {
+        assert_eq!(
+            ApiSet::List(vec![Api::Web3, Api::Eth].into_iter().collect()),
+            "web3,eth".parse().unwrap()
+        );
+    }
+
+    #[test]
+    fn test_api_set_unsafe_context() {
+        let expected = vec![
+            // make sure this list contains only SAFE methods
+            Api::Web3,
+            Api::Net,
+            Api::Eth,
+            Api::EthPubSub,
+            Api::Parity,
+            Api::ParityPubSub,
+            Api::Traces,
+            Api::Rpc,
+        ]
+        .into_iter()
+        .collect();
+        assert_eq!(ApiSet::UnsafeContext.list_apis(), expected);
+    }
+
+    #[test]
+    fn test_api_set_ipc_context() {
+        let expected = vec![
+            // safe
+            Api::Web3,
+            Api::Net,
+            Api::Eth,
+            Api::EthPubSub,
+            Api::Parity,
+            Api::ParityPubSub,
+            Api::Traces,
+            Api::Rpc,
+            // semi-safe
+            Api::ParityAccounts,
+        ]
+        .into_iter()
+        .collect();
+        assert_eq!(ApiSet::IpcContext.list_apis(), expected);
+    }
+
+    #[test]
+    fn test_all_apis() {
+        assert_eq!(
+            "all".parse::<ApiSet>().unwrap(),
+            ApiSet::List(
+                vec![
+                    Api::Web3,
+                    Api::Net,
+                    Api::Eth,
+                    Api::EthPubSub,
+                    Api::Parity,
+                    Api::ParityPubSub,
+                    Api::Traces,
+                    Api::Rpc,
+                    Api::SecretStore,
+                    Api::ParityAccounts,
+                    Api::ParitySet,
+                    Api::Signer,
+                    Api::Personal,
+                    Api::Debug,
+                ]
+                .into_iter()
+                .collect()
+            )
+        );
+    }
+
+    #[test]
+    fn test_all_without_personal_apis() {
+        assert_eq!(
+            "personal,all,-personal".parse::<ApiSet>().unwrap(),
+            ApiSet::List(
+                vec![
+                    Api::Web3,
+                    Api::Net,
+                    Api::Eth,
+                    Api::EthPubSub,
+                    Api::Parity,
+                    Api::ParityPubSub,
+                    Api::Traces,
+                    Api::Rpc,
+                    Api::SecretStore,
+                    Api::ParityAccounts,
+                    Api::ParitySet,
+                    Api::Signer,
+                    Api::Debug,
+                ]
+                .into_iter()
+                .collect()
+            )
+        );
+    }
+
+    #[test]
+    fn test_safe_parsing() {
+        assert_eq!(
+            "safe".parse::<ApiSet>().unwrap(),
+            ApiSet::List(
+                vec![
+                    Api::Web3,
+                    Api::Net,
+                    Api::Eth,
+                    Api::EthPubSub,
+                    Api::Parity,
+                    Api::ParityPubSub,
+                    Api::Traces,
+                    Api::Rpc,
+                ]
+                .into_iter()
+                .collect()
+            )
+        );
+    }
+}

bin/oe/run.rs

@@ -0,0 +1,751 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::{
+    any::Any,
+    str::FromStr,
+    sync::{atomic, Arc, Weak},
+    thread,
+    time::{Duration, Instant},
+};
+
+use crate::{
+    account_utils,
+    cache::CacheConfig,
+    db,
+    helpers::{execute_upgrades, passwords_from_files, to_client_config},
+    informant::{FullNodeInformantData, Informant},
+    metrics::{start_prometheus_metrics, MetricsConfiguration},
+    miner::{external::ExternalMiner, work_notify::WorkPoster},
+    modules,
+    params::{
+        fatdb_switch_to_bool, mode_switch_to_bool, tracing_switch_to_bool, AccountsConfig,
+        GasPricerConfig, MinerExtras, Pruning, SpecType, Switch,
+    },
+    rpc, rpc_apis, secretstore, signer,
+    sync::{self, SyncConfig},
+    user_defaults::UserDefaults,
+};
+use ansi_term::Colour;
+use dir::{DatabaseDirectories, Directories};
+use ethcore::{
+    client::{BlockChainClient, BlockInfo, Client, DatabaseCompactionProfile, Mode, VMType},
+    miner::{self, stratum, Miner, MinerOptions, MinerService},
+    snapshot::{self, SnapshotConfiguration},
+    verification::queue::VerifierSettings,
+};
+use ethcore_logger::{Config as LogConfig, RotatingLogger};
+use ethcore_service::ClientService;
+use ethereum_types::{H256, U64};
+use journaldb::Algorithm;
+use jsonrpc_core;
+use node_filter::NodeFilter;
+use parity_rpc::{
+    informant, is_major_importing, FutureOutput, FutureResponse, FutureResult, Metadata,
+    NetworkSettings, Origin, PubSubSession,
+};
+use parity_runtime::Runtime;
+use parity_version::version;
+
+// How often we attempt to take a snapshot: only snapshot on blocknumbers that are multiples of this.
+const SNAPSHOT_PERIOD: u64 = 20000;
+
+// Start snapshoting from `tip`-`history, with this we want to bypass reorgs. Should be smaller than prunning history.
+const SNAPSHOT_HISTORY: u64 = 50;
+
+// Full client number of DNS threads
+const FETCH_FULL_NUM_DNS_THREADS: usize = 4;
+
+#[derive(Debug, PartialEq)]
+pub struct RunCmd {
+    pub cache_config: CacheConfig,
+    pub dirs: Directories,
+    pub spec: SpecType,
+    pub pruning: Pruning,
+    pub pruning_history: u64,
+    pub pruning_memory: usize,
+    /// Some if execution should be daemonized. Contains pid_file path.
+    pub daemon: Option<String>,
+    pub logger_config: LogConfig,
+    pub miner_options: MinerOptions,
+    pub gas_price_percentile: usize,
+    pub poll_lifetime: u32,
+    pub ws_conf: rpc::WsConfiguration,
+    pub http_conf: rpc::HttpConfiguration,
+    pub ipc_conf: rpc::IpcConfiguration,
+    pub net_conf: sync::NetworkConfiguration,
+    pub network_id: Option<u64>,
+    pub warp_sync: bool,
+    pub warp_barrier: Option<u64>,
+    pub acc_conf: AccountsConfig,
+    pub gas_pricer_conf: GasPricerConfig,
+    pub miner_extras: MinerExtras,
+    pub mode: Option<Mode>,
+    pub tracing: Switch,
+    pub fat_db: Switch,
+    pub compaction: DatabaseCompactionProfile,
+    pub vm_type: VMType,
+    pub experimental_rpcs: bool,
+    pub net_settings: NetworkSettings,
+    pub secretstore_conf: secretstore::Configuration,
+    pub name: String,
+    pub custom_bootnodes: bool,
+    pub stratum: Option<stratum::Options>,
+    pub snapshot_conf: SnapshotConfiguration,
+    pub check_seal: bool,
+    pub allow_missing_blocks: bool,
+    pub download_old_blocks: bool,
+    pub verifier_settings: VerifierSettings,
+    pub no_persistent_txqueue: bool,
+    pub max_round_blocks_to_import: usize,
+    pub metrics_conf: MetricsConfiguration,
+}
+
+// node info fetcher for the local store.
+struct FullNodeInfo {
+    miner: Option<Arc<Miner>>, // TODO: only TXQ needed, just use that after decoupling.
+}
+
+impl crate::local_store::NodeInfo for FullNodeInfo {
+    fn pending_transactions(&self) -> Vec<crate::types::transaction::PendingTransaction> {
+        let miner = match self.miner.as_ref() {
+            Some(m) => m,
+            None => return Vec::new(),
+        };
+
+        miner
+            .local_transactions()
+            .values()
+            .filter_map(|status| match *status {
+                crate::miner::pool::local_transactions::Status::Pending(ref tx) => {
+                    Some(tx.pending().clone())
+                }
+                _ => None,
+            })
+            .collect()
+    }
+}
+
+/// Executes the given run command.
+///
+/// On error, returns what to print on stderr.
+pub fn execute(cmd: RunCmd, logger: Arc<RotatingLogger>) -> Result<RunningClient, String> {
+    // load spec
+    let spec = cmd.spec.spec(&cmd.dirs.cache)?;
+
+    // load genesis hash
+    let genesis_hash = spec.genesis_header().hash();
+
+    // database paths
+    let db_dirs = cmd.dirs.database(
+        genesis_hash,
+        cmd.spec.legacy_fork_name(),
+        spec.data_dir.clone(),
+    );
+
+    // user defaults path
+    let user_defaults_path = db_dirs.user_defaults_path();
+
+    // load user defaults
+    let mut user_defaults = UserDefaults::load(&user_defaults_path)?;
+
+    // select pruning algorithm
+    let algorithm = cmd.pruning.to_algorithm(&user_defaults);
+
+    // check if tracing is on
+    let tracing = tracing_switch_to_bool(cmd.tracing, &user_defaults)?;
+
+    // check if fatdb is on
+    let fat_db = fatdb_switch_to_bool(cmd.fat_db, &user_defaults, algorithm)?;
+
+    // get the mode
+    let mode = mode_switch_to_bool(cmd.mode, &user_defaults)?;
+    trace!(target: "mode", "mode is {:?}", mode);
+    let network_enabled = match mode {
+        Mode::Dark(_) | Mode::Off => false,
+        _ => true,
+    };
+
+    // prepare client and snapshot paths.
+    let client_path = db_dirs.client_path(algorithm);
+    let snapshot_path = db_dirs.snapshot_path();
+
+    // execute upgrades
+    execute_upgrades(&cmd.dirs.base, &db_dirs, algorithm, &cmd.compaction)?;
+
+    // create dirs used by parity
+    cmd.dirs.create_dirs(
+        cmd.acc_conf.unlocked_accounts.len() == 0,
+        cmd.secretstore_conf.enabled,
+    )?;
+
+    //print out running parity environment
+    print_running_environment(&spec.data_dir, &cmd.dirs, &db_dirs);
+
+    // display info about used pruning algorithm
+    info!(
+        "State DB configuration: {}{}{}",
+        Colour::White.bold().paint(algorithm.as_str()),
+        match fat_db {
+            true => Colour::White.bold().paint(" +Fat").to_string(),
+            false => "".to_owned(),
+        },
+        match tracing {
+            true => Colour::White.bold().paint(" +Trace").to_string(),
+            false => "".to_owned(),
+        }
+    );
+    info!(
+        "Operating mode: {}",
+        Colour::White.bold().paint(format!("{}", mode))
+    );
+
+    // display warning about using experimental journaldb algorithm
+    if !algorithm.is_stable() {
+        warn!(
+            "Your chosen strategy is {}! You can re-run with --pruning to change.",
+            Colour::Red.bold().paint("unstable")
+        );
+    }
+
+    // create sync config
+    let mut sync_config = SyncConfig::default();
+    sync_config.network_id = match cmd.network_id {
+        Some(id) => id,
+        None => spec.network_id(),
+    };
+    if spec.subprotocol_name().len() > 8 {
+        warn!("Your chain specification's subprotocol length is more then 8. Ignoring.");
+    } else {
+        sync_config.subprotocol_name = U64::from(spec.subprotocol_name().as_bytes())
+    }
+
+    sync_config.fork_block = spec.fork_block();
+    let mut warp_sync = spec.engine.supports_warp() && cmd.warp_sync;
+    if warp_sync {
+        // Logging is not initialized yet, so we print directly to stderr
+        if fat_db {
+            warn!("Warning: Warp Sync is disabled because Fat DB is turned on.");
+            warp_sync = false;
+        } else if tracing {
+            warn!("Warning: Warp Sync is disabled because tracing is turned on.");
+            warp_sync = false;
+        } else if algorithm != Algorithm::OverlayRecent {
+            warn!("Warning: Warp Sync is disabled because of non-default pruning mode.");
+            warp_sync = false;
+        }
+    }
+    sync_config.warp_sync = match (warp_sync, cmd.warp_barrier) {
+        (true, Some(block)) => sync::WarpSync::OnlyAndAfter(block),
+        (true, _) => sync::WarpSync::Enabled,
+        _ => sync::WarpSync::Disabled,
+    };
+    sync_config.download_old_blocks = cmd.download_old_blocks;
+    sync_config.eip1559_transition = spec.params().eip1559_transition;
+
+    let passwords = passwords_from_files(&cmd.acc_conf.password_files)?;
+
+    // prepare account provider
+    let account_provider = Arc::new(account_utils::prepare_account_provider(
+        &cmd.spec,
+        &cmd.dirs,
+        &spec.data_dir,
+        cmd.acc_conf,
+        &passwords,
+    )?);
+
+    // spin up event loop
+    let runtime = Runtime::with_default_thread_count();
+
+    // fetch service
+    let fetch = fetch::Client::new(FETCH_FULL_NUM_DNS_THREADS)
+        .map_err(|e| format!("Error starting fetch client: {:?}", e))?;
+
+    let txpool_size = cmd.miner_options.pool_limits.max_count;
+    // create miner
+    let miner = Arc::new(Miner::new(
+        cmd.miner_options,
+        cmd.gas_pricer_conf
+            .to_gas_pricer(fetch.clone(), runtime.executor()),
+        &spec,
+        (
+            cmd.miner_extras.local_accounts,
+            account_utils::miner_local_accounts(account_provider.clone()),
+        ),
+    ));
+    miner.set_author(miner::Author::External(cmd.miner_extras.author));
+    miner.set_gas_range_target(cmd.miner_extras.gas_range_target);
+    miner.set_extra_data(cmd.miner_extras.extra_data);
+
+    if !cmd.miner_extras.work_notify.is_empty() {
+        miner.add_work_listener(Box::new(WorkPoster::new(
+            &cmd.miner_extras.work_notify,
+            fetch.clone(),
+            runtime.executor(),
+        )));
+    }
+
+    let engine_signer = cmd.miner_extras.engine_signer;
+    if engine_signer != Default::default() {
+        if let Some(author) = account_utils::miner_author(
+            &cmd.spec,
+            &cmd.dirs,
+            &account_provider,
+            engine_signer,
+            &passwords,
+        )? {
+            miner.set_author(author);
+        }
+    }
+
+    // create client config
+    let mut client_config = to_client_config(
+        &cmd.cache_config,
+        spec.name.to_lowercase(),
+        mode.clone(),
+        tracing,
+        fat_db,
+        cmd.compaction,
+        cmd.vm_type,
+        cmd.name,
+        algorithm,
+        cmd.pruning_history,
+        cmd.pruning_memory,
+        cmd.check_seal,
+        cmd.max_round_blocks_to_import,
+    );
+
+    client_config.queue.verifier_settings = cmd.verifier_settings;
+    client_config.queue.verifier_settings.bad_hashes = verification_bad_blocks(&cmd.spec);
+    client_config.transaction_verification_queue_size = ::std::cmp::max(2048, txpool_size / 4);
+    client_config.snapshot = cmd.snapshot_conf.clone();
+
+    // set up bootnodes
+    let mut net_conf = cmd.net_conf;
+    if !cmd.custom_bootnodes {
+        net_conf.boot_nodes = spec.nodes.clone();
+    }
+
+    // set network path.
+    net_conf.net_config_path = Some(db_dirs.network_path().to_string_lossy().into_owned());
+
+    let restoration_db_handler = db::restoration_db_handler(&client_path, &client_config);
+    let client_db = restoration_db_handler
+        .open(&client_path)
+        .map_err(|e| format!("Failed to open database {:?}", e))?;
+
+    // create client service.
+    let service = ClientService::start(
+        client_config,
+        &spec,
+        client_db,
+        &snapshot_path,
+        restoration_db_handler,
+        &cmd.dirs.ipc_path(),
+        miner.clone(),
+    )
+    .map_err(|e| format!("Client service error: {:?}", e))?;
+
+    let connection_filter_address = spec.params().node_permission_contract;
+    // drop the spec to free up genesis state.
+    let forks = spec.hard_forks.clone();
+    drop(spec);
+
+    // take handle to client
+    let client = service.client();
+    // Update miners block gas limit and base_fee
+    let base_fee = client
+        .engine()
+        .calculate_base_fee(&client.best_block_header());
+    let allow_non_eoa_sender = client
+        .engine()
+        .allow_non_eoa_sender(client.best_block_header().number() + 1);
+    miner.update_transaction_queue_limits(
+        *client.best_block_header().gas_limit(),
+        base_fee,
+        allow_non_eoa_sender,
+    );
+
+    let connection_filter = connection_filter_address.map(|a| {
+        Arc::new(NodeFilter::new(
+            Arc::downgrade(&client) as Weak<dyn BlockChainClient>,
+            a,
+        ))
+    });
+    let snapshot_service = service.snapshot_service();
+
+    // initialize the local node information store.
+    let store = {
+        let db = service.db();
+        let node_info = FullNodeInfo {
+            miner: match cmd.no_persistent_txqueue {
+                true => None,
+                false => Some(miner.clone()),
+            },
+        };
+
+        let store = crate::local_store::create(
+            db.key_value().clone(),
+            ::ethcore_db::COL_NODE_INFO,
+            node_info,
+        );
+
+        if cmd.no_persistent_txqueue {
+            info!("Running without a persistent transaction queue.");
+
+            if let Err(e) = store.clear() {
+                warn!("Error clearing persistent transaction queue: {}", e);
+            }
+        }
+
+        // re-queue pending transactions.
+        match store.pending_transactions() {
+            Ok(pending) => {
+                for pending_tx in pending {
+                    if let Err(e) = miner.import_own_transaction(&*client, pending_tx) {
+                        warn!("Error importing saved transaction: {}", e)
+                    }
+                }
+            }
+            Err(e) => warn!("Error loading cached pending transactions from disk: {}", e),
+        }
+
+        Arc::new(store)
+    };
+
+    // register it as an IO service to update periodically.
+    service
+        .register_io_handler(store)
+        .map_err(|_| "Unable to register local store handler".to_owned())?;
+
+    // create external miner
+    let external_miner = Arc::new(ExternalMiner::default());
+
+    // start stratum
+    if let Some(ref stratum_config) = cmd.stratum {
+        stratum::Stratum::register(stratum_config, miner.clone(), Arc::downgrade(&client))
+            .map_err(|e| format!("Stratum start error: {:?}", e))?;
+    }
+
+    // create sync object
+    let (sync_provider, manage_network, chain_notify, priority_tasks) = modules::sync(
+        sync_config,
+        net_conf.clone().into(),
+        client.clone(),
+        forks,
+        snapshot_service.clone(),
+        &cmd.logger_config,
+        connection_filter
+            .clone()
+            .map(|f| f as Arc<dyn crate::sync::ConnectionFilter + 'static>),
+    )
+    .map_err(|e| format!("Sync error: {}", e))?;
+
+    service.add_notify(chain_notify.clone());
+
+    // Propagate transactions as soon as they are imported.
+    let tx = ::parking_lot::Mutex::new(priority_tasks);
+    let is_ready = Arc::new(atomic::AtomicBool::new(true));
+    miner.add_transactions_listener(Box::new(move |_hashes| {
+        // we want to have only one PendingTransactions task in the queue.
+        if is_ready
+            .compare_exchange(
+                true,
+                false,
+                atomic::Ordering::SeqCst,
+                atomic::Ordering::SeqCst,
+            )
+            .is_ok()
+        {
+            let task =
+                crate::sync::PriorityTask::PropagateTransactions(Instant::now(), is_ready.clone());
+            // we ignore error cause it means that we are closing
+            let _ = tx.lock().send(task);
+        }
+    }));
+
+    // start network
+    if network_enabled {
+        chain_notify.start();
+    }
+
+    // set up dependencies for rpc servers
+    let rpc_stats = Arc::new(informant::RpcStats::default());
+    let secret_store = account_provider.clone();
+    let signer_service = Arc::new(signer::new_service(&cmd.ws_conf, &cmd.logger_config));
+
+    let deps_for_rpc_apis = Arc::new(rpc_apis::FullDependencies {
+        signer_service: signer_service,
+        snapshot: snapshot_service.clone(),
+        client: client.clone(),
+        sync: sync_provider.clone(),
+        net: manage_network.clone(),
+        accounts: secret_store,
+        miner: miner.clone(),
+        external_miner: external_miner.clone(),
+        logger: logger.clone(),
+        settings: Arc::new(cmd.net_settings.clone()),
+        net_service: manage_network.clone(),
+        experimental_rpcs: cmd.experimental_rpcs,
+        ws_address: cmd.ws_conf.address(),
+        fetch: fetch.clone(),
+        executor: runtime.executor(),
+        gas_price_percentile: cmd.gas_price_percentile,
+        poll_lifetime: cmd.poll_lifetime,
+        allow_missing_blocks: cmd.allow_missing_blocks,
+        no_ancient_blocks: !cmd.download_old_blocks,
+    });
+
+    let dependencies = rpc::Dependencies {
+        apis: deps_for_rpc_apis.clone(),
+        executor: runtime.executor(),
+        stats: rpc_stats.clone(),
+    };
+
+    // start rpc servers
+    let rpc_direct = rpc::setup_apis(rpc_apis::ApiSet::All, &dependencies);
+    let ws_server = rpc::new_ws(cmd.ws_conf.clone(), &dependencies)?;
+    let ipc_server = rpc::new_ipc(cmd.ipc_conf, &dependencies)?;
+
+    // start the prometheus metrics server
+    start_prometheus_metrics(&cmd.metrics_conf, &dependencies)?;
+
+    let http_server = rpc::new_http(
+        "HTTP JSON-RPC",
+        "jsonrpc",
+        cmd.http_conf.clone(),
+        &dependencies,
+    )?;
+
+    // secret store key server
+    let secretstore_deps = secretstore::Dependencies {
+        client: client.clone(),
+        sync: sync_provider.clone(),
+        miner: miner.clone(),
+        account_provider,
+        accounts_passwords: &passwords,
+    };
+    let secretstore_key_server = secretstore::start(
+        cmd.secretstore_conf.clone(),
+        secretstore_deps,
+        runtime.executor(),
+    )?;
+
+    // the informant
+    let informant = Arc::new(Informant::new(
+        FullNodeInformantData {
+            client: service.client(),
+            sync: Some(sync_provider.clone()),
+            net: Some(manage_network.clone()),
+        },
+        Some(snapshot_service.clone()),
+        Some(rpc_stats.clone()),
+        cmd.logger_config.color,
+    ));
+    service.add_notify(informant.clone());
+    service
+        .register_io_handler(informant.clone())
+        .map_err(|_| "Unable to register informant handler".to_owned())?;
+
+    // save user defaults
+    user_defaults.is_first_launch = false;
+    user_defaults.pruning = algorithm;
+    user_defaults.tracing = tracing;
+    user_defaults.fat_db = fat_db;
+    user_defaults.set_mode(mode);
+    user_defaults.save(&user_defaults_path)?;
+
+    // tell client how to save the default mode if it gets changed.
+    client.on_user_defaults_change(move |mode: Option<Mode>| {
+        if let Some(mode) = mode {
+            user_defaults.set_mode(mode);
+        }
+        let _ = user_defaults.save(&user_defaults_path); // discard failures - there's nothing we can do
+    });
+
+    // the watcher must be kept alive.
+    let watcher = match cmd.snapshot_conf.enable {
+        false => None,
+        true => {
+            let sync = sync_provider.clone();
+            let client = client.clone();
+            let watcher = Arc::new(snapshot::Watcher::new(
+                service.client(),
+                move || is_major_importing(Some(sync.status().state), client.queue_info()),
+                service.io().channel(),
+                SNAPSHOT_PERIOD,
+                SNAPSHOT_HISTORY,
+            ));
+
+            service.add_notify(watcher.clone());
+            Some(watcher)
+        }
+    };
+
+    Ok(RunningClient {
+        inner: RunningClientInner::Full {
+            rpc: rpc_direct,
+            informant,
+            client,
+            client_service: Arc::new(service),
+            keep_alive: Box::new((
+                watcher,
+                ws_server,
+                http_server,
+                ipc_server,
+                secretstore_key_server,
+                runtime,
+            )),
+        },
+    })
+}
+
+/// Set bad blocks in VerificationQeueu. By omiting header we can omit particular fork of chain.
+fn verification_bad_blocks(spec: &SpecType) -> Vec<H256> {
+    match *spec {
+        SpecType::Ropsten => {
+            vec![
+                H256::from_str("1eac3d16c642411f13c287e29144c6f58fda859407c8f24c38deb168e1040714")
+                    .expect("Valid hex string"),
+            ]
+        }
+        _ => vec![],
+    }
+}
+
+/// Parity client currently executing in background threads.
+///
+/// Should be destroyed by calling `shutdown()`, otherwise execution will continue in the
+/// background.
+pub struct RunningClient {
+    inner: RunningClientInner,
+}
+
+enum RunningClientInner {
+    Full {
+        rpc:
+            jsonrpc_core::MetaIoHandler<Metadata, informant::Middleware<informant::ClientNotifier>>,
+        informant: Arc<Informant<FullNodeInformantData>>,
+        client: Arc<Client>,
+        client_service: Arc<ClientService>,
+        keep_alive: Box<dyn Any>,
+    },
+}
+
+impl RunningClient {
+    /// Performs an asynchronous RPC query.
+    // FIXME: [tomaka] This API should be better, with for example a Future
+    pub fn rpc_query(
+        &self,
+        request: &str,
+        session: Option<Arc<PubSubSession>>,
+    ) -> FutureResult<FutureResponse, FutureOutput> {
+        let metadata = Metadata {
+            origin: Origin::CApi,
+            session,
+        };
+
+        match self.inner {
+            RunningClientInner::Full { ref rpc, .. } => rpc.handle_request(request, metadata),
+        }
+    }
+
+    /// Shuts down the client.
+    pub fn shutdown(self) {
+        match self.inner {
+            RunningClientInner::Full {
+                rpc,
+                informant,
+                client,
+                client_service,
+                keep_alive,
+            } => {
+                info!("Finishing work, please wait...");
+                // Create a weak reference to the client so that we can wait on shutdown
+                // until it is dropped
+                let weak_client = Arc::downgrade(&client);
+                // Shutdown and drop the ClientService
+                client_service.shutdown();
+                trace!(target: "shutdown", "ClientService shut down");
+                drop(client_service);
+                trace!(target: "shutdown", "ClientService dropped");
+                // drop this stuff as soon as exit detected.
+                drop(rpc);
+                trace!(target: "shutdown", "RPC dropped");
+                drop(keep_alive);
+                trace!(target: "shutdown", "KeepAlive dropped");
+                // to make sure timer does not spawn requests while shutdown is in progress
+                informant.shutdown();
+                trace!(target: "shutdown", "Informant shut down");
+                // just Arc is dropping here, to allow other reference release in its default time
+                drop(informant);
+                trace!(target: "shutdown", "Informant dropped");
+                drop(client);
+                trace!(target: "shutdown", "Client dropped");
+                // This may help when debugging ref cycles. Requires nightly-only  `#![feature(weak_counts)]`
+                // trace!(target: "shutdown", "Waiting for refs to Client to shutdown, strong_count={:?}, weak_count={:?}", weak_client.strong_count(), weak_client.weak_count());
+                trace!(target: "shutdown", "Waiting for refs to Client to shutdown");
+                wait_for_drop(weak_client);
+            }
+        }
+    }
+}
+
+fn print_running_environment(data_dir: &str, dirs: &Directories, db_dirs: &DatabaseDirectories) {
+    info!("Starting {}", Colour::White.bold().paint(version()));
+    info!(
+        "Keys path {}",
+        Colour::White
+            .bold()
+            .paint(dirs.keys_path(data_dir).to_string_lossy().into_owned())
+    );
+    info!(
+        "DB path {}",
+        Colour::White
+            .bold()
+            .paint(db_dirs.db_root_path().to_string_lossy().into_owned())
+    );
+}
+
+fn wait_for_drop<T>(w: Weak<T>) {
+    const SLEEP_DURATION: Duration = Duration::from_secs(1);
+    const WARN_TIMEOUT: Duration = Duration::from_secs(60);
+    const MAX_TIMEOUT: Duration = Duration::from_secs(300);
+
+    let instant = Instant::now();
+    let mut warned = false;
+
+    while instant.elapsed() < MAX_TIMEOUT {
+        if w.upgrade().is_none() {
+            return;
+        }
+
+        if !warned && instant.elapsed() > WARN_TIMEOUT {
+            warned = true;
+            warn!("Shutdown is taking longer than expected.");
+        }
+
+        thread::sleep(SLEEP_DURATION);
+
+        // When debugging shutdown issues on a nightly build it can help to enable this with the
+        // `#![feature(weak_counts)]` added to lib.rs (TODO: enable when
+        // https://github.com/rust-lang/rust/issues/57977 is stable)
+        // trace!(target: "shutdown", "Waiting for client to drop, strong_count={:?}, weak_count={:?}", w.strong_count(), w.weak_count());
+        trace!(target: "shutdown", "Waiting for client to drop");
+    }
+
+    warn!("Shutdown timeout reached, exiting uncleanly.");
+}

bin/oe/secretstore.rs

@@ -0,0 +1,333 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use crate::{account_utils::AccountProvider, sync::SyncProvider};
+use crypto::publickey::{Public, Secret};
+use dir::{default_data_path, helpers::replace_home};
+use ethcore::{client::Client, miner::Miner};
+use ethereum_types::Address;
+use ethkey::Password;
+use parity_runtime::Executor;
+use std::{collections::BTreeMap, sync::Arc};
+
+/// This node secret key.
+#[derive(Debug, PartialEq, Clone)]
+pub enum NodeSecretKey {
+    /// Stored as plain text in configuration file.
+    Plain(Secret),
+    /// Stored as account in key store.
+    #[cfg(feature = "accounts")]
+    KeyStore(Address),
+}
+
+/// Secret store service contract address.
+#[derive(Debug, PartialEq, Clone)]
+pub enum ContractAddress {
+    /// Contract address is read from registry.
+    Registry,
+    /// Contract address is specified.
+    Address(Address),
+}
+
+#[derive(Debug, PartialEq, Clone)]
+/// Secret store configuration
+pub struct Configuration {
+    /// Is secret store functionality enabled?
+    pub enabled: bool,
+    /// Is HTTP API enabled?
+    pub http_enabled: bool,
+    /// Is auto migrate enabled.
+    pub auto_migrate_enabled: bool,
+    /// ACL check contract address.
+    pub acl_check_contract_address: Option<ContractAddress>,
+    /// Service contract address.
+    pub service_contract_address: Option<ContractAddress>,
+    /// Server key generation service contract address.
+    pub service_contract_srv_gen_address: Option<ContractAddress>,
+    /// Server key retrieval service contract address.
+    pub service_contract_srv_retr_address: Option<ContractAddress>,
+    /// Document key store service contract address.
+    pub service_contract_doc_store_address: Option<ContractAddress>,
+    /// Document key shadow retrieval service contract address.
+    pub service_contract_doc_sretr_address: Option<ContractAddress>,
+    /// This node secret.
+    pub self_secret: Option<NodeSecretKey>,
+    /// Other nodes IDs + addresses.
+    pub nodes: BTreeMap<Public, (String, u16)>,
+    /// Key Server Set contract address. If None, 'nodes' map is used.
+    pub key_server_set_contract_address: Option<ContractAddress>,
+    /// Interface to listen to
+    pub interface: String,
+    /// Port to listen to
+    pub port: u16,
+    /// Interface to listen to
+    pub http_interface: String,
+    /// Port to listen to
+    pub http_port: u16,
+    /// Data directory path for secret store
+    pub data_path: String,
+    /// Administrator public key.
+    pub admin_public: Option<Public>,
+}
+
+/// Secret store dependencies
+pub struct Dependencies<'a> {
+    /// Blockchain client.
+    pub client: Arc<Client>,
+    /// Sync provider.
+    pub sync: Arc<dyn SyncProvider>,
+    /// Miner service.
+    pub miner: Arc<Miner>,
+    /// Account provider.
+    pub account_provider: Arc<AccountProvider>,
+    /// Passed accounts passwords.
+    pub accounts_passwords: &'a [Password],
+}
+
+#[cfg(not(feature = "secretstore"))]
+mod server {
+    use super::{Configuration, Dependencies, Executor};
+
+    /// Noop key server implementation
+    pub struct KeyServer;
+
+    impl KeyServer {
+        /// Create new noop key server
+        pub fn new(
+            _conf: Configuration,
+            _deps: Dependencies,
+            _executor: Executor,
+        ) -> Result<Self, String> {
+            Ok(KeyServer)
+        }
+    }
+}
+
+#[cfg(feature = "secretstore")]
+mod server {
+    use super::{Configuration, ContractAddress, Dependencies, Executor, NodeSecretKey};
+    use ansi_term::Colour::{Red, White};
+    use db;
+    use ethcore_secretstore;
+    use ethkey::KeyPair;
+    use std::sync::Arc;
+
+    fn into_service_contract_address(
+        address: ContractAddress,
+    ) -> ethcore_secretstore::ContractAddress {
+        match address {
+            ContractAddress::Registry => ethcore_secretstore::ContractAddress::Registry,
+            ContractAddress::Address(address) => {
+                ethcore_secretstore::ContractAddress::Address(address)
+            }
+        }
+    }
+
+    /// Key server
+    pub struct KeyServer {
+        _key_server: Box<dyn ethcore_secretstore::KeyServer>,
+    }
+
+    impl KeyServer {
+        /// Create new key server
+        pub fn new(
+            mut conf: Configuration,
+            deps: Dependencies,
+            executor: Executor,
+        ) -> Result<Self, String> {
+            let self_secret: Arc<dyn ethcore_secretstore::NodeKeyPair> =
+                match conf.self_secret.take() {
+                    Some(NodeSecretKey::Plain(secret)) => {
+                        Arc::new(ethcore_secretstore::PlainNodeKeyPair::new(
+                            KeyPair::from_secret(secret)
+                                .map_err(|e| format!("invalid secret: {}", e))?,
+                        ))
+                    }
+                    #[cfg(feature = "accounts")]
+                    Some(NodeSecretKey::KeyStore(account)) => {
+                        // Check if account exists
+                        if !deps.account_provider.has_account(account.clone()) {
+                            return Err(format!(
+                                "Account {} passed as secret store node key is not found",
+                                account
+                            ));
+                        }
+
+                        // Check if any passwords have been read from the password file(s)
+                        if deps.accounts_passwords.is_empty() {
+                            return Err(format!(
+                                "No password found for the secret store node account {}",
+                                account
+                            ));
+                        }
+
+                        // Attempt to sign in the engine signer.
+                        let password = deps
+                            .accounts_passwords
+                            .iter()
+                            .find(|p| {
+                                deps.account_provider
+                                    .sign(account.clone(), Some((*p).clone()), Default::default())
+                                    .is_ok()
+                            })
+                            .ok_or_else(|| {
+                                format!(
+                                    "No valid password for the secret store node account {}",
+                                    account
+                                )
+                            })?;
+                        Arc::new(
+                            ethcore_secretstore::KeyStoreNodeKeyPair::new(
+                                deps.account_provider,
+                                account,
+                                password.clone(),
+                            )
+                            .map_err(|e| format!("{}", e))?,
+                        )
+                    }
+                    None => return Err("self secret is required when using secretstore".into()),
+                };
+
+            info!(
+                "Starting SecretStore node: {}",
+                White.bold().paint(format!("{:?}", self_secret.public()))
+            );
+            if conf.acl_check_contract_address.is_none() {
+                warn!(
+                    "Running SecretStore with disabled ACL check: {}",
+                    Red.bold().paint("everyone has access to stored keys")
+                );
+            }
+
+            let key_server_name = format!("{}:{}", conf.interface, conf.port);
+            let mut cconf = ethcore_secretstore::ServiceConfiguration {
+                listener_address: if conf.http_enabled {
+                    Some(ethcore_secretstore::NodeAddress {
+                        address: conf.http_interface.clone(),
+                        port: conf.http_port,
+                    })
+                } else {
+                    None
+                },
+                service_contract_address: conf
+                    .service_contract_address
+                    .map(into_service_contract_address),
+                service_contract_srv_gen_address: conf
+                    .service_contract_srv_gen_address
+                    .map(into_service_contract_address),
+                service_contract_srv_retr_address: conf
+                    .service_contract_srv_retr_address
+                    .map(into_service_contract_address),
+                service_contract_doc_store_address: conf
+                    .service_contract_doc_store_address
+                    .map(into_service_contract_address),
+                service_contract_doc_sretr_address: conf
+                    .service_contract_doc_sretr_address
+                    .map(into_service_contract_address),
+                acl_check_contract_address: conf
+                    .acl_check_contract_address
+                    .map(into_service_contract_address),
+                cluster_config: ethcore_secretstore::ClusterConfiguration {
+                    listener_address: ethcore_secretstore::NodeAddress {
+                        address: conf.interface.clone(),
+                        port: conf.port,
+                    },
+                    nodes: conf
+                        .nodes
+                        .into_iter()
+                        .map(|(p, (ip, port))| {
+                            (
+                                p,
+                                ethcore_secretstore::NodeAddress {
+                                    address: ip,
+                                    port: port,
+                                },
+                            )
+                        })
+                        .collect(),
+                    key_server_set_contract_address: conf
+                        .key_server_set_contract_address
+                        .map(into_service_contract_address),
+                    allow_connecting_to_higher_nodes: true,
+                    admin_public: conf.admin_public,
+                    auto_migrate_enabled: conf.auto_migrate_enabled,
+                },
+            };
+
+            cconf.cluster_config.nodes.insert(
+                self_secret.public().clone(),
+                cconf.cluster_config.listener_address.clone(),
+            );
+
+            let db = db::open_secretstore_db(&conf.data_path)?;
+            let key_server = ethcore_secretstore::start(
+                deps.client,
+                deps.sync,
+                deps.miner,
+                self_secret,
+                cconf,
+                db,
+                executor,
+            )
+            .map_err(|e| format!("Error starting KeyServer {}: {}", key_server_name, e))?;
+
+            Ok(KeyServer {
+                _key_server: key_server,
+            })
+        }
+    }
+}
+
+pub use self::server::KeyServer;
+
+impl Default for Configuration {
+    fn default() -> Self {
+        let data_dir = default_data_path();
+        Configuration {
+            enabled: true,
+            http_enabled: true,
+            auto_migrate_enabled: true,
+            acl_check_contract_address: Some(ContractAddress::Registry),
+            service_contract_address: None,
+            service_contract_srv_gen_address: None,
+            service_contract_srv_retr_address: None,
+            service_contract_doc_store_address: None,
+            service_contract_doc_sretr_address: None,
+            self_secret: None,
+            admin_public: None,
+            nodes: BTreeMap::new(),
+            key_server_set_contract_address: Some(ContractAddress::Registry),
+            interface: "127.0.0.1".to_owned(),
+            port: 8083,
+            http_interface: "127.0.0.1".to_owned(),
+            http_port: 8082,
+            data_path: replace_home(&data_dir, "$BASE/secretstore"),
+        }
+    }
+}
+
+/// Start secret store-related functionality
+pub fn start(
+    conf: Configuration,
+    deps: Dependencies,
+    executor: Executor,
+) -> Result<Option<KeyServer>, String> {
+    if !conf.enabled {
+        return Ok(None);
+    }
+
+    KeyServer::new(conf, deps, executor).map(|s| Some(s))
+}

bin/oe/signer.rs

@@ -0,0 +1,98 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::{
+    io,
+    path::{Path, PathBuf},
+};
+
+use crate::{path::restrict_permissions_owner, rpc, rpc_apis};
+use ansi_term::Colour::White;
+use ethcore_logger::Config as LogConfig;
+use parity_rpc;
+
+pub const CODES_FILENAME: &'static str = "authcodes";
+
+pub struct NewToken {
+    pub token: String,
+    pub message: String,
+}
+
+pub fn new_service(
+    ws_conf: &rpc::WsConfiguration,
+    logger_config: &LogConfig,
+) -> rpc_apis::SignerService {
+    let logger_config_color = logger_config.color;
+    let signer_path = ws_conf.signer_path.clone();
+    let signer_enabled = ws_conf.support_token_api;
+
+    rpc_apis::SignerService::new(
+        move || {
+            generate_new_token(&signer_path, logger_config_color).map_err(|e| format!("{:?}", e))
+        },
+        signer_enabled,
+    )
+}
+
+pub fn codes_path(path: &Path) -> PathBuf {
+    let mut p = path.to_owned();
+    p.push(CODES_FILENAME);
+    let _ = restrict_permissions_owner(&p, true, false);
+    p
+}
+
+pub fn execute(ws_conf: rpc::WsConfiguration, logger_config: LogConfig) -> Result<String, String> {
+    Ok(generate_token_and_url(&ws_conf, &logger_config)?.message)
+}
+
+pub fn generate_token_and_url(
+    ws_conf: &rpc::WsConfiguration,
+    logger_config: &LogConfig,
+) -> Result<NewToken, String> {
+    let code = generate_new_token(&ws_conf.signer_path, logger_config.color)
+        .map_err(|err| format!("Error generating token: {:?}", err))?;
+    let colored = |s: String| match logger_config.color {
+        true => format!("{}", White.bold().paint(s)),
+        false => s,
+    };
+
+    Ok(NewToken {
+        token: code.clone(),
+        message: format!(
+            r#"
+Generated token:
+{}
+"#,
+            colored(code)
+        ),
+    })
+}
+
+fn generate_new_token(path: &Path, logger_config_color: bool) -> io::Result<String> {
+    let path = codes_path(path);
+    let mut codes = parity_rpc::AuthCodes::from_file(&path)?;
+    codes.clear_garbage();
+    let code = codes.generate_new()?;
+    codes.to_file(&path)?;
+    trace!(
+        "New key code created: {}",
+        match logger_config_color {
+            true => format!("{}", White.bold().paint(&code[..])),
+            false => format!("{}", &code[..]),
+        }
+    );
+    Ok(code)
+}

bin/oe/snapshot.rs

@@ -0,0 +1,347 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Snapshot and restoration commands.
+
+use std::{
+    path::{Path, PathBuf},
+    sync::Arc,
+    time::Duration,
+};
+
+use crate::{hash::keccak, types::ids::BlockId};
+use ethcore::{
+    client::{DatabaseCompactionProfile, Mode, VMType},
+    miner::Miner,
+    snapshot::{
+        io::{PackedReader, PackedWriter, SnapshotReader},
+        service::Service as SnapshotService,
+        Progress, RestorationStatus, SnapshotConfiguration, SnapshotService as SS,
+    },
+};
+use ethcore_service::ClientService;
+
+use crate::{
+    cache::CacheConfig,
+    db,
+    helpers::{execute_upgrades, to_client_config},
+    params::{fatdb_switch_to_bool, tracing_switch_to_bool, Pruning, SpecType, Switch},
+    user_defaults::UserDefaults,
+};
+use dir::Directories;
+
+/// Kinds of snapshot commands.
+#[derive(Debug, PartialEq, Clone, Copy)]
+pub enum Kind {
+    /// Take a snapshot.
+    Take,
+    /// Restore a snapshot.
+    Restore,
+}
+
+/// Command for snapshot creation or restoration.
+#[derive(Debug, PartialEq)]
+pub struct SnapshotCommand {
+    pub cache_config: CacheConfig,
+    pub dirs: Directories,
+    pub spec: SpecType,
+    pub pruning: Pruning,
+    pub pruning_history: u64,
+    pub pruning_memory: usize,
+    pub tracing: Switch,
+    pub fat_db: Switch,
+    pub compaction: DatabaseCompactionProfile,
+    pub file_path: Option<String>,
+    pub kind: Kind,
+    pub block_at: BlockId,
+    pub max_round_blocks_to_import: usize,
+    pub snapshot_conf: SnapshotConfiguration,
+}
+
+// helper for reading chunks from arbitrary reader and feeding them into the
+// service.
+fn restore_using<R: SnapshotReader>(
+    snapshot: Arc<SnapshotService>,
+    reader: &R,
+    recover: bool,
+) -> Result<(), String> {
+    let manifest = reader.manifest();
+
+    info!(
+        "Restoring to block #{} (0x{:?})",
+        manifest.block_number, manifest.block_hash
+    );
+
+    snapshot
+        .init_restore(manifest.clone(), recover)
+        .map_err(|e| format!("Failed to begin restoration: {}", e))?;
+
+    let (num_state, num_blocks) = (manifest.state_hashes.len(), manifest.block_hashes.len());
+
+    let informant_handle = snapshot.clone();
+    ::std::thread::spawn(move || {
+        while let RestorationStatus::Ongoing {
+            state_chunks_done,
+            block_chunks_done,
+            ..
+        } = informant_handle.restoration_status()
+        {
+            info!(
+                "Processed {}/{} state chunks and {}/{} block chunks.",
+                state_chunks_done, num_state, block_chunks_done, num_blocks
+            );
+            ::std::thread::sleep(Duration::from_secs(5));
+        }
+    });
+
+    info!("Restoring state");
+    for &state_hash in &manifest.state_hashes {
+        if snapshot.restoration_status() == RestorationStatus::Failed {
+            return Err("Restoration failed".into());
+        }
+
+        let chunk = reader.chunk(state_hash).map_err(|e| {
+            format!(
+                "Encountered error while reading chunk {:?}: {}",
+                state_hash, e
+            )
+        })?;
+
+        let hash = keccak(&chunk);
+        if hash != state_hash {
+            return Err(format!(
+                "Mismatched chunk hash. Expected {:?}, got {:?}",
+                state_hash, hash
+            ));
+        }
+
+        snapshot.feed_state_chunk(state_hash, &chunk);
+    }
+
+    info!("Restoring blocks");
+    for &block_hash in &manifest.block_hashes {
+        if snapshot.restoration_status() == RestorationStatus::Failed {
+            return Err("Restoration failed".into());
+        }
+
+        let chunk = reader.chunk(block_hash).map_err(|e| {
+            format!(
+                "Encountered error while reading chunk {:?}: {}",
+                block_hash, e
+            )
+        })?;
+
+        let hash = keccak(&chunk);
+        if hash != block_hash {
+            return Err(format!(
+                "Mismatched chunk hash. Expected {:?}, got {:?}",
+                block_hash, hash
+            ));
+        }
+        snapshot.feed_block_chunk(block_hash, &chunk);
+    }
+
+    match snapshot.restoration_status() {
+        RestorationStatus::Ongoing { .. } => {
+            Err("Snapshot file is incomplete and missing chunks.".into())
+        }
+        RestorationStatus::Initializing { .. } => {
+            Err("Snapshot restoration is still initializing.".into())
+        }
+        RestorationStatus::Failed => Err("Snapshot restoration failed.".into()),
+        RestorationStatus::Inactive => {
+            info!("Restoration complete.");
+            Ok(())
+        }
+    }
+}
+
+impl SnapshotCommand {
+    // shared portion of snapshot commands: start the client service
+    fn start_service(self) -> Result<ClientService, String> {
+        // load spec file
+        let spec = self.spec.spec(&self.dirs.cache)?;
+
+        // load genesis hash
+        let genesis_hash = spec.genesis_header().hash();
+
+        // database paths
+        let db_dirs = self
+            .dirs
+            .database(genesis_hash, None, spec.data_dir.clone());
+
+        // user defaults path
+        let user_defaults_path = db_dirs.user_defaults_path();
+
+        // load user defaults
+        let user_defaults = UserDefaults::load(&user_defaults_path)?;
+
+        // select pruning algorithm
+        let algorithm = self.pruning.to_algorithm(&user_defaults);
+
+        // check if tracing is on
+        let tracing = tracing_switch_to_bool(self.tracing, &user_defaults)?;
+
+        // check if fatdb is on
+        let fat_db = fatdb_switch_to_bool(self.fat_db, &user_defaults, algorithm)?;
+
+        // prepare client and snapshot paths.
+        let client_path = db_dirs.client_path(algorithm);
+        let snapshot_path = db_dirs.snapshot_path();
+
+        // execute upgrades
+        execute_upgrades(&self.dirs.base, &db_dirs, algorithm, &self.compaction)?;
+
+        // prepare client config
+        let mut client_config = to_client_config(
+            &self.cache_config,
+            spec.name.to_lowercase(),
+            Mode::Active,
+            tracing,
+            fat_db,
+            self.compaction,
+            VMType::default(),
+            "".into(),
+            algorithm,
+            self.pruning_history,
+            self.pruning_memory,
+            true,
+            self.max_round_blocks_to_import,
+        );
+
+        client_config.snapshot = self.snapshot_conf;
+
+        let restoration_db_handler = db::restoration_db_handler(&client_path, &client_config);
+        let client_db = restoration_db_handler
+            .open(&client_path)
+            .map_err(|e| format!("Failed to open database {:?}", e))?;
+
+        let service = ClientService::start(
+            client_config,
+            &spec,
+            client_db,
+            &snapshot_path,
+            restoration_db_handler,
+            &self.dirs.ipc_path(),
+            // TODO [ToDr] don't use test miner here
+            // (actually don't require miner at all)
+            Arc::new(Miner::new_for_tests(&spec, None)),
+        )
+        .map_err(|e| format!("Client service error: {:?}", e))?;
+
+        Ok(service)
+    }
+    /// restore from a snapshot
+    pub fn restore(self) -> Result<(), String> {
+        let file = self.file_path.clone();
+        let service = self.start_service()?;
+
+        warn!("Snapshot restoration is experimental and the format may be subject to change.");
+        warn!(
+            "On encountering an unexpected error, please ensure that you have a recent snapshot."
+        );
+
+        let snapshot = service.snapshot_service();
+
+        if let Some(file) = file {
+            info!("Attempting to restore from snapshot at '{}'", file);
+
+            let reader = PackedReader::new(Path::new(&file))
+                .map_err(|e| format!("Couldn't open snapshot file: {}", e))
+                .and_then(|x| x.ok_or("Snapshot file has invalid format.".into()));
+
+            let reader = reader?;
+            restore_using(snapshot, &reader, true)?;
+        } else {
+            info!("Attempting to restore from local snapshot.");
+
+            // attempting restoration with recovery will lead to deadlock
+            // as we currently hold a read lock on the service's reader.
+            match *snapshot.reader() {
+                Some(ref reader) => restore_using(snapshot.clone(), reader, false)?,
+                None => return Err("No local snapshot found.".into()),
+            }
+        }
+
+        Ok(())
+    }
+
+    /// Take a snapshot from the head of the chain.
+    pub fn take_snapshot(self) -> Result<(), String> {
+        let file_path = self
+            .file_path
+            .clone()
+            .ok_or("No file path provided.".to_owned())?;
+        let file_path: PathBuf = file_path.into();
+        let block_at = self.block_at;
+        let service = self.start_service()?;
+
+        warn!("Snapshots are currently experimental. File formats may be subject to change.");
+
+        let writer = PackedWriter::new(&file_path)
+            .map_err(|e| format!("Failed to open snapshot writer: {}", e))?;
+
+        let progress = Arc::new(Progress::default());
+        let p = progress.clone();
+        let informant_handle = ::std::thread::spawn(move || {
+            ::std::thread::sleep(Duration::from_secs(5));
+
+            let mut last_size = 0;
+            while !p.done() {
+                let cur_size = p.size();
+                if cur_size != last_size {
+                    last_size = cur_size;
+                    let bytes = crate::informant::format_bytes(cur_size as usize);
+                    info!(
+                        "Snapshot: {} accounts {} blocks {}",
+                        p.accounts(),
+                        p.blocks(),
+                        bytes
+                    );
+                }
+
+                ::std::thread::sleep(Duration::from_secs(5));
+            }
+        });
+
+        if let Err(e) = service.client().take_snapshot(writer, block_at, &*progress) {
+            let _ = ::std::fs::remove_file(&file_path);
+            return Err(format!(
+                "Encountered fatal error while creating snapshot: {}",
+                e
+            ));
+        }
+
+        info!("snapshot creation complete");
+
+        assert!(progress.done());
+        informant_handle
+            .join()
+            .map_err(|_| "failed to join logger thread")?;
+
+        Ok(())
+    }
+}
+
+/// Execute this snapshot command.
+pub fn execute(cmd: SnapshotCommand) -> Result<String, String> {
+    match cmd.kind {
+        Kind::Take => cmd.take_snapshot()?,
+        Kind::Restore => cmd.restore()?,
+    }
+
+    Ok(String::new())
+}

bin/oe/stratum.rs

@@ -0,0 +1,119 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! OpenEthereum sync service
+
+use std::sync::Arc;
+use std::sync::atomic::{AtomicBool, Ordering};
+use ethcore_stratum::{Stratum as StratumServer, PushWorkHandler, RemoteJobDispatcher, ServiceConfiguration};
+use modules::service_urls;
+use boot;
+use hypervisor::service::IpcModuleId;
+use hypervisor::{HYPERVISOR_IPC_URL, ControlService};
+use std::net::{SocketAddr, IpAddr};
+use std::str::FromStr;
+use nanoipc;
+use std::thread;
+use ethcore::miner::stratum::{STRATUM_SOCKET_NAME, JOB_DISPATCHER_SOCKET_NAME};
+
+pub const MODULE_ID: IpcModuleId = 8000;
+
+#[derive(Default)]
+struct StratumControlService {
+	pub stop: Arc<AtomicBool>,
+}
+
+impl ControlService for StratumControlService {
+	fn shutdown(&self) -> bool {
+		trace!(target: "hypervisor", "Received shutdown from control service");
+		self.stop.store(true, ::std::sync::atomic::Ordering::SeqCst);
+		true
+	}
+}
+
+pub fn main() {
+	boot::setup_cli_logger("stratum");
+
+	let service_config: ServiceConfiguration = boot::payload()
+		.unwrap_or_else(|e| {
+			println!("Fatal: error reading boot arguments ({:?})", e);
+			std::process::exit(1)
+		});
+
+	let job_dispatcher = dependency!(
+		RemoteJobDispatcher,
+		&service_urls::with_base(&service_config.io_path, JOB_DISPATCHER_SOCKET_NAME)
+	);
+
+	let _ = boot::main_thread();
+	let service_stop = Arc::new(AtomicBool::new(false));
+
+	let server =
+		StratumServer::start(
+			&SocketAddr::new(
+				IpAddr::from_str(&service_config.listen_addr)
+					.unwrap_or_else(|e| {
+						println!("Fatal: invalid listen address: '{}' ({:?})", &service_config.listen_addr, e);
+						std::process::exit(1)
+					}),
+				service_config.port,
+			),
+			job_dispatcher.service().clone(),
+			service_config.secret
+		).unwrap_or_else(
+			|e| {
+				println!("Fatal: cannot start stratum server({:?})", e);
+				std::process::exit(1)
+			}
+		);
+
+	boot::host_service(
+		&service_urls::with_base(&service_config.io_path, STRATUM_SOCKET_NAME),
+		service_stop.clone(),
+		server.clone() as Arc<PushWorkHandler>
+	);
+
+	let hypervisor = boot::register(
+		&service_urls::with_base(&service_config.io_path, HYPERVISOR_IPC_URL),
+		&service_urls::with_base(&service_config.io_path, service_urls::STRATUM_CONTROL),
+		MODULE_ID
+	);
+
+	let timer_svc = server.clone();
+	let timer_stop = service_stop.clone();
+	thread::spawn(move || {
+		while !timer_stop.load(Ordering::SeqCst) {
+			thread::park_timeout(::std::time::Duration::from_millis(2000));
+			// It almost always not doing anything, only greets new peers with a job
+			timer_svc.maintain();
+		}
+	});
+
+	let control_service = Arc::new(StratumControlService::default());
+	let as_control = control_service.clone() as Arc<ControlService>;
+	let mut worker = nanoipc::Worker::<ControlService>::new(&as_control);
+	worker.add_reqrep(
+		&service_urls::with_base(&service_config.io_path, service_urls::STRATUM_CONTROL)
+	).unwrap();
+
+	while !control_service.stop.load(Ordering::SeqCst) {
+		worker.poll();
+	}
+	service_stop.store(true, Ordering::SeqCst);
+
+	hypervisor.module_shutdown(MODULE_ID);
+	trace!(target: "hypervisor", "Stratum process terminated gracefully");
+}

bin/oe/upgrade.rs

@@ -0,0 +1,246 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Parity upgrade logic
+
+use dir::{default_data_path, helpers::replace_home, home_dir, DatabaseDirectories};
+use journaldb::Algorithm;
+use semver::{SemVerError, Version};
+use std::{
+    collections::*,
+    fs::{self, create_dir_all, File},
+    io,
+    io::{Read, Write},
+    path::{Path, PathBuf},
+};
+
+#[derive(Debug)]
+pub enum Error {
+    CannotCreateConfigPath(io::Error),
+    CannotWriteVersionFile(io::Error),
+    CannotUpdateVersionFile(io::Error),
+    SemVer(SemVerError),
+}
+
+impl From<SemVerError> for Error {
+    fn from(err: SemVerError) -> Self {
+        Error::SemVer(err)
+    }
+}
+
+const CURRENT_VERSION: &'static str = env!("CARGO_PKG_VERSION");
+
+#[derive(Hash, PartialEq, Eq)]
+struct UpgradeKey {
+    pub old_version: Version,
+    pub new_version: Version,
+}
+
+type UpgradeList = HashMap<UpgradeKey, fn() -> Result<(), Error>>;
+
+impl UpgradeKey {
+    // given the following config exist
+    // ver.lock 1.1 (`previous_version`)
+    //
+    //  current_version 1.4 (`current_version`)
+    //
+    //
+    //upgrades (set of `UpgradeKey`)
+    //	1.0 -> 1.1 (u1)
+    //	1.1 -> 1.2 (u2)
+    //	1.2 -> 1.3 (u3)
+    //	1.3 -> 1.4 (u4)
+    //	1.4 -> 1.5 (u5)
+    //
+    // then the following upgrades should be applied:
+    // u2, u3, u4
+    fn is_applicable(&self, previous_version: &Version, current_version: &Version) -> bool {
+        self.old_version >= *previous_version && self.new_version <= *current_version
+    }
+}
+
+// dummy upgrade (remove when the first one is in)
+fn dummy_upgrade() -> Result<(), Error> {
+    Ok(())
+}
+
+fn push_upgrades(upgrades: &mut UpgradeList) {
+    // dummy upgrade (remove when the first one is in)
+    upgrades.insert(
+        UpgradeKey {
+            old_version: Version::new(0, 9, 0),
+            new_version: Version::new(1, 0, 0),
+        },
+        dummy_upgrade,
+    );
+}
+
+fn upgrade_from_version(previous_version: &Version) -> Result<usize, Error> {
+    let mut upgrades = HashMap::new();
+    push_upgrades(&mut upgrades);
+
+    let current_version = Version::parse(CURRENT_VERSION)?;
+
+    let mut count = 0;
+    for upgrade_key in upgrades.keys() {
+        if upgrade_key.is_applicable(previous_version, &current_version) {
+            let upgrade_script = upgrades[upgrade_key];
+            upgrade_script()?;
+            count += 1;
+        }
+    }
+    Ok(count)
+}
+
+fn with_locked_version<F>(db_path: &str, script: F) -> Result<usize, Error>
+where
+    F: Fn(&Version) -> Result<usize, Error>,
+{
+    let mut path = PathBuf::from(db_path);
+    create_dir_all(&path).map_err(Error::CannotCreateConfigPath)?;
+    path.push("ver.lock");
+
+    let version = File::open(&path)
+        .ok()
+        .and_then(|ref mut file| {
+            let mut version_string = String::new();
+            file.read_to_string(&mut version_string)
+                .ok()
+                .and_then(|_| Version::parse(&version_string).ok())
+        })
+        .unwrap_or(Version::new(0, 9, 0));
+
+    let mut lock = File::create(&path).map_err(Error::CannotWriteVersionFile)?;
+    let result = script(&version);
+
+    let written_version = Version::parse(CURRENT_VERSION)?;
+    lock.write_all(written_version.to_string().as_bytes())
+        .map_err(Error::CannotUpdateVersionFile)?;
+    result
+}
+
+pub fn upgrade(db_path: &str) -> Result<usize, Error> {
+    with_locked_version(db_path, |ver| upgrade_from_version(ver))
+}
+
+fn file_exists(path: &Path) -> bool {
+    match fs::metadata(&path) {
+        Err(ref e) if e.kind() == io::ErrorKind::NotFound => false,
+        _ => true,
+    }
+}
+
+#[cfg(any(test, feature = "accounts"))]
+pub fn upgrade_key_location(from: &PathBuf, to: &PathBuf) {
+    match fs::create_dir_all(&to).and_then(|()| fs::read_dir(from)) {
+        Ok(entries) => {
+            let files: Vec<_> = entries
+                .filter_map(|f| {
+                    f.ok().and_then(|f| {
+                        if f.file_type().ok().map_or(false, |f| f.is_file()) {
+                            f.file_name().to_str().map(|s| s.to_owned())
+                        } else {
+                            None
+                        }
+                    })
+                })
+                .collect();
+            let mut num: usize = 0;
+            for name in files {
+                let mut from = from.clone();
+                from.push(&name);
+                let mut to = to.clone();
+                to.push(&name);
+                if !file_exists(&to) {
+                    if let Err(e) = fs::rename(&from, &to) {
+                        debug!("Error upgrading key {:?}: {:?}", from, e);
+                    } else {
+                        num += 1;
+                    }
+                } else {
+                    debug!("Skipped upgrading key {:?}", from);
+                }
+            }
+            if num > 0 {
+                info!(
+                    "Moved {} keys from {} to {}",
+                    num,
+                    from.to_string_lossy(),
+                    to.to_string_lossy()
+                );
+            }
+        }
+        Err(e) => {
+            debug!("Error moving keys from {:?} to {:?}: {:?}", from, to, e);
+        }
+    }
+}
+
+fn upgrade_dir_location(source: &PathBuf, dest: &PathBuf) {
+    if file_exists(&source) {
+        if !file_exists(&dest) {
+            let mut parent = dest.clone();
+            parent.pop();
+            if let Err(e) = fs::create_dir_all(&parent).and_then(|()| fs::rename(&source, &dest)) {
+                debug!("Skipped path {:?} -> {:?} :{:?}", source, dest, e);
+            } else {
+                info!(
+                    "Moved {} to {}",
+                    source.to_string_lossy(),
+                    dest.to_string_lossy()
+                );
+            }
+        } else {
+            debug!(
+                "Skipped upgrading directory {:?}, Destination already exists at {:?}",
+                source, dest
+            );
+        }
+    }
+}
+
+fn upgrade_user_defaults(dirs: &DatabaseDirectories) {
+    let source = dirs.legacy_user_defaults_path();
+    let dest = dirs.user_defaults_path();
+    if file_exists(&source) {
+        if !file_exists(&dest) {
+            if let Err(e) = fs::rename(&source, &dest) {
+                debug!("Skipped upgrading user defaults {:?}:{:?}", dest, e);
+            }
+        } else {
+            debug!(
+                "Skipped upgrading user defaults {:?}, File exists at {:?}",
+                source, dest
+            );
+        }
+    }
+}
+
+pub fn upgrade_data_paths(base_path: &str, dirs: &DatabaseDirectories, pruning: Algorithm) {
+    if home_dir().is_none() {
+        return;
+    }
+
+    let legacy_root_path = replace_home("", "$HOME/.parity");
+    let default_path = default_data_path();
+    if legacy_root_path != base_path && base_path == default_path {
+        upgrade_dir_location(&PathBuf::from(legacy_root_path), &PathBuf::from(&base_path));
+    }
+    upgrade_dir_location(&dirs.legacy_version_path(pruning), &dirs.db_path(pruning));
+    upgrade_dir_location(&dirs.legacy_snapshot_path(), &dirs.snapshot_path());
+    upgrade_dir_location(&dirs.legacy_network_path(), &dirs.network_path());
+    upgrade_user_defaults(&dirs);
+}

bin/oe/user_defaults.rs

@@ -0,0 +1,188 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use ethcore::client::Mode as ClientMode;
+use journaldb::Algorithm;
+use serde::{Deserialize, Deserializer, Serialize, Serializer};
+use serde_json::{de::from_reader, ser::to_string};
+use std::{fs::File, io::Write, path::Path, time::Duration};
+
+#[derive(Clone)]
+pub struct Seconds(Duration);
+
+impl Seconds {
+    pub fn value(&self) -> u64 {
+        self.0.as_secs()
+    }
+}
+
+impl From<u64> for Seconds {
+    fn from(s: u64) -> Seconds {
+        Seconds(Duration::from_secs(s))
+    }
+}
+
+impl From<Duration> for Seconds {
+    fn from(d: Duration) -> Seconds {
+        Seconds(d)
+    }
+}
+
+impl Into<Duration> for Seconds {
+    fn into(self) -> Duration {
+        self.0
+    }
+}
+
+impl Serialize for Seconds {
+    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+        serializer.serialize_u64(self.value())
+    }
+}
+
+impl<'de> Deserialize<'de> for Seconds {
+    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
+        let secs = u64::deserialize(deserializer)?;
+        Ok(Seconds::from(secs))
+    }
+}
+
+#[derive(Clone, Serialize, Deserialize)]
+#[serde(rename_all = "lowercase", tag = "mode")]
+pub enum Mode {
+    Active,
+    Passive {
+        #[serde(rename = "mode.timeout")]
+        timeout: Seconds,
+        #[serde(rename = "mode.alarm")]
+        alarm: Seconds,
+    },
+    Dark {
+        #[serde(rename = "mode.timeout")]
+        timeout: Seconds,
+    },
+    Offline,
+}
+
+impl Into<ClientMode> for Mode {
+    fn into(self) -> ClientMode {
+        match self {
+            Mode::Active => ClientMode::Active,
+            Mode::Passive { timeout, alarm } => ClientMode::Passive(timeout.into(), alarm.into()),
+            Mode::Dark { timeout } => ClientMode::Dark(timeout.into()),
+            Mode::Offline => ClientMode::Off,
+        }
+    }
+}
+
+impl From<ClientMode> for Mode {
+    fn from(mode: ClientMode) -> Mode {
+        match mode {
+            ClientMode::Active => Mode::Active,
+            ClientMode::Passive(timeout, alarm) => Mode::Passive {
+                timeout: timeout.into(),
+                alarm: alarm.into(),
+            },
+            ClientMode::Dark(timeout) => Mode::Dark {
+                timeout: timeout.into(),
+            },
+            ClientMode::Off => Mode::Offline,
+        }
+    }
+}
+
+#[derive(Serialize, Deserialize)]
+pub struct UserDefaults {
+    pub is_first_launch: bool,
+    #[serde(with = "algorithm_serde")]
+    pub pruning: Algorithm,
+    pub tracing: bool,
+    pub fat_db: bool,
+    #[serde(flatten)]
+    mode: Mode,
+}
+
+impl UserDefaults {
+    pub fn mode(&self) -> ClientMode {
+        self.mode.clone().into()
+    }
+
+    pub fn set_mode(&mut self, mode: ClientMode) {
+        self.mode = mode.into();
+    }
+}
+
+mod algorithm_serde {
+    use journaldb::Algorithm;
+    use serde::{de::Error, Deserialize, Deserializer, Serialize, Serializer};
+
+    pub fn serialize<S>(algorithm: &Algorithm, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        algorithm.as_str().serialize(serializer)
+    }
+
+    pub fn deserialize<'de, D>(deserializer: D) -> Result<Algorithm, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let pruning = String::deserialize(deserializer)?;
+        pruning
+            .parse()
+            .map_err(|_| Error::custom("invalid pruning method"))
+    }
+}
+
+impl Default for UserDefaults {
+    fn default() -> Self {
+        UserDefaults {
+            is_first_launch: true,
+            pruning: Algorithm::OverlayRecent,
+            tracing: false,
+            fat_db: false,
+            mode: Mode::Active,
+        }
+    }
+}
+
+impl UserDefaults {
+    pub fn load<P>(path: P) -> Result<Self, String>
+    where
+        P: AsRef<Path>,
+    {
+        match File::open(path) {
+            Ok(file) => match from_reader(file) {
+                Ok(defaults) => Ok(defaults),
+                Err(e) => {
+                    warn!("Error loading user defaults file: {:?}", e);
+                    Ok(UserDefaults::default())
+                }
+            },
+            _ => Ok(UserDefaults::default()),
+        }
+    }
+
+    pub fn save<P>(&self, path: P) -> Result<(), String>
+    where
+        P: AsRef<Path>,
+    {
+        let mut file: File =
+            File::create(path).map_err(|_| "Cannot create user defaults file".to_owned())?;
+        file.write_all(to_string(&self).unwrap().as_bytes())
+            .map_err(|_| "Failed to save user defaults".to_owned())
+    }
+}

build.rs

@@ -1,25 +0,0 @@
-// Copyright 2015, 2016 Parity Technologies (UK) Ltd.
-// This file is part of Parity.
-
-// Parity is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-
-// Parity is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-
-// You should have received a copy of the GNU General Public License
-// along with Parity.  If not, see <http://www.gnu.org/licenses/>.
-
-extern crate rustc_version;
-
-use rustc_version::{version_meta, Channel};
-
-fn main() {
-	if let Channel::Nightly = version_meta().channel {
-		println!("cargo:rustc-cfg=nightly");
-	}
-}

crates/accounts/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+description = "OpenEthereum Account Management"
+homepage = "https://github.com/openethereum/openethereum"
+license = "GPL-3.0"
+name = "ethcore-accounts"
+version = "0.1.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+edition = "2018"
+
+[dependencies]
+common-types = { path = "../ethcore/types" }
+ethkey = { path = "ethkey" }
+ethstore = { path = "ethstore" }
+log = "0.4"
+parity-crypto = { version = "0.6.2", features = [ "publickey" ] }
+parking_lot = "0.11.1"
+serde = "1.0"
+serde_derive = "1.0"
+serde_json = "1.0"
+
+[dev-dependencies]
+ethereum-types = "0.9.2"
+tempdir = "0.3"

crates/accounts/ethkey/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+description = "Parity Ethereum Keys Generator"
+name = "ethkey"
+version = "0.3.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+
+[dependencies]
+edit-distance = "2.0"
+parity-crypto = { version = "0.6.2", features = ["publickey"] }
+eth-secp256k1 = { git = "https://github.com/paritytech/rust-secp256k1", rev = "9791e79f21a5309dcb6e0bd254b1ef88fca2f1f4" }
+ethereum-types = "0.9.2"
+lazy_static = "1.0"
+log = "0.4"
+memzero = { path = "../../../crates/util/memzero" }
+parity-wordlist = "1.3"
+quick-error = "1.2.2"
+rand = "0.7.3"
+rustc-hex = "1.0"
+serde = "1.0"
+serde_derive = "1.0"
+tiny-keccak = "1.4"

crates/accounts/ethkey/README.md

@@ -0,0 +1,220 @@
+## ethkey-cli
+
+Parity Ethereum keys generator.
+
+### Usage
+
+```
+Parity Ethereum Keys Generator.
+  Copyright 2015-2019 Parity Technologies (UK) Ltd.
+
+Usage:
+    ethkey info <secret-or-phrase> [options]
+    ethkey generate random [options]
+    ethkey generate prefix <prefix> [options]
+    ethkey sign <secret> <message>
+    ethkey verify public <public> <signature> <message>
+    ethkey verify address <address> <signature> <message>
+    ethkey recover <address> <known-phrase>
+    ethkey [-h | --help]
+
+Options:
+    -h, --help         Display this message and exit.
+    -s, --secret       Display only the secret key.
+    -p, --public       Display only the public key.
+    -a, --address      Display only the address.
+    -b, --brain        Use parity brain wallet algorithm. Not recommended.
+
+Commands:
+    info               Display public key and address of the secret.
+    generate random    Generates new random Ethereum key.
+    generate prefix    Random generation, but address must start with a prefix ("vanity address").
+    sign               Sign message using a secret key.
+    verify             Verify signer of the signature by public key or address.
+    recover            Try to find brain phrase matching given address from partial phrase.
+```
+
+### Examples
+
+#### `info <secret>`
+*Display info about private key.*
+
+- `<secret>` - ethereum secret, 32 bytes long
+
+```
+ethkey info 17d08f5fe8c77af811caa0c9a187e668ce3b74a99acc3f6d976f075fa8e0be55
+```
+
+```
+secret:  17d08f5fe8c77af811caa0c9a187e668ce3b74a99acc3f6d976f075fa8e0be55
+public:  689268c0ff57a20cd299fa60d3fb374862aff565b20b5f1767906a99e6e09f3ff04ca2b2a5cd22f62941db103c0356df1a8ed20ce322cab2483db67685afd124
+address: 26d1ec50b4e62c1d1a40d16e7cacc6a6580757d5
+```
+
+--
+
+
+#### `info --brain <phrase>`
+*Display info about private key generate from brain wallet recovery phrase.*
+
+- `<phrase>` - Parity recovery phrase, 12 words
+
+```
+ethkey info --brain "this is sparta"
+```
+
+```
+The recover phrase was not generated by Parity: The word 'this' does not come from the dictionary.
+
+secret:  aa22b54c0cb43ee30a014afe5ef3664b1cde299feabca46cd3167a85a57c39f2
+public:  c4c5398da6843632c123f543d714d2d2277716c11ff612b2a2f23c6bda4d6f0327c31cd58c55a9572c3cc141dade0c32747a13b7ef34c241b26c84adbb28fcf4
+address: 006e27b6a72e1f34c626762f3c4761547aff1421
+```
+
+--
+
+#### `generate random`
+*Generate new keypair randomly.*
+
+```
+ethkey generate random
+```
+
+```
+secret:  7d29fab185a33e2cd955812397354c472d2b84615b645aa135ff539f6b0d70d5
+public:  35f222d88b80151857a2877826d940104887376a94c1cbd2c8c7c192eb701df88a18a4ecb8b05b1466c5b3706042027b5e079fe3a3683e66d822b0e047aa3418
+address: a8fa5dd30a87bb9e3288d604eb74949c515ab66e
+```
+
+--
+
+#### `generate random --brain`
+*Generate new keypair with recovery phrase randomly.*
+
+```
+ethkey generate random --brain
+```
+
+```
+recovery phrase: thwarting scandal creamer nuzzle asparagus blast crouch trusting anytime elixir frenzied octagon
+secret:  001ce488d50d2f7579dc190c4655f32918d505cee3de63bddc7101bc91c0c2f0
+public:  4e19a5fdae82596e1485c69b687c9cc52b5078e5b0668ef3ce8543cd90e712cb00df822489bc1f1dcb3623538a54476c7b3def44e1a51dc174e86448b63f42d0
+address: 00cf3711cbd3a1512570639280758118ba0b2bcb
+```
+
+
+--
+
+#### `generate prefix <prefix>`
+*Generate new keypair randomly with address starting with prefix.*
+
+- `<prefix>` - desired address prefix, 0 - 32 bytes long.
+
+```
+ethkey generate prefix ff
+```
+
+```
+secret:  2075b1d9c124ea673de7273758ed6de14802a9da8a73ceb74533d7c312ff6acd
+public:  48dbce4508566a05509980a5dd1335599fcdac6f9858ba67018cecb9f09b8c4066dc4c18ae2722112fd4d9ac36d626793fffffb26071dfeb0c2300df994bd173
+address: fff7e25dff2aa60f61f9d98130c8646a01f31649
+```
+
+--
+
+#### `generate prefix --brain <prefix>`
+*Generate new keypair with recovery phrase randomly with address starting with prefix.*
+
+- `<prefix>` - desired address prefix, 0 - 32 bytes long.
+
+```
+ethkey generate prefix --brain 00cf
+```
+
+```
+recovery phrase: thwarting scandal creamer nuzzle asparagus blast crouch trusting anytime elixir frenzied octagon
+secret:  001ce488d50d2f7579dc190c4655f32918d505cee3de63bddc7101bc91c0c2f0
+public:  4e19a5fdae82596e1485c69b687c9cc52b5078e5b0668ef3ce8543cd90e712cb00df822489bc1f1dcb3623538a54476c7b3def44e1a51dc174e86448b63f42d0
+address: 00cf3711cbd3a1512570639280758118ba0b2bcb
+```
+
+--
+
+#### `sign <secret> <message>`
+*Sign a message with a secret.*
+
+- `<secret>` - ethereum secret, 32 bytes long
+- `<message>` - message to sign, 32 bytes long
+
+```
+ethkey sign 17d08f5fe8c77af811caa0c9a187e668ce3b74a99acc3f6d976f075fa8e0be55 bd50b7370c3f96733b31744c6c45079e7ae6c8d299613246d28ebcef507ec987
+```
+
+```
+c1878cf60417151c766a712653d26ef350c8c75393458b7a9be715f053215af63dfd3b02c2ae65a8677917a8efa3172acb71cb90196e42106953ea0363c5aaf200
+```
+
+--
+
+#### `verify public <public> <signature> <message>`
+*Verify the signature.*
+
+- `<public>` - ethereum public, 64 bytes long
+- `<signature>` - message signature, 65 bytes long
+- `<message>` - message, 32 bytes long
+
+```
+ethkey verify public 689268c0ff57a20cd299fa60d3fb374862aff565b20b5f1767906a99e6e09f3ff04ca2b2a5cd22f62941db103c0356df1a8ed20ce322cab2483db67685afd124 c1878cf60417151c766a712653d26ef350c8c75393458b7a9be715f053215af63dfd3b02c2ae65a8677917a8efa3172acb71cb90196e42106953ea0363c5aaf200 bd50b7370c3f96733b31744c6c45079e7ae6c8d299613246d28ebcef507ec987
+```
+
+```
+true
+```
+
+--
+
+#### `verify address <address> <signature> <message>`
+*Verify the signature.*
+
+- `<address>` - ethereum address, 20 bytes long
+- `<signature>` - message signature, 65 bytes long
+- `<message>` - message, 32 bytes long
+
+```
+ethkey verify address 689268c0ff57a20cd299fa60d3fb374862aff565b20b5f1767906a99e6e09f3ff04ca2b2a5cd22f62941db103c0356df1a8ed20ce322cab2483db67685afd124 c1878cf60417151c766a712653d26ef350c8c75393458b7a9be715f053215af63dfd3b02c2ae65a8677917a8efa3172acb71cb90196e42106953ea0363c5aaf200 bd50b7370c3f96733b31744c6c45079e7ae6c8d299613246d28ebcef507ec987
+```
+
+```
+true
+```
+
+--
+
+#### `recover <address> <known-phrase>`
+*Try to recover an account given expected address and partial (too short or with invalid words) recovery phrase.*
+
+- `<address>` - ethereum address, 20 bytes long
+- `<known-phrase>` - known phrase, can be in a form of `thwarting * creamer`
+
+```
+RUST_LOG="info" ethkey recover "00cf3711cbd3a1512570639280758118ba0b2bcb" "thwarting scandal creamer nuzzle asparagus blast crouch trusting anytime elixir frenzied octag"
+```
+
+```
+INFO:ethkey::brain_recover: Invalid word 'octag', looking for potential substitutions.
+INFO:ethkey::brain_recover: Closest words: ["ocean", "octagon", "octane", "outage", "tag", "acting", "acts", "aorta", "cage", "chug"]
+INFO:ethkey::brain_recover: Starting to test 7776 possible combinations.
+
+thwarting scandal creamer nuzzle asparagus blast crouch trusting anytime elixir frenzied octagon
+secret:  001ce488d50d2f7579dc190c4655f32918d505cee3de63bddc7101bc91c0c2f0
+public:  4e19a5fdae82596e1485c69b687c9cc52b5078e5b0668ef3ce8543cd90e712cb00df822489bc1f1dcb3623538a54476c7b3def44e1a51dc174e86448b63f42d0
+address: 00cf3711cbd3a1512570639280758118ba0b2bcb
+```
+
+## Parity Ethereum toolchain
+_This project is a part of the Parity Ethereum toolchain._
+
+- [evmbin](https://github.com/paritytech/parity-ethereum/blob/master/evmbin/) - EVM implementation for Parity Ethereum.
+- [ethabi](https://github.com/paritytech/ethabi) - Parity Ethereum function calls encoding.
+- [ethstore](https://github.com/paritytech/parity-ethereum/blob/master/accounts/ethstore) - Parity Ethereum key management.
+- [ethkey](https://github.com/paritytech/parity-ethereum/blob/master/accounts/ethkey) - Parity Ethereum keys generator.

crates/accounts/ethkey/src/brain.rs

@@ -0,0 +1,69 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use parity_crypto::{
+    publickey::{KeyPair, Secret},
+    Keccak256,
+};
+use parity_wordlist;
+
+/// Simple brainwallet.
+pub struct Brain(String);
+
+impl Brain {
+    pub fn new(s: String) -> Self {
+        Brain(s)
+    }
+
+    pub fn validate_phrase(phrase: &str, expected_words: usize) -> Result<(), ::WordlistError> {
+        parity_wordlist::validate_phrase(phrase, expected_words)
+    }
+
+    pub fn generate(&mut self) -> KeyPair {
+        let seed = self.0.clone();
+        let mut secret = seed.into_bytes().keccak256();
+
+        let mut i = 0;
+        loop {
+            secret = secret.keccak256();
+
+            match i > 16384 {
+                false => i += 1,
+                true => {
+                    if let Ok(pair) = Secret::import_key(&secret).and_then(KeyPair::from_secret) {
+                        if pair.address()[0] == 0 {
+                            trace!("Testing: {}, got: {:?}", self.0, pair.address());
+                            return pair;
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use Brain;
+
+    #[test]
+    fn test_brain() {
+        let words = "this is sparta!".to_owned();
+        let first_keypair = Brain::new(words.clone()).generate();
+        let second_keypair = Brain::new(words.clone()).generate();
+        assert_eq!(first_keypair.secret(), second_keypair.secret());
+    }
+}

crates/accounts/ethkey/src/brain_prefix.rs

@@ -0,0 +1,69 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use super::Brain;
+use parity_crypto::publickey::{Error, KeyPair};
+use parity_wordlist as wordlist;
+
+/// Tries to find brain-seed keypair with address starting with given prefix.
+pub struct BrainPrefix {
+    prefix: Vec<u8>,
+    iterations: usize,
+    no_of_words: usize,
+    last_phrase: String,
+}
+
+impl BrainPrefix {
+    pub fn new(prefix: Vec<u8>, iterations: usize, no_of_words: usize) -> Self {
+        BrainPrefix {
+            prefix,
+            iterations,
+            no_of_words,
+            last_phrase: String::new(),
+        }
+    }
+
+    pub fn phrase(&self) -> &str {
+        &self.last_phrase
+    }
+
+    pub fn generate(&mut self) -> Result<KeyPair, Error> {
+        for _ in 0..self.iterations {
+            let phrase = wordlist::random_phrase(self.no_of_words);
+            let keypair = Brain::new(phrase.clone()).generate();
+            if keypair.address().as_ref().starts_with(&self.prefix) {
+                self.last_phrase = phrase;
+                return Ok(keypair);
+            }
+        }
+
+        Err(Error::Custom("Could not find keypair".into()))
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use BrainPrefix;
+
+    #[test]
+    fn prefix_generator() {
+        let prefix = vec![0x00u8];
+        let keypair = BrainPrefix::new(prefix.clone(), usize::max_value(), 12)
+            .generate()
+            .unwrap();
+        assert!(keypair.address().as_bytes().starts_with(&prefix));
+    }
+}

crates/accounts/ethkey/src/brain_recover.rs

@@ -0,0 +1,177 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::collections::HashSet;
+
+use edit_distance::edit_distance;
+use parity_crypto::publickey::Address;
+use parity_wordlist;
+
+use super::Brain;
+
+/// Tries to find a phrase for address, given the number
+/// of expected words and a partial phrase.
+///
+/// Returns `None` if phrase couldn't be found.
+pub fn brain_recover(
+    address: &Address,
+    known_phrase: &str,
+    expected_words: usize,
+) -> Option<String> {
+    let it = PhrasesIterator::from_known_phrase(known_phrase, expected_words);
+    for phrase in it {
+        let keypair = Brain::new(phrase.clone()).generate();
+        trace!("Testing: {}, got: {:?}", phrase, keypair.address());
+        if &keypair.address() == address {
+            return Some(phrase);
+        }
+    }
+
+    None
+}
+
+fn generate_substitutions(word: &str) -> Vec<&'static str> {
+    let mut words = parity_wordlist::WORDS
+        .iter()
+        .cloned()
+        .map(|w| (edit_distance(w, word), w))
+        .collect::<Vec<_>>();
+    words.sort_by(|a, b| a.0.cmp(&b.0));
+
+    words.into_iter().map(|pair| pair.1).collect()
+}
+
+/// Iterator over possible
+pub struct PhrasesIterator {
+    words: Vec<Vec<&'static str>>,
+    combinations: u64,
+    indexes: Vec<usize>,
+    has_next: bool,
+}
+
+impl PhrasesIterator {
+    pub fn from_known_phrase(known_phrase: &str, expected_words: usize) -> Self {
+        let known_words = parity_wordlist::WORDS
+            .iter()
+            .cloned()
+            .collect::<HashSet<_>>();
+        let mut words = known_phrase
+            .split(' ')
+            .map(|word| match known_words.get(word) {
+                None => {
+                    info!(
+                        "Invalid word '{}', looking for potential substitutions.",
+                        word
+                    );
+                    let substitutions = generate_substitutions(word);
+                    info!("Closest words: {:?}", &substitutions[..10]);
+                    substitutions
+                }
+                Some(word) => vec![*word],
+            })
+            .collect::<Vec<_>>();
+
+        // add missing words
+        if words.len() < expected_words {
+            let to_add = expected_words - words.len();
+            info!("Number of words is insuficcient adding {} more.", to_add);
+            for _ in 0..to_add {
+                words.push(parity_wordlist::WORDS.iter().cloned().collect());
+            }
+        }
+
+        // start searching
+        PhrasesIterator::new(words)
+    }
+
+    pub fn new(words: Vec<Vec<&'static str>>) -> Self {
+        let combinations = words.iter().fold(1u64, |acc, x| acc * x.len() as u64);
+        let indexes = words.iter().map(|_| 0).collect();
+        info!("Starting to test {} possible combinations.", combinations);
+
+        PhrasesIterator {
+            words,
+            combinations,
+            indexes,
+            has_next: combinations > 0,
+        }
+    }
+
+    pub fn combinations(&self) -> u64 {
+        self.combinations
+    }
+
+    fn current(&self) -> String {
+        let mut s = self.words[0][self.indexes[0]].to_owned();
+        for i in 1..self.indexes.len() {
+            s.push(' ');
+            s.push_str(self.words[i][self.indexes[i]]);
+        }
+        s
+    }
+
+    fn next_index(&mut self) -> bool {
+        let mut pos = self.indexes.len();
+        while pos > 0 {
+            pos -= 1;
+            self.indexes[pos] += 1;
+            if self.indexes[pos] >= self.words[pos].len() {
+                self.indexes[pos] = 0;
+            } else {
+                return true;
+            }
+        }
+
+        false
+    }
+}
+
+impl Iterator for PhrasesIterator {
+    type Item = String;
+
+    fn next(&mut self) -> Option<String> {
+        if !self.has_next {
+            return None;
+        }
+
+        let phrase = self.current();
+        self.has_next = self.next_index();
+        Some(phrase)
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::PhrasesIterator;
+
+    #[test]
+    fn should_generate_possible_combinations() {
+        let mut it =
+            PhrasesIterator::new(vec![vec!["1", "2", "3"], vec!["test"], vec!["a", "b", "c"]]);
+
+        assert_eq!(it.combinations(), 9);
+        assert_eq!(it.next(), Some("1 test a".to_owned()));
+        assert_eq!(it.next(), Some("1 test b".to_owned()));
+        assert_eq!(it.next(), Some("1 test c".to_owned()));
+        assert_eq!(it.next(), Some("2 test a".to_owned()));
+        assert_eq!(it.next(), Some("2 test b".to_owned()));
+        assert_eq!(it.next(), Some("2 test c".to_owned()));
+        assert_eq!(it.next(), Some("3 test a".to_owned()));
+        assert_eq!(it.next(), Some("3 test b".to_owned()));
+        assert_eq!(it.next(), Some("3 test c".to_owned()));
+        assert_eq!(it.next(), None);
+    }
+}

crates/accounts/ethkey/src/error.rs

@@ -0,0 +1,88 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use crypto::Error as CryptoError;
+use std::{error, fmt};
+
+#[derive(Debug)]
+/// Crypto error
+pub enum Error {
+    /// Invalid secret key
+    InvalidSecret,
+    /// Invalid public key
+    InvalidPublic,
+    /// Invalid address
+    InvalidAddress,
+    /// Invalid EC signature
+    InvalidSignature,
+    /// Invalid AES message
+    InvalidMessage,
+    /// IO Error
+    Io(::std::io::Error),
+    /// Custom
+    Custom(String),
+}
+
+impl fmt::Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        let msg = match *self {
+            Error::InvalidSecret => "Invalid secret".into(),
+            Error::InvalidPublic => "Invalid public".into(),
+            Error::InvalidAddress => "Invalid address".into(),
+            Error::InvalidSignature => "Invalid EC signature".into(),
+            Error::InvalidMessage => "Invalid AES message".into(),
+            Error::Io(ref err) => format!("I/O error: {}", err),
+            Error::Custom(ref s) => s.clone(),
+        };
+
+        f.write_fmt(format_args!("Crypto error ({})", msg))
+    }
+}
+
+impl error::Error for Error {
+    fn description(&self) -> &str {
+        format!("{:?}", &self)
+    }
+}
+
+impl Into<String> for Error {
+    fn into(self) -> String {
+        format!("{}", self)
+    }
+}
+
+impl From<CryptoError> for Error {
+    fn from(e: CryptoError) -> Error {
+        Error::Custom(e.to_string())
+    }
+}
+
+impl From<::secp256k1::Error> for Error {
+    fn from(e: ::secp256k1::Error) -> Error {
+        match e {
+            ::secp256k1::Error::InvalidMessage => Error::InvalidMessage,
+            ::secp256k1::Error::InvalidPublicKey => Error::InvalidPublic,
+            ::secp256k1::Error::InvalidSecretKey => Error::InvalidSecret,
+            _ => Error::InvalidSignature,
+        }
+    }
+}
+
+impl From<::std::io::Error> for Error {
+    fn from(err: ::std::io::Error) -> Error {
+        Error::Io(err)
+    }
+}

crates/accounts/ethkey/src/lib.rs

@@ -0,0 +1,39 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+// #![warn(missing_docs)]
+
+extern crate edit_distance;
+extern crate parity_crypto;
+extern crate parity_wordlist;
+extern crate serde;
+
+#[macro_use]
+extern crate log;
+#[macro_use]
+extern crate serde_derive;
+
+mod brain;
+mod brain_prefix;
+mod password;
+mod prefix;
+
+pub mod brain_recover;
+
+pub use self::{
+    brain::Brain, brain_prefix::BrainPrefix, parity_wordlist::Error as WordlistError,
+    password::Password, prefix::Prefix,
+};

crates/accounts/ethkey/src/password.rs

@@ -0,0 +1,59 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+// This file is part of OpenEthereum.
+
+// OpenEthereum is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// OpenEthereum is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.
+
+use std::{fmt, ptr};
+
+#[derive(Clone, PartialEq, Eq, Serialize, Deserialize)]
+pub struct Password(String);
+
+impl fmt::Debug for Password {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "Password(******)")
+    }
+}
+
+impl Password {
+    pub fn as_bytes(&self) -> &[u8] {
+        self.0.as_bytes()
+    }
+
+    pub fn as_str(&self) -> &str {
+        self.0.as_str()
+    }
+}
+
+// Custom drop impl to zero out memory.
+impl Drop for Password {
+    fn drop(&mut self) {
+        unsafe {
+            for byte_ref in self.0.as_mut_vec() {
+                ptr::write_volatile(byte_ref, 0)
+            }
+        }
+    }
+}
+
+impl From<String> for Password {
+    fn from(s: String) -> Password {
+        Password(s)
+    }
+}
+
+impl<'a> From<&'a str> for Password {
+    fn from(s: &'a str) -> Password {
+        Password::from(String::from(s))
+    }
+}