History

Kieran Prasch 18d3d6e0a5 removed federated finnegan's wake demo script.		2022-12-07 11:29:26 +00:00
..
README.md	ibex -> tapir in docs and demos	2022-11-02 13:30:42 +00:00
finnegans-wake-demo-l2.py	Remove Ibex and Oryx from nucypher	2022-11-02 13:25:43 +00:00
finnegans-wake-excerpt.txt	Respond to RFCs in PR #2560	2021-02-13 18:35:31 -08:00

README.md

Finnegan's Wake Demo

This illustrates Alice sharing data with Bob over the Threshold Network using proxy re-encryption (PRE), without revealing private keys to intermediary entities. For more detailed information see the official documentation.

There are two version of the example, one using the decentralized network (ethereum/polygon), and a federated example using a local network.

Decentralized Network Demo

First, configure the demo by making exporting environment variables with your provider and wallet details.

export DEMO_L1_PROVIDER_URI=<YOUR ETH PROVIDER URL>
export DEMO_L2_PROVIDER_URI=<YOUR POLYGON PROVIDER URL>
export DEMO_L2_WALLET_FILEPATH=<YOUR WALLET FILEPATH>
export DEMO_ALICE_ADDRESS=<YOUR ALICE ETH ADDRESS>

Alternatively you can use the provided .env.template file by making a copy named .env and adding your provider and wallet details. To set the variables in your current session run: export $(cat .env | xargs)

Optionally, you can change the network the demo is running on by changing the value of L1_NETWORK and L2_NETWORK. If you change these values be sure to also change L1_PROVIDER_URI and L2_PROVIDER_URI accordingly.

Available options for L1_NETWORK are tapir or mainnet. Available options for L2_NETWORK are mumbai or mainnet

Ensure Alice's account has a bit of MATIC on polygon to pay for the policy.

Subsequently, to execute the demo run: python3 finnegans-wake-demo-l2.py

For more detailed logging change the value of LOG_LEVEL to 'debug'.