forked from Talenttrust/Talenttrust-Contracts
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathprotocol_fees.rs
More file actions
377 lines (296 loc) · 13.5 KB
/
Copy pathprotocol_fees.rs
File metadata and controls
377 lines (296 loc) · 13.5 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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
#![cfg(test)]
use soroban_sdk::testutils::Ledger as _;
use soroban_sdk::{testutils::Address as _, Address, Env, vec};
use crate::{Escrow, EscrowClient, DataKey, Error, ReleaseAuthorization};
#[test]
fn test_default_fees_are_zero() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
let contract_id = env.register(Escrow, ());
let client = EscrowClient::new(&env, &contract_id);
// Default values before initialization or setting must be 0
assert_eq!(client.get_protocol_fee_bps(), 0);
assert_eq!(client.get_accumulated_protocol_fees(), 0);
}
/// Test that `get_protocol_fee_bps` returns 0 when uninitialized.
#[test]
fn test_get_protocol_fee_bps_returns_zero_when_uninitialized() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
assert_eq!(client.get_protocol_fee_bps(), 0);
}
/// Test that `get_accumulated_protocol_fees` returns 0 when uninitialized.
#[test]
fn test_get_accumulated_protocol_fees_returns_zero_when_uninitialized() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
assert_eq!(client.get_accumulated_protocol_fees(), 0);
}
/// Test that `get_protocol_fee_bps` returns the configured value after admin sets it.
#[test]
fn test_get_protocol_fee_bps_after_configuration() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
env.mock_all_auths();
let admin = Address::generate(&env);
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
client.initialize(&admin);
assert_eq!(client.get_protocol_fee_bps(), 0);
client.set_protocol_fee_bps(&500u32);
assert_eq!(client.get_protocol_fee_bps(), 500);
client.set_protocol_fee_bps(&1000u32);
assert_eq!(client.get_protocol_fee_bps(), 1000);
}
/// Test that protocol fee updates accept 0 and 10_000 basis points.
#[test]
fn test_set_protocol_fee_bps_accepts_boundary_values() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
env.mock_all_auths();
let admin = Address::generate(&env);
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
client.initialize(&admin);
assert!(client.set_protocol_fee_bps(&0u32));
assert_eq!(client.get_protocol_fee_bps(), 0);
assert!(client.set_protocol_fee_bps(&10_000u32));
assert_eq!(client.get_protocol_fee_bps(), 10_000);
}
/// Test that protocol fee updates reject values above 100%.
#[test]
fn test_set_protocol_fee_bps_rejects_values_above_100_percent() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
env.mock_all_auths();
let admin = Address::generate(&env);
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
client.initialize(&admin);
assert!(client.set_protocol_fee_bps(&0u32));
let result = client.try_set_protocol_fee_bps(&10_001u32);
super::assert_contract_error(result, Error::InvalidProtocolParameters);
assert_eq!(client.get_protocol_fee_bps(), 0);
}
/// Test that `get_accumulated_protocol_fees` reflects fees accumulated after milestone releases.
#[test]
fn test_get_accumulated_protocol_fees_after_releases() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
env.mock_all_auths();
let admin = Address::generate(&env);
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
client.initialize(&admin);
client.set_protocol_fee_bps(&1000u32);
let client_addr = Address::generate(&env);
let freelancer_addr = Address::generate(&env);
let milestones = vec![&env, 1000_i128, 2500_i128, 3333_i128];
let id = client.create_contract(
&client_addr,
&freelancer_addr,
&None,
&milestones,
&ReleaseAuthorization::ClientOnly,
);
client.deposit_funds(&id, &client_addr, &6833_i128);
assert_eq!(client.get_accumulated_protocol_fees(), 0);
// Fee: 1000 * 1000 / 10_000 = 100
client.approve_milestone_release(&id, &client_addr, &0);
client.release_milestone(&id, &client_addr, &0);
assert_eq!(client.get_accumulated_protocol_fees(), 100);
// Fee: 2500 * 1000 / 10_000 = 250
client.approve_milestone_release(&id, &client_addr, &1);
client.release_milestone(&id, &client_addr, &1);
assert_eq!(client.get_accumulated_protocol_fees(), 350);
// Fee: 3333 * 1000 / 10_000 = 333
client.approve_milestone_release(&id, &client_addr, &2);
client.release_milestone(&id, &client_addr, &2);
assert_eq!(client.get_accumulated_protocol_fees(), 683);
}
/// Test that accumulated fees remain at 0 when fee rate is 0.
#[test]
fn test_no_fees_accumulated_when_rate_is_zero() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
env.mock_all_auths();
let admin = Address::generate(&env);
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
client.initialize(&admin);
assert_eq!(client.get_protocol_fee_bps(), 0);
let client_addr = Address::generate(&env);
let freelancer_addr = Address::generate(&env);
let milestones = vec![&env, 1000_i128];
let id = client.create_contract(
&client_addr,
&freelancer_addr,
&None,
&milestones,
&ReleaseAuthorization::ClientOnly,
);
client.deposit_funds(&id, &client_addr, &1000_i128);
client.approve_milestone_release(&id, &client_addr, &0);
client.release_milestone(&id, &client_addr, &0);
assert_eq!(client.get_accumulated_protocol_fees(), 0);
}
/// Test that read functions bump TTL and can be called multiple times without error.
#[test]
fn test_readers_bump_ttl_and_are_non_destructive() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
env.mock_all_auths();
let admin = Address::generate(&env);
let contract_id = env.register(Escrow, ());
let client = EscrowClient::new(&env, &contract_id);
client.initialize(&admin);
client.set_protocol_fee_bps(&250u32);
env.as_contract(&contract_id, || {
env.storage()
.persistent()
.set(&DataKey::AccumulatedProtocolFees, &5000_i128);
});
for _ in 0..10 {
assert_eq!(client.get_protocol_fee_bps(), 250);
assert_eq!(client.get_accumulated_protocol_fees(), 5000);
}
}
/// Test readers work when keys are set directly without initialization.
#[test]
fn test_readers_work_without_initialization() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
env.as_contract(&contract_id, || {
env.storage()
.persistent()
.set(&DataKey::ProtocolFeeBps, &123u32);
env.storage()
.persistent()
.set(&DataKey::AccumulatedProtocolFees, &456_i128);
});
assert_eq!(client.get_protocol_fee_bps(), 123);
assert_eq!(client.get_accumulated_protocol_fees(), 456);
}
#[test]
fn test_fee_math_0_bps() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
let fee = Escrow::calculate_protocol_fee(&env, 1000, 0);
assert_eq!(fee, 0);
}
#[test]
#![cfg(test)]
use soroban_sdk::{testutils::Address as _, Address, Env, vec, String};
use crate::{Escrow, EscrowClient, DataKey};
fn create_token_contract(e: &Env, admin: &Address) -> Address {
e.register_stellar_asset_contract(admin.clone())
}
#[test]
fn test_fee_accrual_and_withdrawal() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
env.mock_all_auths();
let admin = Address::generate(&env);
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
let token_admin = Address::generate(&env);
let token = create_token_contract(&env, &token_admin);
let token_client = soroban_sdk::token::Client::new(&env, &token);
let token_admin_client = soroban_sdk::token::StellarAssetClient::new(&env, &token);
// Initialize with 1000 bps (10%)
client.initialize(&admin, &1000u32);
let client_addr = Address::generate(&env);
let freelancer_addr = Address::generate(&env);
// Milestones: 1000, 2500, 3333
let milestones = vec![&env, 1000_i128, 2500_i128, 3333_i128];
// Note: create_contract has different arguments depending on the current iteration of the code.
// Based on lib.rs line 145: pub fn create_contract(env: Env, client: Address, freelancer: Address, arbiter: Option<Address>, milestones: Vec<i128>, terms_hash: Option<Bytes>, grace_period_seconds: Option<u64>)
// Wait, let's use the actual create_contract signature from lib.rs.
// Looking at lib.rs, create_contract in test.rs uses:
// client.create_contract(&client_addr, &freelancer_addr, &None, &milestones);
let id = client.create_contract(&client_addr, &freelancer_addr, &None, &milestones, &None, &None);
client.deposit_funds(&id, &6833_i128); // 1000 + 2500 + 3333 = 6833
// Release milestone 0 (1000)
// Fee: (1000 * 1000 + 9999) / 10000 = (1000000 + 9999) / 10000 = 1009999 / 10000 = 100
assert!(client.release_milestone(&id, &0));
// Release milestone 1 (2500)
// Fee: (2500 * 1000 + 9999) / 10000 = (2500000 + 9999) / 10000 = 2509999 / 10000 = 250
assert!(client.release_milestone(&id, &1));
// Release milestone 2 (3333)
// Fee: (3333 * 1000 + 9999) / 10000 = (3333000 + 9999) / 10000 = 3342999 / 10000 = 334
assert!(client.release_milestone(&id, &2));
// Total accumulated fees: 100 + 250 + 334 = 684
// Mint tokens to the contract so it has funds to transfer out
token_admin_client.mint(&contract_id, &684);
let destination = Address::generate(&env);
// Admin withdraws protocol fees
let success = client.withdraw_protocol_fees(&admin, &destination, &684_i128, &token);
assert!(success);
assert_eq!(token_client.balance(&destination), 684);
}
#[test]
#[should_panic(expected = "HostError: Error(Contract, #6)")] // UnauthorizedRole
fn test_unauthorized_withdrawal() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
env.mock_all_auths();
let admin = Address::generate(&env);
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
client.initialize(&admin, &1000u32);
let fake_admin = Address::generate(&env);
let destination = Address::generate(&env);
let token = Address::generate(&env);
// This should panic
client.withdraw_protocol_fees(&fake_admin, &destination, &100_i128, &token);
}
#[test]
#[should_panic(expected = "HostError: Error(Contract, #13)")] // InsufficientAccumulatedFees
fn test_over_withdrawal() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
env.mock_all_auths();
let admin = Address::generate(&env);
let contract_id = env.register_contract(None, Escrow);
let client = EscrowClient::new(&env, &contract_id);
client.initialize(&admin, &1000u32);
let destination = Address::generate(&env);
let token = Address::generate(&env);
// Withdraw more than 0
client.withdraw_protocol_fees(&admin, &destination, &100_i128, &token);
}
#[test]
fn test_fee_math_0_bps() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
let fee = Escrow::calculate_protocol_fee(&env, 1000, 0);
assert_eq!(fee, 0);
}
#[test]
fn test_fee_math_normal_bps() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
let fee = Escrow::calculate_protocol_fee(&env, 1000, 1000);
assert_eq!(fee, 100);
}
#[test]
#[should_panic(expected = "HostError: Error(Contract, #25)")] // PotentialOverflow
fn test_fee_math_overflow() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
Escrow::calculate_protocol_fee(&env, i128::MAX, 1000);
}
#[test]
fn test_fee_math_tiny_amount() {
let env = Env::default();
env.ledger().with_mut(|li| { li.max_entry_ttl = 3_110_400; li.min_persistent_entry_ttl = 3_110_400; });
// 9 * 1000 = 9000. 9000 / 10000 = 0 (rounds to zero)
let fee = Escrow::calculate_protocol_fee(&env, 9, 1000);
assert_eq!(fee, 0);
}