Skip to content

Commit

Permalink
cli: Use simulated compute units in vote interactions (#2696)
Browse files Browse the repository at this point in the history 
* cli: Add simulated compute units to vote interactions

#### Problem

The CLI can simulate to get the compute budget used by a transaction,
but vote interactions are still using the default compute unit limit.

#### Summary of changes

Add tests for setting a compute unit price with `test_case`, and then
change the compute unit limit to `Simulated`.

* Use simulated compute units

* Fix rebase issues
  • Loading branch information
@joncinque
joncinque authored Sep 24, 2024
1 parent 1bcb252 commit 43cc2dd
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 33 deletions.
48 changes: 37 additions & 11 deletions cli/src/vote.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ use {
log_instruction_custom_error, CliCommand, CliCommandInfo, CliConfig, CliError,
ProcessResult,
},
compute_budget::{ComputeUnitConfig, WithComputeUnitConfig},
compute_budget::{
simulate_and_update_compute_unit_limit, ComputeUnitConfig, WithComputeUnitConfig,
},
memo::WithMemo,
nonce::check_nonce_account,
spend_utils::{resolve_spend_tx_and_check_account_balances, SpendAmount},
Expand Down Expand Up @@ -821,7 +823,10 @@ pub fn process_create_vote_account(
let nonce_authority = config.signers[nonce_authority];
let space = VoteStateVersions::vote_state_size_of(true) as u64;

let compute_unit_limit = ComputeUnitLimit::Default;
let compute_unit_limit = match blockhash_query {
BlockhashQuery::None(_) | BlockhashQuery::FeeCalculator(_, _) => ComputeUnitLimit::Default,
BlockhashQuery::All(_) => ComputeUnitLimit::Simulated,
};
let build_message = |lamports| {
let vote_init = VoteInit {
node_pubkey: identity_pubkey,
Expand Down Expand Up @@ -1001,19 +1006,24 @@ pub fn process_vote_authorize(
vote_authorize, // vote or withdraw
)
};

let compute_unit_limit = match blockhash_query {
BlockhashQuery::None(_) | BlockhashQuery::FeeCalculator(_, _) => ComputeUnitLimit::Default,
BlockhashQuery::All(_) => ComputeUnitLimit::Simulated,
};
let ixs = vec![vote_ix]
.with_memo(memo)
.with_compute_unit_config(&ComputeUnitConfig {
compute_unit_price,
compute_unit_limit: ComputeUnitLimit::Default,
compute_unit_limit,
});

let recent_blockhash = blockhash_query.get_blockhash(rpc_client, config.commitment)?;

let nonce_authority = config.signers[nonce_authority];
let fee_payer = config.signers[fee_payer];

let message = if let Some(nonce_account) = &nonce_account {
let mut message = if let Some(nonce_account) = &nonce_account {
Message::new_with_nonce(
ixs,
Some(&fee_payer.pubkey()),
Expand All @@ -1023,6 +1033,7 @@ pub fn process_vote_authorize(
} else {
Message::new(&ixs, Some(&fee_payer.pubkey()))
};
simulate_and_update_compute_unit_limit(&compute_unit_limit, rpc_client, &mut message)?;
let mut tx = Transaction::new_unsigned(message);

if sign_only {
Expand Down Expand Up @@ -1079,6 +1090,10 @@ pub fn process_vote_update_validator(
(&new_identity_pubkey, "new_identity_account".to_string()),
)?;
let recent_blockhash = blockhash_query.get_blockhash(rpc_client, config.commitment)?;
let compute_unit_limit = match blockhash_query {
BlockhashQuery::None(_) | BlockhashQuery::FeeCalculator(_, _) => ComputeUnitLimit::Default,
BlockhashQuery::All(_) => ComputeUnitLimit::Simulated,
};
let ixs = vec![vote_instruction::update_validator_identity(
vote_account_pubkey,
&authorized_withdrawer.pubkey(),
Expand All @@ -1087,12 +1102,12 @@ pub fn process_vote_update_validator(
.with_memo(memo)
.with_compute_unit_config(&ComputeUnitConfig {
compute_unit_price,
compute_unit_limit: ComputeUnitLimit::Default,
compute_unit_limit,
});
let nonce_authority = config.signers[nonce_authority];
let fee_payer = config.signers[fee_payer];

let message = if let Some(nonce_account) = &nonce_account {
let mut message = if let Some(nonce_account) = &nonce_account {
Message::new_with_nonce(
ixs,
Some(&fee_payer.pubkey()),
Expand All @@ -1102,6 +1117,7 @@ pub fn process_vote_update_validator(
} else {
Message::new(&ixs, Some(&fee_payer.pubkey()))
};
simulate_and_update_compute_unit_limit(&compute_unit_limit, rpc_client, &mut message)?;
let mut tx = Transaction::new_unsigned(message);

if sign_only {
Expand Down Expand Up @@ -1152,6 +1168,10 @@ pub fn process_vote_update_commission(
) -> ProcessResult {
let authorized_withdrawer = config.signers[withdraw_authority];
let recent_blockhash = blockhash_query.get_blockhash(rpc_client, config.commitment)?;
let compute_unit_limit = match blockhash_query {
BlockhashQuery::None(_) | BlockhashQuery::FeeCalculator(_, _) => ComputeUnitLimit::Default,
BlockhashQuery::All(_) => ComputeUnitLimit::Simulated,
};
let ixs = vec![vote_instruction::update_commission(
vote_account_pubkey,
&authorized_withdrawer.pubkey(),
Expand All @@ -1160,12 +1180,12 @@ pub fn process_vote_update_commission(
.with_memo(memo)
.with_compute_unit_config(&ComputeUnitConfig {
compute_unit_price,
compute_unit_limit: ComputeUnitLimit::Default,
compute_unit_limit,
});
let nonce_authority = config.signers[nonce_authority];
let fee_payer = config.signers[fee_payer];

let message = if let Some(nonce_account) = &nonce_account {
let mut message = if let Some(nonce_account) = &nonce_account {
Message::new_with_nonce(
ixs,
Some(&fee_payer.pubkey()),
Expand All @@ -1175,6 +1195,7 @@ pub fn process_vote_update_commission(
} else {
Message::new(&ixs, Some(&fee_payer.pubkey()))
};
simulate_and_update_compute_unit_limit(&compute_unit_limit, rpc_client, &mut message)?;
let mut tx = Transaction::new_unsigned(message);
if sign_only {
tx.try_partial_sign(&config.signers, recent_blockhash)?;
Expand Down Expand Up @@ -1318,7 +1339,10 @@ pub fn process_withdraw_from_vote_account(
let fee_payer = config.signers[fee_payer];
let nonce_authority = config.signers[nonce_authority];

let compute_unit_limit = ComputeUnitLimit::Default;
let compute_unit_limit = match blockhash_query {
BlockhashQuery::None(_) | BlockhashQuery::FeeCalculator(_, _) => ComputeUnitLimit::Default,
BlockhashQuery::All(_) => ComputeUnitLimit::Simulated,
};
let build_message = |lamports| {
let ixs = vec![withdraw(
vote_account_pubkey,
Expand Down Expand Up @@ -1441,6 +1465,7 @@ pub fn process_close_vote_account(

let current_balance = rpc_client.get_balance(vote_account_pubkey)?;

let compute_unit_limit = ComputeUnitLimit::Simulated;
let ixs = vec![withdraw(
vote_account_pubkey,
&withdraw_authority.pubkey(),
Expand All @@ -1450,10 +1475,11 @@ pub fn process_close_vote_account(
.with_memo(memo)
.with_compute_unit_config(&ComputeUnitConfig {
compute_unit_price,
compute_unit_limit: ComputeUnitLimit::Default,
compute_unit_limit,
});

let message = Message::new(&ixs, Some(&fee_payer.pubkey()));
let mut message = Message::new(&ixs, Some(&fee_payer.pubkey()));
simulate_and_update_compute_unit_limit(&compute_unit_limit, rpc_client, &mut message)?;
let mut tx = Transaction::new_unsigned(message);
tx.try_sign(&config.signers, latest_blockhash)?;
check_account_for_fee_with_commitment(
Expand Down
47 changes: 25 additions & 22 deletions cli/tests/vote.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ use {
solana_streamer::socket::SocketAddrSpace,
solana_test_validator::TestValidator,
solana_vote_program::vote_state::{VoteAuthorize, VoteState, VoteStateVersions},
test_case::test_case,
};

#[test]
fn test_vote_authorize_and_withdraw() {
#[test_case(None; "base")]
#[test_case(Some(1_000_000); "with_compute_unit_price")]
fn test_vote_authorize_and_withdraw(compute_unit_price: Option<u64>) {
let mint_keypair = Keypair::new();
let mint_pubkey = mint_keypair.pubkey();
let faucet_addr = run_local_faucet(mint_keypair, None);
Expand Down Expand Up @@ -56,7 +58,7 @@ fn test_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config).unwrap();
let vote_account = rpc_client
Expand Down Expand Up @@ -88,7 +90,7 @@ fn test_vote_authorize_and_withdraw() {
fee_payer: 0,
derived_address_seed: None,
derived_address_program_id: None,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config).unwrap();
let expected_balance = expected_balance + 10_000;
Expand All @@ -110,7 +112,7 @@ fn test_vote_authorize_and_withdraw() {
fee_payer: 0,
authorized: 0,
new_authorized: None,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config).unwrap();
let vote_account = rpc_client
Expand All @@ -136,7 +138,7 @@ fn test_vote_authorize_and_withdraw() {
fee_payer: 0,
authorized: 1,
new_authorized: Some(1),
compute_unit_price: None,
compute_unit_price,
};
process_command(&config).unwrap_err(); // unsigned by new authority should fail
config.signers = vec![
Expand All @@ -157,7 +159,7 @@ fn test_vote_authorize_and_withdraw() {
fee_payer: 0,
authorized: 1,
new_authorized: Some(2),
compute_unit_price: None,
compute_unit_price,
};
process_command(&config).unwrap();
let vote_account = rpc_client
Expand All @@ -182,7 +184,7 @@ fn test_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config).unwrap();
let expected_balance = expected_balance - 1_000;
Expand All @@ -203,7 +205,7 @@ fn test_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config).unwrap();

Expand All @@ -216,15 +218,16 @@ fn test_vote_authorize_and_withdraw() {
destination_account_pubkey: destination_account,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config).unwrap();
check_balance!(0, &rpc_client, &vote_account_pubkey);
check_balance!(expected_balance, &rpc_client, &destination_account);
}

#[test]
fn test_offline_vote_authorize_and_withdraw() {
#[test_case(None; "base")]
#[test_case(Some(1_000_000); "with_compute_unit_price")]
fn test_offline_vote_authorize_and_withdraw(compute_unit_price: Option<u64>) {
let mint_keypair = Keypair::new();
let mint_pubkey = mint_keypair.pubkey();
let faucet_addr = run_local_faucet(mint_keypair, None);
Expand Down Expand Up @@ -283,7 +286,7 @@ fn test_offline_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config_payer).unwrap();
let vote_account = rpc_client
Expand Down Expand Up @@ -315,7 +318,7 @@ fn test_offline_vote_authorize_and_withdraw() {
fee_payer: 0,
derived_address_seed: None,
derived_address_program_id: None,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config_payer).unwrap();
let expected_balance = expected_balance + 10_000;
Expand All @@ -337,7 +340,7 @@ fn test_offline_vote_authorize_and_withdraw() {
fee_payer: 0,
authorized: 0,
new_authorized: None,
compute_unit_price: None,
compute_unit_price,
};
config_offline.output_format = OutputFormat::JsonCompact;
let sig_response = process_command(&config_offline).unwrap();
Expand All @@ -360,7 +363,7 @@ fn test_offline_vote_authorize_and_withdraw() {
fee_payer: 0,
authorized: 0,
new_authorized: None,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config_payer).unwrap();
let vote_account = rpc_client
Expand All @@ -387,7 +390,7 @@ fn test_offline_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
config_offline.output_format = OutputFormat::JsonCompact;
let sig_response = process_command(&config_offline).unwrap();
Expand All @@ -408,7 +411,7 @@ fn test_offline_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config_payer).unwrap();
let expected_balance = expected_balance - 1_000;
Expand All @@ -435,7 +438,7 @@ fn test_offline_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config_offline).unwrap();
config_offline.output_format = OutputFormat::JsonCompact;
Expand All @@ -456,7 +459,7 @@ fn test_offline_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config_payer).unwrap();

Expand All @@ -476,7 +479,7 @@ fn test_offline_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config_offline).unwrap();
config_offline.output_format = OutputFormat::JsonCompact;
Expand All @@ -498,7 +501,7 @@ fn test_offline_vote_authorize_and_withdraw() {
nonce_authority: 0,
memo: None,
fee_payer: 0,
compute_unit_price: None,
compute_unit_price,
};
process_command(&config_payer).unwrap();
check_balance!(0, &rpc_client, &vote_account_pubkey);
Expand Down

0 comments on commit 43cc2dd

Please sign in to comment.