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

Respond to RFCs in #1639

pull/1639/head
derekpierre 2020-02-03 10:06:16 -05:00
parent 09dcc2b933
commit 1ebbb1721a
2 changed files with 13 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/source/support/faq.rst
View File

@ -6,7 +6,7 @@ What are the recommended specifications for running a nucypher node?
-------------------------------------------------------------------- --------------------------------------------------------------------
Worker nodes need to run ``nucypher`` and a local ethereum node. In total, you will Worker nodes need to run ``nucypher`` and a local ethereum node. In total, you will
require at 4GB for RAM. Nodes also need 24/7 uptime and a static, public IPv4 address. require at least 4GB for RAM. Nodes also need 24/7 uptime and a static, public IPv4 address.
For ``nucypher`` specific requirements, see `System Requirements and Dependencies <https://docs.nucypher.com/en/latest/guides/installation_guide.html#system-requirements-and-dependencies/>`_. For ``nucypher`` specific requirements, see `System Requirements and Dependencies <https://docs.nucypher.com/en/latest/guides/installation_guide.html#system-requirements-and-dependencies/>`_.
@ -24,10 +24,10 @@ How long is a period?
Can my Staker and Worker address be the same? Can my Staker and Worker address be the same?
-------------------------------------------------------------------------------------- ---------------------------------------------
Technically, yes, but it is not recommended. The accounts have different security considerations - the staker address Technically, yes, but it is not recommended. The accounts have different security considerations - the staker address
can be a high-value hardware wallet (with NU and ETH) that performs stake management while the worker is high-value and can be a hardware wallet (with NU and ETH) that performs stake management while the worker
address is low-value and needs to remain unlocked while running (software wallet with ETH) since it address is low-value and needs to remain unlocked while running (software wallet with ETH) since it
is used by an Ursula node. is used by an Ursula node.
@ -74,15 +74,7 @@ This is **ONLY** a heuristic to ensure that your node is running correctly, it d
#. Ensure that your worker is bonded with your staker - ``nucypher stake list`` and check that #. Ensure that your worker is bonded with your staker - ``nucypher stake list`` and check that
*Worker* is set correctly i.e. not ``0x0000``. *Worker* is set correctly i.e. not ``0x0000``.
#. Ensure that your node is listed on the `Status Monitor Page <https://status.nucypher.network>`_ (this can take a few mins). #. Ensure that your node is listed on the `Status Monitor Page <https://status.nucypher.network>`_ (this can take a few minutes).
If your node is on the status monitor page but:
a. Does not have a green dot, you should ensure that your Ursula node can confirm activity (hint: does your worker address have ETH to pay gas?).
Try locally running ``nucypher ursula confirm-activity``
b. Has a *Last Seen* value of ``No Connection to Node`` then there may be connectivity issues with your
node - redo the check in step #2.
What's the best way to run Ursula in the background? What's the best way to run Ursula in the background?
@ -108,13 +100,13 @@ Run::
> --network cassandra > --network cassandra
> --staking-address <your_staker_address>`` > --staking-address <your_staker_address>``
Note that a minimum of two periods must elapse before rewards will be delivered to your wallet. For example, say we are in Period 5 when you start staking: Note that a minimum of two periods must elapse before rewards will be delivered to your wallet. For example, say we
Period 5: You deposit stake and initiate a worker are in Period 5 when you start staking:
Period 5: Your worker calls ``confirmActivity()`` in order to receive work for the next period
Period 6: Your worker successfully performs the work - Period 5: You deposit stake and initiate a worker
Period 7: Your worker receives rewards for the work completed in the previous period - Period 5: Your worker calls ``confirmActivity()`` in order to receive work for the next period
(which calls ``confirmActivity()`` to receive work for the next period (1)), then in period 1 the Ursula - Period 6: Your worker successfully performs the work
node does work and will get rewarded in period 2 for the work performed in period 1. - Period 7: Your worker receives rewards for the work completed in the previous period
.. note:: .. note::

4
docs/source/support/troubleshooting.rst
View File

@ -42,13 +42,13 @@ builtins.ValueError: {'code': -32000, 'message': 'insufficient funds for gas * p
---------------------------------------------------------------------------------------------- ----------------------------------------------------------------------------------------------
The Ursula node does not have enough (Goerli) ETH to pay for transaction gas. Ensure that your worker address has The Ursula node does not have enough (Goerli) ETH to pay for transaction gas. Ensure that your worker address has
(Goerli) ETH in it. (Goerli) ETH.
Warning! Error encountered during contract execution [Out of gas] Warning! Error encountered during contract execution [Out of gas]
----------------------------------------------------------------- -----------------------------------------------------------------
The Ursula node does not have enough (Goerli) ETH to pay for transaction gas; ensure that your worker address has (Goerli) ETH in it. The Ursula node does not have enough (Goerli) ETH to pay for transaction gas; ensure that your worker address has (Goerli) ETH.
RuntimeError: Click will abort further execution because Python 3 was configured to use ASCII as encoding for the environment RuntimeError: Click will abort further execution because Python 3 was configured to use ASCII as encoding for the environment