NuCypher Quickstart


Install NuCypher

$ pip3 install -U nucypher

Run a Federated-Only Development Ursula

$ nucypher ursula run --dev --federated-only

Configure a Persistent Ursula

$ nucypher ursula init --federated-only

Run a Persistent Ursula

$ nucypher ursula run --network <NETWORK_DOMAIN> --teacher <SEEDNODE_URI> --federated-only

Replace <NETWORK_DOMAIN> with the network domain and <SEEDNODE_URI> with the URI of a node running on that network domain you want to connect to (for example or 0xdeadbeef@

If you’re connecting to the devnet, you should use --network devnet --teacher

Run a Geth-Connected Development Ursula

Run a local geth node in development mode:

$ geth --dev

Run a local development Ursula connected to the geth node

$ nucypher ursula run --dev --provider ipc:///tmp/geth.ipc --checksum-address <GETH_DEV_ADDRESS>

Replace <GETH_DEV_ADDRESS> with the geth node’s public checksum address.