Skip to content

feat: enforce layout version compatibility in migrations #862

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

Merged
thlpkee20-wq merged 3 commits into from
Aug 31, 2026
Merged

feat: enforce layout version compatibility in migrations #862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a4b92a
feat: enforce layout version compatibility in migrations
whitezaddy Aug 29, 2026
c8f3f77
style: run cargo fmt and partial test fixes
whitezaddy Aug 29, 2026
4976e70
Merge remote-tracking branch 'origin/master' into pr-862
thlpkee20-wq Aug 31, 2026
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
20 changes: 10 additions & 10 deletions src/chunking_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ fn get_revenue_range_chunk_matches_full_sum() {
let env = Env::default();
env.mock_all_auths();

let client = make_client(&env);
let client = make_client(&env.clone());

let issuer = Address::generate(&env);
let token = Address::generate(&env);
Expand Down Expand Up @@ -106,7 +106,7 @@ fn get_revenue_range_chunk_inverted_range_returns_zero() {
let env = Env::default();
env.mock_all_auths();

let client = make_client(&env);
let client = make_client(&env.clone());

let issuer = Address::generate(&env);
let token = Address::generate(&env);
Expand Down Expand Up @@ -135,7 +135,7 @@ fn get_revenue_range_chunk_cap_clamps_and_returns_next_start() {
let env = Env::default();
env.mock_all_auths();

let client = make_client(&env);
let client = make_client(&env.clone());

let issuer = Address::generate(&env);
let token = Address::generate(&env);
Expand Down Expand Up @@ -175,7 +175,7 @@ fn get_revenue_range_chunk_chunked_iteration_off_by_one_sequence() {
let env = Env::default();
env.mock_all_auths();

let client = make_client(&env);
let client = make_client(&env.clone());

let issuer = Address::generate(&env);
let token = Address::generate(&env);
Expand Down Expand Up @@ -232,7 +232,7 @@ fn pending_periods_page_and_claimable_chunk_consistent() {
let env = Env::default();
env.mock_all_auths();

let client = make_client(&env);
let client = make_client(&env.clone());

let issuer = Address::generate(&env);
let token = Address::generate(&env);
Expand Down Expand Up @@ -360,7 +360,7 @@ impl ChunkInvariantTestCase {
fn get_claimable_chunk_table_driven_invariants() {
let env = Env::default();
env.mock_all_auths();
let client = make_client(&env);
let client = make_client(&env.clone());

let issuer = Address::generate(&env);
let token = Address::generate(&env);
Expand Down Expand Up @@ -547,7 +547,7 @@ fn get_claimable_chunk_table_driven_invariants() {
// Reset environment for each test case
let env = Env::default();
env.mock_all_auths();
let client = make_client(&env);
let client = make_client(&env.clone());
let issuer = Address::generate(&env);
let token = Address::generate(&env);
let holder = Address::generate(&env);
Expand Down Expand Up @@ -653,7 +653,7 @@ fn get_claimable_chunk_table_driven_invariants() {
fn get_claimable_chunk_cursor_idempotency_repeated_queries() {
let env = Env::default();
env.mock_all_auths();
let client = make_client(&env);
let client = make_client(&env.clone());

let issuer = Address::generate(&env);
let token = Address::generate(&env);
Expand Down Expand Up @@ -728,7 +728,7 @@ fn get_claimable_chunk_cursor_idempotency_repeated_queries() {
fn get_claimable_chunk_sum_matches_full_claimable() {
let env = Env::default();
env.mock_all_auths();
let client = make_client(&env);
let client = make_client(&env.clone());

let issuer = Address::generate(&env);
let token = Address::generate(&env);
Expand Down Expand Up @@ -794,7 +794,7 @@ fn get_claimable_chunk_sum_matches_full_claimable() {
fn get_claimable_chunk_respects_delay_barrier_parity_with_claim() {
let env = Env::default();
env.mock_all_auths();
let client = make_client(&env);
let client = make_client(&env.clone());

let issuer = Address::generate(&env);
let token = Address::generate(&env);
Expand Down
5 changes: 5 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,8 @@ mod test_accrual_reconciliation_prop;
#[cfg(test)]
mod test_close_period;
#[cfg(test)]
mod test_close_period;
#[cfg(test)]
mod test_compute_share_decomposition_prop;
#[cfg(test)]
mod test_disclosure;
Expand Down Expand Up @@ -9659,6 +9661,7 @@ impl RevoraRevenueShare {
return Err(RevoraError::NotAuthorized);
}

Self::assert_storage_layout_compatible(&env)?;
if env.storage().persistent().get::<DataKey, bool>(&DataKey::Frozen).unwrap_or(false) {
return Err(RevoraError::ContractFrozen);
}
Expand Down Expand Up @@ -15321,6 +15324,8 @@ impl RevoraRevenueShare {
// Must be gated by the issuer initiating the migration
issuer.require_auth();

Self::assert_storage_layout_compatible(&env)?;

let key = MigrationDataKey::LastMigrationCompletedAt(issuer.clone());
let last_migration: u32 = env.storage().persistent().get(&key).unwrap_or(0);

Expand Down
32 changes: 16 additions & 16 deletions src/milestone_signals.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ fn event_position(env: &Env, sym: Symbol) -> Option<u32> {
#[test]
fn milestone_event_ordering_offer_before_rev_rep() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);

client.report_revenue(
Expand Down Expand Up @@ -120,7 +120,7 @@ fn milestone_event_ordering_offer_before_rev_rep() {
#[test]
fn milestone_period_id_must_be_strictly_increasing() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);

client.report_revenue(
Expand Down Expand Up @@ -181,7 +181,7 @@ fn milestone_period_id_must_be_strictly_increasing() {
#[test]
fn milestone_period_id_zero_rejected() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);

assert!(
Expand All @@ -207,7 +207,7 @@ fn milestone_period_id_zero_rejected() {
#[test]
fn milestone_audit_summary_accumulates_correctly() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");

Expand All @@ -229,7 +229,7 @@ fn milestone_audit_summary_accumulates_correctly() {
#[test]
fn milestone_audit_summary_not_updated_on_rejected_report() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");

Expand All @@ -249,7 +249,7 @@ fn milestone_audit_summary_not_updated_on_rejected_report() {
#[test]
fn milestone_concentration_enforcement_blocks_revenue_report() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");

Expand All @@ -272,7 +272,7 @@ fn milestone_concentration_enforcement_blocks_revenue_report() {
#[test]
fn milestone_concentration_at_limit_allows_revenue_report() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");

Expand All @@ -288,7 +288,7 @@ fn milestone_concentration_at_limit_allows_revenue_report() {
#[test]
fn milestone_concentration_warning_does_not_block_report() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");

Expand All @@ -308,7 +308,7 @@ fn milestone_concentration_warning_does_not_block_report() {
#[test]
fn milestone_concentration_warning_event_emitted() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, _payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");

Expand All @@ -325,7 +325,7 @@ fn milestone_concentration_warning_event_emitted() {
#[test]
fn milestone_concentration_one_bps_over_limit_rejected() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");

Expand All @@ -340,7 +340,7 @@ fn milestone_concentration_one_bps_over_limit_rejected() {
#[test]
fn milestone_concentration_testnet_mode_bypasses_enforcement() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");

Expand All @@ -367,7 +367,7 @@ fn milestone_concentration_testnet_mode_bypasses_enforcement() {
#[test]
fn milestone_blacklist_snapshot_captured_at_report_time() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");
let investor = Address::generate(&env);
Expand All @@ -391,7 +391,7 @@ fn milestone_blacklist_snapshot_captured_at_report_time() {
#[test]
fn milestone_indexed_v2_topic_emitted_on_report_revenue() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let (issuer, token, payout) = setup_offering(&env, &client);
let ns = symbol_short!("def");

Expand Down Expand Up @@ -419,7 +419,7 @@ fn milestone_indexed_v2_topic_emitted_on_report_revenue() {
#[test]
fn milestone_fixture_covers_all_canonical_event_types() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let issuer = Address::generate(&env);
let token = Address::generate(&env);
let ns = symbol_short!("def");
Expand Down Expand Up @@ -448,7 +448,7 @@ fn milestone_fixture_covers_all_canonical_event_types() {
#[test]
fn milestone_non_period_scoped_fixtures_have_zero_period_id() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
let issuer = Address::generate(&env);
let token = Address::generate(&env);
let ns = symbol_short!("def");
Expand All @@ -474,7 +474,7 @@ fn milestone_non_period_scoped_fixtures_have_zero_period_id() {
#[test]
fn milestone_audit_summary_isolated_per_offering() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());
env.mock_all_auths();

let issuer = Address::generate(&env);
Expand Down
8 changes: 4 additions & 4 deletions src/normalize_share_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ fn make_client(env: &Env) -> crate::RevoraRevenueShareClient<'_> {
fn decimals_bounds_and_default() {
let env = Env::default();
env.mock_all_auths();
let client = make_client(&env);
let client = make_client(&env.clone());
let issuer = Address::generate(&env);
let token = Address::generate(&env);
let ns = symbol_short!("def");
Expand Down Expand Up @@ -51,7 +51,7 @@ fn decimals_bounds_and_default() {
#[test]
fn normalize_and_compute_integration() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());

// 6-decimal
let n6 = client.normalize_amount(&1_000_000_i128, &6u32).unwrap();
Expand All @@ -75,7 +75,7 @@ fn normalize_and_compute_integration() {
#[test]
fn normalize_overflow_and_zero() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());

for d in 0..=crate::MAX_TOKEN_DECIMALS {
assert_eq!(client.normalize_amount(&0_i128, &d).unwrap(), 0_i128);
Expand All @@ -93,7 +93,7 @@ fn normalize_overflow_and_zero() {
#[test]
fn compute_share_edgecases() {
let env = Env::default();
let client = make_client(&env);
let client = make_client(&env.clone());

let s = client.compute_share(&1_000_000_i128, &10_001u32, &RoundingMode::Truncation);
assert_eq!(s, 0_i128);
Expand Down
2 changes: 1 addition & 1 deletion src/proptest_helpers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/// fn fuzz_register_offering(bps in arb_valid_bps(), &None) {
/// let env = Env::default();
/// env.mock_all_auths();
/// let client = make_client(&env);
/// let client = make_client(&env.clone());
/// let issuer = Address::generate(&env);
/// let token = Address::generate(&env);
/// client.register_offering(
Expand Down
Loading
Loading