Skip to content

Commit 6d2011a

Browse files
committed
refactor: additional snake case naming changes
1 parent e2e4df1 commit 6d2011a

File tree

4 files changed

+33
-68
lines changed

4 files changed

+33
-68
lines changed

src/core/MultistrategyVault.sol

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ contract MultistrategyVault is IMultistrategyVault {
334334
* @param name_ New name for the vault token
335335
* @custom:security Only callable by roleManager
336336
*/
337-
function set_name(string memory name_) external override {
337+
function setName(string memory name_) external override {
338338
require(msg.sender == roleManager, NotAllowed());
339339
name = name_;
340340
}
@@ -345,7 +345,7 @@ contract MultistrategyVault is IMultistrategyVault {
345345
* @param symbol_ New symbol ticker for the vault token
346346
* @custom:security Only callable by roleManager
347347
*/
348-
function set_symbol(string memory symbol_) external override {
348+
function setSymbol(string memory symbol_) external override {
349349
require(msg.sender == roleManager, NotAllowed());
350350
symbol = symbol_;
351351
}
@@ -1667,15 +1667,6 @@ contract MultistrategyVault is IMultistrategyVault {
16671667
return _convertToAssets(shares_, Rounding.ROUND_DOWN);
16681668
}
16691669

1670-
/**
1671-
* @notice Returns the default withdrawal queue
1672-
* @dev Same as getDefaultQueue()
1673-
* @return queue Array of strategy addresses in withdrawal priority order
1674-
*/
1675-
function defaultQueue() external view override returns (address[] memory) {
1676-
return _defaultQueue;
1677-
}
1678-
16791670
/**
16801671
* @notice Returns maximum assets that can be deposited for a receiver
16811672
* @dev Checks against depositLimit or depositLimitModule (if set)
@@ -1821,31 +1812,6 @@ contract MultistrategyVault is IMultistrategyVault {
18211812
return API_VERSION;
18221813
}
18231814

1824-
// ============================================
1825-
// VIEW FUNCTIONS - STRATEGY QUERIES
1826-
// ============================================
1827-
1828-
/**
1829-
* @notice Calculates the unrealized losses for a withdrawal from strategy
1830-
* @dev Compares strategy's actual asset value vs recorded debt
1831-
* If strategy is underwater, user takes proportional share of loss
1832-
*
1833-
* Formula: loss = assetsNeeded - (assetsNeeded * strategyAssets / currentDebt)
1834-
*
1835-
* @param strategy_ Address of the strategy
1836-
* @param assetsNeeded_ Amount of assets to withdraw from strategy
1837-
* @return loss User's share of unrealized losses
1838-
*/
1839-
function assess_share_of_unrealised_losses(
1840-
address strategy_,
1841-
uint256 assetsNeeded_
1842-
) external view returns (uint256) {
1843-
uint256 currentDebt = _strategies[strategy_].currentDebt;
1844-
require(currentDebt >= assetsNeeded_, NotEnoughDebt());
1845-
1846-
return _assess_share_of_unrealised_losses(strategy_, currentDebt, assetsNeeded_);
1847-
}
1848-
18491815
// ============================================
18501816
// VIEW FUNCTIONS - PROFIT LOCKING
18511817
// ============================================

src/core/interfaces/IMultistrategyVault.sol

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,6 @@ interface IMultistrategyVault {
349349
// NOTE: The following functions are declared for interface completeness where
350350
// some implementations may expose equivalent public state variables.
351351
function strategies(address strategy) external view returns (StrategyParams memory);
352-
function defaultQueue() external view returns (address[] memory);
353352
function useDefaultQueue() external view returns (bool);
354353
function autoAllocate() external view returns (bool);
355354
function minimumTotalIdle() external view returns (uint256);
@@ -456,8 +455,8 @@ interface IMultistrategyVault {
456455
) external returns (bool);
457456

458457
// Management Functions
459-
function set_name(string memory name) external;
460-
function set_symbol(string memory symbol) external;
458+
function setName(string memory name) external;
459+
function setSymbol(string memory symbol) external;
461460
function set_accountant(address newAccountant) external;
462461
function set_default_queue(address[] memory newDefaultQueue) external;
463462
function set_use_default_queue(bool useDefaultQueue) external;

test/unit/core/multistrategyvault/QueueManagement.t.sol

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ contract QueueManagementTest is Test {
196196

197197
function testAddStrategyAddsToQueue() public {
198198
// Check empty queue initially
199-
address[] memory queue = vault.defaultQueue();
199+
address[] memory queue = vault.get_default_queue();
200200
assertEq(queue.length, 0, "Queue should start empty");
201201

202202
// Add first strategy
@@ -205,7 +205,7 @@ contract QueueManagementTest is Test {
205205
vault.add_strategy(strategyOne, true);
206206

207207
// Check queue contains the first strategy
208-
queue = vault.defaultQueue();
208+
queue = vault.get_default_queue();
209209
assertEq(queue.length, 1, "Queue should have one strategy");
210210
assertEq(queue[0], strategyOne, "First strategy should be in queue");
211211

@@ -215,15 +215,15 @@ contract QueueManagementTest is Test {
215215
vault.add_strategy(strategyTwo, true);
216216

217217
// Check queue contains both strategies in order
218-
queue = vault.defaultQueue();
218+
queue = vault.get_default_queue();
219219
assertEq(queue.length, 2, "Queue should have two strategies");
220220
assertEq(queue[0], strategyOne, "First strategy should be first in queue");
221221
assertEq(queue[1], strategyTwo, "Second strategy should be second in queue");
222222
}
223223

224224
function testAddStrategyDontAddToQueue() public {
225225
// Check empty queue initially
226-
address[] memory queue = vault.defaultQueue();
226+
address[] memory queue = vault.get_default_queue();
227227
assertEq(queue.length, 0, "Queue should start empty");
228228

229229
// Add first strategy without adding to queue
@@ -232,7 +232,7 @@ contract QueueManagementTest is Test {
232232
vault.add_strategy(strategyOne, false);
233233

234234
// Check queue is still empty
235-
queue = vault.defaultQueue();
235+
queue = vault.get_default_queue();
236236
assertEq(queue.length, 0, "Queue should still be empty");
237237

238238
// Check strategy is still active
@@ -245,13 +245,13 @@ contract QueueManagementTest is Test {
245245
vault.add_strategy(strategyTwo, false);
246246

247247
// Check queue is still empty
248-
queue = vault.defaultQueue();
248+
queue = vault.get_default_queue();
249249
assertEq(queue.length, 0, "Queue should still be empty");
250250
}
251251

252252
function testAddElevenStrategiesAddsTenToQueue() public {
253253
// Check empty queue initially
254-
address[] memory queue = vault.defaultQueue();
254+
address[] memory queue = vault.get_default_queue();
255255
assertEq(queue.length, 0, "Queue should start empty");
256256

257257
// Add 10 strategies and check queue length increases each time
@@ -263,12 +263,12 @@ contract QueueManagementTest is Test {
263263
vm.prank(gov);
264264
vault.add_strategy(newStrategy, true);
265265

266-
queue = vault.defaultQueue();
266+
queue = vault.get_default_queue();
267267
assertEq(queue.length, i + 1, "Queue length should increase");
268268
}
269269

270270
// Store queue for comparison
271-
address[] memory defaultQueue = vault.defaultQueue();
271+
address[] memory defaultQueue = vault.get_default_queue();
272272
assertEq(defaultQueue.length, 10, "Default queue should have 10 strategies");
273273

274274
// Add 11th strategy
@@ -283,7 +283,7 @@ contract QueueManagementTest is Test {
283283
assertGt(params.activation, 0, "Strategy should be active");
284284

285285
// Check queue remains unchanged
286-
address[] memory newQueue = vault.defaultQueue();
286+
address[] memory newQueue = vault.get_default_queue();
287287
assertEq(newQueue.length, 10, "Queue should still have 10 strategies");
288288

289289
// Verify 11th strategy isn't in queue
@@ -299,7 +299,7 @@ contract QueueManagementTest is Test {
299299

300300
function testRevokeStrategyRemovesStrategyFromQueue() public {
301301
// Check empty queue initially
302-
address[] memory queue = vault.defaultQueue();
302+
address[] memory queue = vault.get_default_queue();
303303
assertEq(queue.length, 0, "Queue should start empty");
304304

305305
// Add a strategy
@@ -308,7 +308,7 @@ contract QueueManagementTest is Test {
308308
vault.add_strategy(strategyOne, true);
309309

310310
// Check queue contains the strategy
311-
queue = vault.defaultQueue();
311+
queue = vault.get_default_queue();
312312
assertEq(queue.length, 1, "Queue should have one strategy");
313313
assertEq(queue[0], strategyOne, "Strategy should be in queue");
314314

@@ -320,7 +320,7 @@ contract QueueManagementTest is Test {
320320
IMultistrategyVault.StrategyParams memory params = vault.strategies(strategyOne);
321321
assertEq(params.activation, 0, "Strategy should not be active");
322322

323-
queue = vault.defaultQueue();
323+
queue = vault.get_default_queue();
324324
assertEq(queue.length, 0, "Queue should be empty");
325325
}
326326

@@ -334,7 +334,7 @@ contract QueueManagementTest is Test {
334334
IMultistrategyVault.StrategyParams memory params = vault.strategies(strategyOne);
335335
assertGt(params.activation, 0, "Strategy should be active");
336336

337-
address[] memory queue = vault.defaultQueue();
337+
address[] memory queue = vault.get_default_queue();
338338
assertEq(queue.length, 0, "Queue should be empty");
339339

340340
// Revoke the strategy
@@ -345,7 +345,7 @@ contract QueueManagementTest is Test {
345345
params = vault.strategies(strategyOne);
346346
assertEq(params.activation, 0, "Strategy should not be active");
347347

348-
queue = vault.defaultQueue();
348+
queue = vault.get_default_queue();
349349
assertEq(queue.length, 0, "Queue should still be empty");
350350
}
351351

@@ -360,7 +360,7 @@ contract QueueManagementTest is Test {
360360
vault.add_strategy(strategyTwo, true);
361361

362362
// Check queue contains both strategies
363-
address[] memory queue = vault.defaultQueue();
363+
address[] memory queue = vault.get_default_queue();
364364
assertEq(queue.length, 2, "Queue should have two strategies");
365365
assertEq(queue[0], strategyOne, "First strategy should be first in queue");
366366
assertEq(queue[1], strategyTwo, "Second strategy should be second in queue");
@@ -373,7 +373,7 @@ contract QueueManagementTest is Test {
373373
IMultistrategyVault.StrategyParams memory params = vault.strategies(strategyOne);
374374
assertEq(params.activation, 0, "First strategy should not be active");
375375

376-
queue = vault.defaultQueue();
376+
queue = vault.get_default_queue();
377377
assertEq(queue.length, 1, "Queue should have one strategy");
378378
assertEq(queue[0], strategyTwo, "Only second strategy should be in queue");
379379
}
@@ -390,7 +390,7 @@ contract QueueManagementTest is Test {
390390
}
391391

392392
// Store queue for comparison
393-
address[] memory defaultQueue = vault.defaultQueue();
393+
address[] memory defaultQueue = vault.get_default_queue();
394394
assertEq(defaultQueue.length, 10, "Default queue should have 10 strategies");
395395

396396
// Add 11th strategy
@@ -407,7 +407,7 @@ contract QueueManagementTest is Test {
407407
vault.revoke_strategy(eleventhStrategy);
408408

409409
// Check queue is unchanged
410-
address[] memory newQueue = vault.defaultQueue();
410+
address[] memory newQueue = vault.get_default_queue();
411411
assertEq(newQueue.length, 10, "Queue should still have 10 strategies");
412412

413413
// Verify queue is unchanged
@@ -427,7 +427,7 @@ contract QueueManagementTest is Test {
427427
vault.add_strategy(strategyTwo, true);
428428

429429
// Check default queue order
430-
address[] memory queue = vault.defaultQueue();
430+
address[] memory queue = vault.get_default_queue();
431431
assertEq(queue.length, 2, "Queue should have two strategies");
432432
assertEq(queue[0], strategyOne, "First strategy should be first in queue");
433433
assertEq(queue[1], strategyTwo, "Second strategy should be second in queue");
@@ -443,7 +443,7 @@ contract QueueManagementTest is Test {
443443
vault.set_default_queue(newQueue);
444444

445445
// Check new queue is set
446-
queue = vault.defaultQueue();
446+
queue = vault.get_default_queue();
447447
assertEq(queue.length, 2, "Queue should have two strategies");
448448
assertEq(queue[0], strategyTwo, "First strategy should now be the second strategy");
449449
assertEq(queue[1], strategyOne, "Second strategy should now be the first strategy");

test/unit/core/multistrategyvault/RoleBasedAccess.t.sol

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -531,15 +531,15 @@ contract RoleBasedAccessTest is Test {
531531
vault.add_role(bunny, IMultistrategyVault.Roles.QUEUE_MANAGER);
532532

533533
// Get initial queue
534-
address[] memory initialQueue = vault.defaultQueue();
534+
address[] memory initialQueue = vault.get_default_queue();
535535
assertGt(initialQueue.length, 0, "Initial queue should not be empty");
536536

537537
// Set default queue with bunny
538538
vm.prank(bunny);
539539
vault.set_default_queue(new address[](0));
540540

541541
// Verify new state
542-
address[] memory newQueue = vault.defaultQueue();
542+
address[] memory newQueue = vault.get_default_queue();
543543
assertEq(newQueue.length, 0, "Queue should be empty after setting");
544544
}
545545

@@ -729,7 +729,7 @@ contract RoleBasedAccessTest is Test {
729729
// Verify bunny can't set name
730730
vm.prank(bunny);
731731
vm.expectRevert(IMultistrategyVault.NotAllowed.selector);
732-
vault.set_name(newName);
732+
vault.setName(newName);
733733

734734
// Give bunny ALL roles
735735
vm.prank(gov);
@@ -738,14 +738,14 @@ contract RoleBasedAccessTest is Test {
738738
// Verify bunny still can't set name (only roleManager can)
739739
vm.prank(bunny);
740740
vm.expectRevert(IMultistrategyVault.NotAllowed.selector);
741-
vault.set_name(newName);
741+
vault.setName(newName);
742742

743743
// Verify name unchanged
744744
assertEq(vault.name(), initialName, "Name should be unchanged");
745745

746746
// Set name with gov (roleManager)
747747
vm.prank(gov);
748-
vault.set_name(newName);
748+
vault.setName(newName);
749749

750750
// Verify name changed
751751
assertEq(vault.name(), newName, "Name should be changed");
@@ -760,7 +760,7 @@ contract RoleBasedAccessTest is Test {
760760
// Verify bunny can't set symbol
761761
vm.prank(bunny);
762762
vm.expectRevert(IMultistrategyVault.NotAllowed.selector);
763-
vault.set_symbol(newSymbol);
763+
vault.setSymbol(newSymbol);
764764

765765
// Give bunny ALL roles
766766
vm.prank(gov);
@@ -769,14 +769,14 @@ contract RoleBasedAccessTest is Test {
769769
// Verify bunny still can't set symbol (only roleManager can)
770770
vm.prank(bunny);
771771
vm.expectRevert(IMultistrategyVault.NotAllowed.selector);
772-
vault.set_symbol(newSymbol);
772+
vault.setSymbol(newSymbol);
773773

774774
// Verify symbol unchanged
775775
assertEq(vault.symbol(), initialSymbol, "Symbol should be unchanged");
776776

777777
// Set symbol with gov (roleManager)
778778
vm.prank(gov);
779-
vault.set_symbol(newSymbol);
779+
vault.setSymbol(newSymbol);
780780

781781
// Verify symbol changed
782782
assertEq(vault.symbol(), newSymbol, "Symbol should be changed");

0 commit comments

Comments
 (0)