Skip to content

Commit

Permalink
Update shimmer-firefly-governance-guide.md (#1261)
Browse files Browse the repository at this point in the history
* Update shimmer-firefly-governance-guide.md

Grammar, spelling and Make the guide generic for IOTA and Shimmer

* Update sidebars.ts

rename, remove Shimmer

* Rename shimmer-firefly-governance-guide.md to firefly-governance-guide.md

changed file title

* Fix broken links

* add governance image

* change image

* change image

* change image

* change image

---------

Co-authored-by: Dr-Electron <[email protected]>
  • Loading branch information
Phyloiota and Dr-Electron authored Oct 22, 2023
1 parent fa2c4ea commit f7858f7
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 21 deletions.
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
---
title: Governance Guide to Shimmer Firefly
description: A step-by-step guide to the Governance functionality in Shimmer Firefly
image: /img/learn/governance/shimmer-gov.png
title: Governance Guide to Firefly
description: A step-by-step guide to the Governance functionality in the Firefly Wallet
image: /img/learn/governance/iota_governance.png
keywords:
- guide
- Firefly
- Shimmer
- IOTA
- Governance
---

With the newest release, Shimmer Firefly enables decentralized voting with SMR tokens directly in the Wallet.
The [Firefly Wallet](https://firefly.iota.org/) includes decentralized Governance voting with SMR or IOTA tokens directly in the Wallet.

**Here is a step-by-step guide on how you use this new feature.**
**Here is a step-by-step guide on how you use this feature.**

### 1. Access the Governance Dashboard in the side menu

Expand All @@ -23,7 +24,7 @@ With the newest release, Shimmer Firefly enables decentralized voting with SMR t

**- Your Voting Power**

- Derived directly from your SMR tokens, every SMR token gives you 1 Voting Power
- Derived directly from your SMR or IOTA tokens, every IOTA or Shimmer Token translates to 1 voting Power in its respective network

**- Governance Details**

Expand All @@ -36,7 +37,7 @@ With the newest release, Shimmer Firefly enables decentralized voting with SMR t
**- Proposal overview**

- Displays all proposals the node has in its database
- default sorted by phases: Starting with "announcement", then "voting open", then "counting," then "closed". You can filter and sort proposals by type, phase, participation and order or search for proposals by name.
- default sorted by phases: Starting with "announcement", then "voting open", then "counting," then "closed". You can filter and sort proposals by type, phase, participation, and order or search for proposals by name.

![Firefly-governance-overview](/img/learn/governance/Firefly-gov2.png)

Expand All @@ -53,18 +54,18 @@ To vote on a proposal, you must tell the Wallet how many SMR tokens you want to

![confirm-voting-power](/img/learn/governance/Firefly-gov4.png)

The amount of SMR tokens you choose for governance are now transferred to a separate output and can only be used for governance now. If you want to send them out of your Wallet, or use them for anything else you will have to remove them from the governance output by reducing your voting power.
The amount of SMR/IOTA tokens you choose for governance are now transferred to a separate output and can only be used for governance now. If you want to send them out of your Wallet or use them for anything else, you must remove them from the governance output by reducing your voting power.

:::info Token Ownership

The voting output belongs to your own private key! By voting, you are never losing control over your Tokens. The voting output is just a specified output that is only used for your governance activities but the tokens never leave your control in this process.
The voting output belongs to your private key! By voting, you are never losing control over your Tokens. The voting output is just a specified output only used for your governance activities, but the tokens never leave your control in this process.

:::

### 4. Vote on a proposal

- You can only vote on proposals in the "voting open" or "counting" phase.
- A Proposal can consist of several questions, and every question can have up to 10 answers. Answers can have additional information shown in a tooltip accessible by clicking on the little "**I**" at the end of the bar.
- A Proposal can consist of several questions, and every question can have up to 10 answers. Answers can have additional information shown in a tooltip accessible by clicking the little "**I**" at the end of the bar.

![select-proposal](/img/learn/governance/Firefly-gov5.png)

Expand All @@ -74,7 +75,7 @@ The voting output belongs to your own private key! By voting, you are never losi

![vote-on-proposal](/img/learn/governance/Firefly-gov6.png)

Voting on proposlas as long as they are only in the "voting open" phase does not yet lead to counting of votes. In this phase, you can always change your opinion without any outcome on the final amount of votes counted for you.
Voting on proposlas as long as they are only in the "voting open" phase does not yet lead to counting votes. In this phase, you can always change your opinion without any outcome on the final amount of votes counted for you.
Once a proposal has reached the "counting" phase, the Tokens you have allocated for governance are counted and accumulated for the answers you choose every 5 seconds. This means the counted votes for you increase every 5 seconds by the amount of voting power you have allocated.

![show-voted](/img/learn/governance/Firefly-gov7.png)
Expand All @@ -85,7 +86,7 @@ Once you have voted on proposals, the Governance Dashboard will indicate in whic

### 5. Change / reduce voting power

Once you are actively voting on proposals but wish to either free some tokens to use ot for something else. or add more tokens to your voting power, you can easily do this by using the "Manage voting power function" again.
Once you actively vote on proposals but wish to either free some tokens to use for something else. or add more tokens to your voting power, you can easily do this by using the "Manage voting power function" again.

- Reduce your Voting power using the slider or type it in the field

Expand All @@ -95,14 +96,14 @@ Once you are actively voting on proposals but wish to either free some tokens to

![confirm-reduce](/img/learn/governance/Firefly-gov10.png)

- And because reducing the voting power stopps your current votes, revote with one click on all proposals with the new voting power.
- Because reducing the voting power stops your current votes, revote with one click on all proposals with the new voting power.

![revote-voting-power](/img/learn/governance/Firefly-gov11.png)

### 6. Adding custom community proposals to Firefly

To enable decentralized governance, you can also use Firefly to vote on proposlas that are not added to the official IOTA Foundation nodes to which the Firefly Wallet connects by default.
Every community can theoretically use the Firefly Wallet and ask SMR token holders to decide on proposals. Therefore those proposals need to be added to a Hornet node (via the hornet dashboard), and then the user can tell Firefly to display this proposal to enable voting on it.
Every community can theoretically use the Firefly Wallet and ask SMR token holders to decide on proposals. Therefore, those proposals need to be added to a Hornet node (via the Hornet dashboard), and then the user can tell Firefly to display this proposal to enable voting on it.

- Click on "Add Proposals"

Expand All @@ -112,4 +113,4 @@ Add the URL of the node you want Firefly to connect to and the proposal ID of th

![add-cusom-event](/img/learn/governance/Firefly-gov13.png)

- Click confirm. Firefly will now connect to this custom node, load the proposal information and add the proposal to the dashboard.
- Click confirm. Firefly will now connect to this custom node, load the proposal information, and add the proposal to the dashboard.
4 changes: 2 additions & 2 deletions docs/learn/governance/governance-intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: An Overview and Introduction to the Governance of Shimmer and IOTA
image: /img/learn/governance/shimmer-gov.png
image: /img/learn/governance/iota_governance.png
keywords:
- Introduction
- Shimmer
Expand Down Expand Up @@ -75,7 +75,7 @@ This feature consists of 2 components:

A detailed technical description of this voting functionality can be found in the [Governance - tech](./governance-tech.md) section of the Wiki.

A detailed description of how to participate in Governance votes can be found in the [Firefly Governance Guide](./shimmer-firefly-governance-guide.md)
A detailed description of how to participate in Governance votes can be found in the [Firefly Governance Guide](./firefly-governance-guide.md)

### Governance Resources

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/governance/governance-scope.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Governance Scope
description: Defines exactly in which areas of the Shimmer network governance processes are currently implemented
image: /img/learn/governance/shimmer-gov.png
image: /img/learn/governance/iota_governance.png
keywords:
- Shimmer
- Governance
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/governance/governance-tech.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ In contrast to the earlier voting system developed, the current version does not

- Create a governance event following the [specifications for participation events](https://github.com/iota-community/treasury/blob/main/specifications/hornet-participation-plugin.md)
- Add this governance event to a Hornet node with the [INX Participation Plugin](/hornet/2.0/inx-plugins/participation/welcome)
- Add this governance event to the Firefly wallet by connecting the Wallet to a node that carries this event and use the [“add event”](./shimmer-firefly-governance-guide.md#6-adding-custom-community-proposals-to-firefly) function in the Governance section
- Add this governance event to the Firefly wallet by connecting the Wallet to a node that carries this event and use the [“add event”](./firefly-governance-guide.md#6-adding-custom-community-proposals-to-firefly) function in the Governance section
- Vote on this event with tokens

Community members, projects, or other ecosystem participants can create governance events and invite the token holders to participate in such votes.
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/governance/the-shimmer-governance-framework.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: The Shimmer Governance Framework
description: This is the full specification for all governance processes in the Shimmer network. Detailed rules and procedures are defined here.
image: /img/learn/governance/shimmer-gov.png
image: /img/learn/governance/iota_governance.png
keywords:
- Specification
- Shimmer
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ module.exports = {
'governance/the-shimmer-governance-framework',
'governance/shimmer-community-grant-committee',
'governance/governance-scope',
'governance/shimmer-firefly-governance-guide',
'governance/firefly-governance-guide',
],
},
'glossary',
Expand Down
Binary file added static/img/learn/governance/iota_governance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f7858f7

Please sign in to comment.