1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
use cosmwasm_schema::cw_serde;
use cosmwasm_std::{Addr, BlockInfo, CosmosMsg, Decimal, Empty, Uint128};
use cw_utils::{Expiration, Threshold};
use crate::{DepositInfo, Status, Vote};
// we multiply by this when calculating needed_votes in order to round up properly
// Note: `10u128.pow(9)` fails as "u128::pow` is not yet stable as a const fn"
const PRECISION_FACTOR: u128 = 1_000_000_000;
#[cw_serde]
pub struct Proposal {
pub title: String,
pub description: String,
pub start_height: u64,
pub expires: Expiration,
pub msgs: Vec<CosmosMsg<Empty>>,
pub status: Status,
/// pass requirements
pub threshold: Threshold,
// the total weight when the proposal started (used to calculate percentages)
pub total_weight: u64,
// summary of existing votes
pub votes: Votes,
/// The address that created the proposal.
pub proposer: Addr,
/// The deposit that was paid along with this proposal. This may
/// be refunded upon proposal completion.
pub deposit: Option<DepositInfo>,
}
impl Proposal {
/// current_status is non-mutable and returns what the status should be.
/// (designed for queries)
pub fn current_status(&self, block: &BlockInfo) -> Status {
let mut status = self.status;
// if open, check if voting is passed or timed out
if status == Status::Open && self.is_passed(block) {
status = Status::Passed;
}
if status == Status::Open && (self.is_rejected(block) || self.expires.is_expired(block)) {
status = Status::Rejected;
}
status
}
/// update_status sets the status of the proposal to current_status.
/// (designed for handler logic)
pub fn update_status(&mut self, block: &BlockInfo) {
self.status = self.current_status(block);
}
/// Returns true if this proposal is sure to pass (even before expiration, if no future
/// sequence of possible votes could cause it to fail).
pub fn is_passed(&self, block: &BlockInfo) -> bool {
match self.threshold {
Threshold::AbsoluteCount {
weight: weight_needed,
} => self.votes.yes >= weight_needed,
Threshold::AbsolutePercentage {
percentage: percentage_needed,
} => {
self.votes.yes
>= votes_needed(self.total_weight - self.votes.abstain, percentage_needed)
}
Threshold::ThresholdQuorum { threshold, quorum } => {
// we always require the quorum
if self.votes.total() < votes_needed(self.total_weight, quorum) {
return false;
}
if self.expires.is_expired(block) {
// If expired, we compare vote_count against the total number of votes (minus abstain).
let opinions = self.votes.total() - self.votes.abstain;
self.votes.yes >= votes_needed(opinions, threshold)
} else {
// If not expired, we must assume all non-votes will be cast against
let possible_opinions = self.total_weight - self.votes.abstain;
self.votes.yes >= votes_needed(possible_opinions, threshold)
}
}
}
}
/// Returns true if this proposal is sure to be rejected (even before expiration, if
/// no future sequence of possible votes could cause it to pass).
pub fn is_rejected(&self, block: &BlockInfo) -> bool {
match self.threshold {
Threshold::AbsoluteCount {
weight: weight_needed,
} => {
let weight = self.total_weight - weight_needed;
self.votes.no > weight
}
Threshold::AbsolutePercentage {
percentage: percentage_needed,
} => {
self.votes.no
> votes_needed(
self.total_weight - self.votes.abstain,
Decimal::one() - percentage_needed,
)
}
Threshold::ThresholdQuorum {
threshold,
quorum: _,
} => {
if self.expires.is_expired(block) {
// If expired, we compare vote_count against the total number of votes (minus abstain).
let opinions = self.votes.total() - self.votes.abstain;
self.votes.no > votes_needed(opinions, Decimal::one() - threshold)
} else {
// If not expired, we must assume all non-votes will be cast for
let possible_opinions = self.total_weight - self.votes.abstain;
self.votes.no > votes_needed(possible_opinions, Decimal::one() - threshold)
}
}
}
}
}
// weight of votes for each option
#[cw_serde]
pub struct Votes {
pub yes: u64,
pub no: u64,
pub abstain: u64,
pub veto: u64,
}
impl Votes {
/// sum of all votes
pub fn total(&self) -> u64 {
self.yes + self.no + self.abstain + self.veto
}
/// create it with a yes vote for this much
pub fn yes(init_weight: u64) -> Self {
Votes {
yes: init_weight,
no: 0,
abstain: 0,
veto: 0,
}
}
pub fn add_vote(&mut self, vote: Vote, weight: u64) {
match vote {
Vote::Yes => self.yes += weight,
Vote::Abstain => self.abstain += weight,
Vote::No => self.no += weight,
Vote::Veto => self.veto += weight,
}
}
}
// this is a helper function so Decimal works with u64 rather than Uint128
// also, we must *round up* here, as we need 8, not 7 votes to reach 50% of 15 total
fn votes_needed(weight: u64, percentage: Decimal) -> u64 {
let applied = percentage * Uint128::new(PRECISION_FACTOR * weight as u128);
// Divide by PRECISION_FACTOR, rounding up to the nearest integer
((applied.u128() + PRECISION_FACTOR - 1) / PRECISION_FACTOR) as u64
}
// we cast a ballot with our chosen vote and a given weight
// stored under the key that voted
#[cw_serde]
pub struct Ballot {
pub weight: u64,
pub vote: Vote,
}
#[cfg(test)]
mod test {
use super::*;
use cosmwasm_std::testing::mock_env;
#[test]
fn count_votes() {
let mut votes = Votes::yes(5);
votes.add_vote(Vote::No, 10);
votes.add_vote(Vote::Veto, 20);
votes.add_vote(Vote::Yes, 30);
votes.add_vote(Vote::Abstain, 40);
assert_eq!(votes.total(), 105);
assert_eq!(votes.yes, 35);
assert_eq!(votes.no, 10);
assert_eq!(votes.veto, 20);
assert_eq!(votes.abstain, 40);
}
#[test]
// we ensure this rounds up (as it calculates needed votes)
fn votes_needed_rounds_properly() {
// round up right below 1
assert_eq!(1, votes_needed(3, Decimal::permille(333)));
// round up right over 1
assert_eq!(2, votes_needed(3, Decimal::permille(334)));
assert_eq!(11, votes_needed(30, Decimal::permille(334)));
// exact matches don't round
assert_eq!(17, votes_needed(34, Decimal::percent(50)));
assert_eq!(12, votes_needed(48, Decimal::percent(25)));
}
fn setup_prop(
threshold: Threshold,
votes: Votes,
total_weight: u64,
is_expired: bool,
) -> (Proposal, BlockInfo) {
let block = mock_env().block;
let expires = match is_expired {
true => Expiration::AtHeight(block.height - 5),
false => Expiration::AtHeight(block.height + 100),
};
let prop = Proposal {
title: "Demo".to_string(),
description: "Info".to_string(),
start_height: 100,
expires,
msgs: vec![],
status: Status::Open,
proposer: Addr::unchecked("Proposer"),
deposit: None,
threshold,
total_weight,
votes,
};
(prop, block)
}
fn check_is_passed(
threshold: Threshold,
votes: Votes,
total_weight: u64,
is_expired: bool,
) -> bool {
let (prop, block) = setup_prop(threshold, votes, total_weight, is_expired);
prop.is_passed(&block)
}
fn check_is_rejected(
threshold: Threshold,
votes: Votes,
total_weight: u64,
is_expired: bool,
) -> bool {
let (prop, block) = setup_prop(threshold, votes, total_weight, is_expired);
prop.is_rejected(&block)
}
#[test]
fn proposal_passed_absolute_count() {
let fixed = Threshold::AbsoluteCount { weight: 10 };
let mut votes = Votes::yes(7);
votes.add_vote(Vote::Veto, 4);
// same expired or not, total_weight or whatever
assert!(!check_is_passed(fixed.clone(), votes.clone(), 30, false));
assert!(!check_is_passed(fixed.clone(), votes.clone(), 30, true));
// a few more yes votes and we are good
votes.add_vote(Vote::Yes, 3);
assert!(check_is_passed(fixed.clone(), votes.clone(), 30, false));
assert!(check_is_passed(fixed, votes, 30, true));
}
#[test]
fn proposal_rejected_absolute_count() {
let fixed = Threshold::AbsoluteCount { weight: 10 };
let mut votes = Votes::yes(0);
votes.add_vote(Vote::Veto, 4);
votes.add_vote(Vote::No, 7);
// In order to reject the proposal we need no votes > 30 - 10, currently it is not rejected
assert!(!check_is_rejected(fixed.clone(), votes.clone(), 30, false));
assert!(!check_is_rejected(fixed.clone(), votes.clone(), 30, true));
// 7 + 14 = 21 > 20, we can now reject
votes.add_vote(Vote::No, 14);
assert!(check_is_rejected(fixed.clone(), votes.clone(), 30, false));
assert!(check_is_rejected(fixed, votes, 30, true));
}
#[test]
fn proposal_passed_absolute_percentage() {
let percent = Threshold::AbsolutePercentage {
percentage: Decimal::percent(50),
};
let mut votes = Votes::yes(7);
votes.add_vote(Vote::No, 4);
votes.add_vote(Vote::Abstain, 2);
// same expired or not, if yes >= ceiling(0.5 * (total - abstained))
// 7 of (15-2) passes
assert!(check_is_passed(percent.clone(), votes.clone(), 15, false));
assert!(check_is_passed(percent.clone(), votes.clone(), 15, true));
// but 7 of (17-2) fails
assert!(!check_is_passed(percent.clone(), votes.clone(), 17, false));
// if the total were a bit lower, this would pass
assert!(check_is_passed(percent.clone(), votes.clone(), 14, false));
assert!(check_is_passed(percent, votes, 14, true));
}
#[test]
fn proposal_rejected_absolute_percentage() {
let percent = Threshold::AbsolutePercentage {
percentage: Decimal::percent(60),
};
// 4 YES, 7 NO, 2 ABSTAIN
let mut votes = Votes::yes(4);
votes.add_vote(Vote::No, 7);
votes.add_vote(Vote::Abstain, 2);
// 15 total voting power
// we need no votes > 0.4 * 15, no votes > 6
assert!(check_is_rejected(percent.clone(), votes.clone(), 15, false));
assert!(check_is_rejected(percent.clone(), votes.clone(), 15, true));
// 17 total voting power
// we need no votes > 0.4 * 17, no votes > 6.8
// still rejected
assert!(check_is_rejected(percent.clone(), votes.clone(), 17, false));
assert!(check_is_rejected(percent.clone(), votes.clone(), 17, true));
// Not rejected if total weight is 20
// as no votes > 0.4 * 18, no votes > 8
assert!(!check_is_rejected(
percent.clone(),
votes.clone(),
20,
false
));
assert!(!check_is_rejected(percent, votes.clone(), 20, true));
}
#[test]
fn proposal_passed_quorum() {
let quorum = Threshold::ThresholdQuorum {
threshold: Decimal::percent(50),
quorum: Decimal::percent(40),
};
// all non-yes votes are counted for quorum
let passing = Votes {
yes: 7,
no: 3,
abstain: 2,
veto: 1,
};
// abstain votes are not counted for threshold => yes / (yes + no + veto)
let passes_ignoring_abstain = Votes {
yes: 6,
no: 4,
abstain: 5,
veto: 2,
};
// fails any way you look at it
let failing = Votes {
yes: 6,
no: 5,
abstain: 2,
veto: 2,
};
// first, expired (voting period over)
// over quorum (40% of 30 = 12), over threshold (7/11 > 50%)
assert!(check_is_passed(quorum.clone(), passing.clone(), 30, true));
// under quorum it is not passing (40% of 33 = 13.2 > 13)
assert!(!check_is_passed(quorum.clone(), passing.clone(), 33, true));
// over quorum, threshold passes if we ignore abstain
// 17 total votes w/ abstain => 40% quorum of 40 total
// 6 yes / (6 yes + 4 no + 2 votes) => 50% threshold
assert!(check_is_passed(
quorum.clone(),
passes_ignoring_abstain.clone(),
40,
true
));
// over quorum, but under threshold fails also
assert!(!check_is_passed(quorum.clone(), failing, 20, true));
// now, check with open voting period
// would pass if closed, but fail here, as remaining votes no -> fail
assert!(!check_is_passed(quorum.clone(), passing.clone(), 30, false));
assert!(!check_is_passed(
quorum.clone(),
passes_ignoring_abstain.clone(),
40,
false
));
// if we have threshold * total_weight as yes votes this must pass
assert!(check_is_passed(quorum.clone(), passing.clone(), 14, false));
// all votes have been cast, some abstain
assert!(check_is_passed(
quorum.clone(),
passes_ignoring_abstain,
17,
false
));
// 3 votes uncast, if they all vote no, we have 7 yes, 7 no+veto, 2 abstain (out of 16)
assert!(check_is_passed(quorum, passing, 16, false));
}
#[test]
fn proposal_rejected_quorum() {
let quorum = Threshold::ThresholdQuorum {
threshold: Decimal::percent(60),
quorum: Decimal::percent(40),
};
// all non-yes votes are counted for quorum
let rejecting = Votes {
yes: 3,
no: 7,
abstain: 2,
veto: 1,
};
// abstain votes are not counted for threshold => yes / (yes + no + veto)
let rejected_ignoring_abstain = Votes {
yes: 4,
no: 6,
abstain: 5,
veto: 2,
};
// fails any way you look at it
let failing = Votes {
yes: 5,
no: 5,
abstain: 2,
veto: 3,
};
// first, expired (voting period over)
// over quorum (40% of 30 = 12, 13 votes casted)
// 13 - 2 abstains = 11
// we need no votes > 0.4 * 11, no votes > 4.4
// We can reject this
assert!(check_is_rejected(
quorum.clone(),
rejecting.clone(),
30,
true
));
// Under quorum and cannot reject as it is not expired
assert!(!check_is_rejected(
quorum.clone(),
rejecting.clone(),
50,
false
));
// Can reject when expired.
assert!(check_is_rejected(
quorum.clone(),
rejecting.clone(),
50,
true
));
// Check edgecase where quorum is not met but we can reject
// 35% vote no
let quorum_edgecase = Threshold::ThresholdQuorum {
threshold: Decimal::percent(67),
quorum: Decimal::percent(40),
};
assert!(check_is_rejected(
quorum_edgecase,
Votes {
yes: 15,
no: 35,
abstain: 0,
veto: 10
},
100,
true
));
// over quorum, threshold passes if we ignore abstain
// 17 total votes > 40% quorum
// 6 no > 0.4 * (6 no + 4 yes + 2 votes)
// 6 > 4.8
// we can reject
assert!(check_is_rejected(
quorum.clone(),
rejected_ignoring_abstain.clone(),
40,
true
));
// over quorum
// total opinions due to abstains: 13
// no votes > 0.4 * 13, no votes > 5 to reject, we have 5 exactly so cannot reject
assert!(!check_is_rejected(quorum.clone(), failing, 20, true));
// voting period on going
// over quorum (40% of 14 = 5, 13 votes casted)
// 13 - 2 abstains = 11
// we need no votes > 0.4 * 11, no votes > 4.4
// We can reject this even when it hasn't expired
assert!(check_is_rejected(
quorum.clone(),
rejecting.clone(),
14,
false
));
// all votes have been cast, some abstain
// voting period on going
// over quorum (40% of 17 = 7, 17 casted_
// 17 - 5 = 12 total opinions
// we need no votes > 0.4 * 12, no votes > 4.8
// We can reject this even when it hasn't expired
assert!(check_is_rejected(
quorum.clone(),
rejected_ignoring_abstain,
17,
false
));
// 3 votes uncast, if they all vote yes, we have 7 no, 7 yes+veto, 2 abstain (out of 16)
assert!(check_is_rejected(quorum, rejecting, 16, false));
}
#[test]
fn quorum_edge_cases() {
// when we pass absolute threshold (everyone else voting no, we pass), but still don't hit quorum
let quorum = Threshold::ThresholdQuorum {
threshold: Decimal::percent(60),
quorum: Decimal::percent(80),
};
// try 9 yes, 1 no (out of 15) -> 90% voter threshold, 60% absolute threshold, still no quorum
// doesn't matter if expired or not
let missing_voters = Votes {
yes: 9,
no: 1,
abstain: 0,
veto: 0,
};
assert!(!check_is_passed(
quorum.clone(),
missing_voters.clone(),
15,
false
));
assert!(!check_is_passed(quorum.clone(), missing_voters, 15, true));
// 1 less yes, 3 vetos and this passes only when expired
let wait_til_expired = Votes {
yes: 8,
no: 1,
abstain: 0,
veto: 3,
};
assert!(!check_is_passed(
quorum.clone(),
wait_til_expired.clone(),
15,
false
));
assert!(check_is_passed(quorum.clone(), wait_til_expired, 15, true));
// 9 yes and 3 nos passes early
let passes_early = Votes {
yes: 9,
no: 3,
abstain: 0,
veto: 0,
};
assert!(check_is_passed(
quorum.clone(),
passes_early.clone(),
15,
false
));
assert!(check_is_passed(quorum, passes_early, 15, true));
}
}