From 7ddb3b7a7cb0daf38ac7cc25431bbc186ef0a725 Mon Sep 17 00:00:00 2001 From: derekpierre Date: Wed, 16 Feb 2022 12:21:59 -0500 Subject: [PATCH] Removal of `NuCypher Network` references in the docs. --- docs/source/application_development/cli_examples.rst | 2 +- docs/source/application_development/getting_started.rst | 8 ++++---- docs/source/application_development/local_fleet_demo.rst | 2 +- docs/source/application_development/web_development.rst | 8 ++++---- docs/source/demos/finnegans_wake_demo.rst | 2 +- docs/source/glossary.rst | 4 ++-- docs/source/index.rst | 2 +- docs/source/support/faq.rst | 4 ++-- nucypher/utilities/porter/porter.py | 2 +- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/source/application_development/cli_examples.rst b/docs/source/application_development/cli_examples.rst index dbf95fc65..751b86502 100644 --- a/docs/source/application_development/cli_examples.rst +++ b/docs/source/application_development/cli_examples.rst @@ -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:: diff --git a/docs/source/application_development/getting_started.rst b/docs/source/application_development/getting_started.rst index 915cedd1c..ebb7cb3e4 100644 --- a/docs/source/application_development/getting_started.rst +++ b/docs/source/application_development/getting_started.rst @@ -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=, # 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 diff --git a/docs/source/application_development/local_fleet_demo.rst b/docs/source/application_development/local_fleet_demo.rst index 7b72bae65..21a735a8e 100644 --- a/docs/source/application_development/local_fleet_demo.rst +++ b/docs/source/application_development/local_fleet_demo.rst @@ -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:: diff --git a/docs/source/application_development/web_development.rst b/docs/source/application_development/web_development.rst index 3293dd6d3..4285475f9 100644 --- a/docs/source/application_development/web_development.rst +++ b/docs/source/application_development/web_development.rst @@ -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: 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: 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: 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: Provider: ... diff --git a/docs/source/demos/finnegans_wake_demo.rst b/docs/source/demos/finnegans_wake_demo.rst index 80d0f9782..7eb5e6f3e 100644 --- a/docs/source/demos/finnegans_wake_demo.rst +++ b/docs/source/demos/finnegans_wake_demo.rst @@ -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 | +------+-----------+----------------------------------------------------------------------------------------------+ diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 7621b4351..533b93987 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -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. diff --git a/docs/source/index.rst b/docs/source/index.rst index 29b039e38..f7491c873 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 diff --git a/docs/source/support/faq.rst b/docs/source/support/faq.rst index 939f3cb35..968eecdcd 100644 --- a/docs/source/support/faq.rst +++ b/docs/source/support/faq.rst @@ -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 ` Q: When installing on Docker, what do I input for ? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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 ` to read more about the difference between both testnets. diff --git a/nucypher/utilities/porter/porter.py b/nucypher/utilities/porter/porter.py index 9082853fd..b904caf69 100644 --- a/nucypher/utilities/porter/porter.py +++ b/nucypher/utilities/porter/porter.py @@ -57,7 +57,7 @@ class Porter(Learner): | | | |_| | | | |_( (/ /| | |_| \___/|_| \___)____)_| -the Pipe for nucypher network operations +the Pipe for PRE Application network operations """ APP_NAME = "Porter"