Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document passing settings to chains. #427

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document passing settings to chains. #427

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions docs/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,27 @@ The above chain configuration sets up a new local private chain within your
project. The chain above would set it's data directory to
``<project-dir>/chains/my-chain/``.

You can pass chain settings in ``settings`` in subkey. In the case
of geth processes, these are directly mapped to command line arguments.

Below is an example how to make the temporary chain to listen to JSON-RPC.

.. code-block:: javascript

"temp": {
"chain": {
"class": "populus.chain.geth.TemporaryGethChain",
"settings": {
"rpc_port": "8548"
}
# ...
}
}

For more information about possible arguments to pass geth see
`py-geth project <https://github.com/ethereum/py-geth/blob/6584152225da1539c0d378b8284774da40024cc6/geth/wrapper.py#L104>`_
function ``construct_popen_command()``.

To simplify configuration of chains you can use the ``ChainConfig`` object.

.. code-block:: python
Expand Down