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

Mostly reordering of specific page content; addition of helpful/contextual links.

pull/2463/head
derekpierre 2021-02-02 16:27:11 -05:00
parent 9965ea33d6
commit 3b6d47dfe3
8 changed files with 129 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/source/application_development/testnet.rst
View File

@ -1,9 +1,11 @@
.. _lynx-testnet:
=============
Lynx Testnet
=============
NuCypher provides a public Long-Term Support testnet running on the ethereum Goerli testnet as a stable playground
for application development and network users (e.g., Alices wishing to create sharing policies, grant & Retrieve, etc.).
NuCypher provides a public Long-Term Support testnet running on the Ethereum Goerli testnet as a stable playground
for application development and network users (e.g., Alices wishing to create sharing policies, grant and retrieve, etc.).
.. note::
@ -14,7 +16,8 @@ for application development and network users (e.g., Alices wishing to create sh
.. important::
Goerli ETH is required to use the Lynx testnet.
Goerli ETH is required to use the Lynx testnet, and can be obtained from its `standard faucet <https://goerli-faucet.slock.it/>`_
or `authenticated faucet <https://faucet.goerli.mudit.blog/>`_.
Alice and Bob can use the lynx testnet using the python API:

145
docs/source/references/cli_reference.rst
View File

@ -70,51 +70,6 @@ Bob
+--------------------------+-------------------------------------------------------------------------------+
Cloudworkers
------------
Manage worker and other staker-related operations on cloud infrastructure.
.. code:: bash
(nucypher)$ nucypher cloudworkers ACTION [OPTIONS]
**Cloudworkers Command Actions**
+----------------------+-------------------------------------------------------------------------------+
| Action | Description |
+======================+===============================================================================+
| ``up`` | Creates and deploys hosts for all active local stakers. |
+----------------------+-------------------------------------------------------------------------------+
| ``create`` | Creates and deploys the given number of hosts independent of stakes |
+----------------------+-------------------------------------------------------------------------------+
| ``add`` | Add an existing host to be managed by cloudworkers CLI tools |
+----------------------+-------------------------------------------------------------------------------+
| ``add_for_stake`` | Add an existing host to be managed for a specified local staker address |
+----------------------+-------------------------------------------------------------------------------+
| ``deploy`` | Install and run Ursula on existing managed hosts. |
+----------------------+-------------------------------------------------------------------------------+
| ``update`` | Update or manage existing installed Ursula. |
+----------------------+-------------------------------------------------------------------------------+
| ``destroy`` | Shut down and cleanup resources deployed on AWS or Digital Ocean |
+----------------------+-------------------------------------------------------------------------------+
| ``stop`` | Stop the selected nodes. |
+----------------------+-------------------------------------------------------------------------------+
| ``status`` | Prints a formatted status of selected managed hosts. |
+----------------------+-------------------------------------------------------------------------------+
| ``logs`` | Download and display the accumulated stdout logs of selected hosts |
+----------------------+-------------------------------------------------------------------------------+
| ``backup`` | Download local copies of critical data from selected installed Ursulas |
+----------------------+-------------------------------------------------------------------------------+
| ``restore`` | Reconstitute and deploy an operating Ursula from backed up data |
+----------------------+-------------------------------------------------------------------------------+
| ``list_hosts`` | Print local nicknames of all managed hosts under a given namespace |
+----------------------+-------------------------------------------------------------------------------+
| ``list_namespaces`` | Print namespaces under a given network |
+----------------------+-------------------------------------------------------------------------------+
Enrico
-------
@ -210,34 +165,6 @@ Manage stakes and other staker-related operations.
+-------------------------+---------------------------------------------+
Status
------
Echo a snapshot of live NuCypher Network metadata.
.. code:: bash
(nucypher)$ nucypher status ACTION [OPTIONS]
**Status Command Actions**
+--------------------------+---------------------------------------------------------------------+
| Action | Description |
+==========================+=====================================================================+
| ``events`` | Show events associated to NuCypher contracts. |
+--------------------------+---------------------------------------------------------------------+
| ``fee-range`` | Provide information on the global fee range. |
+--------------------------+---------------------------------------------------------------------+
| ``locked-tokens`` | Display a graph of the number of locked tokens over time. |
+--------------------------+---------------------------------------------------------------------+
| ``network`` | Overall information of the NuCypher Network. |
+--------------------------+---------------------------------------------------------------------+
| ``stakers`` | Show relevant information about stakers. |
+--------------------------+---------------------------------------------------------------------+
Ursula
------
@ -267,3 +194,75 @@ Ursula
+--------------------------+---------------------------------------------------------------------+
| ``run`` | Start Ursula. |
+--------------------------+---------------------------------------------------------------------+
Cloudworkers
------------
Manage worker and other staker-related operations on cloud infrastructure.
.. code:: bash
(nucypher)$ nucypher cloudworkers ACTION [OPTIONS]
**Cloudworkers Command Actions**
+----------------------+-------------------------------------------------------------------------------+
| Action | Description |
+======================+===============================================================================+
| ``up`` | Creates and deploys hosts for all active local stakers. |
+----------------------+-------------------------------------------------------------------------------+
| ``create`` | Creates and deploys the given number of hosts independent of stakes |
+----------------------+-------------------------------------------------------------------------------+
| ``add`` | Add an existing host to be managed by cloudworkers CLI tools |
+----------------------+-------------------------------------------------------------------------------+
| ``add_for_stake`` | Add an existing host to be managed for a specified local staker address |
+----------------------+-------------------------------------------------------------------------------+
| ``deploy`` | Install and run Ursula on existing managed hosts. |
+----------------------+-------------------------------------------------------------------------------+
| ``update`` | Update or manage existing installed Ursula. |
+----------------------+-------------------------------------------------------------------------------+
| ``destroy`` | Shut down and cleanup resources deployed on AWS or Digital Ocean |
+----------------------+-------------------------------------------------------------------------------+
| ``stop`` | Stop the selected nodes. |
+----------------------+-------------------------------------------------------------------------------+
| ``status`` | Prints a formatted status of selected managed hosts. |
+----------------------+-------------------------------------------------------------------------------+
| ``logs`` | Download and display the accumulated stdout logs of selected hosts |
+----------------------+-------------------------------------------------------------------------------+
| ``backup`` | Download local copies of critical data from selected installed Ursulas |
+----------------------+-------------------------------------------------------------------------------+
| ``restore`` | Reconstitute and deploy an operating Ursula from backed up data |
+----------------------+-------------------------------------------------------------------------------+
| ``list_hosts`` | Print local nicknames of all managed hosts under a given namespace |
+----------------------+-------------------------------------------------------------------------------+
| ``list_namespaces`` | Print namespaces under a given network |
+----------------------+-------------------------------------------------------------------------------+
Status
------
Echo a snapshot of live NuCypher Network metadata.
.. code:: bash
(nucypher)$ nucypher status ACTION [OPTIONS]
**Status Command Actions**
+--------------------------+---------------------------------------------------------------------+
| Action | Description |
+==========================+=====================================================================+
| ``events`` | Show events associated to NuCypher contracts. |
+--------------------------+---------------------------------------------------------------------+
| ``fee-range`` | Provide information on the global fee range. |
+--------------------------+---------------------------------------------------------------------+
| ``locked-tokens`` | Display a graph of the number of locked tokens over time. |
+--------------------------+---------------------------------------------------------------------+
| ``network`` | Overall information of the NuCypher Network. |
+--------------------------+---------------------------------------------------------------------+
| ``stakers`` | Show relevant information about stakers. |
+--------------------------+---------------------------------------------------------------------+

8
docs/source/references/networks.rst
View File

@ -19,8 +19,8 @@ Mainnet
Lynx
****
Public Long-Term Support testnet, A stable playground for network users (e.g., Alices wishing to create sharing
policies). Running on Ethereum Goerli testnet.
Public Long-Term Support testnet to provide a stable playground for network users (e.g., Alices wishing to create sharing
policies). Running on Ethereum Goerli testnet (see :ref:`lynx-testnet`).
* `NuCypherToken 0x02B50E38E5872068F325B1A7ca94D90ce2bfff63 <https://goerli.etherscan.io/address/0x02B50E38E5872068F325B1A7ca94D90ce2bfff63>`_
* `StakingEscrow (Dispatcher) 0x40Ca356d8180Ddc21C82263F9EbCeaAc6Cad7250 <https://goerli.etherscan.io/address/0x40Ca356d8180Ddc21C82263F9EbCeaAc6Cad7250>`_
@ -31,8 +31,8 @@ policies). Running on Ethereum Goerli testnet.
Ibex
****
Public testnet, intended as a playground for stakers & node operators (e.g., learning how to create and manage
stakes, setting up a node), as well as for internal development purposes. Running on Ethereun Rinkeby testnet.
Public testnet, intended as a playground for stakers and node operators (e.g., learning how to create and manage
stakes, setting up a node, as well as for internal development purposes. Running on Ethereun Rinkeby testnet (see :ref:`ibex-testnet`).
* `NuCypherToken 0x78D591D90a4a768B9D2790deA465D472b6Fe0f18 <https://rinkeby.etherscan.io/address/0x78D591D90a4a768B9D2790deA465D472b6Fe0f18>`_
* `StakingEscrow (Dispatcher) 0x6A6F917a3FF3d33d26BB4743140F205486cD6B4B <https://rinkeby.etherscan.io/address/0x6A6F917a3FF3d33d26BB4743140F205486cD6B4B>`_

52
docs/source/references/signers.rst
View File

@ -15,8 +15,8 @@ For example, external signers can be used with:
The following signers are currently supported:
#. :ref:`Hardware Wallet <signing-with-hardware>` (recommended for :ref:`Stakers <staking-guide>`)
#. :ref:`Clef <signing-with-clef>`
#. :ref:`Local Keystore <signing-with-local-keystore>` (recommended for :ref:`Workers <ursula-config-guide>`)
#. :ref:`Clef <signing-with-clef>`
.. _signing-with-hardware:
@ -39,6 +39,31 @@ A `Trezor <https://trezor.io/>`_ signer can be specified either through the CLI
API (``nucypher.blockchain.eth.signers.Signer.from_signer_uri``), using the URI ``trezor``.
.. _signing-with-local-keystore:
Signing with Local Keystore
***************************
.. important::
For operational security, the Keystore signer is not recommended for :ref:`Staker operations <staking-guide>`.
An exception can be made for testnets, but Staker operations should be performed using a hardware wallet.
Local keystore signing utilizes `eth-account <https://github.com/ethereum/eth-account>`_ to sign ethereum transactions
using local ethereum keystore files. By default on Linux, the keystore directory path is ``~/.ethereum/keystore``
(on MacOS for Rinkeby testnet, ``/Users/<username>/Library/Ethereum/rinkeby/keystore``).
Usage
+++++
Specify the local keystore signer either through the CLI (``--signer``) or API (``nucypher.blockchain.eth.signers.Signer.from_signer_uri``),
using the URI ``keystore://<PATH TO LOCAL KEYSTORE>``.
The path provided can either be a directory of keystore files or an individual keystore file. In the case of a
directory, it is scanned and each of the keystore files contained are processed.
.. _signing-with-clef:
Signing with Clef
@ -167,28 +192,3 @@ Usage
Once ``clef`` is running, specify the Clef signer either through the CLI (``--signer``) or
API (``nucypher.blockchain.eth.signers.Signer.from_signer_uri``), using the URI ``clef://<CLEF IPC PATH>``.
.. _signing-with-local-keystore:
Signing with Local Keystore
***************************
.. important::
For operational security, the Keystore signer is not recommended for :ref:`Staker operations <staking-guide>`.
An exception can be made for testnets, but Staker operations should be performed using a hardware wallet.
Local keystore signing utilizes `eth-account <https://github.com/ethereum/eth-account>`_ to sign ethereum transactions
using local ethereum keystore files. By default on Linux, the keystore directory path is ``~/.ethereum/keystore``
(on MacOS for Rinkeby testnet, ``/Users/<username>/Library/Ethereum/rinkeby/keystore``).
Usage
+++++
Specify the local keystore signer either through the CLI (``--signer``) or API (``nucypher.blockchain.eth.signers.Signer.from_signer_uri``),
using the URI ``keystore://<PATH TO LOCAL KEYSTORE>``.
The path provided can either be a directory of keystore files or an individual keystore file. In the case of a
directory, it is scanned and each of the keystore files contained are processed.

8
docs/source/staking/remote_worker_cli.rst
View File

@ -1,10 +1,10 @@
.. _managing-cloud-workers:
Remote Worker Management
========================
Cloud Worker Management
=======================
NuCypher maintains an CLI to assist with the management of multiple remote Nucypher Ursula nodes, leveraging
automation tools like Ansible and Docker.
NuCypher maintains a CLI to assist with the management of multiple Nucypher Ursula nodes deployed in the cloud,
that leverages automation tools such as Ansible and Docker.
.. code:: bash

2
docs/source/staking/stake_initialization.rst
View File

@ -246,7 +246,7 @@ bonded a Worker node to your Staker.
After initiating a stake, the staker must delegate access to a work address through *bonding*.
There is a 1:1 relationship between the roles: A Staker may have multiple substakes but only ever has one Worker at a time.
.. important:: The Worker cannot be changed for a minimum of 2 periods (48 Hours) once bonded.
.. important:: The Worker cannot be changed for a minimum of 2 periods (48 hours) once bonded.
.. code:: bash

12
docs/source/staking/stake_management.rst
View File

@ -16,13 +16,19 @@ Several administrative operations can be performed on active stakes:
+----------------------+-------------------------------------------------------------------------------+
| ``increase`` | Increase an existing stake's value |
+----------------------+-------------------------------------------------------------------------------+
| ``merge`` | Merge two stakes into one |
+----------------------+-------------------------------------------------------------------------------+
| ``remove-unused`` | Remove unused/inactive stakes |
+----------------------+-------------------------------------------------------------------------------+
| ``collect-rewards`` | Collect earned staking rewards and/or policy fees |
+----------------------+-------------------------------------------------------------------------------+
Re-staking
~~~~~~~~~~~
As your Ursula performs work, all rewards are automatically added to your existing stake to optimize earnings.
This feature, called `re-staking`, is *enabled* by default.
This feature, called `re-staking`, is **enabled** by default.
To disable re-staking:
@ -61,9 +67,9 @@ in reduced staking yield. When disabled, the stake's locked duration remains
constant and improves staking yield.
See :ref:`sub-stake-winddown` for more information.
Wind down is *disabled* by default.
Wind down is **disabled** by default.
.. note:: WorkLock participants have wind down *enabled* by default.
.. note:: WorkLock participants have wind down **enabled** by default.
To start winding down an existing stake:

13
docs/source/staking/testnet.rst
View File

@ -1,18 +1,20 @@
.. _ibex-testnet:
=============
Ibex Testnet
=============
NuCypher provides a Public testnet running on the ethereum Rinkeby testnet meant for stakers & node operators learning how to
create and manage stakes, setting up a node), as well as for internal development purposes.
NuCypher provides a public testnet running on the Ethereum Rinkeby testnet meant for stakers and node operators to learn how to
create and manage stakes, set up a node, as well as for internal development purposes.
.. attention::
Ibex Testnet NU can be obtained by joining the `Discord server <https://discord.gg/7rmXa3S>`_ and typing
Ibex Testnet NU can be obtained by joining the `Discord Server <https://discord.gg/7rmXa3S>`_ and typing
``.getfunded <YOUR_STAKER_ETH_ADDRESS>`` in the #testnet-faucet channel. Note that Rinkeby ETH is
also required to use the Ibex testnet.
also required to use the Ibex testnet, and can be obtained from its `faucet <https://faucet.rinkeby.io/>`_.
Stakers and Workers can be configured to use the ibex testnet using the command line:
Stakers and Workers can be configured to use the Ibex testnet using the command line:
.. code::
@ -22,7 +24,6 @@ Stakers and Workers can be configured to use the ibex testnet using the command
# Update an existing staker
$ nucypher stake config --network ibex --provider <RINKEBY PROVIDER URI>
# While creating a new worker
$ nucypher ursula init --network ibex --provider <RINKEBY PROVIDER URI>