[PVM, DAC] AddMemberProposal

vms/platformvm/dac/camino_add_member_proposal.go

@@ -0,0 +1,187 @@
+// Copyright (C) 2023, Chain4Travel AG. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package dac
+
+import (
+	"bytes"
+	"fmt"
+	"time"
+
+	"github.com/ava-labs/avalanchego/ids"
+	"golang.org/x/exp/slices"
+)
+
+const (
+	addMemberProposalDuration     = uint64(time.Hour * 24 * 30 * 2 / time.Second) // 2 month
+	addMemberProposalOptionsCount = 2
+)
+
+var (
+	_ Proposal      = (*AddMemberProposal)(nil)
+	_ ProposalState = (*AddMemberProposalState)(nil)
+)
+
+type AddMemberProposal struct {
+	ApplicantAddress ids.ShortID `serialize:"true"`
+	Start            uint64      `serialize:"true"`
+	End              uint64      `serialize:"true"`
+}
+
+func (p *AddMemberProposal) StartTime() time.Time {
+	return time.Unix(int64(p.Start), 0)
+}
+
+func (p *AddMemberProposal) EndTime() time.Time {
+	return time.Unix(int64(p.End), 0)
+}
+
+func (p *AddMemberProposal) GetOptions() any {
+	return []bool{true, false}
+}
+
+func (p *AddMemberProposal) Verify() error {
+	switch {
+	case p.Start >= p.End:
+		return errEndNotAfterStart
+	case p.End-p.Start != addMemberProposalDuration:
+		return fmt.Errorf("%w (expected: %d, actual: %d)", errWrongDuration, addMemberProposalDuration, p.End-p.Start)
+	}
+	return nil
+}
+
+func (p *AddMemberProposal) CreateProposalState(allowedVoters []ids.ShortID) ProposalState {
+	stateProposal := &AddMemberProposalState{
+		SimpleVoteOptions: SimpleVoteOptions[bool]{
+			Options: []SimpleVoteOption[bool]{
+				{Value: true},
+				{Value: false},
+			},
+		},
+		ApplicantAddress:   p.ApplicantAddress,
+		Start:              p.Start,
+		End:                p.End,
+		AllowedVoters:      allowedVoters,
+		TotalAllowedVoters: uint32(len(allowedVoters)),
+	}
+	return stateProposal
+}
+
+func (p *AddMemberProposal) Visit(visitor VerifierVisitor) error {
+	return visitor.AddMemberProposal(p)
+}
+
+type AddMemberProposalState struct {
+	SimpleVoteOptions[bool] `serialize:"true"`
+
+	ApplicantAddress   ids.ShortID   `serialize:"true"`
+	Start              uint64        `serialize:"true"`
+	End                uint64        `serialize:"true"`
+	AllowedVoters      []ids.ShortID `serialize:"true"`
+	TotalAllowedVoters uint32        `serialize:"true"`
+}
+
+func (p *AddMemberProposalState) StartTime() time.Time {
+	return time.Unix(int64(p.Start), 0)
+}
+
+func (p *AddMemberProposalState) EndTime() time.Time {
+	return time.Unix(int64(p.End), 0)
+}
+
+func (p *AddMemberProposalState) IsActiveAt(time time.Time) bool {
+	timestamp := uint64(time.Unix())
+	return p.Start <= timestamp && timestamp <= p.End
+}
+
+func (p *AddMemberProposalState) CanBeFinished() bool {
+	mostVotedWeight, _, unambiguous := p.GetMostVoted()
+	voted := p.Voted()
+	return voted == p.TotalAllowedVoters || unambiguous && mostVotedWeight > p.TotalAllowedVoters/2
+}
+
+func (p *AddMemberProposalState) IsSuccessful() bool {
+	mostVotedWeight, _, unambiguous := p.GetMostVoted()
+	voted := p.Voted()
+	return unambiguous && voted > p.TotalAllowedVoters/2 && mostVotedWeight > voted/2
+}
+
+func (p *AddMemberProposalState) Outcome() any {
+	_, mostVotedOptionIndex, unambiguous := p.GetMostVoted()
+	if !unambiguous {
+		return -1
+	}
+	return mostVotedOptionIndex
+}
+
+// Votes must be valid for this proposal, could panic otherwise.
+func (p *AddMemberProposalState) Result() (bool, uint32, bool) {
+	mostVotedWeight, mostVotedOptionIndex, unambiguous := p.GetMostVoted()
+	return p.Options[mostVotedOptionIndex].Value, mostVotedWeight, unambiguous
+}
+
+// Will return modified proposal with added vote, original proposal will not be modified!
+func (p *AddMemberProposalState) AddVote(voterAddress ids.ShortID, voteIntf Vote) (ProposalState, error) {
+	vote, ok := voteIntf.(*SimpleVote)
+	if !ok {
+		return nil, ErrWrongVote
+	}
+	if int(vote.OptionIndex) >= len(p.Options) {
+		return nil, ErrWrongVote
+	}
+
+	voterAddrPos, allowedToVote := slices.BinarySearchFunc(p.AllowedVoters, voterAddress, func(id, other ids.ShortID) int {
+		return bytes.Compare(id[:], other[:])
+	})
+	if !allowedToVote {
+		return nil, ErrNotAllowedToVoteOnProposal
+	}
+
+	updatedProposal := &AddMemberProposalState{
+		ApplicantAddress: p.ApplicantAddress,
+		Start:            p.Start,
+		End:              p.End,
+		AllowedVoters:    make([]ids.ShortID, len(p.AllowedVoters)-1),
+		SimpleVoteOptions: SimpleVoteOptions[bool]{
+			Options: make([]SimpleVoteOption[bool], len(p.Options)),
+		},
+		TotalAllowedVoters: p.TotalAllowedVoters,
+	}
+	// we can't use the same slice, cause we need to change its elements
+	copy(updatedProposal.AllowedVoters, p.AllowedVoters[:voterAddrPos])
+	updatedProposal.AllowedVoters = append(updatedProposal.AllowedVoters[:voterAddrPos], p.AllowedVoters[voterAddrPos+1:]...)
+	// we can't use the same slice, cause we need to change its element
+	copy(updatedProposal.Options, p.Options)
+	updatedProposal.Options[vote.OptionIndex].Weight++
+	return updatedProposal, nil
+}
+
+// Will return modified proposal with added vote ignoring allowed voters, original proposal will not be modified!
+func (p *AddMemberProposalState) ForceAddVote(voterAddress ids.ShortID, voteIntf Vote) (ProposalState, error) { //nolint:revive
+	vote, ok := voteIntf.(*SimpleVote)
+	if !ok {
+		return nil, ErrWrongVote
+	}
+	if int(vote.OptionIndex) >= len(p.Options) {
+		return nil, ErrWrongVote
+	}
+
+	updatedProposal := &AddMemberProposalState{
+		ApplicantAddress: p.ApplicantAddress,
+		Start:            p.Start,
+		End:              p.End,
+		AllowedVoters:    p.AllowedVoters,
+		SimpleVoteOptions: SimpleVoteOptions[bool]{
+			Options: make([]SimpleVoteOption[bool], len(p.Options)),
+		},
+		TotalAllowedVoters: p.TotalAllowedVoters,
+	}
+	// we can't use the same slice, cause we need to change its element
+	copy(updatedProposal.Options, p.Options)
+	updatedProposal.Options[vote.OptionIndex].Weight++
+	return updatedProposal, nil
+}
+
+func (p *AddMemberProposalState) Visit(visitor ExecutorVisitor) error {
+	return visitor.AddMemberProposal(p)
+}