Ursula Configuration Guide¶
NuCypher staking operations are divided into two roles “Staker” and “Worker” - This Guide is for Workers.
Worker - (aka “Ursula”) Active network participant, Carries out re-encryption work orders.
The Worker is the bonded delegate of a Staker and an active network node. Workers must remain online to provide uninterrupted re-encryption services on-demand. Each staking account or Staker is bonded to exactly one Worker. The worker’s ethereum account must remain unlocked to send automated work confirmation transactions and have enough ether to pay for transaction gas; however, it is not necessary (and potentially risky) to hold NU tokens on a worker’s account for any reason.
Initiate a new stake ( (see NuCypher Staking Guide))
Run an ethereum node on the Worker’s machine (geth, parity, etc.)
Bond the Worker to a Staker (using the worker address)
nucypheron Worker node
Initialize a Worker node [Ursula Configuration Guide]
Run the Worker, and keep it online [Ursula Configuration Guide]!
1. Running an Ethereum node for Ursula¶
Run Geth with Docker¶
Run a local geth node on Görli using volume bindings:
docker run -it -p 30303:30303 -v ~/.ethereum:/root/.ethereum ethereum/client-go --goerli
For alternate geth configuration via docker see: Geth Docker Documentation.
Run Geth with the CLI¶
$ geth --goerli --nousb ... (geth log output)
Create a software-controlled account in geth in another console:
$ geth attach ~/.ethereum/goerli/geth.ipc > personal.newAccount(); > eth.accounts ["0xc080708026a3a280894365efd51bb64521c45147"]
The new account is
0xc080708026a3a280894365efd51bb64521c45147 in this case.
Fund this account with Görli testnet ETH! https://goerli-faucet.slock.it/.
2. Configure and Run Ursula¶
Ursula / Worker Requirements¶
A fully synced ethereum node or “provider” is required for the worker to read and write to nucypher’s smart contracts.
In order to be a successful Ursula operator, you will need a machine (physical or virtual) which can be kept online consistently without interruption and is externally accessible via TCP port 9151. The well-behaved worker will accept work orders for re-encryption at-will, and be rewarded as a result.
It is assumed that you already have nucypher installed, have initiated a stake, and bonded a worker.
Running an Ursula via CLI (Interactive)¶
(nucypher)$ nucypher ursula init --provider <YOUR PROVIDER URI> --poa --staker-address <YOUR STAKER ADDRESS> --network <NETWORK_NAME>
<YOUR PROVIDER URI> with a valid node web3 node provider string, for example:
ipc:///home/ubuntu/.ethereum/goerli/geth.ipc- Geth Node on Görli testnet running with user
ipc:///tmp/geth.ipc- Geth Development Node
http://localhost:8545- Geth/Parity RPC-HTTP
ws://0.0.0.0:8080- Websocket Provider
<YOUR STAKER ADDRESS> is the address you’ve staked from when following the NuCypher Staking Guide.
<NETWORK_NAME> is the name of the NuCypher network domain where the node will run.
If you’re participating in NuCypher’s incentivized testnet, this name is
If you’re a preallocation user, recall that you’re using a contract to stake.
<YOUR STAKER ADDRESS> with the contract address.
If you don’t know this address, you’ll find it in the preallocation file.
Create a password when prompted
Enter a password to encrypt your keyring: <YOUR PASSWORD HERE>
Run the Ursula!
(nucypher)$ nucypher ursula run --interactive
Verify Ursula Blockchain Connection (Interactive)
This will drop your terminal session into the “Ursula Interactive Console” indicated by the
Verify that the node setup was successful by running the
Ursula >>> status
To view a list of known Ursulas, execute the
Ursula >>> known_nodes
You can also view your node’s network status webpage by navigating your web browser to
Ensure that this URL can be accessed publicly: it means that your node can be seen by other NuCypher nodes.
Since Ursulas self-sign TLS certificates, you may receive a warning from your web browser.
To stop your node from the interactive console and return to the terminal session:
Ursula >>> stop
Running an Ursula with Docker¶
Assuming geth is running locally on goerli, configure and run an Ursula using port and volume bindings:
export NUCYPHER_KEYRING_PASSWORD=<YOUR KEYRING_PASSWORD> export NUCYPHER_WORKER_ETH_PASSWORD=<YOUR WORKER ETH ACCOUNT PASSWORD> # Interactive Ursula-Worker Initialization docker run -it -v ~/.ethereum:/root/.ethereum -v ~/.local/share/nucypher:/root/.local/share/nucypher -e NUCYPHER_KEYRING_PASSWORD nucypher:latest nucypher ursula init --provider file:///root/.ethereum/goerli/geth.ipc --staker-address <YOUR STAKING ADDRESS> --network <NETWORK_NAME> # Daemonized Ursula docker run -d -v ~/.ethereum:/root/.ethereum -v ~/.local/share/nucypher:/root/.local/share/nucypher -p 9151:9151 -e NUCYPHER_KEYRING_PASSWORD -e NUCYPHER_WORKER_ETH_PASSWORD nucypher/nucypher:latest nucypher ursula run
<YOUR STAKING ADDRESS> is the address you’ve staked from when following the NuCypher Staking Guide.