Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update clef URIs to use the "clef://" scheme prefix

pull/1944/head
derekpierre 2020-05-01 11:38:08 -04:00
parent 8d7416dd6e
commit 4f5b6c6d36
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/guides/installation_guide.rst
View File

@ -277,8 +277,6 @@ Systemd Service Installation
* ``<YOUR WORKER ADDRESS PASSWORD>`` - Worker's ETH account password
* ``<YOUR_PASSWORD>`` - Ursula's keyring password
* ``<VIRTUALENV_PATH>`` - The absolute path to the python virtual environment containing the ``nucypher`` executable
* ``<SEEDNODE_URI>`` - A seednode URI of a node on the network you are connecting to
#. Enable Ursula System Service

28
docs/source/guides/network_node/staking_guide.rst
View File

@ -206,7 +206,7 @@ by specifying the keystore directory path:
.. code:: bash
$ clef --keystore <PATH TO GOERLI KEYSTORE> --chainid 5 --advanced
$ clef --keystore <PATH TO KEYSTORE> --chainid 5 --advanced
- <PATH TO KEYSTORE> - The path to the directory containing geth-formatted private key files; the default path for Linux is ``~/.ethereum/goerli/keystore``.
@ -222,7 +222,7 @@ by specifying the keystore directory path:
------- Signer info -------
* extapi_version : 6.0.0
* extapi_http : n/a
* extapi_ipc : /home/user/.clef/clef.ipc
* extapi_ipc : /home/<username>/.clef/clef.ipc
* intapi_version : 7.0.0
@ -238,13 +238,13 @@ Some examples:
.. code:: bash
# Create a new stakeholder with clef as the default signer
$ nucypher stake init-stakeholder --signer ~/clef/clef.ipc ...
$ nucypher stake init-stakeholder --signer clef:///home/<username>/.clef/clef.ipc ...
# Update an existing configuration with clef as the default signer
$ nucypher stake config --signer ~/clef/clef.ipc # Set clef as the default signer
$ nucypher stake config --signer clef:///home/<username>/.clef/clef.ipc # Set clef as the default signer
# Create a new stake using inline signer and provider values
$ nucypher stake create --signer ~/clef/clef.ipc --provider ~/.ethereum/goerli/geth.ipc
$ nucypher stake create --signer clef:///home/<username>/.clef/clef.ipc --provider ~/.ethereum/geth.ipc
Interacting with clef
@ -302,25 +302,27 @@ to indicate which are the automated rules (in our case, allowing listing of acco
.. code:: bash
$ clef --keystore /path/to/keystore --chainid 5 --advanced --rules rules.js
$ clef --keystore <PATH TO KEYSTORE> --chainid 5 --advanced --rules rules.js
Initialize a new stakeholder
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Before continuing with stake initiation and management, A setup step is required to configure nucypher for staking.
This will create a configuration file (`~/.local/share/nucypher/stakeholder.josn`) containing editable configuration values.
This will create a configuration file (`~/.local/share/nucypher/stakeholder.json`) containing editable configuration values.
.. code:: bash
(nucypher)$ nucypher stake init-stakeholder --provider <PROVIDER> --network <NETWORK_NAME>
(nucypher)$ nucypher stake init-stakeholder --signer <SIGNER URI> --provider <PROVIDER> --network <NETWORK_NAME>
If you ran ``geth`` node as above, your ``<PROVIDER>`` is
``ipc:///home/<username>/.ethereum/goerli/geth.ipc``
(on MacOS, ``ipc:///Users/<username>/Library/Ethereum/goerli/geth.ipc``)
where:
* If you utilized a `Clef Setup`_, the ``SIGNER URI`` is ``clef:///home/<username>/.clef/clef.ipc``
* If you ran ``geth`` node as above, your ``<PROVIDER>`` is ``ipc:///home/<username>/.ethereum/goerli/geth.ipc``
(on MacOS, ``ipc:///Users/<username>/Library/Ethereum/goerli/geth.ipc``)
* ``<NETWORK_NAME>`` is the name of the NuCypher network domain where the staker will participate.
``<NETWORK_NAME>`` is the name of the NuCypher network domain where the staker will participate.
.. note:: If you're participating in NuCypher's incentivized testnet, this name is ``gemini``.