v2

Documentation

Index

• Constants
• Variables
• type AuthorizeVote
• type ErrorStatusT
• type StartVote
• type StartVoteReply
• type StartVoteRunoff
• type StartVoteRunoffReply
• type Vote
• type VoteDetails
• type VoteDetailsReply
• type VoteOption
• type VoteT

Constants

const (
	APIVersion = 2

	RouteStartVote       = "/vote/start"
	RouteStartVoteRunoff = "/vote/startrunoff"
	RouteVoteDetails     = "/vote/{token:[A-z0-9]{64}}"

	// Vote types
	//
	// VoteTypeStandard is used to indicate a simple approve or reject
	// proposal vote where the winner is the voting option that has met
	// the specified pass and quorum requirements.
	//
	// VoteTypeRunoff specifies a runoff vote that multiple proposals compete in.
	// All proposals are voted on like normal, but there can only be one winner
	// in a runoff vote. The winner is the proposal that meets the quorum
	// requirement, meets the pass requirement, and that has the most net yes
	// votes. The winning proposal is considered approved and all other proposals
	// are considered rejected. If no proposals meet the quorum and pass
	// requirements then all proposals are considered rejected.
	// Note: in a runoff vote it is possible for a proposal to meet the quorum
	// and pass requirements but still be rejected if it does not have the most
	// net yes votes.
	VoteTypeInvalid  VoteT = 0
	VoteTypeStandard VoteT = 1
	VoteTypeRunoff   VoteT = 2

	// AuthorizeVote actions
	AuthVoteActionAuthorize = "authorize"
	AuthVoteActionRevoke    = "revoke"
)

Variables

var (
	// APIRoute is the prefix to the v2 API routes
	APIRoute = fmt.Sprintf("/v%v", APIVersion)
)

Types

type AuthorizeVote

type AuthorizeVote struct {
	Token     string `json:"token"`     // Proposal token
	Action    string `json:"action"`    // Authorize or revoke
	PublicKey string `json:"publickey"` // Key used for signature
	Signature string `json:"signature"` // Signature of token+version+action
}

AuthorizeVote is used to indicate that a proposal has been finalized and is ready to be voted on.

type ErrorStatusT

type ErrorStatusT int

type StartVote

type StartVote struct {
	Vote      Vote   `json:"vote"`
	PublicKey string `json:"publickey"` // Key used for signature
	Signature string `json:"signature"` // Signature of Vote hash
}

StartVote starts the voting period on the given proposal.

Signature is a signature of the hex encoded SHA256 digest of the JSON encoded v2 Vote struct.

Differences between v1 and v2:

• Signature has been updated to be a signature of the Vote hash. It was previously a signature of just the proposal token.
• Vote has been updated. See the Vote comment for more details.

type StartVoteReply

type StartVoteReply struct {
	StartBlockHeight uint32   `json:"startblockheight"` // Block height of vote start
	StartBlockHash   string   `json:"startblockhash"`   // Block hash of vote start
	EndBlockHeight   uint32   `json:"endblockheight"`   // Block height of vote end
	EligibleTickets  []string `json:"eligibletickets"`  // Valid voting tickets
}

StartVoteReply is the reply to the StartVote command.

Differences between v1 and v2:

• StartBlockHeight was changed from a string to a uint32.
• EndBlockHeight was changed from a string to a uint32. It was also renamed from EndHeight to EndBlockHeight to be consistent with StartBlockHeight.

type StartVoteRunoff

type StartVoteRunoff struct {
	Token          string          `json:"token"`
	AuthorizeVotes []AuthorizeVote `json:"authorizevotes"`
	StartVotes     []StartVote     `json:"startvotes"`
}

StartVoteRunoff starts the runoff voting process on all public, non-abandoned RFP submissions for the provided RFP token.

AuthorizeVotes must contain a vote authorization for each RFP submission that is participating in the runoff vote. Unlike standard votes, these vote authorizations are not signed by the submission author. They are signed by the admin starting the runoff vote.

StartVotes must contain a StartVote for each RFP submission that is participating in the runoff vote. The runoff vote can only be started once the RFP proposal itself has been approved by a vote and once the LinkBy submission deadline has expired. Once the LinkBy deadline has expired, the runoff vote can be started at any point by an admin. It is not required that RFP submission authors authorize the start of the vote.

type StartVoteRunoffReply

type StartVoteRunoffReply struct {
	StartBlockHeight uint32   `json:"startblockheight"` // Block height of vote start
	StartBlockHash   string   `json:"startblockhash"`   // Block hash of vote start
	EndBlockHeight   uint32   `json:"endblockheight"`   // Block height of vote end
	EligibleTickets  []string `json:"eligibletickets"`  // Valid voting tickets
}

The StartVoteRunoffReply is the reply to the StartVoteRunoff command. The returned vote info will be the same for all RFP submissions.

type Vote

type Vote struct {
	Token            string       `json:"token"`            // Proposal token
	ProposalVersion  uint32       `json:"proposalversion"`  // Proposal version of vote
	Type             VoteT        `json:"type"`             // Type of vote
	Mask             uint64       `json:"mask"`             // Valid votebits
	Duration         uint32       `json:"duration"`         // Duration in blocks
	QuorumPercentage uint32       `json:"quorumpercentage"` // Quorum requirement
	PassPercentage   uint32       `json:"passpercentage"`   // Approval requirement
	Options          []VoteOption `json:"options"`          // Vote options
}

Vote represents the vote params and vote options for a proposal vote.

QuorumPercentage is the percent of eligible votes required for a quorum. PassPercentage is the percent of total votes required for the proposal to be considered approved.

Differences between v1 and v2:

• Added the Version field that specifies the version of the proposal that is being voted on. This was added so that the proposal version is included in the StartVote signature.
• Added the Type field that specifies the vote type.

type VoteDetails

type VoteDetails struct {
	Token string `json:"token"` // Proposal token
}

VoteDetails returns the votes details for the specified proposal.

type VoteDetailsReply

type VoteDetailsReply struct {
	Version          uint32   `json:"version"`          // StartVote version
	Vote             string   `json:"vote"`             // JSON encoded Vote struct
	PublicKey        string   `json:"publickey"`        // Key used for signature
	Signature        string   `json:"signature"`        // Start vote signature
	StartBlockHeight uint32   `json:"startblockheight"` // Block height
	StartBlockHash   string   `json:"startblockhash"`   // Block hash
	EndBlockHeight   uint32   `json:"endblockheight"`   // Height of vote end
	EligibleTickets  []string `json:"eligibletickets"`  // Valid voting ticket
}

VoteDetailsReply is the reply to the VoteDetails command. It contains all of the information from a StartVote and StartVoteReply.

Version specifies the StartVote version that was used to initiate the proposal vote. See the StartVote comment for details on the differences between the StartVote versions.

Vote contains a JSON encoded Vote and needs to be decoded according to the Version. See the Vote comment for details on the differences between the Vote versions.

type VoteOption

type VoteOption struct {
	Id          string `json:"id"`          // Single unique word identifying vote (e.g. yes)
	Description string `json:"description"` // Longer description of the vote.
	Bits        uint64 `json:"bits"`        // Bits used for this option
}

VoteOption describes a single vote option.

type VoteT

type VoteT int