Skip to content
This repository was archived by the owner on Oct 28, 2021. It is now read-only.

Documentation for creating a private network with 2 nodes #5546

Merged
halfalicious merged 12 commits into from
Apr 8, 2019
Merged

Documentation for creating a private network with 2 nodes #5546

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9a0ada4
Rename existing private network documentation
halfalicious Apr 2, 2019
98409f3
Initial (extremely rough) version of new private docs
halfalicious Apr 2, 2019
0d1ea37
Lots of revisions. Still need to add proper formatting
halfalicious Apr 3, 2019
515cf26
More edits
halfalicious Apr 3, 2019
d672288
First round of formatting changes
halfalicious Apr 4, 2019
119b719
More formatting changes and minor language tweaks
halfalicious Apr 5, 2019
ab56949
More formatting changes/edits
halfalicious Apr 5, 2019
8b9983d
More minor tweaks
halfalicious Apr 5, 2019
d918c99
More updates
halfalicious Apr 5, 2019
0f37479
Yet more edits
halfalicious Apr 5, 2019
ad8787b
Update index
halfalicious Apr 5, 2019
48eead6
Address PR feedback
halfalicious Apr 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Yet more edits
  • Loading branch information
@halfalicious
halfalicious committed Apr 5, 2019
commit 0f374795ea6ced78b459fa38d85dfb0690b055aa
10 changes: 5 additions & 5 deletions doc/private_net_sync.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ An Ethereum chain is some state (e.g. accounts and balances and/or contract code
Mining
------
- Mining will be done using the Aleth CPU miner (Aleth doesn't include a GPU miner because of the high maintenance and support costs. Please see `EthMiner <https://github.com/ethereum-mining/ethminer>`_ for GPU mining support).
- Only one node will mine to keep your machine responsive.
- If mining slows down your system too much or you'd like both nodes to mine, you can tune the number of mining threads via ``-t <thread count>``.
- We will only start mining for one node to keep your machine responsive.
- If mining slows down your system too much or you'd like to have both nodes mine, you can tune the number of mining threads via ``-t <thread count>``.

Chain Configuration
-------------------
- You typically run a private chain using a chain configuration json file (this isn't strictly required, but it makes testing a lot easier since you can do things like lower the difficulty rate and pre-fund addresses).
- You typically initialize a private chain using a chain configuration json file (this isn't strictly required, but it makes testing a lot easier since you can do things like lower the difficulty rate and pre-fund addresses).
- The chain configuration json file format is defined here: https://github.com/ethereum/wiki/wiki/Ethereum-Chain-Spec-Format
Copy link
Member

@gumb0 gumb0 Apr 5, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really follow that spec? It might be outdated.

Copy link
Contributor Author

@halfalicious halfalicious Apr 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question! I assumed we did, Ill investigate

Copy link
Contributor Author

@halfalicious halfalicious Apr 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, the spec is either deprecated or we don't fully implement the spec (for example it lists a "nodes" key which we don't support). I'll remove the link.

- Here's an example file:

Expand Down Expand Up @@ -72,7 +72,7 @@ Chain Configuration
}
}

- **Both nodes must use the same chain configuration file:** The chain configuration is used to create the chain's genesis state, so using a different configuration with each node means that the nodes will be unable to peer with each other. An example of this is shown in the `Common Problems`_ section.
- **Both nodes must use the same chain configuration file:** The chain configuration is used to create the chain's genesis state, so using a different configuration for each node means that they won't be able to peer with each other. An example of this is shown in the `Common Problems`_ section.

Instructions
============
Expand Down Expand Up @@ -106,7 +106,7 @@ Enter the desired password when prompted
Address: 002c73acd4bc217998966964d27f0ee79a47befb


2. Add each address generated in the previous step to the ``accounts`` section of your chain configuration file (we'll refer to this as ``config.json`` from now on) along with the desired balance in wei. For example, the following initializes each account with 2000000000000000000 wei (2 ether):
2. Add each address generated in the previous step to the ``accounts`` section of your chain configuration file (we'll refer to this as ``config.json``) along with the desired balance in wei. For example, the following initializes each account with 2 ether (2000000000000000000 wei):

::

Expand Down