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.
3.2 [Building from Source Code](#chapter-0032)<br>
17
-
3.3 [Starting Open Ethereum](#chapter-0034)
25
+
3.3 [Starting OpenEthereum](#chapter-0034)
18
26
4.[Testing](#chapter-004)
19
27
5.[Documentation](#chapter-005)
20
28
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)
24
31
25
32
26
33
## 1. Description <aid="chapter-001"></a>
27
34
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.
29
36
30
37
- Clean, modular codebase for easy customisation
31
38
- Advanced CLI-based client
@@ -35,19 +42,19 @@
35
42
36
43
## 2. Technical Overview <aid="chapter-002"></a>
37
44
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.
39
46
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.
41
48
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!
43
50
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.
so Open Ethereum begins syncing the Ethereum blockchain.
129
+
so OpenEthereum begins syncing the Ethereum blockchain.
123
130
124
131
#### Using `systemd` service file
125
132
126
-
To start Open Ethereum as a regular user using `systemd` init:
133
+
To start OpenEthereum as a regular user using `systemd` init:
127
134
128
135
1. Copy `./scripts/parity.service` to your
129
136
`systemd` user directory (usually `~/.config/systemd/user`).
130
137
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.
132
139
133
140
## 4. Testing <aid="chapter-004"></a>
134
141
@@ -152,9 +159,9 @@ You can show your logs in the test output by passing `--nocapture` (i.e. `cargo
152
159
153
160
Be sure to [check out our old wiki](https://wiki.parity.io) for more information.
154
161
155
-
### Viewing documentation for Open Ethereum packages
162
+
### Viewing documentation for OpenEthereum packages
156
163
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:
158
165
159
166
***All** packages
160
167
```
@@ -174,48 +181,48 @@ Replacing `<spec>` with one of the following from the details section below (i.e
174
181
**Package List**
175
182
<details><p>
176
183
177
-
*Open Ethereum (EthCore) Client Application
184
+
*OpenEthereum Client Application
178
185
```bash
179
186
open-ethereum
180
187
```
181
-
*Open Ethereum Account Management, Key Management Tool, and Keys Generator
188
+
*OpenEthereum Account Management, Key Management Tool, and Keys Generator
@@ -290,59 +297,26 @@ Caching, Importing Blocks, and Block Information
290
297
291
298
</p></details>
292
299
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
-
319
300
## 6. Toolchain <a id="chapter-006"></a>
320
301
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:
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).
0 commit comments