-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
remove public functions from binary_tally. Turnkey_tally goes to test…
…_only
- Loading branch information
1 parent
f424ace
commit d776fe4
Showing
2 changed files
with
125 additions
and
132 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
236 changes: 113 additions & 123 deletions
236
framework/libra-framework/sources/ol_sources/vote_lib/tally/turnkey_binary.move
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,123 +1,113 @@ | ||
|
|
||
| /// See BinaryTally.move for the details docs on developing your own poll. | ||
|
|
||
| /// This is a simple implementation of a simple binary choice poll with a deadline. | ||
| /// It can be used to instantiate very simple referenda, and to programatically initiate actions/events/transactions based on a result. | ||
| /// It's also intended as a demonstration. Developers can use this as a template to create their own tally algorithm and other workflows. | ||
|
|
||
| module ol_framework::turnkey_binary_poll { | ||
|
|
||
| use ol_framework::ballot::{Self, BallotTracker}; | ||
| use ol_framework::binary_tally::{Self, BinaryTally}; | ||
| use diem_framework::account; | ||
| use std::guid; | ||
| use std::error; | ||
| use std::signer; | ||
| use std::option::Option; | ||
|
|
||
| /// tally not initialized | ||
| const ENOT_INITIALIZED: u64 = 0; | ||
| /// no ballot found | ||
| const ENO_BALLOT_FOUND: u64 = 1; | ||
| /// not enrolled to participate in ballot | ||
| const ENOT_ENROLLED: u64 = 2; | ||
| /// you've already voted | ||
| const EALREADY_VOTED: u64 = 3; | ||
| /// not a valid vote option | ||
| const EINVALID_VOTE: u64 = 4; | ||
|
|
||
| // Duplicated from ballot | ||
| const PENDING: u8 = 1; | ||
| const APPROVED: u8 = 2; | ||
| const REJECTED: u8 = 3; | ||
|
|
||
|
|
||
| /// In BinaryPoll we have a single place to track every BinaryTally of a given "issue" that can carry IssueData as a payload. | ||
|
|
||
| /// The "B" generic is deceptively simple. How the state actually looks in memory is: | ||
| /// struct ballot::BallotTracker< | ||
| /// ballot::ballot< | ||
| /// BinaryPoll::BinaryTally< | ||
| /// IssueData { whatever: you_decide } | ||
|
|
||
| struct AllPolls<B> has key, store, drop { | ||
| tracker: BallotTracker<B>, | ||
| } | ||
|
|
||
| /// Developers who need more flexibility, can instead construct the BallotTracker object and then wrap it in another struct on their third party module. | ||
| public fun init_polling_at_address<IssueData: drop + store>( | ||
| sig: &signer, | ||
| ) { | ||
| move_to<AllPolls<IssueData>>(sig, AllPolls { | ||
| tracker: ballot::new_tracker<IssueData>(), | ||
| }); | ||
|
|
||
| // store the capability in the account so the functions below can mutate the ballot and ballot box (by sharing the token/capability needed to create GUIDs) | ||
| // If the developer wants to allow other access control to the Create Capability, they can do so by storing the capability in a different module (i.e. the third party module calling this function) | ||
| // let guid = account::create_guid(sig); | ||
| // move_to(sig, VoteCapability { guid_cap }); | ||
| } | ||
|
|
||
| /// If the BallotTracker is standalone at root of address, you can use thie function as long as the CreateCapability is available. | ||
| public fun propose_ballot_by_owner<IssueData: drop + store>( | ||
| sig: &signer, | ||
| tally_type: IssueData, | ||
| ) acquires AllPolls{ | ||
| assert!(exists<AllPolls<IssueData>>(signer::address_of(sig)), error::invalid_state(ENOT_INITIALIZED)); | ||
| // let guid_cap = &borrow_global<VoteCapability>(signer::address_of(sig)).guid_cap; | ||
| let guid = account::create_guid(sig); | ||
| // propose_ballot_with_capability<IssueData>(guid, tally_type); | ||
| let state = borrow_global_mut<AllPolls<IssueData>>(signer::address_of(sig)); | ||
| ballot::propose_ballot(&mut state.tracker, guid, tally_type); | ||
| } | ||
|
|
||
| // public fun propose_ballot_with_capability<IssueData: drop + store>( | ||
| // guid: &guid::GUID, | ||
| // tally_type: IssueData, | ||
| // ) acquires AllPolls { | ||
| // let addr = guid::get_capability_address(guid_cap); | ||
| // let state = borrow_global_mut<AllPolls<IssueData>>(addr); | ||
| // ballot::propose_ballot(&mut state.tracker, guid, tally_type); | ||
| // } | ||
|
|
||
|
|
||
|
|
||
| /// Public helper to get data on an issue without privileges. Returns tuple if the ballot is (found, its index, its status enum, is it completed) | ||
| public fun find_by_address<IssueData: drop + store>(poll_address: address, uid: &guid::ID): (bool, u64, u8, bool) acquires AllPolls { | ||
| let state = borrow_global<AllPolls<IssueData>>(poll_address); | ||
| ballot::find_anywhere(&state.tracker, uid) | ||
| } | ||
|
|
||
| //////// API //////// | ||
|
|
||
| public fun propose_ballot_owner_script<IssueData: drop + store>( | ||
| sig: &signer, | ||
| tally_type: IssueData, | ||
| ) acquires AllPolls{ | ||
| propose_ballot_by_owner<IssueData>(sig, tally_type); | ||
| } | ||
|
|
||
| public fun add_remove_voters<IssueData: drop + store>( | ||
| sig: &signer, | ||
| voters: vector<address>, | ||
| uid: &guid::ID, | ||
| add_remove: bool, | ||
| ) acquires AllPolls { | ||
| let addr = signer::address_of(sig); | ||
| let state = borrow_global_mut<AllPolls<BinaryTally<IssueData>>>(addr); | ||
| binary_tally::update_enrollment<IssueData>(&mut state.tracker, uid, voters, add_remove); | ||
| } | ||
|
|
||
| // Use this Vote API for a handler that is called by the voter and then lazily executes a different function based on the return. | ||
| public fun vote<IssueData: drop + store>( | ||
| sig: &signer, | ||
| vote_address: address, | ||
| uid: &guid::ID, | ||
| for_against: bool, | ||
| ): Option<bool> acquires AllPolls { //returns some() if the vote was completed, and true/false if it passed. | ||
| let state = borrow_global_mut<AllPolls<BinaryTally<IssueData>>>(vote_address); | ||
| binary_tally::vote<IssueData>(sig, &mut state.tracker, uid, for_against) | ||
| } | ||
|
|
||
|
|
||
| } | ||
| // Demoware | ||
| #[test_only] | ||
| /// See BinaryTally.move for the details docs on developing your own poll. | ||
|
|
||
| /// This is a simple implementation of a simple binary choice poll with a deadline. | ||
| /// It can be used to instantiate very simple referenda, and to programatically initiate actions/events/transactions based on a result. | ||
| /// It's also intended as a demonstration. Developers can use this as a template to create their own tally algorithm and other workflows. | ||
|
|
||
| module ol_framework::turnkey_binary_poll { | ||
|
|
||
| use ol_framework::ballot::{Self, BallotTracker}; | ||
| use ol_framework::binary_tally::{Self, BinaryTally}; | ||
| use diem_framework::account; | ||
| use std::guid; | ||
| use std::error; | ||
| use std::signer; | ||
| use std::option::Option; | ||
|
|
||
| /// tally not initialized | ||
| const ENOT_INITIALIZED: u64 = 0; | ||
| /// no ballot found | ||
| const ENO_BALLOT_FOUND: u64 = 1; | ||
| /// not enrolled to participate in ballot | ||
| const ENOT_ENROLLED: u64 = 2; | ||
| /// you've already voted | ||
| const EALREADY_VOTED: u64 = 3; | ||
| /// not a valid vote option | ||
| const EINVALID_VOTE: u64 = 4; | ||
|
|
||
| // Duplicated from ballot | ||
| const PENDING: u8 = 1; | ||
| const APPROVED: u8 = 2; | ||
| const REJECTED: u8 = 3; | ||
|
|
||
|
|
||
| /// In BinaryPoll we have a single place to track every BinaryTally of a given "issue" that can carry IssueData as a payload. | ||
|
|
||
| /// The "B" generic is deceptively simple. How the state actually looks in memory is: | ||
| /// struct ballot::BallotTracker< | ||
| /// ballot::ballot< | ||
| /// BinaryPoll::BinaryTally< | ||
| /// IssueData { whatever: you_decide } | ||
|
|
||
| struct AllPolls<B> has key, store, drop { | ||
| tracker: BallotTracker<B>, | ||
| } | ||
|
|
||
| /// Developers who need more flexibility, can instead construct the BallotTracker object and then wrap it in another struct on their third party module. | ||
| public(friend) fun init_polling_at_address<IssueData: drop + store>( | ||
| sig: &signer, | ||
| ) { | ||
| move_to<AllPolls<IssueData>>(sig, AllPolls { | ||
| tracker: ballot::new_tracker<IssueData>(), | ||
| }); | ||
|
|
||
| // store the capability in the account so the functions below can mutate the ballot and ballot box (by sharing the token/capability needed to create GUIDs) | ||
| // If the developer wants to allow other access control to the Create Capability, they can do so by storing the capability in a different module (i.e. the third party module calling this function) | ||
| // let guid = account::create_guid(sig); | ||
| // move_to(sig, VoteCapability { guid_cap }); | ||
| } | ||
|
|
||
| /// If the BallotTracker is standalone at root of address, you can use thie function as long as the CreateCapability is available. | ||
| public(friend) fun propose_ballot_by_owner<IssueData: drop + store>( | ||
| sig: &signer, | ||
| tally_type: IssueData, | ||
| ) acquires AllPolls{ | ||
| assert!(exists<AllPolls<IssueData>>(signer::address_of(sig)), error::invalid_state(ENOT_INITIALIZED)); | ||
| // let guid_cap = &borrow_global<VoteCapability>(signer::address_of(sig)).guid_cap; | ||
| let guid = account::create_guid(sig); | ||
| // propose_ballot_with_capability<IssueData>(guid, tally_type); | ||
| let state = borrow_global_mut<AllPolls<IssueData>>(signer::address_of(sig)); | ||
| ballot::propose_ballot(&mut state.tracker, guid, tally_type); | ||
| } | ||
|
|
||
| /// Public helper to get data on an issue without privileges. Returns tuple if the ballot is (found, its index, its status enum, is it completed) | ||
| public(friend) fun find_by_address<IssueData: drop + store>(poll_address: address, uid: &guid::ID): (bool, u64, u8, bool) acquires AllPolls { | ||
| let state = borrow_global<AllPolls<IssueData>>(poll_address); | ||
| ballot::find_anywhere(&state.tracker, uid) | ||
| } | ||
|
|
||
| //////// API //////// | ||
|
|
||
| public(friend) fun propose_ballot_owner_script<IssueData: drop + store>( | ||
| sig: &signer, | ||
| tally_type: IssueData, | ||
| ) acquires AllPolls{ | ||
| propose_ballot_by_owner<IssueData>(sig, tally_type); | ||
| } | ||
|
|
||
| public(friend) fun add_remove_voters<IssueData: drop + store>( | ||
| sig: &signer, | ||
| voters: vector<address>, | ||
| uid: &guid::ID, | ||
| add_remove: bool, | ||
| ) acquires AllPolls { | ||
| let addr = signer::address_of(sig); | ||
| let state = borrow_global_mut<AllPolls<BinaryTally<IssueData>>>(addr); | ||
| binary_tally::update_enrollment<IssueData>(&mut state.tracker, uid, voters, add_remove); | ||
| } | ||
|
|
||
| // Use this Vote API for a handler that is called by the voter and then lazily executes a different function based on the return. | ||
| public(friend) fun vote<IssueData: drop + store>( | ||
| sig: &signer, | ||
| vote_address: address, | ||
| uid: &guid::ID, | ||
| for_against: bool, | ||
| ): Option<bool> acquires AllPolls { //returns some() if the vote was completed, and true/false if it passed. | ||
| let state = borrow_global_mut<AllPolls<BinaryTally<IssueData>>>(vote_address); | ||
| binary_tally::vote<IssueData>(sig, &mut state.tracker, uid, for_against) | ||
| } | ||
|
|
||
|
|
||
| } |