Skip to content

feat(refund): add instance TTL bump on hot read/write paths #1020

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
greatest0fallt1me merged 1 commit into from
Jul 30, 2026
+137 −15
Merged

feat(refund): add instance TTL bump on hot read/write paths #1020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 17 additions & 15 deletions contracts/refund/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ impl RefundContract {
) -> Result<u64, RefundError> {
requester.require_auth();
Self::ensure_initialized(&env)?;
Self::bump_instance_ttl(&env);

if amount <= 0 {
return Err(RefundError::InvalidAmount);
Expand Down Expand Up @@ -170,6 +171,7 @@ impl RefundContract {
) -> Result<(), RefundError> {
admin.require_auth();
Self::ensure_initialized(&env)?;
Self::bump_instance_ttl(&env);

let stored_admin: Address = Self::get_admin_internal(&env)?;
if admin != stored_admin {
Expand Down Expand Up @@ -222,6 +224,7 @@ impl RefundContract {
) -> Result<(), RefundError> {
admin.require_auth();
Self::ensure_initialized(&env)?;
Self::bump_instance_ttl(&env);

let stored_admin: Address = Self::get_admin_internal(&env)?;
if admin != stored_admin {
Expand Down Expand Up @@ -278,6 +281,7 @@ impl RefundContract {
) -> Result<(), RefundError> {
admin.require_auth();
Self::ensure_initialized(&env)?;
Self::bump_instance_ttl(&env);

let stored_admin: Address = Self::get_admin_internal(&env)?;
if admin != stored_admin {
Expand Down Expand Up @@ -345,6 +349,7 @@ impl RefundContract {
) -> Result<(), RefundError> {
admin.require_auth();
Self::ensure_initialized(&env)?;
Self::bump_instance_ttl(&env);

let stored_admin: Address = Self::get_admin_internal(&env)?;
if admin != stored_admin {
Expand Down Expand Up @@ -374,19 +379,15 @@ impl RefundContract {
///
/// Bumps instance storage TTL on read to prevent premature archival.
pub fn get_admin(env: Env) -> Result<Address, RefundError> {
env.storage()
.instance()
.extend_ttl(INSTANCE_BUMP_THRESHOLD, INSTANCE_BUMP_AMOUNT);
Self::bump_instance_ttl(&env);
Self::get_admin_internal(&env)
}

/// Get the current refund configuration.
///
/// Bumps instance storage TTL on read to prevent premature archival.
pub fn get_config(env: Env) -> Result<RefundConfig, RefundError> {
env.storage()
.instance()
.extend_ttl(INSTANCE_BUMP_THRESHOLD, INSTANCE_BUMP_AMOUNT);
Self::bump_instance_ttl(&env);
env.storage()
.instance()
.get(&StorageKey::RefundConfig)
Expand All @@ -400,9 +401,7 @@ impl RefundContract {
env: Env,
request_id: u64,
) -> Result<RefundRequest, RefundError> {
env.storage()
.instance()
.extend_ttl(INSTANCE_BUMP_THRESHOLD, INSTANCE_BUMP_AMOUNT);
Self::bump_instance_ttl(&env);

let key = StorageKey::PendingRefund(request_id);
if env.storage().persistent().has(&key) {
Expand All @@ -420,9 +419,7 @@ impl RefundContract {
///
/// Bumps instance storage TTL on read to prevent premature archival.
pub fn get_total_refunds(env: Env) -> Result<i128, RefundError> {
env.storage()
.instance()
.extend_ttl(INSTANCE_BUMP_THRESHOLD, INSTANCE_BUMP_AMOUNT);
Self::bump_instance_ttl(&env);
Self::ensure_initialized(&env)?;
Ok(env
.storage()
Expand All @@ -435,9 +432,7 @@ impl RefundContract {
///
/// Bumps instance storage TTL on read to prevent premature archival.
pub fn get_refund_counter(env: Env) -> Result<u64, RefundError> {
env.storage()
.instance()
.extend_ttl(INSTANCE_BUMP_THRESHOLD, INSTANCE_BUMP_AMOUNT);
Self::bump_instance_ttl(&env);
Self::ensure_initialized(&env)?;
Ok(env
.storage()
Expand All @@ -462,6 +457,13 @@ impl RefundContract {
Ok(())
}

/// Bump instance storage TTL to prevent premature archival on hot read paths.
pub(crate) fn bump_instance_ttl(env: &Env) {
env.storage()
.instance()
.extend_ttl(INSTANCE_BUMP_THRESHOLD, INSTANCE_BUMP_AMOUNT);
}

/// Publish the `"initialized"` event.
///
/// **What**: Announces that the contract has just been configured with its
Expand Down
120 changes: 120 additions & 0 deletions contracts/refund/src/test_ttl_bump.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,4 +184,124 @@ fn test_multiple_refund_requests_bump_ttl() {
env.storage().instance().get_ttl()
});
assert_eq!(inst_ttl, INSTANCE_BUMP_AMOUNT);
}

#[test]
fn test_request_refund_bumps_instance_ttl() {
let (env, _admin, client) = setup();
let requester = Address::generate(&env);
let token = Address::generate(&env);

let seq = env.ledger().sequence();
env.ledger()
.set_sequence_number(seq + INSTANCE_BUMP_AMOUNT - INSTANCE_BUMP_THRESHOLD + 10);

let ttl_before = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert!(ttl_before < INSTANCE_BUMP_THRESHOLD);

let _ = client.request_refund(&requester, &token, &500, &Symbol::new(&env, "test"));

let ttl_after = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert_eq!(ttl_after, INSTANCE_BUMP_AMOUNT);
}

#[test]
fn test_approve_refund_bumps_instance_ttl() {
let (env, admin, client) = setup();
let requester = Address::generate(&env);
let token = Address::generate(&env);

let request_id = client.request_refund(&requester, &token, &500, &Symbol::new(&env, "test"));

let seq = env.ledger().sequence();
env.ledger()
.set_sequence_number(seq + INSTANCE_BUMP_AMOUNT - INSTANCE_BUMP_THRESHOLD + 10);

let ttl_before = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert!(ttl_before < INSTANCE_BUMP_THRESHOLD);

client.approve_refund(&admin, &request_id);

let ttl_after = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert_eq!(ttl_after, INSTANCE_BUMP_AMOUNT);
}

#[test]
fn test_reject_refund_bumps_instance_ttl() {
let (env, admin, client) = setup();
let requester = Address::generate(&env);
let token = Address::generate(&env);

let request_id = client.request_refund(&requester, &token, &500, &Symbol::new(&env, "test"));

let seq = env.ledger().sequence();
env.ledger()
.set_sequence_number(seq + INSTANCE_BUMP_AMOUNT - INSTANCE_BUMP_THRESHOLD + 10);

let ttl_before = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert!(ttl_before < INSTANCE_BUMP_THRESHOLD);

client.reject_refund(&admin, &request_id);

let ttl_after = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert_eq!(ttl_after, INSTANCE_BUMP_AMOUNT);
}

#[test]
fn test_process_refund_bumps_instance_ttl() {
let (env, admin, client) = setup();
let requester = Address::generate(&env);
let token = Address::generate(&env);

let request_id = client.request_refund(&requester, &token, &500, &Symbol::new(&env, "test"));
client.approve_refund(&admin, &request_id);

let seq = env.ledger().sequence();
env.ledger()
.set_sequence_number(seq + INSTANCE_BUMP_AMOUNT - INSTANCE_BUMP_THRESHOLD + 10);

let ttl_before = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert!(ttl_before < INSTANCE_BUMP_THRESHOLD);

client.process_refund(&admin, &request_id);

let ttl_after = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert_eq!(ttl_after, INSTANCE_BUMP_AMOUNT);
}

#[test]
fn test_update_config_bumps_instance_ttl() {
let (env, admin, client) = setup();

let seq = env.ledger().sequence();
env.ledger()
.set_sequence_number(seq + INSTANCE_BUMP_AMOUNT - INSTANCE_BUMP_THRESHOLD + 10);

let ttl_before = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert!(ttl_before < INSTANCE_BUMP_THRESHOLD);

client.update_config(&admin, &500, &200);

let ttl_after = env.as_contract(&env.current_contract_address(), || {
env.storage().instance().get_ttl()
});
assert_eq!(ttl_after, INSTANCE_BUMP_AMOUNT);
}
Loading