This reverts commit 34344982a9
.
This commit is contained in:
25
programs/vote_api/Cargo.toml
Normal file
25
programs/vote_api/Cargo.toml
Normal file
@ -0,0 +1,25 @@
|
||||
[package]
|
||||
name = "solana-vote-api"
|
||||
version = "0.14.0"
|
||||
description = "Solana Vote program API"
|
||||
authors = ["Solana Maintainers <maintainers@solana.com>"]
|
||||
repository = "https://github.com/solana-labs/solana"
|
||||
license = "Apache-2.0"
|
||||
homepage = "https://solana.com/"
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
bincode = "1.1.3"
|
||||
log = "0.4.2"
|
||||
serde = "1.0.90"
|
||||
serde_derive = "1.0.90"
|
||||
solana-logger = { path = "../../logger", version = "0.14.0" }
|
||||
solana-metrics = { path = "../../metrics", version = "0.14.0" }
|
||||
solana-sdk = { path = "../../sdk", version = "0.14.0" }
|
||||
|
||||
[dev-dependencies]
|
||||
solana-runtime = { path = "../../runtime", version = "0.14.0" }
|
||||
|
||||
[lib]
|
||||
name = "solana_vote_api"
|
||||
crate-type = ["lib"]
|
17
programs/vote_api/src/lib.rs
Normal file
17
programs/vote_api/src/lib.rs
Normal file
@ -0,0 +1,17 @@
|
||||
pub mod vote_instruction;
|
||||
pub mod vote_state;
|
||||
|
||||
use solana_sdk::pubkey::Pubkey;
|
||||
|
||||
const VOTE_PROGRAM_ID: [u8; 32] = [
|
||||
132, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||
0,
|
||||
];
|
||||
|
||||
pub fn check_id(program_id: &Pubkey) -> bool {
|
||||
program_id.as_ref() == VOTE_PROGRAM_ID
|
||||
}
|
||||
|
||||
pub fn id() -> Pubkey {
|
||||
Pubkey::new(&VOTE_PROGRAM_ID)
|
||||
}
|
219
programs/vote_api/src/vote_instruction.rs
Normal file
219
programs/vote_api/src/vote_instruction.rs
Normal file
@ -0,0 +1,219 @@
|
||||
//! Vote program
|
||||
//! Receive and processes votes from validators
|
||||
|
||||
use crate::id;
|
||||
use crate::vote_state::{self, Vote, VoteState};
|
||||
use bincode::deserialize;
|
||||
use log::*;
|
||||
use serde_derive::{Deserialize, Serialize};
|
||||
use solana_sdk::account::KeyedAccount;
|
||||
use solana_sdk::instruction::{AccountMeta, Instruction, InstructionError};
|
||||
use solana_sdk::pubkey::Pubkey;
|
||||
use solana_sdk::system_instruction;
|
||||
|
||||
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)]
|
||||
pub enum VoteInstruction {
|
||||
/// Initialize the VoteState for this `vote account`
|
||||
/// takes a node_id and commission
|
||||
InitializeAccount(Pubkey, u32),
|
||||
|
||||
/// Authorize a voter to send signed votes.
|
||||
AuthorizeVoter(Pubkey),
|
||||
|
||||
/// A Vote instruction with recent votes
|
||||
Vote(Vec<Vote>),
|
||||
}
|
||||
|
||||
fn initialize_account(vote_id: &Pubkey, node_id: &Pubkey, commission: u32) -> Instruction {
|
||||
let account_metas = vec![AccountMeta::new(*vote_id, false)];
|
||||
Instruction::new(
|
||||
id(),
|
||||
&VoteInstruction::InitializeAccount(*node_id, commission),
|
||||
account_metas,
|
||||
)
|
||||
}
|
||||
|
||||
pub fn create_account(
|
||||
from_id: &Pubkey,
|
||||
vote_id: &Pubkey,
|
||||
node_id: &Pubkey,
|
||||
commission: u32,
|
||||
lamports: u64,
|
||||
) -> Vec<Instruction> {
|
||||
let space = VoteState::size_of() as u64;
|
||||
let create_ix = system_instruction::create_account(&from_id, vote_id, lamports, space, &id());
|
||||
let init_ix = initialize_account(vote_id, node_id, commission);
|
||||
vec![create_ix, init_ix]
|
||||
}
|
||||
|
||||
pub fn authorize_voter(vote_id: &Pubkey, authorized_voter_id: &Pubkey) -> Instruction {
|
||||
let account_metas = vec![AccountMeta::new(*vote_id, true)];
|
||||
Instruction::new(
|
||||
id(),
|
||||
&VoteInstruction::AuthorizeVoter(*authorized_voter_id),
|
||||
account_metas,
|
||||
)
|
||||
}
|
||||
|
||||
pub fn vote(vote_id: &Pubkey, recent_votes: Vec<Vote>) -> Instruction {
|
||||
let account_metas = vec![AccountMeta::new(*vote_id, true)];
|
||||
Instruction::new(id(), &VoteInstruction::Vote(recent_votes), account_metas)
|
||||
}
|
||||
|
||||
pub fn process_instruction(
|
||||
_program_id: &Pubkey,
|
||||
keyed_accounts: &mut [KeyedAccount],
|
||||
data: &[u8],
|
||||
_tick_height: u64,
|
||||
) -> Result<(), InstructionError> {
|
||||
solana_logger::setup();
|
||||
|
||||
trace!("process_instruction: {:?}", data);
|
||||
trace!("keyed_accounts: {:?}", keyed_accounts);
|
||||
|
||||
match deserialize(data).map_err(|_| InstructionError::InvalidInstructionData)? {
|
||||
VoteInstruction::InitializeAccount(node_id, commission) => {
|
||||
let mut vote_account = &mut keyed_accounts[0];
|
||||
vote_state::initialize_account(&mut vote_account, &node_id, commission)
|
||||
}
|
||||
VoteInstruction::AuthorizeVoter(voter_id) => {
|
||||
let (vote_account, other_signers) = keyed_accounts.split_at_mut(1);
|
||||
let vote_account = &mut vote_account[0];
|
||||
|
||||
vote_state::authorize_voter(vote_account, other_signers, &voter_id)
|
||||
}
|
||||
VoteInstruction::Vote(vote) => {
|
||||
solana_metrics::submit(
|
||||
solana_metrics::influxdb::Point::new("vote-native")
|
||||
.add_field("count", solana_metrics::influxdb::Value::Integer(1))
|
||||
.to_owned(),
|
||||
);
|
||||
let (vote_account, other_signers) = keyed_accounts.split_at_mut(1);
|
||||
let vote_account = &mut vote_account[0];
|
||||
|
||||
vote_state::process_vote(vote_account, other_signers, &vote)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::id;
|
||||
use crate::vote_instruction;
|
||||
use crate::vote_state::{Vote, VoteState};
|
||||
use solana_runtime::bank::Bank;
|
||||
use solana_runtime::bank_client::BankClient;
|
||||
use solana_sdk::client::SyncClient;
|
||||
use solana_sdk::genesis_block::GenesisBlock;
|
||||
use solana_sdk::instruction::InstructionError;
|
||||
use solana_sdk::message::Message;
|
||||
use solana_sdk::pubkey::Pubkey;
|
||||
use solana_sdk::signature::{Keypair, KeypairUtil};
|
||||
use solana_sdk::system_instruction;
|
||||
use solana_sdk::transaction::{Result, TransactionError};
|
||||
|
||||
fn create_bank(lamports: u64) -> (Bank, Keypair) {
|
||||
let (genesis_block, mint_keypair) = GenesisBlock::new(lamports);
|
||||
let mut bank = Bank::new(&genesis_block);
|
||||
bank.add_instruction_processor(id(), process_instruction);
|
||||
(bank, mint_keypair)
|
||||
}
|
||||
|
||||
fn create_vote_account(
|
||||
bank_client: &BankClient,
|
||||
from_keypair: &Keypair,
|
||||
vote_id: &Pubkey,
|
||||
lamports: u64,
|
||||
) -> Result<()> {
|
||||
let ixs = vote_instruction::create_account(
|
||||
&from_keypair.pubkey(),
|
||||
vote_id,
|
||||
&Pubkey::new_rand(),
|
||||
0,
|
||||
lamports,
|
||||
);
|
||||
let message = Message::new(ixs);
|
||||
bank_client
|
||||
.send_message(&[from_keypair], message)
|
||||
.map_err(|err| err.unwrap())?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn submit_vote(
|
||||
bank_client: &BankClient,
|
||||
vote_keypair: &Keypair,
|
||||
tick_height: u64,
|
||||
) -> Result<()> {
|
||||
let vote_ix = vote_instruction::vote(&vote_keypair.pubkey(), vec![Vote::new(tick_height)]);
|
||||
bank_client
|
||||
.send_instruction(vote_keypair, vote_ix)
|
||||
.map_err(|err| err.unwrap())?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote_bank_basic() {
|
||||
let (bank, from_keypair) = create_bank(10_000);
|
||||
let bank_client = BankClient::new(bank);
|
||||
|
||||
let vote_keypair = Keypair::new();
|
||||
let vote_id = vote_keypair.pubkey();
|
||||
|
||||
create_vote_account(&bank_client, &from_keypair, &vote_id, 100).unwrap();
|
||||
submit_vote(&bank_client, &vote_keypair, 0).unwrap();
|
||||
|
||||
let vote_account_data = bank_client.get_account_data(&vote_id).unwrap().unwrap();
|
||||
let vote_state = VoteState::deserialize(&vote_account_data).unwrap();
|
||||
assert_eq!(vote_state.votes.len(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote_via_bank_authorize_voter() {
|
||||
let (bank, mallory_keypair) = create_bank(10_000);
|
||||
let bank_client = BankClient::new(bank);
|
||||
|
||||
let vote_keypair = Keypair::new();
|
||||
let vote_id = vote_keypair.pubkey();
|
||||
|
||||
create_vote_account(&bank_client, &mallory_keypair, &vote_id, 100).unwrap();
|
||||
|
||||
let mallory_id = mallory_keypair.pubkey();
|
||||
let vote_ix = vote_instruction::authorize_voter(&vote_id, &mallory_id);
|
||||
|
||||
let message = Message::new(vec![vote_ix]);
|
||||
assert!(bank_client.send_message(&[&vote_keypair], message).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote_via_bank_with_no_signature() {
|
||||
let (bank, mallory_keypair) = create_bank(10_000);
|
||||
let bank_client = BankClient::new(bank);
|
||||
|
||||
let vote_keypair = Keypair::new();
|
||||
let vote_id = vote_keypair.pubkey();
|
||||
|
||||
create_vote_account(&bank_client, &mallory_keypair, &vote_id, 100).unwrap();
|
||||
|
||||
let mallory_id = mallory_keypair.pubkey();
|
||||
let mut vote_ix = vote_instruction::vote(&vote_id, vec![Vote::new(0)]);
|
||||
vote_ix.accounts[0].is_signer = false; // <--- attack!! No signer required.
|
||||
|
||||
// Sneak in an instruction so that the transaction is signed but
|
||||
// the 0th account in the second instruction is not! The program
|
||||
// needs to check that it's signed.
|
||||
let move_ix = system_instruction::transfer(&mallory_id, &vote_id, 1);
|
||||
let message = Message::new(vec![move_ix, vote_ix]);
|
||||
let result = bank_client.send_message(&[&mallory_keypair], message);
|
||||
|
||||
// And ensure there's no vote.
|
||||
let vote_account_data = bank_client.get_account_data(&vote_id).unwrap().unwrap();
|
||||
let vote_state = VoteState::deserialize(&vote_account_data).unwrap();
|
||||
assert_eq!(vote_state.votes.len(), 0);
|
||||
|
||||
assert_eq!(
|
||||
result.unwrap_err().unwrap(),
|
||||
TransactionError::InstructionError(1, InstructionError::MissingRequiredSignature)
|
||||
);
|
||||
}
|
||||
}
|
610
programs/vote_api/src/vote_state.rs
Normal file
610
programs/vote_api/src/vote_state.rs
Normal file
@ -0,0 +1,610 @@
|
||||
//! Vote state, vote program
|
||||
//! Receive and processes votes from validators
|
||||
use crate::id;
|
||||
use bincode::{deserialize, serialize_into, serialized_size, ErrorKind};
|
||||
use serde_derive::{Deserialize, Serialize};
|
||||
use solana_sdk::account::{Account, KeyedAccount};
|
||||
use solana_sdk::instruction::InstructionError;
|
||||
use solana_sdk::instruction_processor_utils::State;
|
||||
use solana_sdk::pubkey::Pubkey;
|
||||
use std::collections::VecDeque;
|
||||
|
||||
// Maximum number of votes to keep around
|
||||
pub const MAX_LOCKOUT_HISTORY: usize = 31;
|
||||
pub const INITIAL_LOCKOUT: usize = 2;
|
||||
|
||||
#[derive(Serialize, Default, Deserialize, Debug, PartialEq, Eq, Clone)]
|
||||
pub struct Vote {
|
||||
// TODO: add signature of the state here as well
|
||||
/// A vote for height slot
|
||||
pub slot: u64,
|
||||
}
|
||||
|
||||
impl Vote {
|
||||
pub fn new(slot: u64) -> Self {
|
||||
Self { slot }
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Serialize, Default, Deserialize, Debug, PartialEq, Eq, Clone)]
|
||||
pub struct Lockout {
|
||||
pub slot: u64,
|
||||
pub confirmation_count: u32,
|
||||
}
|
||||
|
||||
impl Lockout {
|
||||
pub fn new(vote: &Vote) -> Self {
|
||||
Self {
|
||||
slot: vote.slot,
|
||||
confirmation_count: 1,
|
||||
}
|
||||
}
|
||||
|
||||
// The number of slots for which this vote is locked
|
||||
pub fn lockout(&self) -> u64 {
|
||||
(INITIAL_LOCKOUT as u64).pow(self.confirmation_count)
|
||||
}
|
||||
|
||||
// The slot height at which this vote expires (cannot vote for any slot
|
||||
// less than this)
|
||||
pub fn expiration_slot(&self) -> u64 {
|
||||
self.slot + self.lockout()
|
||||
}
|
||||
pub fn is_expired(&self, slot: u64) -> bool {
|
||||
self.expiration_slot() < slot
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Serialize, Deserialize, PartialEq, Eq, Clone)]
|
||||
pub struct VoteState {
|
||||
pub votes: VecDeque<Lockout>,
|
||||
pub node_id: Pubkey,
|
||||
pub authorized_voter_id: Pubkey,
|
||||
/// fraction of std::u32::MAX that represents what part of a rewards
|
||||
/// payout should be given to this VoteAccount
|
||||
pub commission: u32,
|
||||
pub root_slot: Option<u64>,
|
||||
credits: u64,
|
||||
}
|
||||
|
||||
impl VoteState {
|
||||
pub fn new(vote_id: &Pubkey, node_id: &Pubkey, commission: u32) -> Self {
|
||||
let votes = VecDeque::new();
|
||||
let credits = 0;
|
||||
let root_slot = None;
|
||||
Self {
|
||||
votes,
|
||||
node_id: *node_id,
|
||||
authorized_voter_id: *vote_id,
|
||||
credits,
|
||||
commission,
|
||||
root_slot,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn size_of() -> usize {
|
||||
// Upper limit on the size of the Vote State. Equal to
|
||||
// size_of(VoteState) when votes.len() is MAX_LOCKOUT_HISTORY
|
||||
let mut vote_state = Self::default();
|
||||
vote_state.votes = VecDeque::from(vec![Lockout::default(); MAX_LOCKOUT_HISTORY]);
|
||||
vote_state.root_slot = Some(std::u64::MAX);
|
||||
serialized_size(&vote_state).unwrap() as usize
|
||||
}
|
||||
|
||||
pub fn deserialize(input: &[u8]) -> Result<Self, InstructionError> {
|
||||
deserialize(input).map_err(|_| InstructionError::InvalidAccountData)
|
||||
}
|
||||
|
||||
pub fn serialize(&self, output: &mut [u8]) -> Result<(), InstructionError> {
|
||||
serialize_into(output, self).map_err(|err| match *err {
|
||||
ErrorKind::SizeLimit => InstructionError::AccountDataTooSmall,
|
||||
_ => InstructionError::GenericError,
|
||||
})
|
||||
}
|
||||
|
||||
/// returns commission split as (voter_portion, staker_portion) tuple
|
||||
///
|
||||
/// if commission calculation is 100% one way or other,
|
||||
/// indicate with None for the 0% side
|
||||
pub fn commission_split(&self, on: f64) -> (f64, f64, bool) {
|
||||
match self.commission {
|
||||
0 => (0.0, on, false),
|
||||
std::u32::MAX => (on, 0.0, false),
|
||||
split => {
|
||||
let mine = on * f64::from(split) / f64::from(std::u32::MAX);
|
||||
(mine, on - mine, true)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub fn process_votes(&mut self, votes: &[Vote]) {
|
||||
votes.iter().for_each(|v| self.process_vote(v));;
|
||||
}
|
||||
|
||||
pub fn process_vote(&mut self, vote: &Vote) {
|
||||
// Ignore votes for slots earlier than we already have votes for
|
||||
if self
|
||||
.votes
|
||||
.back()
|
||||
.map_or(false, |old_vote| old_vote.slot >= vote.slot)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
let vote = Lockout::new(&vote);
|
||||
|
||||
// TODO: Integrity checks
|
||||
// Verify the vote's bank hash matches what is expected
|
||||
|
||||
self.pop_expired_votes(vote.slot);
|
||||
// Once the stack is full, pop the oldest vote and distribute rewards
|
||||
if self.votes.len() == MAX_LOCKOUT_HISTORY {
|
||||
let vote = self.votes.pop_front().unwrap();
|
||||
self.root_slot = Some(vote.slot);
|
||||
self.credits += 1;
|
||||
}
|
||||
self.votes.push_back(vote);
|
||||
self.double_lockouts();
|
||||
}
|
||||
|
||||
pub fn nth_recent_vote(&self, position: usize) -> Option<&Lockout> {
|
||||
if position < self.votes.len() {
|
||||
let pos = self.votes.len() - 1 - position;
|
||||
self.votes.get(pos)
|
||||
} else {
|
||||
None
|
||||
}
|
||||
}
|
||||
|
||||
/// Number of "credits" owed to this account from the mining pool. Submit this
|
||||
/// VoteState to the Rewards program to trade credits for lamports.
|
||||
pub fn credits(&self) -> u64 {
|
||||
self.credits
|
||||
}
|
||||
|
||||
fn pop_expired_votes(&mut self, slot: u64) {
|
||||
loop {
|
||||
if self.votes.back().map_or(false, |v| v.is_expired(slot)) {
|
||||
self.votes.pop_back();
|
||||
} else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn double_lockouts(&mut self) {
|
||||
let stack_depth = self.votes.len();
|
||||
for (i, v) in self.votes.iter_mut().enumerate() {
|
||||
// Don't increase the lockout for this vote until we get more confirmations
|
||||
// than the max number of confirmations this vote has seen
|
||||
if stack_depth > i + v.confirmation_count as usize {
|
||||
v.confirmation_count += 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Authorize the given pubkey to sign votes. This may be called multiple times,
|
||||
/// but will implicitly withdraw authorization from the previously authorized
|
||||
/// voter. The default voter is the owner of the vote account's pubkey.
|
||||
pub fn authorize_voter(
|
||||
vote_account: &mut KeyedAccount,
|
||||
other_signers: &[KeyedAccount],
|
||||
authorized_voter_id: &Pubkey,
|
||||
) -> Result<(), InstructionError> {
|
||||
let mut vote_state: VoteState = vote_account.state()?;
|
||||
|
||||
// current authorized signer must say "yay"
|
||||
let authorized = Some(&vote_state.authorized_voter_id);
|
||||
if vote_account.signer_key() != authorized
|
||||
&& other_signers
|
||||
.iter()
|
||||
.all(|account| account.signer_key() != authorized)
|
||||
{
|
||||
return Err(InstructionError::MissingRequiredSignature);
|
||||
}
|
||||
|
||||
vote_state.authorized_voter_id = *authorized_voter_id;
|
||||
vote_account.set_state(&vote_state)
|
||||
}
|
||||
|
||||
/// Initialize the vote_state for a vote account
|
||||
/// Assumes that the account is being init as part of a account creation or balance transfer and
|
||||
/// that the transaction must be signed by the staker's keys
|
||||
pub fn initialize_account(
|
||||
vote_account: &mut KeyedAccount,
|
||||
node_id: &Pubkey,
|
||||
commission: u32,
|
||||
) -> Result<(), InstructionError> {
|
||||
let vote_state: VoteState = vote_account.state()?;
|
||||
|
||||
if vote_state.authorized_voter_id != Pubkey::default() {
|
||||
return Err(InstructionError::AccountAlreadyInitialized);
|
||||
}
|
||||
vote_account.set_state(&VoteState::new(
|
||||
vote_account.unsigned_key(),
|
||||
node_id,
|
||||
commission,
|
||||
))
|
||||
}
|
||||
|
||||
pub fn process_vote(
|
||||
vote_account: &mut KeyedAccount,
|
||||
other_signers: &[KeyedAccount],
|
||||
votes: &[Vote],
|
||||
) -> Result<(), InstructionError> {
|
||||
let mut vote_state: VoteState = vote_account.state()?;
|
||||
|
||||
if vote_state.authorized_voter_id == Pubkey::default() {
|
||||
return Err(InstructionError::UninitializedAccount);
|
||||
}
|
||||
|
||||
let authorized = Some(&vote_state.authorized_voter_id);
|
||||
// find a signer that matches the authorized_voter_id
|
||||
if vote_account.signer_key() != authorized
|
||||
&& other_signers
|
||||
.iter()
|
||||
.all(|account| account.signer_key() != authorized)
|
||||
{
|
||||
return Err(InstructionError::MissingRequiredSignature);
|
||||
}
|
||||
|
||||
vote_state.process_votes(&votes);
|
||||
vote_account.set_state(&vote_state)
|
||||
}
|
||||
|
||||
// utility function, used by Bank, tests
|
||||
pub fn create_account(
|
||||
vote_id: &Pubkey,
|
||||
node_id: &Pubkey,
|
||||
commission: u32,
|
||||
lamports: u64,
|
||||
) -> Account {
|
||||
let mut vote_account = Account::new(lamports, VoteState::size_of(), &id());
|
||||
|
||||
initialize_account(
|
||||
&mut KeyedAccount::new(vote_id, false, &mut vote_account),
|
||||
node_id,
|
||||
commission,
|
||||
)
|
||||
.unwrap();
|
||||
vote_account
|
||||
}
|
||||
|
||||
// utility function, used by Bank, tests
|
||||
pub fn vote(
|
||||
vote_id: &Pubkey,
|
||||
vote_account: &mut Account,
|
||||
vote: &Vote,
|
||||
) -> Result<VoteState, InstructionError> {
|
||||
process_vote(
|
||||
&mut KeyedAccount::new(vote_id, true, vote_account),
|
||||
&[],
|
||||
&[vote.clone()],
|
||||
)?;
|
||||
vote_account.state()
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::vote_state;
|
||||
|
||||
const MAX_RECENT_VOTES: usize = 16;
|
||||
|
||||
#[test]
|
||||
fn test_initialize_vote_account() {
|
||||
let vote_account_id = Pubkey::new_rand();
|
||||
let mut vote_account = Account::new(100, VoteState::size_of(), &id());
|
||||
|
||||
let node_id = Pubkey::new_rand();
|
||||
|
||||
//init should pass
|
||||
let mut vote_account = KeyedAccount::new(&vote_account_id, false, &mut vote_account);
|
||||
let res = initialize_account(&mut vote_account, &node_id, 0);
|
||||
assert_eq!(res, Ok(()));
|
||||
|
||||
// reinit should fail
|
||||
let res = initialize_account(&mut vote_account, &node_id, 0);
|
||||
assert_eq!(res, Err(InstructionError::AccountAlreadyInitialized));
|
||||
}
|
||||
|
||||
fn create_test_account() -> (Pubkey, Account) {
|
||||
let vote_id = Pubkey::new_rand();
|
||||
(
|
||||
vote_id,
|
||||
vote_state::create_account(&vote_id, &Pubkey::new_rand(), 0, 100),
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote_serialize() {
|
||||
let mut buffer: Vec<u8> = vec![0; VoteState::size_of()];
|
||||
let mut vote_state = VoteState::default();
|
||||
vote_state
|
||||
.votes
|
||||
.resize(MAX_LOCKOUT_HISTORY, Lockout::default());
|
||||
assert!(vote_state.serialize(&mut buffer[0..4]).is_err());
|
||||
vote_state.serialize(&mut buffer).unwrap();
|
||||
assert_eq!(VoteState::deserialize(&buffer).unwrap(), vote_state);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_voter_registration() {
|
||||
let (vote_id, vote_account) = create_test_account();
|
||||
|
||||
let vote_state: VoteState = vote_account.state().unwrap();
|
||||
assert_eq!(vote_state.authorized_voter_id, vote_id);
|
||||
assert!(vote_state.votes.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote() {
|
||||
let (vote_id, mut vote_account) = create_test_account();
|
||||
|
||||
let vote = Vote::new(1);
|
||||
let vote_state = vote_state::vote(&vote_id, &mut vote_account, &vote).unwrap();
|
||||
assert_eq!(vote_state.votes, vec![Lockout::new(&vote)]);
|
||||
assert_eq!(vote_state.credits(), 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote_signature() {
|
||||
let (vote_id, mut vote_account) = create_test_account();
|
||||
|
||||
let vote = vec![Vote::new(1)];
|
||||
|
||||
// unsigned
|
||||
let res = process_vote(
|
||||
&mut KeyedAccount::new(&vote_id, false, &mut vote_account),
|
||||
&[],
|
||||
&vote,
|
||||
);
|
||||
assert_eq!(res, Err(InstructionError::MissingRequiredSignature));
|
||||
|
||||
// unsigned
|
||||
let res = process_vote(
|
||||
&mut KeyedAccount::new(&vote_id, true, &mut vote_account),
|
||||
&[],
|
||||
&vote,
|
||||
);
|
||||
assert_eq!(res, Ok(()));
|
||||
|
||||
// another voter
|
||||
let authorized_voter_id = Pubkey::new_rand();
|
||||
let res = authorize_voter(
|
||||
&mut KeyedAccount::new(&vote_id, false, &mut vote_account),
|
||||
&[],
|
||||
&authorized_voter_id,
|
||||
);
|
||||
assert_eq!(res, Err(InstructionError::MissingRequiredSignature));
|
||||
|
||||
let res = authorize_voter(
|
||||
&mut KeyedAccount::new(&vote_id, true, &mut vote_account),
|
||||
&[],
|
||||
&authorized_voter_id,
|
||||
);
|
||||
assert_eq!(res, Ok(()));
|
||||
// verify authorized_voter_id can authorize authorized_voter_id ;)
|
||||
let res = authorize_voter(
|
||||
&mut KeyedAccount::new(&vote_id, false, &mut vote_account),
|
||||
&[KeyedAccount::new(
|
||||
&authorized_voter_id,
|
||||
true,
|
||||
&mut Account::default(),
|
||||
)],
|
||||
&authorized_voter_id,
|
||||
);
|
||||
assert_eq!(res, Ok(()));
|
||||
|
||||
// not signed by authorized voter
|
||||
let vote = vec![Vote::new(2)];
|
||||
let res = process_vote(
|
||||
&mut KeyedAccount::new(&vote_id, true, &mut vote_account),
|
||||
&[],
|
||||
&vote,
|
||||
);
|
||||
assert_eq!(res, Err(InstructionError::MissingRequiredSignature));
|
||||
|
||||
// signed by authorized voter
|
||||
let vote = vec![Vote::new(2)];
|
||||
let res = process_vote(
|
||||
&mut KeyedAccount::new(&vote_id, false, &mut vote_account),
|
||||
&[KeyedAccount::new(
|
||||
&authorized_voter_id,
|
||||
true,
|
||||
&mut Account::default(),
|
||||
)],
|
||||
&vote,
|
||||
);
|
||||
assert_eq!(res, Ok(()));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote_without_initialization() {
|
||||
let vote_id = Pubkey::new_rand();
|
||||
let mut vote_account = Account::new(100, VoteState::size_of(), &id());
|
||||
|
||||
let res = vote_state::vote(&vote_id, &mut vote_account, &Vote::new(1));
|
||||
assert_eq!(res, Err(InstructionError::UninitializedAccount));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote_lockout() {
|
||||
let (_vote_id, vote_account) = create_test_account();
|
||||
|
||||
let mut vote_state: VoteState = vote_account.state().unwrap();
|
||||
|
||||
for i in 0..(MAX_LOCKOUT_HISTORY + 1) {
|
||||
vote_state.process_vote(&Vote::new((INITIAL_LOCKOUT as usize * i) as u64));
|
||||
}
|
||||
|
||||
// The last vote should have been popped b/c it reached a depth of MAX_LOCKOUT_HISTORY
|
||||
assert_eq!(vote_state.votes.len(), MAX_LOCKOUT_HISTORY);
|
||||
assert_eq!(vote_state.root_slot, Some(0));
|
||||
check_lockouts(&vote_state);
|
||||
|
||||
// One more vote that confirms the entire stack,
|
||||
// the root_slot should change to the
|
||||
// second vote
|
||||
let top_vote = vote_state.votes.front().unwrap().slot;
|
||||
vote_state.process_vote(&Vote::new(
|
||||
vote_state.votes.back().unwrap().expiration_slot(),
|
||||
));
|
||||
assert_eq!(Some(top_vote), vote_state.root_slot);
|
||||
|
||||
// Expire everything except the first vote
|
||||
let vote = Vote::new(vote_state.votes.front().unwrap().expiration_slot());
|
||||
vote_state.process_vote(&vote);
|
||||
// First vote and new vote are both stored for a total of 2 votes
|
||||
assert_eq!(vote_state.votes.len(), 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote_double_lockout_after_expiration() {
|
||||
let voter_id = Pubkey::new_rand();
|
||||
let mut vote_state = VoteState::new(&voter_id, &Pubkey::new_rand(), 0);
|
||||
|
||||
for i in 0..3 {
|
||||
let vote = Vote::new(i as u64);
|
||||
vote_state.process_vote(&vote);
|
||||
}
|
||||
|
||||
check_lockouts(&vote_state);
|
||||
|
||||
// Expire the third vote (which was a vote for slot 2). The height of the
|
||||
// vote stack is unchanged, so none of the previous votes should have
|
||||
// doubled in lockout
|
||||
vote_state.process_vote(&Vote::new((2 + INITIAL_LOCKOUT + 1) as u64));
|
||||
check_lockouts(&vote_state);
|
||||
|
||||
// Vote again, this time the vote stack depth increases, so the lockouts should
|
||||
// double for everybody
|
||||
vote_state.process_vote(&Vote::new((2 + INITIAL_LOCKOUT + 2) as u64));
|
||||
check_lockouts(&vote_state);
|
||||
|
||||
// Vote again, this time the vote stack depth increases, so the lockouts should
|
||||
// double for everybody
|
||||
vote_state.process_vote(&Vote::new((2 + INITIAL_LOCKOUT + 3) as u64));
|
||||
check_lockouts(&vote_state);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_expire_multiple_votes() {
|
||||
let voter_id = Pubkey::new_rand();
|
||||
let mut vote_state = VoteState::new(&voter_id, &Pubkey::new_rand(), 0);
|
||||
|
||||
for i in 0..3 {
|
||||
let vote = Vote::new(i as u64);
|
||||
vote_state.process_vote(&vote);
|
||||
}
|
||||
|
||||
assert_eq!(vote_state.votes[0].confirmation_count, 3);
|
||||
|
||||
// Expire the second and third votes
|
||||
let expire_slot = vote_state.votes[1].slot + vote_state.votes[1].lockout() + 1;
|
||||
vote_state.process_vote(&Vote::new(expire_slot));
|
||||
assert_eq!(vote_state.votes.len(), 2);
|
||||
|
||||
// Check that the old votes expired
|
||||
assert_eq!(vote_state.votes[0].slot, 0);
|
||||
assert_eq!(vote_state.votes[1].slot, expire_slot);
|
||||
|
||||
// Process one more vote
|
||||
vote_state.process_vote(&Vote::new(expire_slot + 1));
|
||||
|
||||
// Confirmation count for the older first vote should remain unchanged
|
||||
assert_eq!(vote_state.votes[0].confirmation_count, 3);
|
||||
|
||||
// The later votes should still have increasing confirmation counts
|
||||
assert_eq!(vote_state.votes[1].confirmation_count, 2);
|
||||
assert_eq!(vote_state.votes[2].confirmation_count, 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_vote_credits() {
|
||||
let voter_id = Pubkey::new_rand();
|
||||
let mut vote_state = VoteState::new(&voter_id, &Pubkey::new_rand(), 0);
|
||||
|
||||
for i in 0..MAX_LOCKOUT_HISTORY {
|
||||
vote_state.process_vote(&Vote::new(i as u64));
|
||||
}
|
||||
|
||||
assert_eq!(vote_state.credits, 0);
|
||||
|
||||
vote_state.process_vote(&Vote::new(MAX_LOCKOUT_HISTORY as u64 + 1));
|
||||
assert_eq!(vote_state.credits, 1);
|
||||
vote_state.process_vote(&Vote::new(MAX_LOCKOUT_HISTORY as u64 + 2));
|
||||
assert_eq!(vote_state.credits(), 2);
|
||||
vote_state.process_vote(&Vote::new(MAX_LOCKOUT_HISTORY as u64 + 3));
|
||||
assert_eq!(vote_state.credits(), 3);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_duplicate_vote() {
|
||||
let voter_id = Pubkey::new_rand();
|
||||
let mut vote_state = VoteState::new(&voter_id, &Pubkey::new_rand(), 0);
|
||||
vote_state.process_vote(&Vote::new(0));
|
||||
vote_state.process_vote(&Vote::new(1));
|
||||
vote_state.process_vote(&Vote::new(0));
|
||||
assert_eq!(vote_state.nth_recent_vote(0).unwrap().slot, 1);
|
||||
assert_eq!(vote_state.nth_recent_vote(1).unwrap().slot, 0);
|
||||
assert!(vote_state.nth_recent_vote(2).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_nth_recent_vote() {
|
||||
let voter_id = Pubkey::new_rand();
|
||||
let mut vote_state = VoteState::new(&voter_id, &Pubkey::new_rand(), 0);
|
||||
for i in 0..MAX_LOCKOUT_HISTORY {
|
||||
vote_state.process_vote(&Vote::new(i as u64));
|
||||
}
|
||||
for i in 0..(MAX_LOCKOUT_HISTORY - 1) {
|
||||
assert_eq!(
|
||||
vote_state.nth_recent_vote(i).unwrap().slot as usize,
|
||||
MAX_LOCKOUT_HISTORY - i - 1,
|
||||
);
|
||||
}
|
||||
assert!(vote_state.nth_recent_vote(MAX_LOCKOUT_HISTORY).is_none());
|
||||
}
|
||||
|
||||
fn check_lockouts(vote_state: &VoteState) {
|
||||
for (i, vote) in vote_state.votes.iter().enumerate() {
|
||||
let num_lockouts = vote_state.votes.len() - i;
|
||||
assert_eq!(
|
||||
vote.lockout(),
|
||||
INITIAL_LOCKOUT.pow(num_lockouts as u32) as u64
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
fn recent_votes(vote_state: &VoteState) -> Vec<Vote> {
|
||||
let start = vote_state.votes.len().saturating_sub(MAX_RECENT_VOTES);
|
||||
(start..vote_state.votes.len())
|
||||
.map(|i| Vote::new(vote_state.votes.get(i).unwrap().slot))
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// check that two accounts with different data can be brought to the same state with one vote submission
|
||||
#[test]
|
||||
fn test_process_missed_votes() {
|
||||
let account_a = Pubkey::new_rand();
|
||||
let mut vote_state_a = VoteState::new(&account_a, &Pubkey::new_rand(), 0);
|
||||
let account_b = Pubkey::new_rand();
|
||||
let mut vote_state_b = VoteState::new(&account_b, &Pubkey::new_rand(), 0);
|
||||
|
||||
// process some votes on account a
|
||||
let votes_a: Vec<_> = (0..5).into_iter().map(|i| Vote::new(i)).collect();
|
||||
vote_state_a.process_votes(&votes_a);
|
||||
assert_ne!(recent_votes(&vote_state_a), recent_votes(&vote_state_b));
|
||||
|
||||
// as long as b has missed less than "NUM_RECENT" votes both accounts should be in sync
|
||||
let votes: Vec<_> = (0..MAX_RECENT_VOTES)
|
||||
.into_iter()
|
||||
.map(|i| Vote::new(i as u64))
|
||||
.collect();
|
||||
vote_state_a.process_votes(&votes);
|
||||
vote_state_b.process_votes(&votes);
|
||||
assert_eq!(recent_votes(&vote_state_a), recent_votes(&vote_state_b));
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user