You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 6, 2020. It is now read-only.
**Built for mission-critical use**: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. Parity Ethereum provides the core infrastructure essential for speedy and reliable services.
- Modular for light integration into your service or product
21
19
22
-
Official website: https://parity.io | Be sure to check out [our wiki](https://wiki.parity.io) for more information.
20
+
## Technical Overview
23
21
24
-
----
22
+
Parity Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity Ethereum using the sophisticated and cutting-edge **Rust programming language**. Parity Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
25
23
26
-
## About Parity-Ethereum
24
+
By default, ParityEthereum 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.
27
25
28
-
Parity-Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity-Ethereum using the sophisticated and cutting-edge Rust programming language. Parity-Ethereum is licensed under the GPLv3, and can be used for all your Ethereum needs.
26
+
If you run into problems while using ParityEthereum, check out the [wiki for documentation](https://wiki.parity.io/), feel free to [file an issue in this repository](https://github.com/paritytech/parity-ethereum/issues/new), or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](SECURITY.md).
29
27
30
-
By default, Parity-Ethereum will run a JSON-RPC HTTP server on `127.0.0.1:8545` and a Web-Sockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs.
28
+
ParityEthereum's current beta-release is 2.0. You can download it at [the releases page](https://github.com/paritytech/parity-ethereum/releases) or follow the instructions below to build from source. Please, mind the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
31
29
32
-
If you run into problems while using Parity-Ethereum, feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](SECURITY.md).
30
+
## Build Dependencies
33
31
34
-
Parity-Ethereum's current beta-release is 2.0. You can download it at [the releases page](https://github.com/paritytech/parity-ethereum/releases) or follow the instructions below to build from source. Please, mind the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
32
+
ParityEthereum requires **Rust version 1.28.x**to build.
35
33
36
-
----
37
-
38
-
## Build dependencies
39
-
40
-
**Parity-Ethereum requires Rust version 1.27.0 to build**
41
-
42
-
We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have rustup, you can install it like this:
34
+
We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have `rustup`, you can install it like this:
43
35
44
36
- Linux:
45
37
```bash
46
38
$ curl https://sh.rustup.rs -sSf | sh
47
39
```
48
40
49
-
Parity-Ethereum also requires `gcc`, `g++`, `libudev-dev`, `pkg-config`, `file`, `make`, and `cmake` packages to be installed.
41
+
ParityEthereum also requires `gcc`, `g++`, `libudev-dev`, `pkg-config`, `file`, `make`, and `cmake` packages to be installed.
50
42
51
43
- OSX:
52
44
```bash
@@ -56,54 +48,50 @@ We recommend installing Rust through [rustup](https://www.rustup.rs/). If you do
56
48
`clang` is required. It comes with Xcode command line tools or can be installed with homebrew.
57
49
58
50
- Windows
59
-
Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the rustup installer from
60
-
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:
51
+
Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the `rustup` installer from
52
+
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:
61
53
```bash
62
54
$ rustup default stable-x86_64-pc-windows-msvc
63
55
```
64
56
65
-
Once you have rustup installed, then you need to install:
57
+
Once you have `rustup` installed, then you need to install:
66
58
*[Perl](https://www.perl.org)
67
59
*[Yasm](https://yasm.tortall.net)
68
60
69
-
Make sure that these binaries are in your `PATH`. After that you should be able to build Parity-Ethereum from source.
61
+
Make sure that these binaries are in your `PATH`. After that, you should be able to build ParityEthereum from source.
70
62
71
-
----
72
-
73
-
## Install from the snap store
63
+
## Install from the Snapcraft Store
74
64
75
65
In any of the [supported Linux distros](https://snapcraft.io/docs/core/install):
76
66
77
67
```bash
78
68
sudo snap install parity
79
69
```
80
70
81
-
Or, if you want to contribute testing the upcoming release:
71
+
Alternatively, if you want to contribute testing the upcoming release:
82
72
83
73
```bash
84
74
sudo snap install parity --beta
85
75
```
86
76
87
-
And to test the latest code landed into the master branch:
77
+
Moreover, to test the latest code from the master branch:
This will produce an executable in the `./target/release` subdirectory.
94
+
This produces an executable in the `./target/release` subdirectory.
107
95
108
96
Note: if cargo fails to parse manifest try:
109
97
@@ -117,7 +105,7 @@ Note, when compiling a crate and you receive errors, it's in most cases your out
117
105
$ cargo clean
118
106
```
119
107
120
-
This will always compile the latest nightly builds. If you want to build stable or beta, do a
108
+
This always compiles the latest nightly builds. If you want to build stable or beta, do a
121
109
122
110
```bash
123
111
$ git checkout stable
@@ -129,11 +117,7 @@ or
129
117
$ git checkout beta
130
118
```
131
119
132
-
first.
133
-
134
-
----
135
-
136
-
## Simple one-line installer for Mac and Ubuntu
120
+
## Simple One-Line Installer for Mac and Linux
137
121
138
122
```bash
139
123
bash <(curl https://get.parity.io -L)
@@ -145,22 +129,39 @@ The one-line installer always defaults to the latest beta release. To install a
145
129
bash <(curl https://get.parity.io -L) -r stable
146
130
```
147
131
148
-
## Start Parity-Ethereum
132
+
## Start ParityEthereum
149
133
150
134
### Manually
151
135
152
-
To start Parity-Ethereum manually, just run
136
+
To start ParityEthereum manually, just run
153
137
154
138
```bash
155
139
$ ./target/release/parity
156
140
```
157
141
158
-
and Parity-Ethereum will begin syncing the Ethereum blockchain.
142
+
so ParityEthereum begins syncing the Ethereum blockchain.
159
143
160
-
### Using systemd service file
144
+
### Using `systemd` service file
161
145
162
-
To start Parity-Ethereum as a regular user using systemd init:
146
+
To start ParityEthereum as a regular user using `systemd` init:
163
147
164
148
1. Copy `./scripts/parity.service` to your
165
-
systemd user directory (usually `~/.config/systemd/user`).
166
-
2. To configure Parity-Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity-Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details.
149
+
`systemd` user directory (usually `~/.config/systemd/user`).
150
+
2. To configure Parity Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details.
0 commit comments