Skip to content
This repository was archived by the owner on Nov 6, 2020. It is now read-only.

Commit bb2d7fb

Browse files
vorot93dvdplm
andauthored
Update README (#11578)
* Update README * Update README.md Co-Authored-By: David <dvdplm@gmail.com> * Update README.md Co-Authored-By: David <dvdplm@gmail.com> * Update README.md Co-Authored-By: David <dvdplm@gmail.com> * more * fix link * discord badge style Co-authored-by: David <dvdplm@gmail.com>
1 parent 70c4ed7 commit bb2d7fb

File tree

1 file changed

+66
-92
lines changed

1 file changed

+66
-92
lines changed

README.md

Lines changed: 66 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
1-
![Open Ethereum](docs/logo-parity-ethereum.svg)
1+
# OpenEthereum
22

3-
<h2 align="center">The Fastest and most Advanced Ethereum Client.</h2>
3+
Fast and feature-rich multi-network Ethereum client.
44

5-
<p align="center"><strong><a href="https://github.com/OpenEthereum/open-ethereum/releases/latest">» Download the latest release «</a></strong></p>
5+
[» Download the latest release «](https://github.com/openethereum/openethereum/releases/latest)
66

7-
<p align="center"><a href="https://github.com/OpenEthereum/open-ethereum/actions" target="_blank"><img src="https://github.com/OpenEthereum/open-ethereum/workflows/Build%20and%20Test%20Suite/badge.svg" /></a>
8-
<a href="https://www.gnu.org/licenses/gpl-3.0.en.html" target="_blank"><img src="https://img.shields.io/badge/license-GPL%20v3-green.svg" /></a></p>
7+
[![GPL licensed][license-badge]][license-url]
8+
[![Build Status][ci-badge]][ci-url]
9+
[![Discord chat][chat-badge]][chat-url]
10+
11+
[license-badge]: https://img.shields.io/badge/license-GPL_v3-green.svg
12+
[license-url]: LICENSE
13+
[ci-badge]: https://github.com/openethereum/openethereum/workflows/Build%20and%20Test%20Suite/badge.svg
14+
[ci-url]: https://github.com/openethereum/openethereum/actions
15+
[chat-badge]: https://img.shields.io/discord/669192218728202270.svg?logo=discord
16+
[chat-url]: https://discord.io/openethereum
917

1018
## Table of Contents
1119

@@ -14,18 +22,17 @@
1422
3. [Building](#chapter-003)<br>
1523
3.1 [Building Dependencies](#chapter-0031)<br>
1624
3.2 [Building from Source Code](#chapter-0032)<br>
17-
3.3 [Starting Open Ethereum](#chapter-0034)
25+
3.3 [Starting OpenEthereum](#chapter-0034)
1826
4. [Testing](#chapter-004)
1927
5. [Documentation](#chapter-005)
2028
6. [Toolchain](#chapter-006)
21-
7. [Community](#chapter-007)
22-
8. [Contributing](#chapter-008)
23-
9. [License](#chapter-009)
29+
7. [Contributing](#chapter-008)
30+
8. [License](#chapter-009)
2431

2532

2633
## 1. Description <a id="chapter-001"></a>
2734

28-
**Built for mission-critical use**: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. Open Ethereum provides the core infrastructure essential for speedy and reliable services.
35+
**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.
2936

3037
- Clean, modular codebase for easy customisation
3138
- Advanced CLI-based client
@@ -35,19 +42,19 @@
3542

3643
## 2. Technical Overview <a id="chapter-002"></a>
3744

38-
Open Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Open Ethereum using the sophisticated and cutting-edge **Rust programming language**. Open Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
45+
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.
3946

40-
By default, Open Ethereum 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.
47+
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.
4148

42-
If you run into problems while using Open Ethereum, check out the [old wiki for documentation](https://wiki.parity.io/), feel free to [file an issue in this repository](https://github.com/OpenEthereum/open-ethereum/issues/new), or hop on our [Discord](https://discord.gg/FJUgGe) 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).
49+
If you run into problems while using OpenEthereum, check out the [old wiki for documentation](https://wiki.parity.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!
4350

44-
You can download Open Ethereum's latest release at [the releases page](https://github.com/OpenEthereum/open-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.
51+
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.
4552

4653
## 3. Building <a id="chapter-003"></a>
4754

4855
### 3.1 Build Dependencies <a id="chapter-0031"></a>
4956

50-
Open Ethereum requires **latest stable Rust version** to build.
57+
OpenEthereum requires **latest stable Rust version** to build.
5158

5259
We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have `rustup`, you can install it like this:
5360

@@ -56,7 +63,7 @@ We recommend installing Rust through [rustup](https://www.rustup.rs/). If you do
5663
$ curl https://sh.rustup.rs -sSf | sh
5764
```
5865

59-
Open Ethereum also requires `clang` (>= 9.0), `clang++`, `pkg-config`, `file`, `make`, and `cmake` packages to be installed.
66+
OpenEthereum also requires `clang` (>= 9.0), `clang++`, `pkg-config`, `file`, `make`, and `cmake` packages to be installed.
6067

6168
- OSX:
6269
```bash
@@ -76,13 +83,13 @@ Once you have `rustup` installed, then you need to install:
7683
* [Perl](https://www.perl.org)
7784
* [Yasm](https://yasm.tortall.net)
7885

79-
Make sure that these binaries are in your `PATH`. After that, you should be able to build Open Ethereum from source.
86+
Make sure that these binaries are in your `PATH`. After that, you should be able to build OpenEthereum from source.
8087

8188
### 3.2 Build from Source Code <a id="chapter-0032"></a>
8289

8390
```bash
84-
# download Open Ethereum code
85-
$ git clone https://github.com/OpenEthereum/open-ethereum
91+
# download OpenEthereum code
92+
$ git clone https://github.com/openethereum/openethereum
8693
$ cd open-ethereum
8794

8895
# build in release mode
@@ -109,26 +116,26 @@ This always compiles the latest nightly builds. If you want to build stable, do
109116
$ git checkout stable
110117
```
111118

112-
### 3.3 Starting Open Ethereum <a id="chapter-0034"></a>
119+
### 3.3 Starting OpenEthereum <a id="chapter-0034"></a>
113120

114121
#### Manually
115122

116-
To start Open Ethereum manually, just run
123+
To start OpenEthereum manually, just run
117124

118125
```bash
119126
$ ./target/release/parity
120127
```
121128

122-
so Open Ethereum begins syncing the Ethereum blockchain.
129+
so OpenEthereum begins syncing the Ethereum blockchain.
123130

124131
#### Using `systemd` service file
125132

126-
To start Open Ethereum as a regular user using `systemd` init:
133+
To start OpenEthereum as a regular user using `systemd` init:
127134

128135
1. Copy `./scripts/parity.service` to your
129136
`systemd` user directory (usually `~/.config/systemd/user`).
130137
2. Copy release to bin folder, write `sudo install ./target/release/parity /usr/bin/parity`
131-
3. To configure Open Ethereum, write a `/etc/parity/config.toml` config file, see [our old wiki](https://paritytech.github.io/wiki/Configuring-Parity) for details.
138+
3. To configure OpenEthereum, see [our old wiki](https://paritytech.github.io/wiki/Configuring-Parity) for details.
132139

133140
## 4. Testing <a id="chapter-004"></a>
134141

@@ -152,9 +159,9 @@ You can show your logs in the test output by passing `--nocapture` (i.e. `cargo
152159

153160
Be sure to [check out our old wiki](https://wiki.parity.io) for more information.
154161

155-
### Viewing documentation for Open Ethereum packages
162+
### Viewing documentation for OpenEthereum packages
156163

157-
You can generate documentation for Open Ethereum 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:
164+
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:
158165

159166
* **All** packages
160167
```
@@ -174,48 +181,48 @@ Replacing `<spec>` with one of the following from the details section below (i.e
174181
**Package List**
175182
<details><p>
176183

177-
* Open Ethereum (EthCore) Client Application
184+
* OpenEthereum Client Application
178185
```bash
179186
open-ethereum
180187
```
181-
* Open Ethereum Account Management, Key Management Tool, and Keys Generator
188+
* OpenEthereum Account Management, Key Management Tool, and Keys Generator
182189
```bash
183190
ethcore-accounts, ethkey-cli, ethstore, ethstore-cli
184191
```
185-
* Open Ethereum Chain Specification
192+
* OpenEthereum Chain Specification
186193
```bash
187194
chainspec
188195
```
189-
* Open Ethereum CLI Signer Tool & RPC Client
196+
* OpenEthereum CLI Signer Tool & RPC Client
190197
```bash
191198
cli-signer parity-rpc-client
192199
```
193-
* Open Ethereum Ethash & ProgPoW Implementations
200+
* OpenEthereum Ethash & ProgPoW Implementations
194201
```bash
195202
ethash
196203
```
197204
* EthCore Library
198205
```bash
199206
ethcore
200207
```
201-
* Open Ethereum Blockchain Database, Test Generator, Configuration,
208+
* OpenEthereum Blockchain Database, Test Generator, Configuration,
202209
Caching, Importing Blocks, and Block Information
203210
```bash
204211
ethcore-blockchain
205212
```
206-
* Open Ethereum (EthCore) Contract Calls and Blockchain Service & Registry Information
213+
* OpenEthereum Contract Calls and Blockchain Service & Registry Information
207214
```bash
208215
ethcore-call-contract
209216
```
210-
* Open Ethereum (EthCore) Database Access & Utilities, Database Cache Manager
217+
* OpenEthereum Database Access & Utilities, Database Cache Manager
211218
```bash
212219
ethcore-db
213220
```
214-
* Open Ethereum Virtual Machine (EVM) Rust Implementation
221+
* OpenEthereum Virtual Machine (EVM) Rust Implementation
215222
```bash
216223
evm
217224
```
218-
* Open Ethereum (EthCore) Light Client Implementation
225+
* OpenEthereum Light Client Implementation
219226
```bash
220227
ethcore-light
221228
```
@@ -227,59 +234,59 @@ Caching, Importing Blocks, and Block Information
227234
```bash
228235
ethcore-private-tx
229236
```
230-
* Open Ethereum (EthCore) Client & Network Service Creation & Registration with the I/O Subsystem
237+
* OpenEthereum Client & Network Service Creation & Registration with the I/O Subsystem
231238
```bash
232239
ethcore-service
233240
```
234-
* Open Ethereum (EthCore) Blockchain Synchronization
241+
* OpenEthereum Blockchain Synchronization
235242
```bash
236243
ethcore-sync
237244
```
238-
* Open Ethereum Common Types
245+
* OpenEthereum Common Types
239246
```bash
240247
common-types
241248
```
242-
* Open Ethereum Virtual Machines (VM) Support Library
249+
* OpenEthereum Virtual Machines (VM) Support Library
243250
```bash
244251
vm
245252
```
246-
* Open Ethereum WASM Interpreter
253+
* OpenEthereum WASM Interpreter
247254
```bash
248255
wasm
249256
```
250-
* Open Ethereum WASM Test Runner
257+
* OpenEthereum WASM Test Runner
251258
```bash
252259
pwasm-run-test
253260
```
254-
* Open Ethereum EVM Implementation
261+
* OpenEthereum EVM Implementation
255262
```bash
256263
evmbin
257264
```
258-
* Open Ethereum JSON Deserialization
265+
* OpenEthereum JSON Deserialization
259266
```bash
260267
ethjson
261268
```
262-
* Open Ethereum State Machine Generalization for Consensus Engines
269+
* OpenEthereum State Machine Generalization for Consensus Engines
263270
```bash
264271
parity-machine
265272
```
266-
* Open Ethereum (EthCore) Miner Interface
273+
* OpenEthereum Miner Interface
267274
```bash
268275
ethcore-miner parity-local-store price-info ethcore-stratum using_queue
269276
```
270-
* Open Ethereum (EthCore) Logger Implementation
277+
* OpenEthereum Logger Implementation
271278
```bash
272279
ethcore-logger
273280
```
274-
* Open Ethereum JSON-RPC Servers
281+
* OpenEthereum JSON-RPC Servers
275282
```bash
276283
parity-rpc
277284
```
278-
* Open Ethereum Updater Service
285+
* OpenEthereum Updater Service
279286
```bash
280287
parity-updater parity-hash-fetch
281288
```
282-
* Open Ethereum Core Libraries (`util`)
289+
* OpenEthereum Core Libraries (`util`)
283290
```bash
284291
ethcore-bloom-journal blooms-db dir eip-712 fake-fetch fastmap fetch ethcore-io
285292
journaldb keccak-hasher len-caching-lock memory-cache memzero
@@ -290,59 +297,26 @@ Caching, Importing Blocks, and Block Information
290297

291298
</p></details>
292299

293-
### Contributing to documentation for Open Ethereum packages
294-
295-
[Document source code](https://doc.rust-lang.org/1.9.0/book/documentation.html) for Open Ethereum packages by annotating the source code with documentation comments.
296-
297-
Example (generic documentation comment):
298-
```markdown
299-
/// Summary
300-
///
301-
/// Description
302-
///
303-
/// # Panics
304-
///
305-
/// # Errors
306-
///
307-
/// # Safety
308-
///
309-
/// # Examples
310-
///
311-
/// Summary of Example 1
312-
///
313-
/// ```rust
314-
/// // insert example 1 code here for use with documentation as tests
315-
/// ```
316-
///
317-
```
318-
319300
## 6. Toolchain <a id="chapter-006"></a>
320301

321-
In addition to the Open Ethereum client, there are additional tools in this repository available:
322-
323-
- [evmbin](./evmbin) - Open Ethereum EVM Implementation.
324-
- [ethstore](./accounts/ethstore) - Open Ethereum Key Management.
325-
- [ethkey](./accounts/ethkey) - Open Ethereum Keys Generator.
326-
327-
The following tool is available in a separate repository:
328-
- [ethabi](https://github.com/OpenEthereum/ethabi) - Open Ethereum Encoding of Function Calls. [Docs here](https://crates.io/crates/ethabi)
329-
- [whisper](https://github.com/OpenEthereum/whisper) - Open Ethereum Whisper-v2 PoC Implementation.
330-
331-
## 7. Community <a id="chapter-007"></a>
302+
In addition to the OpenEthereum client, there are additional tools in this repository available:
332303

333-
### Join the chat!
304+
- [evmbin](./evmbin) - OpenEthereum EVM Implementation.
305+
- [ethstore](./accounts/ethstore) - OpenEthereum Key Management.
306+
- [ethkey](./accounts/ethkey) - OpenEthereum Keys Generator.
334307

335-
Questions? Get in touch with us on Discord:
336-
[![Discord: Open Ethereum](https://img.shields.io/discord/669192218728202270.svg?logo=discord)](https://discord.gg/FJUgGe)
308+
The following tools are available in a separate repository:
309+
- [ethabi](https://github.com/openethereum/ethabi) - OpenEthereum Encoding of Function Calls. [Docs here](https://crates.io/crates/ethabi)
310+
- [whisper](https://github.com/openethereum/whisper) - OpenEthereum Whisper-v2 PoC Implementation.
337311

338-
## 8. Contributing <a id="chapter-008"></a>
312+
## 7. Contributing <a id="chapter-007"></a>
339313

340314
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).
341315

342316
### Contributor Code of Conduct
343317

344318
[CODE_OF_CONDUCT](./.github/CODE_OF_CONDUCT.md)
345319

346-
## 9. License <a id="chapter-009"></a>
320+
## 8. License <a id="chapter-008"></a>
347321

348322
[LICENSE](./LICENSE)

0 commit comments

Comments
 (0)