Referendum Contract

Referendum#

Production nodes or associations cannot determine all decisions. Some extremely important decisions, especially those involving user rights and interests, should involve all users and give full control to the user's voting for governance. The Referendum contract is built for this.

Implement aelf Standards ACS1 and ACS3.

Contract Methods#

Method Name	Request Type	Response Type	Description
ReclaimVoteToken	aelf.Hash	google.protobuf.Empty	Unlock the token used for voting according to proposal id.
CreateOrganization	Referendum.CreateOrganizationInput	aelf.Address	Create an organization and return its address.
CreateOrganizationBySystemContract	Referendum.CreateOrganizationBySystemContractInput	aelf.Address	Creates an organization by system contract and return its address.
GetOrganization	aelf.Address	Referendum.Organization	Get the organization according to the organization address.
CalculateOrganizationAddress	Referendum.CreateOrganizationInput	aelf.Address	Calculate the input and return the organization address.
GetProposalVirtualAddress	aelf.Hash	aelf.Address	Get the virtual address of a proposal based on the proposal id.

AElf.Standards.ACS1#

Method Name	Request Type	Response Type	Description
SetMethodFee	acs1.MethodFees	google.protobuf.Empty	Set the method fees for the specified method. Note that this will override all fees of the method.
ChangeMethodFeeController	AuthorityInfo	google.protobuf.Empty	Change the method fee controller, the default is parliament and default organization.
GetMethodFee	google.protobuf.StringValue	acs1.MethodFees	Query method fee information by method name.
GetMethodFeeController	google.protobuf.Empty	AuthorityInfo	Query the method fee controller.

AElf.Standards.ACS3#

Method Name	Request Type	Response Type	Description
CreateProposal	acs3.CreateProposalInput	aelf.Hash	Create a proposal for which organization members can vote. When the proposal is released, a transaction will be sent to the specified contract. Return id of the newly created proposal.
Approve	aelf.Hash	google.protobuf.Empty	Approve a proposal according to the proposal ID.
Reject	aelf.Hash	google.protobuf.Empty	Reject a proposal according to the proposal ID.
Abstain	aelf.Hash	google.protobuf.Empty	Abstain a proposal according to the proposal ID.
Release	aelf.Hash	google.protobuf.Empty	Release a proposal according to the proposal ID and send a transaction to the specified contract.
ChangeOrganizationThreshold	acs3.ProposalReleaseThreshold	google.protobuf.Empty	Change the thresholds associated with proposals. All fields will be overwritten by the input value and this will affect all current proposals of the organization. Note: only the organization can execute this through a proposal.
ChangeOrganizationProposerWhiteList	acs3.ProposerWhiteList	google.protobuf.Empty	Change the white list of organization proposer. This method overrides the list of whitelisted proposers.
CreateProposalBySystemContract	acs3.CreateProposalBySystemContractInput	aelf.Hash	Create a proposal by system contracts, and return id of the newly created proposal.
ClearProposal	aelf.Hash	google.protobuf.Empty	Remove the specified proposal. If the proposal is in effect, the cleanup fails.
GetProposal	aelf.Hash	acs3.ProposalOutput	Get the proposal according to the proposal ID.
ValidateOrganizationExist	aelf.Address	google.protobuf.BoolValue	Check the existence of an organization.
ValidateProposerInWhiteList	acs3.ValidateProposerInWhiteListInput	google.protobuf.BoolValue	Check if the proposer is whitelisted.

Contract Types#

AElf.Contracts.Referendum#

Referendum.CreateOrganizationBySystemContractInput#

Field	Type	Description	Label
organization_creation_input	CreateOrganizationInput	The parameters of creating organization.
organization_address_feedback_method	string	The organization address callback method which replies the organization address to caller contract.

Referendum.CreateOrganizationInput#

Field	Type	Description
token_symbol	string	The token used during proposal operations.
proposal_release_threshold	acs3.ProposalReleaseThreshold	The threshold for releasing the proposal.
proposer_white_list	acs3.ProposerWhiteList	The proposer whitelist.
creation_token	aelf.Hash	The creation token is for organization address generation.

Referendum.Organization#

Field	Type	Description
proposal_release_threshold	acs3.ProposalReleaseThreshold	The threshold for releasing the proposal.
token_symbol	string	The token used during proposal operations.
organization_address	aelf.Address	The address of organization.
organization_hash	aelf.Hash	The organization's id.
proposer_white_list	acs3.ProposerWhiteList	The proposer whitelist.
creation_token	aelf.Hash	The creation token is for organization address generation.

Referendum.ProposalInfo#

Field	Type	Description
proposal_id	aelf.Hash	The proposal ID.
contract_method_name	string	The method that this proposal will call when being released.
to_address	aelf.Address	The address of the target contract.
params	bytes	The parameters of the release transaction.
expired_time	google.protobuf.Timestamp	The date at which this proposal will expire.
proposer	aelf.Address	The address of the proposer of this proposal.
organization_address	aelf.Address	The address of this proposal's organization.
approval_count	int64	The count of approved.
rejection_count	int64	The count of rejected.
abstention_count	int64	The count of abstained.
proposal_description_url	string	URL used for proposal describing.

Referendum.Receipt#

Field	Type	Description
amount	int64	The amount of token locked.
token_symbol	string	The symbol of token locked.
lock_id	aelf.Hash	The lock ID.

Referendum.ReferendumReceiptCreated#

Field	Type	Description
proposal_id	aelf.Hash	The ID of the proposal.
address	aelf.Address	The sender address.
symbol	string	The symbol of token locked.
amount	int64	The amount of token locked.
receipt_type	string	The type of receipt (Approve, Reject, or Abstain).
time	google.protobuf.Timestamp	The timestamp of this method call.
organization_address	aelf.Address	The address of the organization.

AElf.Standards.ACS1#

acs1.MethodFee#

Field	Type	Description	Label
symbol	string	The token symbol of the method fee.
basic_fee	int64	The amount of fees to be charged.

acs1.MethodFees#

Field	Type	Description	Label
method_name	string	The name of the method to be charged.
fees	MethodFee	List of fees to be charged.	repeated
is_size_fee_free	bool	Optional based on the implementation.

AElf.Standards.ACS3#

acs3.CreateProposalBySystemContractInput#

Field	Type	Description	Label
proposal_input	CreateProposalInput	The parameters of creating proposal.
origin_proposer	aelf.Address	The actor that triggers the call.

acs3.CreateProposalInput#

Field	Type	Description
contract_method_name	string	The name of the method to call after release.
to_address	aelf.Address	The address of the contract to call after release.
params	bytes	The parameter of the method to be called after the release.
expired_time	google.protobuf.Timestamp	The timestamp at which this proposal will expire.
organization_address	aelf.Address	The address of the organization.
proposal_description_url	string	URL used for proposal description.
token	aelf.Hash	The token for proposal ID generation.

acs3.OrganizationCreated#

Field	Type	Description	Label
organization_address	aelf.Address	The address of the created organization.

acs3.OrganizationHashAddressPair#

Field	Type	Description	Label
organization_hash	aelf.Hash	The ID of the organization.
organization_address	aelf.Address	The address of organization.

acs3.OrganizationThresholdChanged#

Field	Type	Description	Label
organization_address	aelf.Address	The organization address
proposer_release_threshold	ProposalReleaseThreshold	The new release threshold.

acs3.OrganizationWhiteListChanged#

Field	Type	Description	Label
organization_address	aelf.Address	The organization address.
proposer_white_list	ProposerWhiteList	The new proposer whitelist.

acs3.ProposalCreated#

Field	Type	Description	Label
proposal_id	aelf.Hash	The ID of the created proposal.
organization_address	aelf.Address	The organization address of the created proposal.

acs3.ProposalOutput#

Field	Type	Description
proposal_id	aelf.Hash	The ID of the proposal.
contract_method_name	string	The method that this proposal will call when being released.
to_address	aelf.Address	The address of the target contract.
params	bytes	The parameters of the release transaction.
expired_time	google.protobuf.Timestamp	The date at which this proposal will expire.
organization_address	aelf.Address	The address of this proposal's organization.
proposer	aelf.Address	The address of the proposer of this proposal.
to_be_released	bool	Indicates if this proposal is releasable.
approval_count	int64	Approval count for this proposal.
rejection_count	int64	Rejection count for this proposal.
abstention_count	int64	Abstention count for this proposal.

acs3.ProposalReleaseThreshold#

Field	Type	Description
minimal_approval_threshold	int64	The value for the minimum approval threshold.
maximal_rejection_threshold	int64	The value for the maximal rejection threshold.
maximal_abstention_threshold	int64	The value for the maximal abstention threshold.
minimal_vote_threshold	int64	The value for the minimal vote threshold.

AElf.Standards.ACS1#

acs1.MethodFee#

Field	Type	Description	Label
symbol	string	The token symbol of the method fee.
basic_fee	int64	The amount of fees to be charged.

acs1.MethodFees#

Field	Type	Description	Label
method_name	string	The name of the method to be charged.
fees	MethodFee	List of fees to be charged.	repeated
is_size_fee_free	bool	Optional based on the implementation.

AElf.Standards.ACS3#

acs3.CreateProposalBySystemContractInput#

Field	Type	Description	Label
proposal_input	CreateProposalInput	The parameters of creating proposal.
origin_proposer	aelf.Address	The actor that triggers the call.

acs3.CreateProposalInput#

Field	Type	Description
contract_method_name	string	The name of the method to call after release.
to_address	aelf.Address	The address of the contract to call after release.
params	bytes	The parameter of the method to be called after the release.
expired_time	google.protobuf.Timestamp	The timestamp at which this proposal will expire.
organization_address	aelf.Address	The address of the organization.
proposal_description_url	string	URL used for proposal description.
token	aelf.Hash	The token for proposal ID generation.

acs3.OrganizationCreated#

Field	Type	Description	Label
organization_address	aelf.Address	The address of the created organization.

acs3.OrganizationHashAddressPair#

Field	Type	Description	Label
organization_hash	aelf.Hash	The ID of organization.
organization_address	aelf.Address	The address of organization.

acs3.OrganizationThresholdChanged#

Field	Type	Description	Label
organization_address	aelf.Address	The organization address
proposer_release_threshold	ProposalReleaseThreshold	The new release threshold.

acs3.OrganizationWhiteListChanged#

Field	Type	Description	Label
organization_address	aelf.Address	The organization address.
proposer_white_list	ProposerWhiteList	The new proposer whitelist.

acs3.ProposalCreated#

Field	Type	Description	Label
proposal_id	aelf.Hash	The ID of the created proposal.
organization_address	aelf.Address	The organization address.

acs3.ProposalOutput#

Field	Type	Description
proposal_id	aelf.Hash	The ID of the proposal.
contract_method_name	string	The method that this proposal will call when being released.
to_address	aelf.Address	The address of the target contract.
params	bytes	The parameters of the release transaction.
expired_time	google.protobuf.Timestamp	The date at which this proposal will expire.
organization_address	aelf.Address	The address of this proposal's organization.
proposer	aelf.Address	The address of the proposer of this proposal.
to_be_released	bool	Indicates if this proposal is releasable.
approval_count	int64	Approval count for this proposal.
rejection_count	int64	Rejection count for this proposal.
abstention_count	int64	Abstention count for this proposal.

acs3.ProposalReleaseThreshold#

Field	Type	Description
minimal_approval_threshold	int64	The value for the minimum approval threshold.
maximal_rejection_threshold	int64	The value for the maximal rejection threshold.
maximal_abstention_threshold	int64	The value for the maximal abstention threshold.
minimal_vote_threshold	int64	The value for the minimal vote threshold.

acs3.ProposalReleased#

Field	Type	Description	Label
proposal_id	aelf.Hash	The id of the released proposal.
organization_address	aelf.Address	The organization address of the released proposal.

acs3.ProposerWhiteList#

Field	Type	Description	Label
proposers	aelf.Address	The address of the proposers	repeated

acs3.ReceiptCreated#

Field	Type	Description
proposal_id	aelf.Hash	The id of the proposal.
address	aelf.Address	The sender address.
receipt_type	string	The type of receipt (Approve, Reject, or Abstain).
time	google.protobuf.Timestamp	The timestamp of this method call.
organization_address	aelf.Address	The address of the organization.

acs3.ValidateProposerInWhiteListInput#

Field	Type	Description	Label
proposer	aelf.Address	The address to search/check.
organization_address	aelf.Address	The address of the organization.

AElf.Types#

aelf.Address#

Field	Type	Description	Label
value	bytes

aelf.BinaryMerkleTree#

Field	Type	Description	Label
nodes	Hash	The leaf nodes.	repeated
root	Hash	The root node hash.
leaf_count	int32	The count of leaf node.

aelf.Hash#

Field	Type	Description	Label
value	bytes

aelf.LogEvent#

Field	Type	Description	Label
address	Address	The contract address.
name	string	The name of the log event.
indexed	bytes	The indexed data.	repeated
non_indexed	bytes	The non-indexed data.

aelf.MerklePath#

Field	Type	Description	Label
merkle_path_nodes	MerklePathNode	The merkle path nodes.	repeated

aelf.MerklePathNode#

Field	Type	Description	Label
hash	Hash	The node hash.
is_left_child_node	bool	Whether it is a left child node.

aelf.SInt32Value#

Field	Type	Description	Label
value	sint32

aelf.SInt64Value#

Field	Type	Description	Label
value	sint64

aelf.ScopedStatePath#

Field	Type	Description	Label
address	Address	The scope address.
path	StatePath	The path of contract state.

aelf.SmartContractRegistration#

Field	Type	Description
category	sint32	The category of contract code(0: C#).
code	bytes	The byte array of the contract code.
code_hash	Hash	The hash of the contract code.
is_system_contract	bool	Whether it is a system contract.
version	int32	The version of the current contract.

aelf.StatePath#

Field	Type	Description	Label
parts	string	The partial path of the state path.	repeated

aelf.Transaction#

Field	Type	Description
from	Address	The address of the sender of the transaction.
to	Address	The address of the contract when calling a contract.
ref_block_number	int64	The height of the referenced block hash.
ref_block_prefix	bytes	The first four bytes of the referenced block hash.
method_name	string	The name of a method in the smart contract at the To address.
params	bytes	The parameters to pass to the smart contract method.
signature	bytes	When signing a transaction it’s actually a subset of the fields.

aelf.TransactionExecutingStateSet#

Field	Type	Description	Label
writes	TransactionExecutingStateSet.WritesEntry	The changed states.	repeated
reads	TransactionExecutingStateSet.ReadsEntry	The read states.	repeated
deletes	TransactionExecutingStateSet.DeletesEntry	The deleted states.	repeated

aelf.TransactionExecutingStateSet.DeletesEntry#

Field	Type	Description	Label
key	string
value	bool

aelf.TransactionExecutingStateSet.ReadsEntry#

Field	Type	Description	Label
key	string
value	bool

aelf.TransactionExecutingStateSet.WritesEntry#

Field	Type	Description	Label
key	string
value	bytes

aelf.TransactionResult#

Field	Type	Description	Label
transaction_id	Hash	The transaction id.
status	TransactionResultStatus	The transaction result status.
logs	LogEvent	The log events.	repeated
bloom	bytes	Bloom filter for transaction logs.
return_value	bytes	The return value of the transaction execution.
block_number	int64	The height of the block hat packages the transaction.
block_hash	Hash	The hash of the block hat packages the transaction.
error	string	Failed execution error message.

aelf.TransactionResultStatus#

Name	Number	Description
NOT_EXISTED		The execution result of the transaction does not exist.
PENDING	1	The transaction is in the transaction pool waiting to be packaged.
FAILED	2	Transaction execution failed.
MINED	3	The transaction was successfully executed and successfully packaged into a block.
CONFLICT	4	When executed in parallel, there are conflicts with other transactions.
PENDING_VALIDATION	5	The transaction is waiting for validation.
NODE_VALIDATION_FAILED	6	Transaction validation failed.

AuthorityInfo#

Field	Type	Description	Label
contract_address	aelf.Address	The contract address of the controller.
owner_address	aelf.Address	The address of the owner of the contract.

Edited on: 17 July 2024 04:48:35 GMT+0