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

Lynx-based Finnegans's wake demo documentation mentions.

pull/2560/head
Kieran Prasch 2021-02-12 23:33:56 -08:00
parent 289078191d
commit c1eed47459
2 changed files with 41 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -31,6 +31,10 @@ without revealing data keys to intermediary entities.
+------+-----------+----------------------------------------------------------------------------------------------+
There are two version of the example, one federated example using a local federated network
and another example using the nucypher application development tesnet on Goerli: "Lynx".
Install NuCypher
----------------
@ -45,32 +49,34 @@ Acquire the ``nucypher`` application code and install the dependencies:
(nucypher-venv)$ cd nucypher
(nucypher-venv)$ pip install -e .
Federated Demo
--------------
Run a fleet of federated Ursulas
--------------------------------
Run the local fleet of federated Ursulas in a separate terminal.
This provides a network of 12 federated Ursulas.
First run the local federated network:
.. code::
(nucypher)$ python examples/run_demo_ursula_fleet.py
python ../run_demo_ursula_fleet.py
Download the Book Text
----------------------
For your convenience we have provided a bash script to acquire the "Finnegan's Wake" text. However,
feel free to use any text of your choice, as long you you edit the demo code accordingly.
To run the script from the ``examples/finnegans_wake_demo`` directory:
Then run the demo:
.. code::
(nucypher)$ ./download_finnegans_wake.sh
python finnegans-wake-demo-federated.py
Run the Demo
---------------
Testnet Demo
------------
After acquiring a text file to re-encrypt, execute the demo from the ``examples/finnegans_wake_demo`` by running:
First, configure the demo. Be sure tat alice's address has some Goerli ETH.
.. code::
(nucypher)$ python finnegans-wake-demo.py
export DEMO_PROVIDER_URI=<GOERLI RPC ENDPOINT>
export DEMO_ALICE_ETH_ADDRESS=<ETH ADDRESS>
export DEMO_SIGNER_URI=keystore://<PATH TO KEYSTORE>
Then run the demo:
.. code::
python finnegans-wake-demo-testnet.py

23
examples/finnegans_wake_demo/README.md
View File

@ -1,4 +1,4 @@
# Ursula exchange example over local network
# Finnegan's Wake Demo
This illustrates Alice sharing data with Bob over the NuCypher network using proxy re-encryption,
without revealing private keys to intermediary entities.
@ -11,10 +11,25 @@ without revealing private keys to intermediary entities.
5. Bob receives and reconstructs the Enrico from Policy public key and Enrico public key
6. Bob retrieves the original message from Enrico and MessageKit
There are two version of the example, one federated example using a local network
and another example using the nucypher application development tesnet: Lynx.
### Run a fleet of federated Ursulas
### Federated Demo
First run the local federated network:
`python ../run_demo_ursula_fleet.py`
Then run the demo:
`python finnegans-wake-demo-federated.py`
### Run
`python finnegans-wake-demo.py`
### Testnet Demo
First, configure the demo. Be sure tat alice's address has some Goerli ETH.
```bash
export DEMO_PROVIDER_URI=<GOERLI RPC ENDPOINT>
export DEMO_ALICE_ETH_ADDRESS=<ETH ADDRESS>
export DEMO_SIGNER_URI=keystore://<PATH TO KEYSTORE>
```
Then run the demo:
`python finnegans-wake-demo-testnet.py`