Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add flag to bake non bootstrap validator stakes into genesis #2704

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

add flag to bake non bootstrap validator stakes into genesis #2704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a44bd0
add flag to bake non bootstrap validator stakes into genesis
Aug 21, 2024
cae626f
switch to validator-genesis-accounts file for baking in validator sta…
Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions genesis/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ pub struct Base64Account {
pub data: String,
pub executable: bool,
}

/// A validator account where the data is encoded as a Base64 string.
/// Includes the vote account and stake account.
#[derive(Serialize, Deserialize, Debug)]
pub struct Base64ValidatorAccount {
pub balance_lamports: u64,
pub stake_lamports: u64,
pub identity_account: String,
pub vote_account: String,
pub stake_account: String,
}
289 changes: 250 additions & 39 deletions genesis/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ use {
},
},
solana_entry::poh::compute_hashes_per_tick,
solana_genesis::{genesis_accounts::add_genesis_accounts, Base64Account},
solana_genesis::{
genesis_accounts::add_genesis_accounts, Base64Account, Base64ValidatorAccount,
},
solana_ledger::{blockstore::create_new_ledger, blockstore_options::LedgerColumnOptions},
solana_rpc_client::rpc_client::RpcClient,
solana_rpc_client_api::request::MAX_MULTIPLE_ACCOUNTS,
Expand Down Expand Up @@ -49,6 +51,7 @@ use {
io::{self, Read},
path::PathBuf,
process,
slice::Iter,
str::FromStr,
time::Duration,
},
Expand Down Expand Up @@ -112,6 +115,62 @@ pub fn load_genesis_accounts(file: &str, genesis_config: &mut GenesisConfig) ->
Ok(lamports)
}

pub fn load_validator_accounts(
file: &str,
commission: u8,
rent: &Rent,
genesis_config: &mut GenesisConfig,
) -> io::Result<()> {
let accounts_file = File::open(file)?;
let validator_genesis_accounts: Vec<Base64ValidatorAccount> =
serde_yaml::from_reader(accounts_file)
.map_err(|err| io::Error::new(io::ErrorKind::Other, format!("{err:?}")))?;

for account_details in validator_genesis_accounts {
let pubkeys = [
pubkey_from_str(account_details.identity_account.as_str()).map_err(|err| {
io::Error::new(
io::ErrorKind::Other,
format!(
"Invalid pubkey/keypair {}: {:?}",
account_details.identity_account, err
),
)
})?,
pubkey_from_str(account_details.vote_account.as_str()).map_err(|err| {
io::Error::new(
io::ErrorKind::Other,
format!(
"Invalid pubkey/keypair {}: {:?}",
account_details.vote_account, err
),
)
})?,
pubkey_from_str(account_details.stake_account.as_str()).map_err(|err| {
io::Error::new(
io::ErrorKind::Other,
format!(
"Invalid pubkey/keypair {}: {:?}",
account_details.stake_account, err
),
)
})?,
];

add_validator_accounts(
genesis_config,
&mut pubkeys.iter(),
account_details.balance_lamports,
account_details.stake_lamports,
commission,
rent,
None,
);
}

Ok(())
}

fn check_rpc_genesis_hash(
cluster_type: &ClusterType,
rpc_client: &RpcClient,
Expand Down Expand Up @@ -176,6 +235,49 @@ fn features_to_deactivate_for_cluster(
Ok(features_to_deactivate)
}

fn add_validator_accounts(
genesis_config: &mut GenesisConfig,
pubkeys_iter: &mut Iter<Pubkey>,
lamports: u64,
stake_lamports: u64,
commission: u8,
rent: &Rent,
authorized_pubkey: Option<&Pubkey>,
) {
loop {
let Some(identity_pubkey) = pubkeys_iter.next() else {
break;
};
let vote_pubkey = pubkeys_iter.next().unwrap();
let stake_pubkey = pubkeys_iter.next().unwrap();

genesis_config.add_account(
*identity_pubkey,
AccountSharedData::new(lamports, 0, &system_program::id()),
);

let vote_account = vote_state::create_account_with_authorized(
identity_pubkey,
identity_pubkey,
identity_pubkey,
commission,
VoteState::get_rent_exempt_reserve(rent).max(1),
);

genesis_config.add_account(
*stake_pubkey,
stake_state::create_account(
authorized_pubkey.unwrap_or(identity_pubkey),
vote_pubkey,
&vote_account,
rent,
stake_lamports,
),
);
genesis_config.add_account(*vote_pubkey, vote_account);
}
}

#[allow(clippy::cognitive_complexity)]
fn main() -> Result<(), Box<dyn error::Error>> {
let default_faucet_pubkey = solana_cli_config::Config::default().keypair_path;
Expand Down Expand Up @@ -422,6 +524,14 @@ fn main() -> Result<(), Box<dyn error::Error>> {
.multiple(true)
.help("The location of pubkey for primordial accounts and balance"),
)
.arg(
Arg::with_name("validator_accounts_file")
.long("validator-accounts-file")
.value_name("FILENAME")
.takes_value(true)
.multiple(true)
.help("The location of identity, vote, and stake pubkeys and balances for validator accounts"),
)
.arg(
Arg::with_name("cluster_type")
.long("cluster-type")
Expand Down Expand Up @@ -627,43 +737,17 @@ fn main() -> Result<(), Box<dyn error::Error>> {
}

let commission = value_t_or_exit!(matches, "vote_commission_percentage", u8);

let mut bootstrap_validator_pubkeys_iter = bootstrap_validator_pubkeys.iter();
loop {
let Some(identity_pubkey) = bootstrap_validator_pubkeys_iter.next() else {
break;
};
let vote_pubkey = bootstrap_validator_pubkeys_iter.next().unwrap();
let stake_pubkey = bootstrap_validator_pubkeys_iter.next().unwrap();

genesis_config.add_account(
*identity_pubkey,
AccountSharedData::new(bootstrap_validator_lamports, 0, &system_program::id()),
);

let vote_account = vote_state::create_account_with_authorized(
identity_pubkey,
identity_pubkey,
identity_pubkey,
commission,
VoteState::get_rent_exempt_reserve(&genesis_config.rent).max(1),
);

genesis_config.add_account(
*stake_pubkey,
stake_state::create_account(
bootstrap_stake_authorized_pubkey
.as_ref()
.unwrap_or(identity_pubkey),
vote_pubkey,
&vote_account,
&genesis_config.rent,
bootstrap_validator_stake_lamports,
),
);

genesis_config.add_account(*vote_pubkey, vote_account);
}
let rent = genesis_config.rent.clone();

add_validator_accounts(
&mut genesis_config,
&mut bootstrap_validator_pubkeys.iter(),
bootstrap_validator_lamports,
bootstrap_validator_stake_lamports,
commission,
&rent,
bootstrap_stake_authorized_pubkey.as_ref(),
);

if let Some(creation_time) = unix_timestamp_from_rfc3339_datetime(&matches, "creation_time") {
genesis_config.creation_time = creation_time;
Expand Down Expand Up @@ -691,6 +775,12 @@ fn main() -> Result<(), Box<dyn error::Error>> {
}
}

if let Some(files) = matches.values_of("validator_accounts_file") {
for file in files {
load_validator_accounts(file, commission, &rent, &mut genesis_config)?;
}
}

let max_genesis_archive_unpacked_size =
value_t_or_exit!(matches, "max_genesis_archive_unpacked_size", u64);

Expand Down Expand Up @@ -810,7 +900,7 @@ fn main() -> Result<(), Box<dyn error::Error>> {
mod tests {
use {
super::*,
solana_sdk::genesis_config::GenesisConfig,
solana_sdk::{borsh1, genesis_config::GenesisConfig, stake},
std::{collections::HashMap, fs::remove_file, io::Write, path::Path},
};

Expand Down Expand Up @@ -1150,4 +1240,125 @@ mod tests {

assert_eq!(genesis_config.accounts.len(), 3);
}

#[test]
fn test_append_validator_accounts_to_genesis() {
// Test invalid file returns error
assert!(load_validator_accounts(
"unknownfile",
100,
&Rent::default(),
&mut GenesisConfig::default()
)
.is_err());

let mut genesis_config = GenesisConfig::default();

let validator_accounts = vec![
Base64ValidatorAccount {
identity_account: solana_sdk::pubkey::new_rand().to_string(),
vote_account: solana_sdk::pubkey::new_rand().to_string(),
stake_account: solana_sdk::pubkey::new_rand().to_string(),
balance_lamports: 100000000000,
stake_lamports: 10000000000,
},
Base64ValidatorAccount {
identity_account: solana_sdk::pubkey::new_rand().to_string(),
vote_account: solana_sdk::pubkey::new_rand().to_string(),
stake_account: solana_sdk::pubkey::new_rand().to_string(),
balance_lamports: 200000000000,
stake_lamports: 20000000000,
},
Base64ValidatorAccount {
identity_account: solana_sdk::pubkey::new_rand().to_string(),
vote_account: solana_sdk::pubkey::new_rand().to_string(),
stake_account: solana_sdk::pubkey::new_rand().to_string(),
balance_lamports: 300000000000,
stake_lamports: 30000000000,
},
];

let serialized = serde_yaml::to_string(&validator_accounts).unwrap();

// Write the YAML string to a file
let path = Path::new("test_append_validator_accounts_to_genesis.yml");
let mut file = File::create(path).unwrap();
file.write_all(b"---\n").unwrap();
file.write_all(serialized.as_bytes()).unwrap();

// Load the validator accounts from the file
load_validator_accounts(
"test_append_validator_accounts_to_genesis.yml",
100,
&Rent::default(),
&mut genesis_config,
)
.expect("Failed to load validator accounts");

remove_file(path).unwrap();

let accounts_per_validator = 3;
let expected_accounts_len = validator_accounts.len() * accounts_per_validator;
{
assert_eq!(genesis_config.accounts.len(), expected_accounts_len);

// Test account data matches
for b64_account in validator_accounts.iter() {
// Check Identity
let identity_pk = b64_account.identity_account.parse().unwrap();
assert_eq!(
system_program::id(),
genesis_config.accounts[&identity_pk].owner
);
assert_eq!(
b64_account.balance_lamports,
genesis_config.accounts[&identity_pk].lamports
);

// Check vote account
let vote_pk = b64_account.vote_account.parse().unwrap();
let vote_data = genesis_config.accounts[&vote_pk].data.clone();
let vote_state = VoteState::deserialize(&vote_data).unwrap();
assert_eq!(vote_state.node_pubkey, identity_pk);
assert_eq!(vote_state.authorized_withdrawer, identity_pk);
let authorized_voters = vote_state.authorized_voters();
assert_eq!(authorized_voters.first().unwrap().1, &identity_pk);

// check stake account
let stake_pk = b64_account.stake_account.parse().unwrap();
assert_eq!(
b64_account.stake_lamports,
genesis_config.accounts[&stake_pk].lamports
);

let stake_data = genesis_config.accounts[&stake_pk].data.clone();
let stake_state =
borsh1::try_from_slice_unchecked::<StakeStateV2>(&stake_data).unwrap();
assert!(
matches!(stake_state, StakeStateV2::Stake(_, _, _)),
"Expected StakeStateV2::Stake variant"
);

if let StakeStateV2::Stake(meta, stake, stake_flags) = stake_state {
assert_eq!(meta.authorized.staker, identity_pk);
assert_eq!(meta.authorized.withdrawer, identity_pk);

assert_eq!(stake.delegation.voter_pubkey, vote_pk);
let stake_account = AccountSharedData::new(
b64_account.stake_lamports,
StakeStateV2::size_of(),
&solana_stake_program::id(),
);
let rent_exempt_reserve =
&Rent::default().minimum_balance(stake_account.data().len());
assert_eq!(
stake.delegation.stake,
b64_account.stake_lamports - rent_exempt_reserve
);

assert_eq!(stake_flags, stake::stake_flags::StakeFlags::empty());
}
}
}
}
}
Loading