feat(gno/govdao): handle T3 abstention in govdao condition to match T2 adding specification (#1504)

Author: MikaelVallenet

gno/p/daocond/cond_govdao.gno

@@ -2,12 +2,16 @@ package daocond
 
 import (
 	"errors"
+	"strconv"
+	"strings"
 
 	"gno.land/p/demo/json"
 	"gno.land/p/demo/ufmt"
 )
 
-func GovDaoCondThreshold(threshold float64, hasRoleFn func(memberId string, role string) bool, usersWithRoleCountFn func(role string) uint32) Condition {
+var roleWeights = []float64{3.0, 2.0, 1.0}
+
+func GovDaoCondThreshold(threshold float64, roles []string, hasRoleFn func(memberId string, role string) bool, usersWithRoleCountFn func(role string) uint32) Condition {
 	if threshold <= 0 || threshold > 1 {
 		panic(errors.New("invalid threshold"))
 	}
@@ -17,15 +21,20 @@ func GovDaoCondThreshold(threshold float64, hasRoleFn func(memberId string, role
 	if hasRoleFn == nil {
 		panic(errors.New("nil hasRoleFn"))
 	}
+	if len(roles) > 3 {
+		panic("the govdao condition handles at most 3 roles")
+	}
 	return &govDaoCondThreshold{
 		threshold:            threshold,
+		roles:                roles,
 		hasRoleFn:            hasRoleFn,
 		usersWithRoleCountFn: usersWithRoleCountFn,
 	}
 }
 
 type govDaoCondThreshold struct {
 	threshold            float64
+	roles                []string
 	hasRoleFn            func(memberId string, role string) bool
 	usersWithRoleCountFn func(role string) uint32
 }
@@ -36,9 +45,13 @@ func (m *govDaoCondThreshold) NewState() State {
 	}
 }
 
-// {threshold}% of {totalvotingpower} total voting power following these ({t1power} - T1, {t2power} T2, {t3power} T3)
 func (m *govDaoCondThreshold) Render() string {
-	return ufmt.Sprintf("%g%% of total voting power (3.0 / T1, 2.0 / T2, 1.0 / T3)*", m.threshold*100)
+	rolePowers := []string{}
+	for i, role := range m.roles {
+		weight := strconv.FormatFloat(roleWeights[i], 'f', 2, 64) // ufmt.Sprintf("%.2f", ...) is not working
+		rolePowers = append(rolePowers, ufmt.Sprintf("%s => %s power", role, weight))
+	}
+	return ufmt.Sprintf("%g%% of total voting power | %s", m.threshold*100, strings.Join(rolePowers, " | "))
 }
 
 func (m *govDaoCondThreshold) RenderJSON() *json.Node {
@@ -62,16 +75,20 @@ func (m *govDaoCondThresholdState) HandleEvent(_ Event, _ map[string]Vote) {
 }
 func (m *govDaoCondThresholdState) RenderJSON(votes map[string]Vote) *json.Node {
 	vPowers, totalPower := m.computeVotingPowers()
-	return json.ObjectNode("", map[string]*json.Node{
+	rolePowers := []string{}
+	for _, role := range m.cond.roles {
+		weight := strconv.FormatFloat(vPowers[role], 'f', 2, 64) // ufmt.Sprintf("%.2f", ...) is not working
+		rolePowers = append(rolePowers, ufmt.Sprintf("%s => %s power", role, weight))
+	}
+	jsonData := json.ObjectNode("", map[string]*json.Node{
 		"type":              json.StringNode("", "govdao-threshold"),
-		"treshold":          json.NumberNode("", m.cond.threshold),
-		"tier1VotingPower":  json.NumberNode("", vPowers[roleT1]),
-		"tier2VotingPower":  json.NumberNode("", vPowers[roleT2]),
-		"tier3VotingPower":  json.NumberNode("", vPowers[roleT3]),
+		"threshold":         json.NumberNode("", m.cond.threshold),
+		"powerSplit":        json.StringNode("", strings.Join(rolePowers, " | ")),
 		"totalYes":          json.NumberNode("", m.yesRatio(votes)),
 		"votingPowerNeeded": json.NumberNode("", m.cond.threshold*totalPower),
 		"totalVotingPower":  json.NumberNode("", totalPower),
 	})
+	return jsonData
 }
 
 var _ State = (*govDaoCondThresholdState)(nil)
@@ -88,15 +105,15 @@ func (m *govDaoCondThresholdState) yesRatio(votes map[string]Vote) float64 {
 		if vote != VoteYes {
 			continue
 		}
-		tier := m.getUserTier(userID)
+		tier := m.getUserRole(userID)
 
 		totalYes += votingPowersByTier[tier]
 	}
 	return totalYes / totalPower
 }
 
-func (m *govDaoCondThresholdState) getUserTier(userID string) string {
-	for _, role := range []string{roleT1, roleT2, roleT3} {
+func (m *govDaoCondThresholdState) getUserRole(userID string) string {
+	for _, role := range m.cond.roles {
 		if m.cond.hasRoleFn(userID, role) {
 			return role
 		}
@@ -105,16 +122,22 @@ func (m *govDaoCondThresholdState) getUserTier(userID string) string {
 }
 
 func (m *govDaoCondThresholdState) computeVotingPowers() (map[string]float64, float64) {
-	totalT1s := float64(m.cond.usersWithRoleCountFn(roleT1))
-	totalT2s := float64(m.cond.usersWithRoleCountFn(roleT2))
-	totalT3s := float64(m.cond.usersWithRoleCountFn(roleT3))
-	votingPowers := map[string]float64{
-		roleT1: 3.0,
-		roleT2: computePower(totalT1s, totalT2s, 2.0),
-		roleT3: computePower(totalT1s, totalT3s, 1.0),
+	votingPowers := make(map[string]float64)
+	totalPower := 0.0
+	countsMembersPerRole := make(map[string]float64)
+
+	for _, role := range m.cond.roles {
+		countsMembersPerRole[role] = float64(m.cond.usersWithRoleCountFn(role))
 	}
 
-	totalPower := votingPowers[roleT1]*totalT1s + votingPowers[roleT2]*totalT2s + votingPowers[roleT3]*totalT3s
+	for i, role := range m.cond.roles {
+		if i == 0 {
+			votingPowers[role] = roleWeights[0] // Highest tier always gets max power (3.0)
+		} else {
+			votingPowers[role] = computePower(countsMembersPerRole[m.cond.roles[0]], countsMembersPerRole[role], roleWeights[i])
+		}
+		totalPower += votingPowers[role] * countsMembersPerRole[role]
+	}
 
 	return votingPowers, totalPower
 }
@@ -138,9 +161,3 @@ func computePower(T1, Tn, maxPower float64) float64 {
 	}
 	return computedPower
 }
-
-const (
-	roleT1 = "T1"
-	roleT2 = "T2"
-	roleT3 = "T3"
-)