600 lines
20 KiB
Rust
600 lines
20 KiB
Rust
use crate::cluster::{Cluster, ClusterValidatorInfo, ValidatorInfo};
|
|
use itertools::izip;
|
|
use log::*;
|
|
use solana_client::thin_client::{create_client, ThinClient};
|
|
use solana_core::{
|
|
cluster_info::{Node, VALIDATOR_PORT_RANGE},
|
|
contact_info::ContactInfo,
|
|
gossip_service::discover_cluster,
|
|
validator::{Validator, ValidatorConfig},
|
|
};
|
|
use solana_ledger::{
|
|
create_new_tmp_ledger,
|
|
genesis_utils::{create_genesis_config_with_leader, GenesisConfigInfo},
|
|
};
|
|
use solana_sdk::{
|
|
client::SyncClient,
|
|
clock::{DEFAULT_DEV_SLOTS_PER_EPOCH, DEFAULT_TICKS_PER_SLOT},
|
|
commitment_config::CommitmentConfig,
|
|
epoch_schedule::EpochSchedule,
|
|
genesis_config::{GenesisConfig, OperatingMode},
|
|
poh_config::PohConfig,
|
|
pubkey::Pubkey,
|
|
signature::{Keypair, Signer},
|
|
system_transaction,
|
|
transaction::Transaction,
|
|
};
|
|
use solana_stake_program::{
|
|
config as stake_config, stake_instruction,
|
|
stake_state::{Authorized, Lockup, StakeState},
|
|
};
|
|
use solana_vote_program::{
|
|
vote_instruction,
|
|
vote_state::{VoteInit, VoteState},
|
|
};
|
|
use std::{
|
|
collections::HashMap,
|
|
io::{Error, ErrorKind, Result},
|
|
iter,
|
|
sync::Arc,
|
|
};
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct ClusterConfig {
|
|
/// The validator config that should be applied to every node in the cluster
|
|
pub validator_configs: Vec<ValidatorConfig>,
|
|
/// Number of nodes that are unstaked and not voting (a.k.a listening)
|
|
pub num_listeners: u64,
|
|
/// The specific pubkeys of each node if specified
|
|
pub validator_keys: Option<Vec<Arc<Keypair>>>,
|
|
/// The stakes of each node
|
|
pub node_stakes: Vec<u64>,
|
|
/// The total lamports available to the cluster
|
|
pub cluster_lamports: u64,
|
|
pub ticks_per_slot: u64,
|
|
pub slots_per_epoch: u64,
|
|
pub stakers_slot_offset: u64,
|
|
pub native_instruction_processors: Vec<(String, Pubkey)>,
|
|
pub operating_mode: OperatingMode,
|
|
pub poh_config: PohConfig,
|
|
}
|
|
|
|
impl Default for ClusterConfig {
|
|
fn default() -> Self {
|
|
ClusterConfig {
|
|
validator_configs: vec![],
|
|
num_listeners: 0,
|
|
validator_keys: None,
|
|
node_stakes: vec![],
|
|
cluster_lamports: 0,
|
|
ticks_per_slot: DEFAULT_TICKS_PER_SLOT,
|
|
slots_per_epoch: DEFAULT_DEV_SLOTS_PER_EPOCH,
|
|
stakers_slot_offset: DEFAULT_DEV_SLOTS_PER_EPOCH,
|
|
native_instruction_processors: vec![],
|
|
operating_mode: OperatingMode::Development,
|
|
poh_config: PohConfig::default(),
|
|
}
|
|
}
|
|
}
|
|
|
|
pub struct LocalCluster {
|
|
/// Keypair with funding to participate in the network
|
|
pub funding_keypair: Keypair,
|
|
/// Entry point from which the rest of the network can be discovered
|
|
pub entry_point_info: ContactInfo,
|
|
pub validators: HashMap<Pubkey, ClusterValidatorInfo>,
|
|
pub genesis_config: GenesisConfig,
|
|
}
|
|
|
|
impl LocalCluster {
|
|
pub fn new_with_equal_stakes(
|
|
num_nodes: usize,
|
|
cluster_lamports: u64,
|
|
lamports_per_node: u64,
|
|
) -> Self {
|
|
let stakes: Vec<_> = (0..num_nodes).map(|_| lamports_per_node).collect();
|
|
let config = ClusterConfig {
|
|
node_stakes: stakes,
|
|
cluster_lamports,
|
|
validator_configs: vec![ValidatorConfig::default(); num_nodes],
|
|
..ClusterConfig::default()
|
|
};
|
|
Self::new(&config)
|
|
}
|
|
|
|
pub fn new(config: &ClusterConfig) -> Self {
|
|
assert_eq!(config.validator_configs.len(), config.node_stakes.len());
|
|
let validator_keys = {
|
|
if let Some(ref keys) = config.validator_keys {
|
|
assert_eq!(config.validator_configs.len(), keys.len());
|
|
keys.clone()
|
|
} else {
|
|
iter::repeat_with(|| Arc::new(Keypair::new()))
|
|
.take(config.validator_configs.len())
|
|
.collect()
|
|
}
|
|
};
|
|
|
|
let leader_keypair = &validator_keys[0];
|
|
let leader_pubkey = leader_keypair.pubkey();
|
|
let leader_node = Node::new_localhost_with_pubkey(&leader_pubkey);
|
|
let GenesisConfigInfo {
|
|
mut genesis_config,
|
|
mint_keypair,
|
|
voting_keypair,
|
|
} = create_genesis_config_with_leader(
|
|
config.cluster_lamports,
|
|
&leader_pubkey,
|
|
config.node_stakes[0],
|
|
);
|
|
genesis_config.ticks_per_slot = config.ticks_per_slot;
|
|
genesis_config.epoch_schedule =
|
|
EpochSchedule::custom(config.slots_per_epoch, config.stakers_slot_offset, true);
|
|
genesis_config.operating_mode = config.operating_mode;
|
|
genesis_config.poh_config = config.poh_config.clone();
|
|
|
|
match genesis_config.operating_mode {
|
|
OperatingMode::Stable | OperatingMode::Preview => {
|
|
genesis_config.native_instruction_processors =
|
|
solana_genesis_programs::get_programs(genesis_config.operating_mode, 0)
|
|
.unwrap_or_else(|| vec![])
|
|
}
|
|
_ => (),
|
|
}
|
|
|
|
genesis_config.inflation =
|
|
solana_genesis_programs::get_inflation(genesis_config.operating_mode, 0).unwrap();
|
|
|
|
genesis_config
|
|
.native_instruction_processors
|
|
.extend_from_slice(&config.native_instruction_processors);
|
|
|
|
// Replace staking config
|
|
genesis_config.add_account(
|
|
stake_config::id(),
|
|
stake_config::create_account(
|
|
1,
|
|
&stake_config::Config {
|
|
warmup_cooldown_rate: 1_000_000_000.0f64,
|
|
slash_penalty: std::u8::MAX,
|
|
},
|
|
),
|
|
);
|
|
|
|
let (leader_ledger_path, _blockhash) = create_new_tmp_ledger!(&genesis_config);
|
|
let leader_contact_info = leader_node.info.clone();
|
|
let leader_voting_keypair = Arc::new(voting_keypair);
|
|
let mut leader_config = config.validator_configs[0].clone();
|
|
leader_config.rpc_ports = Some((
|
|
leader_node.info.rpc.port(),
|
|
leader_node.info.rpc_pubsub.port(),
|
|
));
|
|
let leader_server = Validator::new(
|
|
leader_node,
|
|
&leader_keypair,
|
|
&leader_ledger_path,
|
|
&leader_voting_keypair.pubkey(),
|
|
vec![leader_voting_keypair.clone()],
|
|
None,
|
|
true,
|
|
&leader_config,
|
|
);
|
|
|
|
let mut validators = HashMap::new();
|
|
error!("leader_pubkey: {}", leader_pubkey);
|
|
let leader_info = ValidatorInfo {
|
|
keypair: leader_keypair.clone(),
|
|
voting_keypair: leader_voting_keypair,
|
|
ledger_path: leader_ledger_path,
|
|
contact_info: leader_contact_info.clone(),
|
|
};
|
|
|
|
let cluster_leader = ClusterValidatorInfo::new(
|
|
leader_info,
|
|
config.validator_configs[0].clone(),
|
|
leader_server,
|
|
);
|
|
|
|
validators.insert(leader_pubkey, cluster_leader);
|
|
|
|
let mut cluster = Self {
|
|
funding_keypair: mint_keypair,
|
|
entry_point_info: leader_contact_info,
|
|
validators,
|
|
genesis_config,
|
|
};
|
|
|
|
for (stake, validator_config, key) in izip!(
|
|
(&config.node_stakes[1..]).iter(),
|
|
config.validator_configs[1..].iter(),
|
|
validator_keys[1..].iter(),
|
|
) {
|
|
cluster.add_validator(validator_config, *stake, key.clone());
|
|
}
|
|
|
|
let listener_config = ValidatorConfig {
|
|
voting_disabled: true,
|
|
..config.validator_configs[0].clone()
|
|
};
|
|
(0..config.num_listeners).for_each(|_| {
|
|
cluster.add_validator(&listener_config, 0, Arc::new(Keypair::new()));
|
|
});
|
|
|
|
discover_cluster(
|
|
&cluster.entry_point_info.gossip,
|
|
config.node_stakes.len() + config.num_listeners as usize,
|
|
)
|
|
.unwrap();
|
|
|
|
discover_cluster(&cluster.entry_point_info.gossip, config.node_stakes.len()).unwrap();
|
|
|
|
cluster
|
|
}
|
|
|
|
pub fn exit(&mut self) {
|
|
for node in self.validators.values_mut() {
|
|
if let Some(ref mut v) = node.validator {
|
|
v.exit();
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn close_preserve_ledgers(&mut self) {
|
|
self.exit();
|
|
for (_, node) in self.validators.iter_mut() {
|
|
if let Some(v) = node.validator.take() {
|
|
v.join().expect("Validator join failed");
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn add_validator(
|
|
&mut self,
|
|
validator_config: &ValidatorConfig,
|
|
stake: u64,
|
|
validator_keypair: Arc<Keypair>,
|
|
) -> Pubkey {
|
|
let client = create_client(
|
|
self.entry_point_info.client_facing_addr(),
|
|
VALIDATOR_PORT_RANGE,
|
|
);
|
|
|
|
// Must have enough tokens to fund vote account and set delegate
|
|
let voting_keypair = Keypair::new();
|
|
let validator_pubkey = validator_keypair.pubkey();
|
|
let validator_node = Node::new_localhost_with_pubkey(&validator_keypair.pubkey());
|
|
let contact_info = validator_node.info.clone();
|
|
let (ledger_path, _blockhash) = create_new_tmp_ledger!(&self.genesis_config);
|
|
|
|
if validator_config.voting_disabled {
|
|
// setup as a listener
|
|
info!("listener {} ", validator_pubkey,);
|
|
} else {
|
|
// Give the validator some lamports to setup vote accounts
|
|
let validator_balance = Self::transfer_with_client(
|
|
&client,
|
|
&self.funding_keypair,
|
|
&validator_pubkey,
|
|
stake * 2 + 2,
|
|
);
|
|
info!(
|
|
"validator {} balance {}",
|
|
validator_pubkey, validator_balance
|
|
);
|
|
|
|
Self::setup_vote_and_stake_accounts(
|
|
&client,
|
|
&voting_keypair,
|
|
&validator_keypair,
|
|
stake,
|
|
)
|
|
.unwrap();
|
|
}
|
|
|
|
let mut config = validator_config.clone();
|
|
config.rpc_ports = Some((
|
|
validator_node.info.rpc.port(),
|
|
validator_node.info.rpc_pubsub.port(),
|
|
));
|
|
let voting_keypair = Arc::new(voting_keypair);
|
|
let validator_server = Validator::new(
|
|
validator_node,
|
|
&validator_keypair,
|
|
&ledger_path,
|
|
&voting_keypair.pubkey(),
|
|
vec![voting_keypair.clone()],
|
|
Some(&self.entry_point_info),
|
|
true,
|
|
&config,
|
|
);
|
|
|
|
let validator_pubkey = validator_keypair.pubkey();
|
|
let validator_info = ClusterValidatorInfo::new(
|
|
ValidatorInfo {
|
|
keypair: validator_keypair,
|
|
voting_keypair,
|
|
ledger_path,
|
|
contact_info,
|
|
},
|
|
validator_config.clone(),
|
|
validator_server,
|
|
);
|
|
|
|
self.validators.insert(validator_pubkey, validator_info);
|
|
validator_pubkey
|
|
}
|
|
|
|
fn close(&mut self) {
|
|
self.close_preserve_ledgers();
|
|
}
|
|
|
|
pub fn transfer(&self, source_keypair: &Keypair, dest_pubkey: &Pubkey, lamports: u64) -> u64 {
|
|
let client = create_client(
|
|
self.entry_point_info.client_facing_addr(),
|
|
VALIDATOR_PORT_RANGE,
|
|
);
|
|
Self::transfer_with_client(&client, source_keypair, dest_pubkey, lamports)
|
|
}
|
|
|
|
fn transfer_with_client(
|
|
client: &ThinClient,
|
|
source_keypair: &Keypair,
|
|
dest_pubkey: &Pubkey,
|
|
lamports: u64,
|
|
) -> u64 {
|
|
trace!("getting leader blockhash");
|
|
let (blockhash, _fee_calculator) = client
|
|
.get_recent_blockhash_with_commitment(CommitmentConfig::recent())
|
|
.unwrap();
|
|
let mut tx =
|
|
system_transaction::transfer(&source_keypair, dest_pubkey, lamports, blockhash);
|
|
info!(
|
|
"executing transfer of {} from {} to {}",
|
|
lamports,
|
|
source_keypair.pubkey(),
|
|
*dest_pubkey
|
|
);
|
|
client
|
|
.retry_transfer(&source_keypair, &mut tx, 10)
|
|
.expect("client transfer");
|
|
client
|
|
.wait_for_balance_with_commitment(
|
|
dest_pubkey,
|
|
Some(lamports),
|
|
CommitmentConfig::recent(),
|
|
)
|
|
.expect("get balance")
|
|
}
|
|
|
|
fn setup_vote_and_stake_accounts(
|
|
client: &ThinClient,
|
|
vote_account: &Keypair,
|
|
from_account: &Arc<Keypair>,
|
|
amount: u64,
|
|
) -> Result<()> {
|
|
let vote_account_pubkey = vote_account.pubkey();
|
|
let node_pubkey = from_account.pubkey();
|
|
let stake_account_keypair = Keypair::new();
|
|
let stake_account_pubkey = stake_account_keypair.pubkey();
|
|
|
|
// Create the vote account if necessary
|
|
if client
|
|
.poll_get_balance_with_commitment(&vote_account_pubkey, CommitmentConfig::recent())
|
|
.unwrap_or(0)
|
|
== 0
|
|
{
|
|
// 1) Create vote account
|
|
|
|
let mut transaction = Transaction::new_signed_instructions(
|
|
&[from_account.as_ref(), vote_account],
|
|
&vote_instruction::create_account(
|
|
&from_account.pubkey(),
|
|
&vote_account_pubkey,
|
|
&VoteInit {
|
|
node_pubkey,
|
|
authorized_voter: vote_account_pubkey,
|
|
authorized_withdrawer: vote_account_pubkey,
|
|
commission: 0,
|
|
},
|
|
amount,
|
|
),
|
|
client
|
|
.get_recent_blockhash_with_commitment(CommitmentConfig::recent())
|
|
.unwrap()
|
|
.0,
|
|
);
|
|
client
|
|
.retry_transfer(&from_account, &mut transaction, 10)
|
|
.expect("fund vote");
|
|
client
|
|
.wait_for_balance_with_commitment(
|
|
&vote_account_pubkey,
|
|
Some(amount),
|
|
CommitmentConfig::recent(),
|
|
)
|
|
.expect("get balance");
|
|
|
|
let mut transaction = Transaction::new_signed_instructions(
|
|
&[from_account.as_ref(), &stake_account_keypair],
|
|
&stake_instruction::create_account_and_delegate_stake(
|
|
&from_account.pubkey(),
|
|
&stake_account_pubkey,
|
|
&vote_account_pubkey,
|
|
&Authorized::auto(&stake_account_pubkey),
|
|
&Lockup::default(),
|
|
amount,
|
|
),
|
|
client
|
|
.get_recent_blockhash_with_commitment(CommitmentConfig::recent())
|
|
.unwrap()
|
|
.0,
|
|
);
|
|
|
|
client
|
|
.send_and_confirm_transaction(
|
|
&[from_account.as_ref(), &stake_account_keypair],
|
|
&mut transaction,
|
|
5,
|
|
0,
|
|
)
|
|
.expect("delegate stake");
|
|
client
|
|
.wait_for_balance_with_commitment(
|
|
&stake_account_pubkey,
|
|
Some(amount),
|
|
CommitmentConfig::recent(),
|
|
)
|
|
.expect("get balance");
|
|
} else {
|
|
warn!(
|
|
"{} vote_account already has a balance?!?",
|
|
vote_account_pubkey
|
|
);
|
|
}
|
|
info!("Checking for vote account registration of {}", node_pubkey);
|
|
match (
|
|
client.get_account_with_commitment(&stake_account_pubkey, CommitmentConfig::recent()),
|
|
client.get_account_with_commitment(&vote_account_pubkey, CommitmentConfig::recent()),
|
|
) {
|
|
(Ok(Some(stake_account)), Ok(Some(vote_account))) => {
|
|
match (
|
|
StakeState::stake_from(&stake_account),
|
|
VoteState::from(&vote_account),
|
|
) {
|
|
(Some(stake_state), Some(vote_state)) => {
|
|
if stake_state.delegation.voter_pubkey != vote_account_pubkey
|
|
|| stake_state.delegation.stake != amount
|
|
{
|
|
Err(Error::new(ErrorKind::Other, "invalid stake account state"))
|
|
} else if vote_state.node_pubkey != node_pubkey {
|
|
Err(Error::new(ErrorKind::Other, "invalid vote account state"))
|
|
} else {
|
|
info!("node {} {:?} {:?}", node_pubkey, stake_state, vote_state);
|
|
|
|
Ok(())
|
|
}
|
|
}
|
|
(None, _) => Err(Error::new(ErrorKind::Other, "invalid stake account data")),
|
|
(_, None) => Err(Error::new(ErrorKind::Other, "invalid vote account data")),
|
|
}
|
|
}
|
|
(Ok(None), _) | (Err(_), _) => Err(Error::new(
|
|
ErrorKind::Other,
|
|
"unable to retrieve stake account data",
|
|
)),
|
|
(_, Ok(None)) | (_, Err(_)) => Err(Error::new(
|
|
ErrorKind::Other,
|
|
"unable to retrieve vote account data",
|
|
)),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Cluster for LocalCluster {
|
|
fn get_node_pubkeys(&self) -> Vec<Pubkey> {
|
|
self.validators.keys().cloned().collect()
|
|
}
|
|
|
|
fn get_validator_client(&self, pubkey: &Pubkey) -> Option<ThinClient> {
|
|
self.validators.get(pubkey).map(|f| {
|
|
create_client(
|
|
f.info.contact_info.client_facing_addr(),
|
|
VALIDATOR_PORT_RANGE,
|
|
)
|
|
})
|
|
}
|
|
|
|
fn exit_node(&mut self, pubkey: &Pubkey) -> ClusterValidatorInfo {
|
|
let mut node = self.validators.remove(&pubkey).unwrap();
|
|
|
|
// Shut down the validator
|
|
let mut validator = node.validator.take().expect("Validator must be running");
|
|
validator.exit();
|
|
validator.join().unwrap();
|
|
node
|
|
}
|
|
|
|
fn restart_node(&mut self, pubkey: &Pubkey, mut cluster_validator_info: ClusterValidatorInfo) {
|
|
// Update the stored ContactInfo for this node
|
|
let node = Node::new_localhost_with_pubkey(&pubkey);
|
|
cluster_validator_info.info.contact_info = node.info.clone();
|
|
cluster_validator_info.config.rpc_ports =
|
|
Some((node.info.rpc.port(), node.info.rpc_pubsub.port()));
|
|
|
|
let entry_point_info = {
|
|
if *pubkey == self.entry_point_info.id {
|
|
self.entry_point_info = node.info.clone();
|
|
None
|
|
} else {
|
|
Some(&self.entry_point_info)
|
|
}
|
|
};
|
|
|
|
// Restart the node
|
|
let validator_info = &cluster_validator_info.info;
|
|
|
|
let restarted_node = Validator::new(
|
|
node,
|
|
&validator_info.keypair,
|
|
&validator_info.ledger_path,
|
|
&validator_info.voting_keypair.pubkey(),
|
|
vec![validator_info.voting_keypair.clone()],
|
|
entry_point_info,
|
|
true,
|
|
&cluster_validator_info.config,
|
|
);
|
|
|
|
cluster_validator_info.validator = Some(restarted_node);
|
|
self.validators.insert(*pubkey, cluster_validator_info);
|
|
}
|
|
|
|
fn exit_restart_node(&mut self, pubkey: &Pubkey, validator_config: ValidatorConfig) {
|
|
let mut cluster_validator_info = self.exit_node(pubkey);
|
|
cluster_validator_info.config = validator_config;
|
|
self.restart_node(pubkey, cluster_validator_info);
|
|
}
|
|
|
|
fn get_contact_info(&self, pubkey: &Pubkey) -> Option<&ContactInfo> {
|
|
self.validators.get(pubkey).map(|v| &v.info.contact_info)
|
|
}
|
|
}
|
|
|
|
impl Drop for LocalCluster {
|
|
fn drop(&mut self) {
|
|
self.close();
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
use solana_sdk::epoch_schedule::MINIMUM_SLOTS_PER_EPOCH;
|
|
|
|
#[test]
|
|
fn test_local_cluster_start_and_exit() {
|
|
solana_logger::setup();
|
|
let num_nodes = 1;
|
|
let cluster = LocalCluster::new_with_equal_stakes(num_nodes, 100, 3);
|
|
assert_eq!(cluster.validators.len(), num_nodes);
|
|
}
|
|
|
|
#[test]
|
|
fn test_local_cluster_start_and_exit_with_config() {
|
|
solana_logger::setup();
|
|
let mut validator_config = ValidatorConfig::default();
|
|
validator_config.rpc_config.enable_validator_exit = true;
|
|
const NUM_NODES: usize = 1;
|
|
let config = ClusterConfig {
|
|
validator_configs: vec![ValidatorConfig::default(); NUM_NODES],
|
|
node_stakes: vec![3; NUM_NODES],
|
|
cluster_lamports: 100,
|
|
ticks_per_slot: 8,
|
|
slots_per_epoch: MINIMUM_SLOTS_PER_EPOCH as u64,
|
|
stakers_slot_offset: MINIMUM_SLOTS_PER_EPOCH as u64,
|
|
..ClusterConfig::default()
|
|
};
|
|
let cluster = LocalCluster::new(&config);
|
|
assert_eq!(cluster.validators.len(), NUM_NODES);
|
|
}
|
|
}
|