Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 40 additions & 7 deletions source/mainnet/docs/voting/guardians.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<export-key>`.

.. image:: ../images/voting/guardian-await-key.png
Expand All @@ -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
Expand Down Expand Up @@ -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
=================

Expand All @@ -179,21 +212,21 @@ Windows

Uninstall the app as you uninstall all apps on Microsoft.

Delete the folder ``C:\Users\<user>\AppData\com.concordium.guardian.<network>.<contract-index>.<contract-subindex>`` to remove all guardian keys.
Delete the folder ``C:\Users\<user>\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.<network>.<contract-index>.<contract-subindex>`` where ``~`` represents either ``$HOME`` or ``/Users/<username>`` to remove all guardian keys.
Delete the folder ``~/Library/Application Support/com.concordium.guardian`` where ``~`` represents either ``$HOME`` or ``/Users/<username>`` 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.<network>.<contract-index>.<contract-subindex>``
- ``$HOME/.local/share/com.concordium.guardian.<network>.<contract-index>.<contract-subindex>``
- ``$XDG_DATA_HOME/com.concordium.guardian``
- ``$HOME/.local/share/com.concordium.guardian``

Delete this folder to remove all guardian keys.