forked from Netwalls/BOXMEOUT_STELLA
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtreasury_changes.txt
More file actions
270 lines (268 loc) · 21 KB
/
Copy pathtreasury_changes.txt
File metadata and controls
270 lines (268 loc) · 21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
diff --git a/contracts/treasury/src/lib.rs b/contracts/treasury/src/lib.rs
index 57001752..aa199fd8 100644
--- a/contracts/treasury/src/lib.rs
+++ b/contracts/treasury/src/lib.rs
@@ -1,5 +1,5 @@
#![no_std]
-use soroban_sdk::{contract, contractimpl, Address, Bytes, Env, Vec};
+use soroban_sdk::{contract, contractimpl, token, Address, Bytes, Env, Symbol, Vec};
// ΓöÇΓöÇΓöÇ STORAGE KEYS ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ
// ADMIN -> Address
@@ -33,7 +33,40 @@ impl Treasury {
/// Appends withdrawal to WITHDRAWAL_LOG.
/// Emits FeesWithdrawn event.
pub fn withdraw_fees(env: Env, admin: Address, recipient: Address, amount: i128) {
- todo!("implement: require_auth(admin), check amount <= BALANCE, deduct BALANCE, transfer XLM to recipient, log withdrawal, emit event")
+ // 1. admin.require_auth() must be the first call
+ admin.require_auth();
+
+ // 2. Verify amount <= BALANCE, panic otherwise
+ let balance: i128 = env.storage().persistent().get(&Symbol::new(&env, "BALANCE")).unwrap_or(0);
+ if amount > balance {
+ panic!("amount exceeds balance");
+ }
+
+ // 3. Deduct amount from BALANCE
+ env.storage().persistent().set(&Symbol::new(&env, "BALANCE"), &(balance - amount));
+
+ // 4. Transfer XLM to recipient
+ let native = env.register_stellar_asset_contract(Address::from_str(&env, "native"));
+ let token_client = token::Client::new(&env, &native);
+ token_client.transfer(&env.current_contract_address(), &recipient, &amount);
+
+ // 5. Append (recipient, amount, timestamp) to WITHDRAWAL_LOG
+ let timestamp = env.ledger().timestamp();
+ let mut log: Vec<(Address, i128, u64)> = env
+ .storage()
+ .persistent()
+ .get(&Symbol::new(&env, "WITHDRAWAL_LOG"))
+ .unwrap_or(Vec::new(&env));
+ log.push_back((recipient.clone(), amount, timestamp));
+ env.storage()
+ .persistent()
+ .set(&Symbol::new(&env, "WITHDRAWAL_LOG"), &log);
+
+ // 6. Emit FeesWithdrawn event
+ env.events().publish(
+ (Symbol::new(&env, "FeesWithdrawn"),),
+ (recipient, amount, timestamp),
+ );
}
/// Emergency drain ΓÇö moves ALL funds to recipient.
@@ -60,3 +93,215 @@ impl Treasury {
todo!("implement: read WITHDRAWAL_LOG from storage and return")
}
}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use soroban_sdk::testutils::{Address as _, Events};
+
+ fn create_env() -> Env {
+ Env::default()
+ }
+
+ fn generate_address(env: &Env) -> Address {
+ Address::generate(env)
+ }
+
+ fn register_treasury(env: &Env) -> (Address, TreasuryClient) {
+ let contract_id = env.register_contract(None, Treasury);
+ let client = TreasuryClient::new(env, &contract_id);
+ (contract_id, client)
+ }
+
+ fn set_balance(env: &Env, amount: i128) {
+ env.storage()
+ .persistent()
+ .set(&Symbol::new(env, "BALANCE"), &amount);
+ }
+
+ fn fund_contract_native(env: &Env, contract_id: &Address, amount: i128) {
+ let native = env.register_stellar_asset_contract(Address::from_str(env, "native"));
+ let sac = token::StellarAssetClient::new(env, &native);
+ sac.mint(contract_id, &amount);
+ }
+
+ // ΓöÇΓöÇΓöÇ SUCCESS PATH ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ
+
+ #[test]
+ fn test_withdraw_fees_success() {
+ let env = create_env();
+ let (contract_id, client) = register_treasury(&env);
+ let admin = generate_address(&env);
+ let recipient = generate_address(&env);
+
+ let deposit_amount: i128 = 1000;
+ let withdraw_amount: i128 = 400;
+
+ // Seed the contract's bookkeeping balance and native XLM
+ set_balance(&env, deposit_amount);
+ fund_contract_native(&env, &contract_id, deposit_amount);
+
+ env.mock_all_auths();
+
+ // Record the recipient's XLM balance before withdrawal
+ let native = env.register_stellar_asset_contract(Address::from_str(&env, "native"));
+ let token_client = token::Client::new(&env, &native);
+ let recipient_balance_before = token_client.balance(&recipient);
+
+ // Execute
+ client.withdraw_fees(&admin, &recipient, &withdraw_amount);
+
+ // Assert BALANCE decreased by withdraw_amount
+ let remaining: i128 = env
+ .storage()
+ .persistent()
+ .get(&Symbol::new(&env, "BALANCE"))
+ .unwrap_or(0);
+ assert_eq!(remaining, deposit_amount - withdraw_amount);
+
+ // Assert XLM was transferred to recipient
+ let recipient_balance_after = token_client.balance(&recipient);
+ assert_eq!(
+ recipient_balance_after,
+ recipient_balance_before + withdraw_amount
+ );
+
+ // Assert withdrawal was logged
+ let log: Vec<(Address, i128, u64)> = env
+ .storage()
+ .persistent()
+ .get(&Symbol::new(&env, "WITHDRAWAL_LOG"))
+ .unwrap_or(Vec::new(&env));
+ assert_eq!(log.len(), 1);
+ let (log_recipient, log_amount, _log_ts) = log.get(0).unwrap();
+ assert_eq!(log_recipient, recipient);
+ assert_eq!(log_amount, withdraw_amount);
+
+ // Assert event was emitted
+ let events = env.events().all();
+ assert_eq!(events.len(), 1);
+ }
+
+ #[test]
+ fn test_withdraw_fees_multiple_withdrawals() {
+ let env = create_env();
+ let (contract_id, client) = register_treasury(&env);
+ let admin = generate_address(&env);
+ let recipient = generate_address(&env);
+
+ let initial_balance: i128 = 5000;
+
+ set_balance(&env, initial_balance);
+ fund_contract_native(&env, &contract_id, initial_balance);
+
+ env.mock_all_auths();
+
+ // First withdrawal
+ client.withdraw_fees(&admin, &recipient, &1000);
+ let log: Vec<(Address, i128, u64)> = env
+ .storage()
+ .persistent()
+ .get(&Symbol::new(&env, "WITHDRAWAL_LOG"))
+ .unwrap_or(Vec::new(&env));
+ assert_eq!(log.len(), 1);
+
+ // Second withdrawal
+ client.withdraw_fees(&admin, &recipient, &2000);
+ let log: Vec<(Address, i128, u64)> = env
+ .storage()
+ .persistent()
+ .get(&Symbol::new(&env, "WITHDRAWAL_LOG"))
+ .unwrap_or(Vec::new(&env));
+ assert_eq!(log.len(), 2);
+
+ let remaining: i128 = env
+ .storage()
+ .persistent()
+ .get(&Symbol::new(&env, "BALANCE"))
+ .unwrap_or(0);
+ assert_eq!(remaining, initial_balance - 1000 - 2000);
+ }
+
+ // ΓöÇΓöÇΓöÇ FAILURE: NON-ADMIN ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ
+
+ #[test]
+ #[should_panic(expected = "HostError")]
+ fn test_withdraw_fees_non_admin_panics() {
+ let env = create_env();
+ let (_contract_id, client) = register_treasury(&env);
+ let admin = generate_address(&env);
+ let recipient = generate_address(&env);
+
+ set_balance(&env, 1000);
+
+ // No auth mocked → admin.require_auth() panics with HostError
+ client.withdraw_fees(&admin, &recipient, &500);
+ }
+
+ // ΓöÇΓöÇΓöÇ FAILURE: AMOUNT > BALANCE ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ
+
+ #[test]
+ #[should_panic(expected = "amount exceeds balance")]
+ fn test_withdraw_fees_exceeds_balance_panics() {
+ let env = create_env();
+ let (_contract_id, client) = register_treasury(&env);
+ let admin = generate_address(&env);
+ let recipient = generate_address(&env);
+
+ set_balance(&env, 100);
+
+ env.mock_all_auths();
+
+ // amount (200) > BALANCE (100) → panic with "amount exceeds balance"
+ client.withdraw_fees(&admin, &recipient, &200);
+ }
+
+ // ΓöÇΓöÇΓöÇ FAILURE: ZERO BALANCE ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ
+
+ #[test]
+ #[should_panic(expected = "amount exceeds balance")]
+ fn test_withdraw_fees_zero_balance_panics() {
+ let env = create_env();
+ let (_contract_id, client) = register_treasury(&env);
+ let admin = generate_address(&env);
+ let recipient = generate_address(&env);
+
+ // BALANCE is not set → defaults to 0 via unwrap_or(0)
+ env.mock_all_auths();
+
+ client.withdraw_fees(&admin, &recipient, &1);
+ }
+
+ // ΓöÇΓöÇΓöÇ EVENT STRUCTURE ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇ
+
+ #[test]
+ fn test_withdraw_fees_emits_event() {
+ let env = create_env();
+ let (contract_id, client) = register_treasury(&env);
+ let admin = generate_address(&env);
+ let recipient = generate_address(&env);
+
+ set_balance(&env, 500);
+ fund_contract_native(&env, &contract_id, 500);
+
+ env.mock_all_auths();
+
+ client.withdraw_fees(&admin, &recipient, &300);
+
+ let events = env.events().all();
+ assert_eq!(events.len(), 1);
+
+ let (event_contract_id, topics, data) = &events.get(0).unwrap();
+ assert_eq!(*event_contract_id, contract_id);
+
+ // topics: (Symbol("FeesWithdrawn"),)
+ let (symbol_key,): (Symbol,) = topics.clone().try_into().unwrap();
+ assert_eq!(symbol_key.to_string(), "FeesWithdrawn");
+
+ // data: (recipient, amount, timestamp)
+ let (event_recipient, event_amount, _event_ts): (Address, i128, u64) =
+ data.clone().try_into().unwrap();
+ assert_eq!(event_recipient, recipient);
+ assert_eq!(event_amount, 300);
+ }
+}
\ No newline at end of file