diff --git a/source/mainnet/docs/images/voting/guardian-connect.png b/source/mainnet/docs/images/voting/guardian-connect.png new file mode 100644 index 0000000000..714ffe52e3 Binary files /dev/null and b/source/mainnet/docs/images/voting/guardian-connect.png differ diff --git a/source/mainnet/docs/images/voting/guardian-reconfigure.png b/source/mainnet/docs/images/voting/guardian-reconfigure.png new file mode 100644 index 0000000000..d2930bfe9f Binary files /dev/null and b/source/mainnet/docs/images/voting/guardian-reconfigure.png differ diff --git a/source/mainnet/docs/voting/guardians.rst b/source/mainnet/docs/voting/guardians.rst index 5fa9775f28..2b9d1a49dc 100644 --- a/source/mainnet/docs/voting/guardians.rst +++ b/source/mainnet/docs/voting/guardians.rst @@ -25,13 +25,26 @@ Setup Before the election opens, the guardians must use the Guardian app to create their key pairs, register encrypted shares, and generate their secret key share to be used to decrypt the tally after the election. -Generate guardian keys ----------------------- +Connect to election contract +---------------------------- -Before the election opens, the guardians must use the Guardian app to generate a pre-key. +When the election contract has been initialized, the guardians must connect to the election contract using the Guardian app. This is done in the following sequence of steps: #. Open the Guardian app. +#. Specify the election target, consisting of a Concordium network ("mainnet" or "testnet" from the dropdown) and contract index, which is a positive whole number specified in the input field. + + .. image:: ../images/voting/guardian-connect.png + :alt: connect to election contract dialog + :width: 100% + +#. Click **Connect** to connect to the election contract. + +Connect your account +-------------------- + +The guardian app will sign the guardian transactions and submit them to the chain. For this, it needs the signing key of the account that is registered as a guardian in the smart contract. + #. To connect your account to the Guardian app, you must add your export file for your private account keys. For information about how to generate an export file, see :ref:`Export a private key`. .. image:: ../images/voting/guardian-await-key.png @@ -44,6 +57,11 @@ Before the election opens, the guardians must use the Guardian app to generate a :alt: password dialog :width: 100% +Generate guardian keys +---------------------- + +Before the election opens, the guardians must use the Guardian app to generate a pre-key. + #. Click **Generate guardian key** to create your secret key and register your public key in the election smart contract. .. image:: ../images/voting/guardian-generate-keys.png @@ -169,6 +187,21 @@ After all guardians have registered decryption proofs, the decryption is shown a :alt: dialog shown when awaiting other guardians :width: 100% +Reconfigure the app +=================== + +In the case of a reset of the election, the guardian app must be reconfigured. This can be done through the **Settings** menu. + +The simplest way to reconfigure the app to target the new election is to click **Set Election Target** and update the network and contract index. + + .. image:: ../images/voting/guardian-reconfigure.png + :alt: reconfigure guardian app menu + :width: 100% + +.. note:: + + On Windows/Linux, it might be required to press **Alt** on your keyboard to bring up the application menu where the "Settings" menu is available. + Uninstall the app ================= @@ -179,21 +212,21 @@ Windows Uninstall the app as you uninstall all apps on Microsoft. -Delete the folder ``C:\Users\\AppData\com.concordium.guardian...`` to remove all guardian keys. +Delete the folder ``C:\Users\\AppData\com.concordium.guardian`` to remove all guardian keys. MacOS ----- Uninstall the app as you uninstall all apps on MacOS. -Delete the folder ``~/Library/Application Support/com.concordium.guardian...`` where ``~`` represents either ``$HOME`` or ``/Users/`` to remove all guardian keys. +Delete the folder ``~/Library/Application Support/com.concordium.guardian`` where ``~`` represents either ``$HOME`` or ``/Users/`` to remove all guardian keys. Linux ----- On linux, the application data is stored in one of two places depending on your system: -- ``$XDG_DATA_HOME/com.concordium.guardian...`` -- ``$HOME/.local/share/com.concordium.guardian...`` +- ``$XDG_DATA_HOME/com.concordium.guardian`` +- ``$HOME/.local/share/com.concordium.guardian`` Delete this folder to remove all guardian keys.