Directory chain/common_proposal

Module-level declarations

This is a generic proposal and voting module using pubkeys as voter set members. However provider keys can be used for actual voting.

Types

common_proposal

entity common_proposal

common_proposal_data

struct common_proposal_data

common_proposal_state

enum common_proposal_state

common_proposal_type

enum common_proposal_type

common_proposal_vote_type

enum common_proposal_vote_type

Defined what keys to permit voting by voter set members.

common_proposal_voter

struct common_proposal_voter

common_proposal_voting_results

struct common_proposal_voting_results

common_vote

entity common_vote

common_vote_transaction

entity common_vote_transaction

To track the transaction of each vote

common_voter_set

entity common_voter_set

common_voter_set_governance

entity common_voter_set_governance

common_voter_set_member

entity common_voter_set_member

common_voting_result

enum common_voting_result

Functions

apply_common_voting_result

function apply_common_voting_result(common_proposal: common_proposal)

apply_common_voting_result_handlers

@extendable function apply_common_voting_result_handlers(): map<text, (common_proposal) -> unit>

apply_or_delay_proposal

function apply_or_delay_proposal(prop: common_proposal)

common_proposal_delayed_apply

@extend(proposal_delayed_apply) function common_proposal_delayed_apply(proposal_id: integer)

create_common_voter_set_internal

function create_common_voter_set_internal(name: text, threshold: integer, governor: common_voter_set?, vote_type: common_proposal_vote_type): common_voter_set

delete_common_proposal

function delete_common_proposal(common_proposal: common_proposal)

delete_common_proposal_handlers

@extendable function delete_common_proposal_handlers(): map<text, (common_proposal) -> unit>

internal_common_vote

function internal_common_vote(pubkey: byte_array, proposal: common_proposal, vote: boolean)

max_common_votes

function max_common_votes(common_voter_set: common_voter_set): integer

negative_common_votes

function negative_common_votes(common_proposal: common_proposal): integer

positive_common_votes

function positive_common_votes(common_proposal: common_proposal): integer

proposal_str

@extendable function proposal_str(prop: common_proposal): text?

require_common_proposal

function require_common_proposal(rowid: rowid): common_proposal

require_common_voter_set

function require_common_voter_set(name: text): common_voter_set

require_common_voter_set_governor

function require_common_voter_set_governor(common_voter_set: common_voter_set, pubkey: byte_array)

require_common_voter_set_member_and_signer

function require_common_voter_set_member_and_signer(common_voter_set: common_voter_set, pubkey: byte_array)

require_common_voter_set_with_signer_and_member

function require_common_voter_set_with_signer_and_member(voter_set_name: text, pubkey: byte_array): common_voter_set

require_is_signer

function require_is_signer(pubkey: byte_array)

require_only_pending_proposal_of_type

function require_only_pending_proposal_of_type(proposal: common_proposal)

revoke_common_proposal_unsafe

function revoke_common_proposal_unsafe(prop: common_proposal)

run_common_proposal_event

function run_common_proposal_event(handlers: map<text, (common_proposal) -> unit>, proposal: common_proposal)

try_call_apply_common_voting_result

function try_call_apply_common_voting_result(prop: common_proposal)

try_to_apply_proposal

function try_to_apply_proposal(prop: common_proposal)

Queries

get_common_proposal

query get_common_proposal(id: rowid?): common_proposal_data?

Returns common proposal info.

get_common_proposal_voter_info

query get_common_proposal_voter_info(rowid: rowid): list<common_proposal_voter>

Returns common proposal voting info.

get_common_proposal_voting_results

query get_common_proposal_voting_results(rowid: rowid): common_proposal_voting_results

Returns common proposal voting results.

get_common_proposals_range

query get_common_proposals_range(from: integer, until: integer, only_pending: boolean): list<(rowid: rowid, proposal_type: common_proposal_type, state: common_proposal_state)>

Returns common proposal rowid, proposal_type and state.

get_common_pubkey_votes

query get_common_pubkey_votes(from: integer, until: integer, pubkey: byte_array): list<(proposal: common_proposal, vote: boolean)>

Returns common proposal and votes by criteria.

get_common_voter_set_members

query get_common_voter_set_members(name: text): list<byte_array>

get_common_voter_sets

query get_common_voter_sets(): list<(name: text, member_key_type: common_proposal_vote_type, threshold: integer)>

get_proposals_by_proposer

query get_proposals_by_proposer(proposer: byte_array): list<(id: rowid, timestamp: integer, type: common_proposal_type, description: text, state: common_proposal_state)>

Returns all proposals for a specific proposer

get_relevant_common_proposals

query get_relevant_common_proposals(from: integer, until: integer, only_pending: boolean, my_pubkey: byte_array): list<(rowid: rowid, proposal_type: common_proposal_type, state: common_proposal_state)>

Returns relevant common proposal rowid, proposal_type and state for voter pubkey.

Operations

make_common_vote

operation make_common_vote(my_pubkey: byte_array, proposal_id: rowid, vote: boolean)

Make common vote.

Permission: common voter set member

Rate limit: no

retract_common_vote

operation retract_common_vote(my_pubkey: byte_array, proposal_id: rowid)

Delete vote for proposal.

Permission: common voter set member

Rate limit: no

revoke_common_proposal

operation revoke_common_proposal(my_pubkey: byte_array, proposal_id: rowid)

Revoke common proposal.

Permission: proposal owner

Rate limit: no