marigold-dev / tzvote Goto Github PK

Dapp for delegators to vote on Tezos governance. Goal is for delegates to understand what delegators want and avoid to just chose pass or vote against the crowd

Home Page: https://tzvote.marigold.dev

License: MIT License

HTML 1.36% CSS 9.12% TypeScript 88.61% JavaScript 0.19% Java 0.71%

blockchain ligolang tezos voting-application

tzvote's Introduction

TzVote

Oracle

The Oracle is here to store missing information of current voting period index

compile

TAQ_LIGO_IMAGE=ligolang/ligo:0.72.0 taq compile votingPeriodOracle.jsligo

Test

Dry run

taq simulate votingPeriodOracle.tz --param pokeGame.parameter.default_parameter.tz  --sender alice --protocol nairobi

Unit tests

taq test unit_votingPeriodOracle.jsligo

Deploy

taq deploy votingPeriodOracle.tz -e "testing" --storage votingPeriodOracle.storage.ghostnet.tz

taq deploy votingPeriodOracle.tz -e "production" --storage votingPeriodOracle.storage.mainnet.tz

ghostnet : KT1ACfH87dohx1bAVc4PigcNBAFSTdxrRwj7 mainnet : KT1C8Varn3RWkSk6jJBVSRUHkmmXArGefifp

initialize some data

taq call votingPeriodOracle --param pokeGame.parameter.default_parameter.tz  -e testing

Smart contract

Compile Tezos baker contract

TAQ_LIGO_IMAGE=ligolang/ligo:0.72.0 taq compile tezosTemplate3.jsligo

Unit tests

taq test unit_tezosTemplate3.jsligo

Deploy

taq deploy tezosTemplate3.tz -e "testing" --storage tezosTemplate3.storage.ghostnet.tz

KT1G4DCjT2SviF7T6Ji9zB5m65DR67Mw91nZ

taq deploy tezosTemplate3.tz -e "production" --storage tezosTemplate3.storage.mainnet.tz

KT1FohLnkN7zNk4fQy99D4TJoM83Ln8JJz4c

Compile permissioned Simple Poll contract

TAQ_LIGO_IMAGE=ligolang/ligo:0.72.0 taq compile permissionedSimplePoll.jsligo

Unit tests

taq test unit_permissionedSimplePoll.jsligo

Deploy

taq deploy permissionedSimplePoll.tz -e "testing" --storage permissionedSimplePoll.storage.ghostnet.tz

KT1ACfH87dohx1bAVc4PigcNBAFSTdxrRwj7

taq deploy permissionedSimplePoll.tz -e "production" --storage permissionedSimplePoll.storage.mainnet.tz

KT1CXVRgTKeEn2F2fqVX7tWcMrYRn8vaJwUa

App

Compile both for the frontend

TAQ_LIGO_IMAGE=ligolang/ligo:0.72.0 taq compile tezosTemplate3.jsligo --json && mv artifacts/tezosTemplate3.json ./app/src/contracttemplates/

TAQ_LIGO_IMAGE=ligolang/ligo:0.72.0 taq compile permissionedSimplePoll.jsligo --json && mv artifacts/permissionedSimplePoll.json ./app/src/contracttemplates/

Generate types

taq install @taqueria/plugin-contract-types
taq generate types ./app/src

Build

Install dependencies:

npm i
npm run local

Build for Android (linked to mainnet config by default on package.json)

ionic capacitor add android
ionic capacitor copy android
npm install -g cordova-res
cordova-res android --skip-config --copy
ionic capacitor sync android
ionic capacitor update android

TzCommunity

TzVote utilizes TzCommunity to retrieve people's profile data.

TIPS

Add one of my account alice as a baker

tezos-client register key alice as delegate

Docs

import git submodule and run doc locally

git submodule add https://github.com/marigold-dev/marigold-docs-theme.git docs/theme
git submodule update --init --recursive
mdbook serve --open --port 3003

tzvote's People

Contributors

Stargazers

Watchers

Forkers

gridster omahs zamrokk

tzvote's Issues

bulk add voter addresses

for Permissioned polls, would be very useful if the UI allowed us to add multiple addresses easily (csv file or any similar format pasted into a textarea)

update TZKT indexer link to the Marigold instance

SUMMARY: update TZKT indexer link to the Marigold instance

MOTIVATION: eat your own food

ALTERNATIVES: we use tzkt.io for the moment

DRAWBACKS: Monitorize well our own services

open source TzVote

SUMMARY: open source TzVote

MOTIVATION: expose it to outside Marigold

DETAILED DESIGN:

open source license ? MIT
version to release ? 0.0.1 ?

auto filter poll older than 2 weeks

Connexion not managed on reload

SUMMARY: When i'm already connected with my wallet, if i reload the page or open it in another tab, i'm not detected as connected

IMPACT: bad UX

REPRODUCTION:

go to https://tzvote.marigold.dev/
connect with a wallet
reload the page

simple permissioned vote - Select all delegators directly from a baker address

Add github link in the footer of the frontend

make more visible the vote status to alert of closed polls

logo marigold instead of picture

tzvote anonymous with sapling tokens

add anonymous voting, using internal sapling to redistribute/mix vote tokens

create a template where the creator can choose a baker and all its delegators will be invited. Their votes will correspond to their voting power

Simple Permissioned Polls:
"Contract owner can add/remove permissioned addresses. Each address has 1 vote power. Period dates are free of choice"
this one, we are using it to ask our TTC $tedv delegators to signal their vote for TezosDomains DAO proposals. Would be nice if we could set the voting power of each address according to the voting power delegated to us TTC.

hum ... maybe it is feasible offchain so I need to provide an oracle for this. On the smartcontract it is only possible to get the baker voting power, not the details of delegators

Also this mean that the dates for the vote will be attached to a Tezos voting period (like the baker's template)

Redesign the app based on Vanessa comments

On permissioned voting template, the voter list should never be empty. change UI and backend and unit tests to reflect this

add a "disabled" status to hide some crappy vote poll to not be indexed

add input text to add delegator from any baker

Block voting button if are on the last block of a period or on the first block

SUMMARY: Block voting button if are on the last block of a period or on the first block

IMPACT:

last block : vote will not be taken into account because when the block will be forged, it will appear on the next period and so, be rejected by the smart contract
first block : first block needs to be forged on tezos for the next period index to be display on the chain, then update of the oracle will appear on the second block (normally...if no delay), then when voting :
- vote tx is also on 1st block => rejection
- vote tx is also on oracle update or before => rejection
  Solution ? compare oracle index and tezos index, if different, not time to vote, if sync, then all is fine for voting. So VOTE button can be displayed

REPRODUCTION:

last block : vote on last block of voting period
first block :
- vote on first block
- vote before oracle is updated

refresh bug after voting

old code for baker template is down

need to fix this

Add "Samarkand" voting template

MOTIVATION: propose other ways for user for creating polls

DETAILED DESIGN:

Implement other templates. Propose theses new template when creating a voting session and modify the way results are displayed

Samarkand : https://hackmd.io/EBB3pObiT5y5eJs4tPQjXQ?view#15-Samarkand

DRAWBACKS: some impacts on display and new smart contract templates to create. Big question : how to deal with old templates ? Normally, we should have no impact as these is new smart contracts. Just dapp and devops should be impacted

Add feature to share the poll

Is it possible to add a share option for the poll that has been created? I created a poll and added all my delegators as eligible to vote on. But they have to go on the site and manually search for name of the poll which i don't think is very efficient especially if more bakers start using this to ask the same questions

add tzcommunity for fetching members to add to a permissioned vote

BUG : check public key passed as parameter with source

On this vote we don't check that the param is correct

https://github.com/marigold-dev/tzvote/blame/mainnet/contracts/tezosTemplate3.jsligo

We need to compare : Tezos.address (Tezos.implicit_account senderHashKey) to Tezos.get_source () to avoid hacks

Btw, also change the error label "Sender has no rolls and cannot vote" there is no more rolls

add TzCommunity components

Update DNS ans rename project

SUMMARY: Update DNS ans rename project

MOTIVATION: better maintenance and best marketing name

DETAILED DESIGN:

tzvote.marigold.dev => mainnet
hangzounet.tzvote.marigold.dev => hangzhounet
ithacanet.tzvote.marigold.dev => ithacanet

ALTERNATIVES: as we have today for hangzhou testnet

DRAWBACKS: renaming the git repo might have some impacts

Mainnet availability

SUMMARY: Mainnet availability

MOTIVATION: from testnet to public mainnet exposure

DETAILED DESIGN:

get a mainnet wallet with some tz
set the private key on k8s
deploy a voting session smartcontract with this wallet on mainnet
deploy the oracle smartcontract with this wallet on mainnet

DRAWBACKS: Have an admin account on mainnet that can initally deploy Smart contracts and then refresh the Oracle storage

Implement other templates. Propose theses new template when creating a voting session and modify the way results are displayed

Permissioned Simple poll : https://hackmd.io/EBB3pObiT5y5eJs4tPQjXQ?view#12-Permissioned-Simple-poll

marigold-dev / tzvote Goto Github PK

tzvote's Introduction

TzVote

Oracle

compile

Test

Dry run

Unit tests

Deploy

initialize some data

Smart contract

Compile Tezos baker contract

Unit tests

Deploy

Compile permissioned Simple Poll contract

Unit tests

Deploy

App

Compile both for the frontend

Build

Build for Android (linked to mainnet config by default on package.json)

TzCommunity

TIPS

Docs

tzvote's People

Contributors

Stargazers

Watchers

Forkers

tzvote's Issues

Recommend Projects

Recommend Topics

Recommend Org