Skip to content

Latest commit

 

History

History
76 lines (45 loc) · 4.95 KB

README.md

File metadata and controls

76 lines (45 loc) · 4.95 KB
Raw

AtomOne Governance dApp

AtomOne governance dApp is a platform facilitating web-based access to AtomOne governance where users can seamlessly engage with proposals, view proposal statistics, participate in discussions as well as perform transactions to vote or deposit on proposals. Prioritizing security, AtomOne encourages the use of CLI commands for interactions with the dApp, using your wallet of choice or a public address you can gain immediate access to AtomOne's governance functionalities.

Our goal with the AtomOne governance dApp is to empower the community to effortlessly participate in these types of processes by gauging community sentiment in regards to the potential outcome of AtomOne while making it more accessible to engage, regardless of their technical expertise or background.

Usage

You can visit the deployed dApp at https://gov.atom.one/.

The following is a showcase of the existing functionality.

Homepage

The home page provides a paged view of all existing governance proposals. It shows 16 proposals per page and you can navigate across pages using the navigation arrows at the bottom right.

The default ordering is to show active proposals first (i.e. those in VOTING or DEPOSIT state) but you can use the dropdown control to switch to PASSED first, REJECTED first or FAILED first.

There is also a dropdown control to filter by proposal status altogether as well as a search box to search proposals based on Title and Description content.

In all the pages, there is a button at the top that allows you to connect your address in order to display balances or voting history as well as enable governance-related transactions. There are 2 possible options:

  • You can either simply supply your public govgen address with which the dApp can generate the appropriate CLI commands for voting and depositing txs signable by an offline computer as described here. RECOMMENDED
  • Or you can simply connect your Keplr/Leap/Cosmostation wallets and authorize and submit TXs through their familiar interface.

Proposal page

The page for a specific proposal (URL format: https://gov.atom.one/proposals/XXX where XXX is the id of the proposal) provides a view of all the proposal's details in a tabbed interface.

There is a hero component that includes the title, status, turnout, necessary quorum, expected result, and current vote tallies. It also consists of a call-to-action to Vote or Deposit (depending on the proposal status).

Under the hero component, you will find the following tabs:

  • Description (default): Contains the proposal description (also renders markdown)
  • Info: Contains the general proposal information such as proposer address, submission time, initial and total deposit, voting start time/end time and deposit end time (if appropriate) along with the messages contained in the proposal.
  • Voters: Contains an in-depth analysis of how all accounts have voted and how validators have voted including a complete breakdown of unique votes.
  • Discussions: Links to the discussion forums at Commonwealth.
    • WIP - Conversations will be integrated directly into the application as soon as Commonwealth API is available.
  • Links: Contains useful/helpful links provided by the community that add information and context relevant to the proposal. Links to the discussion forums at Commonwealth. Soon, you will be able to add helpful links to the conversation directly from the Govgen dApp through integration with the Commonwealth API.

Deposit popup

It allows you to add to a proposal's deposit to help push it into the voting period. Once you choose the amount you want to deposit you can either generate the CLI command required to create and then sign the TX using the CLI or use your connected wallet to authorize and broadcast.

Voting popup

Gives you the ability to vote on a proposal either with a single vote (YES/NO/NO WITH VETO/ABSTAIN) or a weighted vote with the weights you require for those 4 options. Like the deposit popup, you can then either generate the CLI command required to create and then sign the TX using the CLI or use your connected wallet to authorize and broadcast.

Local deployment

If you don't want to use the deployed version, you can deploy it locally. The only requirements are node v18+ and pnpm.

First, clone the repo using your favorite git tool.

Then install all packages in the repository:

pnpm i

Then copy the .env.prod or .env.dev file to .env depending on whether you want to deploy for mainnet or devnet respectively.

cp .env.dev .env

Finally, spin up a local instance using:

pnpm dev

Bugs & Feedback

Please use Github Issues to inform us of any bugs or issues you encounter and to request features and improvements.

Thank you.