Remove "Goerli testnet" from provider examples. Clarify currently allowed providers in FAQ

pull/1944/head
derekpierre 2020-04-30 20:49:05 -04:00
parent 891a028b0d
commit 8d7416dd6e
4 changed files with 29 additions and 20 deletions

View File

@ -26,7 +26,9 @@ Initialize Alice and Bob
Replace ``<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 under user ``ubuntu`` (most probably that's what you need).
- ``ipc:///home/<user>/.ethereum/geth.ipc`` - IPC Socket-based JSON-RPC server
- ``https://<host>>`` - HTTP(S)-based JSON-RPC server
- ``ws://<host>:8080`` - Websocket-based JSON-RPC server
Get Bob's Public Keys

View File

@ -116,10 +116,9 @@ Running an Ursula via CLI (Interactive)
Replace ``<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 ``ubuntu`` (default)
- ``ipc:///tmp/geth.ipc`` - Geth Development Node
- ``http://localhost:8545`` - Geth/Parity RPC-HTTP
- ``ws://0.0.0.0:8080`` - Websocket Provider
- ``ipc:///home/<user>/.ethereum/geth.ipc`` - IPC Socket-based JSON-RPC server
- ``https://<host>>`` - HTTP(S)-based JSON-RPC server
- ``ws://<host>:8080`` - Websocket-based JSON-RPC server
``<NETWORK_NAME>`` is the name of the NuCypher network domain where the node will run.

View File

@ -25,8 +25,9 @@ All ``nucypher worklock`` commands share a similar structure:
Replace ``<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 under user ``ubuntu``.
- ``ipc:///home/<user>/.ethereum/geth.ipc`` - IPC Socket-based JSON-RPC server
- ``https://<host>>`` - HTTP(S)-based JSON-RPC server
- ``ws://<host>:8080`` - Websocket-based JSON-RPC server
Show current WorkLock information
---------------------------------

View File

@ -217,7 +217,7 @@ This is **ONLY** a heuristic to ensure that your node is running correctly, it d
.. code::
Starting Ursula on xxx.xxx.xxx.xxx:9151
Connecting to gemini
Connecting to <NETWORK>
Working ~ Keep Ursula Online!
#. Ensure that your node uses the correct IP address and can be accessed via port 9151 from an outside
@ -229,9 +229,9 @@ This is **ONLY** a heuristic to ensure that your node is running correctly, it d
#. Run the following command and ensure that the various settings are correct::
nucypher status stakers
> --provider <your_geth_provider>
> --network gemini
> --staking-address <your_staker_address>
> --provider <YOUR PROVIDER URI>
> --network <NETWORK>
> --staking-address <YOUR STAKER ADDRESS>
#. Ensure that your node is listed on the `Status Monitor Page <https://status.nucypher.network>`_ (this can take a few minutes).
@ -252,9 +252,9 @@ Q: How can I check for currently available staking rewards?
Run::
nucypher status stakers
> --provider <your_geth_provider>
> --network gemini
> --staking-address <your_staker_address>
> --provider <YOUR PROVIDER URI>
> --network <NETWORK>
> --staking-address <YOUR STAKER ADDRESS>
Note that a minimum of two periods must elapse before rewards will be delivered to your wallet. For example, say we
are in Period 5 when you start staking:
@ -276,9 +276,9 @@ Q: How can I observe the settings (re-staking, winding down) for my stake?
Run::
nucypher status stakers
> --provider <your_geth_provider>
> --network gemini
> --staking-address <your_staker_address>
> --provider <YOUR PROVIDER URI>
> --network <NETWORK>
> --staking-address <YOUR STAKER ADDRESS>
Q: Can I extend the duration of my existing stake?
@ -327,9 +327,16 @@ Q: The status of my node on the status monitor seems incorrect?
Check when last your node made a commitment by running::
nucypher status stakers
> --provider <your_geth_provider>
> --network gemini
> --staking-address <your_staker_address>
> --provider <YOUR PROVIDER URI>
> --network <NETWORK>
> --staking-address <YOUR STAKER ADDRESS>
If everything looks fine, the status monitor probably just needs some time to connect to the node again to update the
node's status.
Q: What types of Ethereum web3 node providers do you support?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* IPC Socket-based JSON-RPC server e.g. ``ipc:///home/<user>/.ethereum/geth.ipc``
* HTTP(S)-based JSON-RPC server e.g. ``http://<host>>:8545``
* Websocket-based JSON-RPC server e.g. ``ws://<host>:8080``