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.

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

chore(sequencer): separate test utils from shared benchmark and test utils #1613

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion crates/astria-sequencer/src/accounts/state_ext.rs
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ mod tests {
StateReadExt as _,
StateWriteExt as _,
},
test_utils::{
benchmark_and_test_utils::{
astria_address,
nria,
},
Expand Down
269 changes: 269 additions & 0 deletions crates/astria-sequencer/src/app/benchmark_and_test_utils.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,269 @@
use std::collections::HashMap;

use astria_core::{
primitive::v1::asset::{
Denom,
IbcPrefixed,
},
protocol::{
genesis::v1alpha1::{
Account,
AddressPrefixes,
GenesisAppState,
},
transaction::v1alpha1::action::ValidatorUpdate,
},
Protobuf,
};
use cnidarium::{
Snapshot,
StateDelta,
Storage,
};
use telemetry::Metrics as _;

use crate::{
accounts::StateWriteExt as _,
app::App,
assets::StateWriteExt as _,
benchmark_and_test_utils::{
astria_address_from_hex_string,
nria,
},
bridge::StateWriteExt as _,
ibc::StateWriteExt as _,
mempool::Mempool,
metrics::Metrics,
sequence::StateWriteExt as _,
};

pub(crate) const ALICE_ADDRESS: &str = "1c0c490f1b5528d8173c5de46d131160e4b2c0c3";
pub(crate) const BOB_ADDRESS: &str = "2269aca7b7c03c7d07345f83db4fababd1a05570";
pub(crate) const CAROL_ADDRESS: &str = "4e8846b82a8f31fd59265a9005959c4a030fc44c";
pub(crate) const JUDY_ADDRESS: &str = "989a77160cb0e96e2d168083ab72ffe89b41c199";
pub(crate) const TED_ADDRESS: &str = "4c4f91d8a918357ab5f6f19c1e179968fc39bb44";

pub(crate) fn address_prefixes() -> AddressPrefixes {
AddressPrefixes::try_from_raw(
astria_core::generated::protocol::genesis::v1alpha1::AddressPrefixes {
base: crate::benchmark_and_test_utils::ASTRIA_PREFIX.into(),
ibc_compat: crate::benchmark_and_test_utils::ASTRIA_COMPAT_PREFIX.into(),
},
)
.unwrap()
}

pub(crate) fn default_fees() -> astria_core::protocol::genesis::v1alpha1::Fees {
astria_core::protocol::genesis::v1alpha1::Fees {
transfer_base_fee: 12,
sequence_base_fee: 32,
sequence_byte_cost_multiplier: 1,
init_bridge_account_base_fee: 48,
bridge_lock_byte_cost_multiplier: 1,
bridge_sudo_change_fee: 24,
ics20_withdrawal_base_fee: 24,
}
}

pub(crate) fn proto_genesis_state()
-> astria_core::generated::protocol::genesis::v1alpha1::GenesisAppState {
use astria_core::generated::protocol::genesis::v1alpha1::{
GenesisAppState,
IbcParameters,
};
GenesisAppState {
address_prefixes: Some(address_prefixes().to_raw()),
accounts: default_genesis_accounts()
.into_iter()
.map(Protobuf::into_raw)
.collect(),
authority_sudo_address: Some(astria_address_from_hex_string(JUDY_ADDRESS).to_raw()),
chain_id: "test-1".to_string(),
ibc_sudo_address: Some(astria_address_from_hex_string(TED_ADDRESS).to_raw()),
ibc_relayer_addresses: vec![],
native_asset_base_denomination: nria().to_string(),
ibc_parameters: Some(IbcParameters {
ibc_enabled: true,
inbound_ics20_transfers_enabled: true,
outbound_ics20_transfers_enabled: true,
}),
allowed_fee_assets: vec![nria().to_string()],
fees: Some(default_fees().to_raw()),
}
}

pub(crate) fn genesis_state() -> GenesisAppState {
proto_genesis_state().try_into().unwrap()
}

pub(crate) async fn initialize_app_with_storage(
genesis_state: Option<GenesisAppState>,
genesis_validators: Vec<ValidatorUpdate>,
) -> (App, Storage) {
let storage = cnidarium::TempStorage::new()
.await
.expect("failed to create temp storage backing chain state");
let snapshot = storage.latest_snapshot();
let mempool = Mempool::new();
let metrics = Box::leak(Box::new(Metrics::noop_metrics(&()).unwrap()));
let mut app = App::new(snapshot, mempool, metrics).await.unwrap();

let genesis_state = genesis_state.unwrap_or_else(self::genesis_state);

app.init_chain(
storage.clone(),
genesis_state,
genesis_validators,
"test".to_string(),
)
.await
.unwrap();
app.commit(storage.clone()).await;

(app, storage.clone())
}

pub(crate) fn default_genesis_accounts() -> Vec<Account> {
vec![
Account {
address: astria_address_from_hex_string(ALICE_ADDRESS),
balance: 10u128.pow(19),
},
Account {
address: astria_address_from_hex_string(BOB_ADDRESS),
balance: 10u128.pow(19),
},
Account {
address: astria_address_from_hex_string(CAROL_ADDRESS),
balance: 10u128.pow(19),
},
]
}

pub(crate) fn mock_tx_cost(
denom_0_cost: u128,
denom_1_cost: u128,
denom_2_cost: u128,
) -> HashMap<IbcPrefixed, u128> {
let mut costs: HashMap<IbcPrefixed, u128> = HashMap::<IbcPrefixed, u128>::new();
costs.insert(denom_0().to_ibc_prefixed(), denom_0_cost);
costs.insert(denom_1().to_ibc_prefixed(), denom_1_cost);
costs.insert(denom_2().to_ibc_prefixed(), denom_2_cost); // not present in balances

// we don't sanitize the cost inputs
costs.insert(denom_5().to_ibc_prefixed(), 0); // zero in balances also
costs.insert(denom_6().to_ibc_prefixed(), 0); // not present in balances

costs
}

pub(crate) const MOCK_SEQUENCE_FEE: u128 = 10;
pub(crate) fn denom_0() -> Denom {
"denom_0".parse().unwrap()
}

pub(crate) fn denom_1() -> Denom {
"denom_1".parse().unwrap()
}

pub(crate) fn denom_2() -> Denom {
"denom_2".parse().unwrap()
}

pub(crate) fn denom_3() -> Denom {
"denom_3".parse().unwrap()
}

pub(crate) fn denom_4() -> Denom {
"denom_4".parse().unwrap()
}

pub(crate) fn denom_5() -> Denom {
"denom_5".parse().unwrap()
}

pub(crate) fn denom_6() -> Denom {
"denom_6".parse().unwrap()
}

pub(crate) fn mock_balances(
denom_0_balance: u128,
denom_1_balance: u128,
) -> HashMap<IbcPrefixed, u128> {
let mut balances = HashMap::<IbcPrefixed, u128>::new();
if denom_0_balance != 0 {
balances.insert(denom_0().to_ibc_prefixed(), denom_0_balance);
}
if denom_1_balance != 0 {
balances.insert(denom_1().to_ibc_prefixed(), denom_1_balance);
}
// we don't sanitize the balance inputs
balances.insert(denom_3().to_ibc_prefixed(), 100); // balance transaction costs won't have entry for
balances.insert(denom_4().to_ibc_prefixed(), 0); // zero balance not in transaction
balances.insert(denom_5().to_ibc_prefixed(), 0); // zero balance with corresponding zero cost

balances
}

pub(crate) fn mock_state_put_account_balances(
state: &mut StateDelta<Snapshot>,
address: &[u8; 20],
account_balances: HashMap<IbcPrefixed, u128>,
) {
for (denom, balance) in account_balances {
state.put_account_balance(address, &denom, balance).unwrap();
}
}

pub(crate) fn mock_state_put_account_nonce(
state: &mut StateDelta<Snapshot>,
address: &[u8; 20],
nonce: u32,
) {
state.put_account_nonce(address, nonce).unwrap();
}

pub(crate) async fn mock_state_getter() -> StateDelta<Snapshot> {
let storage = cnidarium::TempStorage::new().await.unwrap();
let snapshot = storage.latest_snapshot();
let mut state: StateDelta<cnidarium::Snapshot> = StateDelta::new(snapshot);

// setup denoms
state
.put_ibc_asset(denom_0().unwrap_trace_prefixed())
.unwrap();
state
.put_ibc_asset(denom_1().unwrap_trace_prefixed())
.unwrap();
state
.put_ibc_asset(denom_2().unwrap_trace_prefixed())
.unwrap();
state
.put_ibc_asset(denom_3().unwrap_trace_prefixed())
.unwrap();
state
.put_ibc_asset(denom_4().unwrap_trace_prefixed())
.unwrap();
state
.put_ibc_asset(denom_5().unwrap_trace_prefixed())
.unwrap();
state
.put_ibc_asset(denom_6().unwrap_trace_prefixed())
.unwrap();

// setup tx fees
state
.put_sequence_action_base_fee(MOCK_SEQUENCE_FEE)
.unwrap();
state.put_sequence_action_byte_cost_multiplier(0).unwrap();
state.put_transfer_base_fee(0).unwrap();
state.put_ics20_withdrawal_base_fee(0).unwrap();
state.put_init_bridge_account_base_fee(0).unwrap();
state.put_bridge_lock_byte_cost_multiplier(0).unwrap();
state.put_bridge_sudo_change_base_fee(0).unwrap();

// put denoms as allowed fee asset
state.put_allowed_fee_asset(&denom_0()).unwrap();

state
}
14 changes: 8 additions & 6 deletions crates/astria-sequencer/src/app/benchmarks.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,19 @@ use cnidarium::Storage;

use crate::{
app::{
test_utils,
test_utils::{
benchmark_and_test_utils::{
mock_balances,
mock_tx_cost,
},
App,
},
benchmark_and_test_utils::astria_address,
benchmark_utils::{
self,
TxTypes,
SIGNER_COUNT,
},
proposal::block_size_constraints::BlockSizeConstraints,
test_utils::astria_address,
};

/// The max time for any benchmark.
Expand Down Expand Up @@ -66,13 +65,16 @@ impl Fixture {
accounts,
authority_sudo_address: first_address.clone(),
ibc_sudo_address: first_address.clone(),
..crate::app::test_utils::proto_genesis_state()
..crate::app::benchmark_and_test_utils::proto_genesis_state()
},
)
.unwrap();

let (app, storage) =
test_utils::initialize_app_with_storage(Some(genesis_state), vec![]).await;
let (app, storage) = crate::app::benchmark_and_test_utils::initialize_app_with_storage(
Some(genesis_state),
vec![],
)
.await;

let mock_balances = mock_balances(0, 0);
let mock_tx_cost = mock_tx_cost(0, 0, 0);
Expand Down
4 changes: 3 additions & 1 deletion crates/astria-sequencer/src/app/mod.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
mod action_handler;
#[cfg(any(test, feature = "benchmark"))]
pub(crate) mod benchmark_and_test_utils;
#[cfg(feature = "benchmark")]
mod benchmarks;
mod state_ext;
pub(crate) mod storage;
#[cfg(any(test, feature = "benchmark"))]
#[cfg(test)]
pub(crate) mod test_utils;
#[cfg(test)]
mod tests_app;
Expand Down
Loading
Loading