Skip to content

feat: settlement OverDraft variant (#531) #577

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

Open
NEA-DEV-coder wants to merge 1 commit into
base: main
Choose a base branch
from
+55 −38
Open

feat: settlement OverDraft variant (#531) #577

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
3 changes: 3 additions & 0 deletions contracts/settlement/src/errors.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ use soroban_sdk::contracterror;
/// | 20 | MigrationNotFound | No migration is pending for the source |
/// | 21 | TimelockNotExpired | Migration delay has not elapsed |
/// | 22 | MigrationBalanceChanged | Approved amount is no longer available |
/// | 23 | OverDraft | Withdrawal amount exceeds the developer's balance |
#[contracterror]
#[derive(Clone, Copy, Debug, PartialEq)]
#[repr(u32)]
Expand All @@ -56,4 +57,6 @@ pub enum SettlementError {
MigrationNotFound = 20,
TimelockNotExpired = 21,
MigrationBalanceChanged = 22,
/// Withdrawal amount exceeds the developer's current balance.
OverDraft = 23,
}
85 changes: 48 additions & 37 deletions contracts/settlement/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ pub use timelock::{PendingDeveloperMigration, DEVELOPER_MIGRATION_TIMELOCK_SECON
mod types;
pub use types::*;


#[contract]
pub struct CalloraSettlement;

Expand Down Expand Up @@ -221,17 +220,11 @@ impl CalloraSettlement {
for item in items.iter() {
let (dev, amount) = item;
let balance_key = StorageKey::DeveloperBalance(dev.clone(), token.clone());
let current: i128 = env
.storage()
.persistent()
.get(&balance_key)
.unwrap_or(0);
let current: i128 = env.storage().persistent().get(&balance_key).unwrap_or(0);
let new_balance = current
.checked_add(amount)
.unwrap_or_else(|| env.panic_with_error(SettlementError::DeveloperOverflow));
env.storage()
.persistent()
.set(&balance_key, &new_balance);
env.storage().persistent().set(&balance_key, &new_balance);
env.storage()
.persistent()
.extend_ttl(&balance_key, 50000, 50000);
Expand Down Expand Up @@ -427,7 +420,7 @@ impl CalloraSettlement {
///
/// # Errors
/// - `AmountNotPositive` if amount is ≤ 0
/// - `InsufficientDeveloperBalance` if developer balance < amount
/// - `OverDraft` if developer balance < amount
/// - `DailyWithdrawCapExceeded` if daily cap is exceeded
/// - `DeveloperBalanceUnderflow` if subtraction underflows
/// - `InsufficientContractBalance` if contract has insufficient token balance
Expand All @@ -451,13 +444,9 @@ impl CalloraSettlement {
}

let balance_key = StorageKey::DeveloperBalance(developer.clone(), token.clone());
let current_balance: i128 = env
.storage()
.persistent()
.get(&balance_key)
.unwrap_or(0);
let current_balance: i128 = env.storage().persistent().get(&balance_key).unwrap_or(0);
if amount > current_balance {
return Err(SettlementError::InsufficientDeveloperBalance);
return Err(SettlementError::OverDraft);
}

let cap: i128 = env
Expand All @@ -471,7 +460,10 @@ impl CalloraSettlement {
.storage()
.persistent()
.get::<_, DailyWithdrawState>(&StorageKey::WithdrawalToday(developer.clone()))
.unwrap_or(DailyWithdrawState { day: today, amount: 0 });
.unwrap_or(DailyWithdrawState {
day: today,
amount: 0,
});
if daily.day != today {
daily.day = today;
daily.amount = 0;
Expand Down Expand Up @@ -504,7 +496,10 @@ impl CalloraSettlement {
.storage()
.persistent()
.get::<_, DailyWithdrawState>(&StorageKey::WithdrawalToday(developer.clone()))
.unwrap_or(DailyWithdrawState { day: today, amount: 0 });
.unwrap_or(DailyWithdrawState {
day: today,
amount: 0,
});
if daily.day != today {
daily.day = today;
daily.amount = 0;
Expand All @@ -513,9 +508,11 @@ impl CalloraSettlement {
env.storage()
.persistent()
.set(&StorageKey::WithdrawalToday(developer.clone()), &daily);
env.storage()
.persistent()
.extend_ttl(&StorageKey::WithdrawalToday(developer.clone()), 50000, 50000);
env.storage().persistent().extend_ttl(
&StorageKey::WithdrawalToday(developer.clone()),
50000,
50000,
);

env.events().publish(
(events::event_developer_withdraw(&env), developer.clone()),
Expand Down Expand Up @@ -549,13 +546,18 @@ impl CalloraSettlement {
env.storage()
.persistent()
.set(&StorageKey::DailyWithdrawCap(developer.clone()), &cap);
env.storage()
.persistent()
.extend_ttl(&StorageKey::DailyWithdrawCap(developer.clone()), 50000, 50000);
env.storage().persistent().extend_ttl(
&StorageKey::DailyWithdrawCap(developer.clone()),
50000,
50000,
);

env.events().publish(
(events::event_daily_withdraw_cap_changed(&env), caller),
DailyWithdrawCapChanged { developer, new_cap: cap },
DailyWithdrawCapChanged {
developer,
new_cap: cap,
},
);
}

Expand Down Expand Up @@ -653,7 +655,10 @@ impl CalloraSettlement {
}

env.events().publish(
(Symbol::new(&env, "developer_force_credited"), developer.clone()),
(
Symbol::new(&env, "developer_force_credited"),
developer.clone(),
),
DeveloperForceCreditedEvent {
developer,
amount,
Expand Down Expand Up @@ -725,7 +730,10 @@ impl CalloraSettlement {
let balance: i128 = env
.storage()
.persistent()
.get(&StorageKey::DeveloperBalance(address.clone(), token.clone()))
.get(&StorageKey::DeveloperBalance(
address.clone(),
token.clone(),
))
.unwrap_or(0i128);
result.push_back(DeveloperBalance {
address: address.clone(),
Expand Down Expand Up @@ -779,7 +787,10 @@ impl CalloraSettlement {
let balance = env
.storage()
.persistent()
.get(&StorageKey::DeveloperBalance(address.clone(), token.clone()))
.get(&StorageKey::DeveloperBalance(
address.clone(),
token.clone(),
))
.unwrap_or(0);
result.push_back(DeveloperBalance {
address: address.clone(),
Expand Down Expand Up @@ -872,7 +883,10 @@ impl CalloraSettlement {
let balance: i128 = env
.storage()
.persistent()
.get(&StorageKey::DeveloperBalance(address.clone(), token.clone()))
.get(&StorageKey::DeveloperBalance(
address.clone(),
token.clone(),
))
.unwrap_or(0i128);
result.push_back(DeveloperBalance {
address: address.clone(),
Expand Down Expand Up @@ -1003,10 +1017,8 @@ impl CalloraSettlement {

inst.remove(&StorageKey::PendingAdmin);

env.events().publish(
(events::event_admin_cancelled(&env), current, pending),
(),
);
env.events()
.publish((events::event_admin_cancelled(&env), current, pending), ());
}

/// Propose a new vault address (admin only).
Expand Down Expand Up @@ -1140,7 +1152,8 @@ impl CalloraSettlement {
}

// Perform the on-chain upgrade via the deployer interface.
env.deployer().update_current_contract_wasm(new_wasm_hash.clone());
env.deployer()
.update_current_contract_wasm(new_wasm_hash.clone());

// Persist the version marker for on-chain queries.
env.storage()
Expand All @@ -1156,9 +1169,7 @@ impl CalloraSettlement {
///
/// Returns `None` if no upgrade has been performed yet (initial deployment).
pub fn get_version(env: Env) -> Option<BytesN<32>> {
env.storage()
.instance()
.get(&StorageKey::ContractVersion)
env.storage().instance().get(&StorageKey::ContractVersion)
}

/// Insert `addr` into `index` in sorted order (ascending by raw bytes).
Expand Down
4 changes: 3 additions & 1 deletion contracts/settlement/src/test_error_codes.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ fn settlement_error_codes_are_stable_and_unique() {
(20, SettlementError::MigrationNotFound),
(21, SettlementError::TimelockNotExpired),
(22, SettlementError::MigrationBalanceChanged),
(23, SettlementError::OverDraft),
];

let mut seen = BTreeSet::new();
Expand All @@ -39,7 +40,7 @@ fn settlement_error_codes_are_stable_and_unique() {
);
}

assert_eq!(seen.len(), 22);
assert_eq!(seen.len(), 23);
}

#[test]
Expand Down Expand Up @@ -68,6 +69,7 @@ fn error_code_docs_list_every_settlement_code() {
"| 20 | `MigrationNotFound` | Settlement | No migration is pending for the source |",
"| 21 | `TimelockNotExpired` | Settlement | Migration delay has not elapsed |",
"| 22 | `MigrationBalanceChanged` | Settlement | Approved amount is no longer available |",
"| 23 | `OverDraft` | Settlement | Withdrawal amount exceeds the developer's balance |",
];

for line in expected_lines {
Expand Down
1 change: 1 addition & 0 deletions docs/ERROR_CODES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ must not be reassigned once released.
| 20 | `MigrationNotFound` | Settlement | No migration is pending for the source |
| 21 | `TimelockNotExpired` | Settlement | Migration delay has not elapsed |
| 22 | `MigrationBalanceChanged` | Settlement | Approved amount is no longer available |
| 23 | `OverDraft` | Settlement | Withdrawal amount exceeds the developer's balance |

## Revenue Pool

Expand Down
Loading