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

Removal of `NuCypher Network` references in the docs.

pull/2870/head
derekpierre 2022-02-16 12:21:59 -05:00
parent a5b43ba9b5
commit 7ddb3b7a7c
9 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/application_development/cli_examples.rst
View File

@ -5,7 +5,7 @@ Overview
--------
This guide is an example of NuCypher's decentralized network allowing Alice to share a secret
with Bob using the NuCypher Network via the ``nucypher`` CLI. It is analogous to the ``python`` example
with Bob using the PRE Application on the Threshold Network via the ``nucypher`` CLI. It is analogous to the ``python`` example
in :doc:`/application_development/getting_started`.
.. note::

8
docs/source/application_development/getting_started.rst
View File

@ -179,11 +179,11 @@ After generating a keystore, any future usage can decrypt the keys from the disk
# Instantiate Alice
alice = Alice(
keystore=keystore, # NuCypher Keystore
known_nodes=[ursula], # Peers (Optional)
signer=signer, # Alice Wallet
keystore=keystore, # NuCypher Keystore
known_nodes=[ursula], # Peers (Optional)
signer=signer, # Alice Wallet
eth_provider_uri=<RPC ENDPOINT>, # Ethereum RPC endpoint
domain='lynx' # NuCypher network (mainnet, lynx, ibex)
domain='lynx' # PRE Application network (mainnet, lynx, ibex)
)
# Alice is identified by her ethereum address

2
docs/source/application_development/local_fleet_demo.rst
View File

@ -8,7 +8,7 @@ Overview
--------
To aid in application development, a network of federated Ursulas can be run locally. These Ursulas do not utilize
blockchain functionality, but afford the same cryptographic capabilities of the public NuCypher network.
blockchain functionality, but afford the same cryptographic capabilities of the public PRE nodes on the Threshold Network.
.. note::

8
docs/source/application_development/web_development.rst
View File

@ -329,7 +329,7 @@ For a full list of CLI options, run:
| | | |_| | | | |_( (/ /| |
|_| \___/|_| \___)____)_|
the Pipe for nucypher network operations
the Pipe for PRE Application network operations
Network: <NETWORK NAME>
Provider: ...
@ -351,7 +351,7 @@ For a full list of CLI options, run:
| | | |_| | | | |_( (/ /| |
|_| \___/|_| \___)____)_|
the Pipe for nucypher network operations
the Pipe for PRE Application network operations
Network: <NETWORK NAME>
Provider: ...
@ -371,7 +371,7 @@ For a full list of CLI options, run:
| | | |_| | | | |_( (/ /| |
|_| \___/|_| \___)____)_|
the Pipe for nucypher network operations
the Pipe for PRE Application network operations
Network: <NETWORK NAME>
Provider: ...
@ -392,7 +392,7 @@ For a full list of CLI options, run:
| | | |_| | | | |_( (/ /| |
|_| \___/|_| \___)____)_|
the Pipe for nucypher network operations
the Pipe for PRE Application network operations
Network: <NETWORK NAME>
Provider: ...

2
docs/source/demos/finnegans_wake_demo.rst
View File

@ -15,7 +15,7 @@ without revealing data keys to intermediary entities.
+------+-----------+----------------------------------------------------------------------------------------------+
| Step | Character | Operation |
+======+===========+==============================================================================================+
| 1 | Alice | Alice sets a Policy on the NuCypher network (2-of-3) and grants access to Bob |
| 1 | Alice | Alice sets a Policy on the PRE Nodes in the Threshold Network and grants access to Bob |
+------+-----------+----------------------------------------------------------------------------------------------+
| 2 | Alice | Label and Alice's public key provided to Bob |
+------+-----------+----------------------------------------------------------------------------------------------+

4
docs/source/glossary.rst
View File

@ -48,8 +48,8 @@ Glossary
Public-key encryption.
Porter
A web service that is the conduit between applications (platform-agnostic) and the nucypher network, that
performs nucypher protocol operations on behalf of Alice and Bob.
A web service that is the conduit between applications (platform-agnostic) and the PRE nodes on the Threshold network, that
performs ``nucypher`` protocol operations on behalf of Alice and Bob.
PRE
Proxy re-encryption.

2
docs/source/index.rst
View File

@ -50,7 +50,7 @@ How does it Work?
1. Alice, the data owner, grants access to her encrypted data to
anyone she wants by creating a policy and uploading it to
the NuCypher network.
the PRE Application on the Threshold Network.
2. Alice gets information about the group of ``n`` PRE nodes (Ursulas) associated
with the policy, which are nodes on the Threshold network providing the PRE service. Each Ursula provides their encrypting key, and Alice creates

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

@ -100,7 +100,7 @@ Nucypher also provides web integration. See :ref:`web-development`.
Running a Node
--------------
*These are questions related to running a node on the NuCypher network.*
*These are questions related to running a PRE node on the Threshold Network.*
Q: What kind of token is T?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -179,7 +179,7 @@ Using docker :ref:`Docker <run-ursula-with-docker>`
Q: When installing on Docker, what do I input for <NETWORK NAME>?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use ``mainnet`` if you want to interact with the main NuCypher network,
Use ``mainnet`` if you want to interact with the PRE Application network,
and either ``lynx`` or ``ibex`` in case you want to use one of our testnets.
Go :ref:`here <faq-testnet>` to read more about the difference between both testnets.

2
nucypher/utilities/porter/porter.py
View File

@ -57,7 +57,7 @@ class Porter(Learner):
| | | |_| | | | |_( (/ /| |
|_| \___/|_| \___)____)_|
the Pipe for nucypher network operations
the Pipe for PRE Application network operations
"""
APP_NAME = "Porter"