open-dollar / od-gov-proposal-app

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

od-gov-proposal-app's Issues

QA Proposal Details

Proposal Details

• Overall- reduce the amount of white space, use consistent font-sizes and heading text.
• left-align text
• Remove large blue bar under section headings headings
• Remove box border for "Decoded Arguments" and move to bottom of list

Data should load with no wallet

Context provider is blocked by https://github.com/open-dollar/od-gov-proposal-app/blob/iana/proposal-details/src/app/contexts/ProposalsContext.tsx#L37

QA Footer

• Page height 100vh
• Use our page loading animation
  

QA: Header

• Remove home icon. Open Dollar icon should be used instead to take the user "home" (eg. /)
• The header width should be the same width as the page content. Currently everything is bunched up together
• "Pending Proposals are..." button should just be text below the page title and use an <a> tag for text "Github".
• Delete the "Proposals" heading, since the sub-headings below are sufficient

Preventing proposal page fail

After clicking on Proposal there is an error fetching data

• Create delay between requests
• Make sure error appears without crashing the page

QA: Cleanup

Data loading

• Content should not move. Should be left-aligned
• Show a few react-loading-skeleton rows for each section: pending, and submitted
  

Add tenderly simulation

Governance Proposal App - Scoping

Web2

• Bootstrap the site using https://github.com/withtally/tally-zero, or create-next-app, or a popular web3 app-specific bootstrapping tool

Web3

• Use a popular web3 library for wallet connections
• Use Ethers for RPC calls
• Should accept an environment variable to load data when the wallet is not connected.

Data

• No database required
• Github API. Proposal data should be fetched on page-load from our public repo: https://github.com/open-dollar/od-contracts/tree/dev/gov-output/mainnet
• Details about each proposal (submitted/unsubmitted) is fetched from the Governance contract using the function proposals(proposalId uint256)

User Experience

• Display a table of all proposals fetched from Github
• Relevant info to show is: ProposalType, description, ProposallId (only the first 9 characters), calldatas, targets, values, and status (eg. "Submitted" or "Unsubmitted")
• If a proposal has not yet been submitted, the "PROPOSE" button should be enabled
• If a user clicks "PROPOSE", prompt to connect their wallet, and trigger the transaction.

Transaction Details

The only transaction needed is to make a proposal

• ODGovernor.propose(targets, calldatas, values, description) https://arbiscan.io/address/0xf704735CE81165261156b41D33AB18a08803B86F#writeContract#F12
• Reasons it may fail: User doesn't have the required voting power

Bonus stretch-goals

Not necessary, but nice-to-haves for the project:

• Show the user's voting power ProtocolToken.getVotes(), compared to the current voting threshold OdGovernor.proposalThreshold()

Notes

• Proposals which have not yet been submitted to governance will return an error
  

QA: Footer

• Footer should have a background color to separate it from page content
• Make more consistent with our od-app footer
• All links should be updated

QA: Proposal row

Unsubmitted proposals

• Move propsal ID to the top of the row, followed by the description
• Remove "Update Delay" text
• Remove Unsubmitted status text

Submitted proposals

• Same as above,
• Can leave the vote details table, but feel free to reduce the spacing / clean it up a bit

QA Proposal interaction

Proposal interaction

• "Not Enough Votes" submission button should say "Propose", even when the button is disabled
• "You do not have enough votes should not be a button- it should be status-text below the button
• Add padding above the bottom explainer text

Debug failing ABI requests