Go to file

Kieran Prasch 1eabacab7c Title touchups for NuFT Guide		2019-01-25 11:01:37 -08:00
.circleci	Removing requirements file lock matching check for now.	2019-01-22 17:04:23 -05:00
deploy	Bite-sized playbook for ursula provisioning; Includes latest API compadibilty; Install via pip; Deprecate stale provisioning playbooks.	2019-01-21 12:32:28 -08:00
docs	Title touchups for NuFT Guide	2019-01-25 11:01:37 -08:00
examples	Remove stale demo files	2019-01-21 15:17:34 -08:00
nucypher	Autodoc most nucypher modules to extract docstrings; Includes Index.	2019-01-25 11:01:37 -08:00
scripts	Include missing nicknames in package data	2018-11-09 09:29:12 -08:00
tests	No longer need to pass the status template around.	2019-01-22 17:04:23 -05:00
.bumpversion.cfg	Good Catch!	2018-11-05 17:31:06 +01:00
.coveragerc	add coveragrc	2018-06-25 15:34:15 -07:00
.coveralls.yml	Try on some coveralls	2018-12-03 14:42:48 -08:00
.gitignore	Respond to RFCs in PR #617	2018-12-19 08:43:33 -08:00
LICENSE	Use conventional top-level package structures	2018-11-09 07:43:31 -08:00
Pipfile	Update dependencies and locks	2019-01-25 10:45:38 -08:00
Pipfile.lock	Update dependencies and locks	2019-01-25 10:45:38 -08:00
README.md	Readme Updates, Include Whitepapers, Borrow language from Website	2019-01-25 11:01:37 -08:00
dev-requirements.txt	Update dependencies and locks	2019-01-25 10:45:38 -08:00
mypy.ini	Tone-down mypy even more	2018-09-21 11:43:07 -07:00
pytest.ini	Test results were not captured by CircleCI. Fixed.	2019-01-05 00:54:34 +01:00
requirements.txt	Update dependencies and locks	2019-01-25 10:45:38 -08:00
setup.cfg	Extrapolate more testing steps for CI workflows; Skip publication steps (preversion).	2018-12-05 16:16:59 -08:00
setup.py	Update extras to match incoming documentation.	2019-01-25 10:51:25 -08:00

README.md

NuCypher

A proxy re-encryption network to empower privacy in decentralized systems

Website https://www.nucypher.com/
GitHub https://www.gihub.com/nucypher/nucypher

.. image:: https://circleci.com/gh/nucypher/nucypher/tree/master.svg?style=svg :target: https://circleci.com/gh/nucypher/nucypher/tree/master

.. image:: https://coveralls.io/repos/github/nucypher/nucypher/badge.svg?branch=master :target: https://coveralls.io/github/nucypher/nucypher?branch=master

NuCypher Proxy Re-encryption Network

Alice, the data owner, encrypts data with her public key and uploads it to IPFS, Swarm, S3, or any supported storage layer. To delegate access to valid recipients, she creates and uploads re-encryption keys to the NuCypher network.
Ursula, a miner, receives the re-encryption keys and stands ready to re-key data. She provides this service in exchange for payment in fees and block rewards. The NuCypher network and the storage layer never have access to Alice's plaintext data.
Bob, a valid recipient, sends an access request to the NuCypher network. If a valid re-encryption key exists and specified conditions are met, the data is re-keyed to his public key and he is able to decrypt with his private key.

Whitepapers

Network

https://www.nucypher.com/static/whitepapers/english.pdf

NuCypher - A proxy re-encryption network to empower privacy in decentralized systems Michael Egorov, David Nuñez, and MacLane Wilkison - NuCypher

Economics

https://www.nucypher.com/static/whitepapers/mining-paper.pdf

NuCypher - Mining & Staking Economics Michael Egorov, MacLane Wilkison - NuCypher

.. toctree:: :maxdepth: 2

Architecture

.. toctree:: :maxdepth: 1

architecture/contracts architecture/upgradeable_proxy_contracts

Guides

.. toctree:: :maxdepth: 2

guides/quickstart guides/federated_testnet_guide guides/installation_guide guides/contribution_guide

Demos

.. toctree:: :maxdepth: 2

demos/local_fleet_demo demos/finnegans_wake_demo demos/heartbeat_demo

API

.. toctree:: :maxdepth: 2

api/characters api/config api/crypto api/keyring api/keystore api/network api/policy

Release Notes

.. toctree:: :maxdepth: 1

release_notes/genesis_release

Indices and Tables

:ref:genindex
:ref:modindex
:ref:search