-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathflatten.sol
More file actions
1816 lines (1581 loc) · 68 KB
/
flatten.sol
File metadata and controls
1816 lines (1581 loc) · 68 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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0 ^0.8.28;
// contracts/interfaces/ICapSymbioticVaultFactory.sol
interface ICapSymbioticVaultFactory {
/// @notice Creates a new vault
/// @param _owner The owner of the vault, will manage delegations and set deposit limits
/// @param asset The asset of the vault
/// @return vault The address of the new vault
function createVault(address _owner, address asset) external returns (address vault, address stakerRewards);
}
// node_modules/@symbioticfi/core/src/interfaces/IVaultConfigurator.sol
interface IVaultConfigurator {
/**
* @notice Initial parameters needed for a vault with a delegator and a slasher deployment.
* @param version entity's version to use
* @param owner initial owner of the entity
* @param vaultParams parameters for the vault initialization
* @param delegatorIndex delegator's index of the implementation to deploy
* @param delegatorParams parameters for the delegator initialization
* @param withSlasher whether to deploy a slasher or not
* @param slasherIndex slasher's index of the implementation to deploy (used only if withSlasher == true)
* @param slasherParams parameters for the slasher initialization (used only if withSlasher == true)
*/
struct InitParams {
uint64 version;
address owner;
bytes vaultParams;
uint64 delegatorIndex;
bytes delegatorParams;
bool withSlasher;
uint64 slasherIndex;
bytes slasherParams;
}
/**
* @notice Get the vault factory's address.
* @return address of the vault factory
*/
function VAULT_FACTORY() external view returns (address);
/**
* @notice Get the delegator factory's address.
* @return address of the delegator factory
*/
function DELEGATOR_FACTORY() external view returns (address);
/**
* @notice Get the slasher factory's address.
* @return address of the slasher factory
*/
function SLASHER_FACTORY() external view returns (address);
/**
* @notice Create a new vault with a delegator and a slasher.
* @param params initial parameters needed for a vault with a delegator and a slasher deployment
* @return vault address of the vault
* @return delegator address of the delegator
* @return slasher address of the slasher
*/
function create(InitParams calldata params) external returns (address vault, address delegator, address slasher);
}
// node_modules/@symbioticfi/core/src/interfaces/common/IEntity.sol
interface IEntity {
error NotInitialized();
/**
* @notice Get the factory's address.
* @return address of the factory
*/
function FACTORY() external view returns (address);
/**
* @notice Get the entity's type.
* @return type of the entity
*/
function TYPE() external view returns (uint64);
/**
* @notice Initialize this entity contract by using a given data.
* @param data some data to use
*/
function initialize(bytes calldata data) external;
}
// node_modules/@symbioticfi/core/src/interfaces/common/IMigratableEntity.sol
interface IMigratableEntity {
error AlreadyInitialized();
error NotFactory();
error NotInitialized();
/**
* @notice Get the factory's address.
* @return address of the factory
*/
function FACTORY() external view returns (address);
/**
* @notice Get the entity's version.
* @return version of the entity
* @dev Starts from 1.
*/
function version() external view returns (uint64);
/**
* @notice Initialize this entity contract by using a given data and setting a particular version and owner.
* @param initialVersion initial version of the entity
* @param owner initial owner of the entity
* @param data some data to use
*/
function initialize(uint64 initialVersion, address owner, bytes calldata data) external;
/**
* @notice Migrate this entity to a particular newer version using a given data.
* @param newVersion new version of the entity
* @param data some data to use
*/
function migrate(uint64 newVersion, bytes calldata data) external;
}
// node_modules/@symbioticfi/core/src/interfaces/common/IRegistry.sol
interface IRegistry {
error EntityNotExist();
/**
* @notice Emitted when an entity is added.
* @param entity address of the added entity
*/
event AddEntity(address indexed entity);
/**
* @notice Get if a given address is an entity.
* @param account address to check
* @return if the given address is an entity
*/
function isEntity(address account) external view returns (bool);
/**
* @notice Get a total number of entities.
* @return total number of entities added
*/
function totalEntities() external view returns (uint256);
/**
* @notice Get an entity given its index.
* @param index index of the entity to get
* @return address of the entity
*/
function entity(uint256 index) external view returns (address);
}
// node_modules/@symbioticfi/core/src/interfaces/slasher/IBurner.sol
interface IBurner {
/**
* @notice Called when a slash happens.
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @param operator address of the operator
* @param amount virtual amount of the collateral slashed
* @param captureTimestamp time point when the stake was captured
*/
function onSlash(bytes32 subnetwork, address operator, uint256 amount, uint48 captureTimestamp) external;
}
// node_modules/@symbioticfi/core/src/interfaces/vault/IVaultStorage.sol
interface IVaultStorage {
error InvalidTimestamp();
error NoPreviousEpoch();
/**
* @notice Get a deposit whitelist enabler/disabler's role.
* @return identifier of the whitelist enabler/disabler role
*/
function DEPOSIT_WHITELIST_SET_ROLE() external view returns (bytes32);
/**
* @notice Get a depositor whitelist status setter's role.
* @return identifier of the depositor whitelist status setter role
*/
function DEPOSITOR_WHITELIST_ROLE() external view returns (bytes32);
/**
* @notice Get a deposit limit enabler/disabler's role.
* @return identifier of the deposit limit enabler/disabler role
*/
function IS_DEPOSIT_LIMIT_SET_ROLE() external view returns (bytes32);
/**
* @notice Get a deposit limit setter's role.
* @return identifier of the deposit limit setter role
*/
function DEPOSIT_LIMIT_SET_ROLE() external view returns (bytes32);
/**
* @notice Get the delegator factory's address.
* @return address of the delegator factory
*/
function DELEGATOR_FACTORY() external view returns (address);
/**
* @notice Get the slasher factory's address.
* @return address of the slasher factory
*/
function SLASHER_FACTORY() external view returns (address);
/**
* @notice Get a vault collateral.
* @return address of the underlying collateral
*/
function collateral() external view returns (address);
/**
* @notice Get a burner to issue debt to (e.g., 0xdEaD or some unwrapper contract).
* @return address of the burner
*/
function burner() external view returns (address);
/**
* @notice Get a delegator (it delegates the vault's stake to networks and operators).
* @return address of the delegator
*/
function delegator() external view returns (address);
/**
* @notice Get if the delegator is initialized.
* @return if the delegator is initialized
*/
function isDelegatorInitialized() external view returns (bool);
/**
* @notice Get a slasher (it provides networks a slashing mechanism).
* @return address of the slasher
*/
function slasher() external view returns (address);
/**
* @notice Get if the slasher is initialized.
* @return if the slasher is initialized
*/
function isSlasherInitialized() external view returns (bool);
/**
* @notice Get a time point of the epoch duration set.
* @return time point of the epoch duration set
*/
function epochDurationInit() external view returns (uint48);
/**
* @notice Get a duration of the vault epoch.
* @return duration of the epoch
*/
function epochDuration() external view returns (uint48);
/**
* @notice Get an epoch at a given timestamp.
* @param timestamp time point to get the epoch at
* @return epoch at the timestamp
* @dev Reverts if the timestamp is less than the start of the epoch 0.
*/
function epochAt(uint48 timestamp) external view returns (uint256);
/**
* @notice Get a current vault epoch.
* @return current epoch
*/
function currentEpoch() external view returns (uint256);
/**
* @notice Get a start of the current vault epoch.
* @return start of the current epoch
*/
function currentEpochStart() external view returns (uint48);
/**
* @notice Get a start of the previous vault epoch.
* @return start of the previous epoch
* @dev Reverts if the current epoch is 0.
*/
function previousEpochStart() external view returns (uint48);
/**
* @notice Get a start of the next vault epoch.
* @return start of the next epoch
*/
function nextEpochStart() external view returns (uint48);
/**
* @notice Get if the deposit whitelist is enabled.
* @return if the deposit whitelist is enabled
*/
function depositWhitelist() external view returns (bool);
/**
* @notice Get if a given account is whitelisted as a depositor.
* @param account address to check
* @return if the account is whitelisted as a depositor
*/
function isDepositorWhitelisted(address account) external view returns (bool);
/**
* @notice Get if the deposit limit is set.
* @return if the deposit limit is set
*/
function isDepositLimit() external view returns (bool);
/**
* @notice Get a deposit limit (maximum amount of the active stake that can be in the vault simultaneously).
* @return deposit limit
*/
function depositLimit() external view returns (uint256);
/**
* @notice Get a total number of active shares in the vault at a given timestamp using a hint.
* @param timestamp time point to get the total number of active shares at
* @param hint hint for the checkpoint index
* @return total number of active shares at the timestamp
*/
function activeSharesAt(uint48 timestamp, bytes memory hint) external view returns (uint256);
/**
* @notice Get a total number of active shares in the vault.
* @return total number of active shares
*/
function activeShares() external view returns (uint256);
/**
* @notice Get a total amount of active stake in the vault at a given timestamp using a hint.
* @param timestamp time point to get the total active stake at
* @param hint hint for the checkpoint index
* @return total amount of active stake at the timestamp
*/
function activeStakeAt(uint48 timestamp, bytes memory hint) external view returns (uint256);
/**
* @notice Get a total amount of active stake in the vault.
* @return total amount of active stake
*/
function activeStake() external view returns (uint256);
/**
* @notice Get a total number of active shares for a particular account at a given timestamp using a hint.
* @param account account to get the number of active shares for
* @param timestamp time point to get the number of active shares for the account at
* @param hint hint for the checkpoint index
* @return number of active shares for the account at the timestamp
*/
function activeSharesOfAt(address account, uint48 timestamp, bytes memory hint) external view returns (uint256);
/**
* @notice Get a number of active shares for a particular account.
* @param account account to get the number of active shares for
* @return number of active shares for the account
*/
function activeSharesOf(address account) external view returns (uint256);
/**
* @notice Get a total amount of the withdrawals at a given epoch.
* @param epoch epoch to get the total amount of the withdrawals at
* @return total amount of the withdrawals at the epoch
*/
function withdrawals(uint256 epoch) external view returns (uint256);
/**
* @notice Get a total number of withdrawal shares at a given epoch.
* @param epoch epoch to get the total number of withdrawal shares at
* @return total number of withdrawal shares at the epoch
*/
function withdrawalShares(uint256 epoch) external view returns (uint256);
/**
* @notice Get a number of withdrawal shares for a particular account at a given epoch (zero if claimed).
* @param epoch epoch to get the number of withdrawal shares for the account at
* @param account account to get the number of withdrawal shares for
* @return number of withdrawal shares for the account at the epoch
*/
function withdrawalSharesOf(uint256 epoch, address account) external view returns (uint256);
/**
* @notice Get if the withdrawals are claimed for a particular account at a given epoch.
* @param epoch epoch to check the withdrawals for the account at
* @param account account to check the withdrawals for
* @return if the withdrawals are claimed for the account at the epoch
*/
function isWithdrawalsClaimed(uint256 epoch, address account) external view returns (bool);
}
// node_modules/@symbioticfi/rewards/src/interfaces/stakerRewards/IStakerRewards.sol
interface IStakerRewards {
/**
* @notice Emitted when a reward is distributed.
* @param network network on behalf of which the reward is distributed
* @param token address of the token
* @param amount amount of tokens
* @param data some used data
*/
event DistributeRewards(address indexed network, address indexed token, uint256 amount, bytes data);
/**
* @notice Get a version of the staker rewards contract (different versions mean different interfaces).
* @return version of the staker rewards contract
* @dev Must return 1 for this one.
*/
function version() external view returns (uint64);
/**
* @notice Get an amount of rewards claimable by a particular account of a given token.
* @param token address of the token
* @param account address of the claimer
* @param data some data to use
* @return amount of claimable tokens
*/
function claimable(address token, address account, bytes calldata data) external view returns (uint256);
/**
* @notice Distribute rewards on behalf of a particular network using a given token.
* @param network network on behalf of which the reward to distribute
* @param token address of the token
* @param amount amount of tokens
* @param data some data to use
*/
function distributeRewards(address network, address token, uint256 amount, bytes calldata data) external;
/**
* @notice Claim rewards using a given token.
* @param recipient address of the tokens' recipient
* @param token address of the token
* @param data some data to use
*/
function claimRewards(address recipient, address token, bytes calldata data) external;
}
// node_modules/@symbioticfi/burners/src/interfaces/router/IBurnerRouter.sol
interface IBurnerRouter is IBurner {
error AlreadySet();
error DuplicateNetworkReceiver();
error DuplicateOperatorNetworkReceiver();
error InsufficientBalance();
error InvalidCollateral();
error InvalidReceiver();
error InvalidReceiverSetEpochsDelay();
error NotReady();
/**
* @notice Structure for a value of `address` type.
* @param value value of `address` type
*/
struct Address {
address value;
}
/**
* @notice Structure for a pending value of `address` type.
* @param value pending value of `address` type
* @param timestamp timestamp since which the pending value can be used
*/
struct PendingAddress {
address value;
uint48 timestamp;
}
/**
* @notice Structure for a value of `uint48` type.
* @param value value of `uint48` type
*/
struct Uint48 {
uint48 value;
}
/**
* @notice Structure for a pending value of `uint48` type.
* @param value pending value of `uint48` type
* @param timestamp timestamp since which the pending value can be used
*/
struct PendingUint48 {
uint48 value;
uint48 timestamp;
}
/**
* @notice Structure used to set a `receiver` for a slashing `network`.
* @param network address of the slashing network
* @param receiver address of the recipient of the slashed funds
*/
struct NetworkReceiver {
address network;
address receiver;
}
/**
* @notice Structure used to set a `receiver` for a slashed `operator` by a slashing `network`.
* @param network address of the slashing network
* @param operator address of the slashed operator
* @param receiver address of the recipient of the slashed funds
*/
struct OperatorNetworkReceiver {
address network;
address operator;
address receiver;
}
/**
* @notice Initial parameters needed for a router deployment.
* @param owner manager of the router's receivers
* @param collateral router's underlying collateral (MUST be the same as the vault's underlying collateral)
* @param delay delay for setting a new receiver or changing the delay itself (in seconds)
* @param globalReceiver address of the global receiver of the slashed funds (if no receiver is set for a network or operator)
* @param networkReceivers array of network receivers to set on deployment (network => receiver)
* @param operatorNetworkReceivers array of operator network receivers to set on deployment (network-operator => receiver)
*/
struct InitParams {
address owner;
address collateral;
uint48 delay;
address globalReceiver;
NetworkReceiver[] networkReceivers;
OperatorNetworkReceiver[] operatorNetworkReceivers;
}
/**
* @notice Emitted when a transfer from the router to the receiver is triggered.
* @param receiver address of the receiver
* @param amount amount of the transfer
*/
event TriggerTransfer(address indexed receiver, uint256 amount);
/**
* @notice Emitted when a global receiver is set (becomes pending for a `delay`).
* @param receiver address of the receiver
*/
event SetGlobalReceiver(address receiver);
/**
* @notice Emitted when a pending global receiver is accepted.
*/
event AcceptGlobalReceiver();
/**
* @notice Emitted when a network receiver is set (becomes pending for a `delay`).
* @param network address of the network
* @param receiver address of the receiver
*/
event SetNetworkReceiver(address indexed network, address receiver);
/**
* @notice Emitted when a pending network receiver is accepted.
* @param network address of the network
*/
event AcceptNetworkReceiver(address indexed network);
/**
* @notice Emitted when an operator network receiver is set (becomes pending for a `delay`).
* @param network address of the network
* @param operator address of the operator
* @param receiver address of the receiver
*/
event SetOperatorNetworkReceiver(address indexed network, address indexed operator, address receiver);
/**
* @notice Emitted when a pending operator network receiver is accepted.
* @param network address of the network
* @param operator address of the operator
*/
event AcceptOperatorNetworkReceiver(address indexed network, address indexed operator);
/**
* @notice Emitted when a delay is set (becomes pending for a `delay`).
* @param delay new delay
*/
event SetDelay(uint48 delay);
/**
* @notice Emitted when a pending delay is accepted.
*/
event AcceptDelay();
/**
* @notice Get a router collateral.
* @return address of the underlying collateral
*/
function collateral() external view returns (address);
/**
* @notice Get a router last checked balance.
* @return last balance of the router
*/
function lastBalance() external view returns (uint256);
/**
* @notice Get a router delay.
* @return delay for setting a new receiver or changing the delay itself (in seconds)
*/
function delay() external view returns (uint48);
/**
* @notice Get a router pending delay.
* @return value pending delay
* @return timestamp timestamp since which the pending delay can be used
*/
function pendingDelay() external view returns (uint48, uint48);
/**
* @notice Get a router global receiver.
* @return address of the global receiver of the slashed funds
*/
function globalReceiver() external view returns (address);
/**
* @notice Get a router pending global receiver.
* @return value pending global receiver
* @return timestamp timestamp since which the pending global receiver can be used
*/
function pendingGlobalReceiver() external view returns (address, uint48);
/**
* @notice Get a router receiver for a slashing network.
* @param network address of the slashing network
* @return address of the receiver
*/
function networkReceiver(address network) external view returns (address);
/**
* @notice Get a router pending receiver for a slashing network.
* @param network address of the slashing network
* @return value pending receiver
* @return timestamp timestamp since which the pending receiver can be used
*/
function pendingNetworkReceiver(address network) external view returns (address, uint48);
/**
* @notice Get a router receiver for a slashed operator by a slashing network.
* @param network address of the slashing network
* @param operator address of the slashed operator
* @return address of the receiver
*/
function operatorNetworkReceiver(address network, address operator) external view returns (address);
/**
* @notice Get a router pending receiver for a slashed operator by a slashing network.
* @param network address of the slashing network
* @param operator address of the slashed operator
* @return value pending receiver
* @return timestamp timestamp since which the pending receiver can be used
*/
function pendingOperatorNetworkReceiver(address network, address operator)
external
view
returns (address, uint48);
/**
* @notice Get a receiver balance of unclaimed collateral.
* @param receiver address of the receiver
* @return amount of the unclaimed collateral tokens
*/
function balanceOf(address receiver) external view returns (uint256);
/**
* @notice Trigger a transfer of the unclaimed collateral to the receiver.
* @param receiver address of the receiver
* @return amount of the transfer
*/
function triggerTransfer(address receiver) external returns (uint256 amount);
/**
* @notice Set a new global receiver of the slashed funds.
* @param receiver address of the new receiver
*/
function setGlobalReceiver(address receiver) external;
/**
* @notice Accept a pending global receiver.
*/
function acceptGlobalReceiver() external;
/**
* @notice Set a new receiver for a slashing network.
* @param network address of the slashing network
* @param receiver address of the new receiver
*/
function setNetworkReceiver(address network, address receiver) external;
/**
* @notice Accept a pending receiver for a slashing network.
* @param network address of the slashing network
*/
function acceptNetworkReceiver(address network) external;
/**
* @notice Set a new receiver for a slashed operator by a slashing network.
* @param network address of the slashing network
* @param operator address of the slashed operator
* @param receiver address of the new receiver
*/
function setOperatorNetworkReceiver(address network, address operator, address receiver) external;
/**
* @notice Accept a pending receiver for a slashed operator by a slashing network.
* @param network address of the slashing network
* @param operator address of the slashed operator
*/
function acceptOperatorNetworkReceiver(address network, address operator) external;
/**
* @notice Set a new delay for setting a new receiver or changing the delay itself.
* @param newDelay new delay (in seconds)
*/
function setDelay(uint48 newDelay) external;
/**
* @notice Accept a pending delay.
*/
function acceptDelay() external;
}
// node_modules/@symbioticfi/core/src/interfaces/delegator/IBaseDelegator.sol
interface IBaseDelegator is IEntity {
error AlreadySet();
error InsufficientHookGas();
error NotNetwork();
error NotSlasher();
error NotVault();
/**
* @notice Base parameters needed for delegators' deployment.
* @param defaultAdminRoleHolder address of the initial DEFAULT_ADMIN_ROLE holder
* @param hook address of the hook contract
* @param hookSetRoleHolder address of the initial HOOK_SET_ROLE holder
*/
struct BaseParams {
address defaultAdminRoleHolder;
address hook;
address hookSetRoleHolder;
}
/**
* @notice Base hints for a stake.
* @param operatorVaultOptInHint hint for the operator-vault opt-in
* @param operatorNetworkOptInHint hint for the operator-network opt-in
*/
struct StakeBaseHints {
bytes operatorVaultOptInHint;
bytes operatorNetworkOptInHint;
}
/**
* @notice Emitted when a subnetwork's maximum limit is set.
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @param amount new maximum subnetwork's limit (how much stake the subnetwork is ready to get)
*/
event SetMaxNetworkLimit(bytes32 indexed subnetwork, uint256 amount);
/**
* @notice Emitted when a slash happens.
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @param operator address of the operator
* @param amount amount of the collateral to be slashed
* @param captureTimestamp time point when the stake was captured
*/
event OnSlash(bytes32 indexed subnetwork, address indexed operator, uint256 amount, uint48 captureTimestamp);
/**
* @notice Emitted when a hook is set.
* @param hook address of the hook
*/
event SetHook(address indexed hook);
/**
* @notice Get a version of the delegator (different versions mean different interfaces).
* @return version of the delegator
* @dev Must return 1 for this one.
*/
function VERSION() external view returns (uint64);
/**
* @notice Get the network registry's address.
* @return address of the network registry
*/
function NETWORK_REGISTRY() external view returns (address);
/**
* @notice Get the vault factory's address.
* @return address of the vault factory
*/
function VAULT_FACTORY() external view returns (address);
/**
* @notice Get the operator-vault opt-in service's address.
* @return address of the operator-vault opt-in service
*/
function OPERATOR_VAULT_OPT_IN_SERVICE() external view returns (address);
/**
* @notice Get the operator-network opt-in service's address.
* @return address of the operator-network opt-in service
*/
function OPERATOR_NETWORK_OPT_IN_SERVICE() external view returns (address);
/**
* @notice Get a gas limit for the hook.
* @return value of the hook gas limit
*/
function HOOK_GAS_LIMIT() external view returns (uint256);
/**
* @notice Get a reserve gas between the gas limit check and the hook's execution.
* @return value of the reserve gas
*/
function HOOK_RESERVE() external view returns (uint256);
/**
* @notice Get a hook setter's role.
* @return identifier of the hook setter role
*/
function HOOK_SET_ROLE() external view returns (bytes32);
/**
* @notice Get the vault's address.
* @return address of the vault
*/
function vault() external view returns (address);
/**
* @notice Get the hook's address.
* @return address of the hook
* @dev The hook can have arbitrary logic under certain functions, however, it doesn't affect the stake guarantees.
*/
function hook() external view returns (address);
/**
* @notice Get a particular subnetwork's maximum limit
* (meaning the subnetwork is not ready to get more as a stake).
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @return maximum limit of the subnetwork
*/
function maxNetworkLimit(bytes32 subnetwork) external view returns (uint256);
/**
* @notice Get a stake that a given subnetwork could be able to slash for a certain operator at a given timestamp
* until the end of the consequent epoch using hints (if no cross-slashing and no slashings by the subnetwork).
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @param operator address of the operator
* @param timestamp time point to capture the stake at
* @param hints hints for the checkpoints' indexes
* @return slashable stake at the given timestamp until the end of the consequent epoch
* @dev Warning: it is not safe to use timestamp >= current one for the stake capturing, as it can change later.
*/
function stakeAt(bytes32 subnetwork, address operator, uint48 timestamp, bytes memory hints)
external
view
returns (uint256);
/**
* @notice Get a stake that a given subnetwork will be able to slash
* for a certain operator until the end of the next epoch (if no cross-slashing and no slashings by the subnetwork).
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @param operator address of the operator
* @return slashable stake until the end of the next epoch
* @dev Warning: this function is not safe to use for stake capturing, as it can change by the end of the block.
*/
function stake(bytes32 subnetwork, address operator) external view returns (uint256);
/**
* @notice Set a maximum limit for a subnetwork (how much stake the subnetwork is ready to get).
* identifier identifier of the subnetwork
* @param amount new maximum subnetwork's limit
* @dev Only a network can call this function.
*/
function setMaxNetworkLimit(uint96 identifier, uint256 amount) external;
/**
* @notice Set a new hook.
* @param hook address of the hook
* @dev Only a HOOK_SET_ROLE holder can call this function.
* The hook can have arbitrary logic under certain functions, however, it doesn't affect the stake guarantees.
*/
function setHook(address hook) external;
/**
* @notice Called when a slash happens.
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @param operator address of the operator
* @param amount amount of the collateral slashed
* @param captureTimestamp time point when the stake was captured
* @param data some additional data
* @dev Only the vault's slasher can call this function.
*/
function onSlash(bytes32 subnetwork, address operator, uint256 amount, uint48 captureTimestamp, bytes calldata data)
external;
}
// node_modules/@symbioticfi/core/src/interfaces/slasher/IBaseSlasher.sol
interface IBaseSlasher is IEntity {
error NoBurner();
error InsufficientBurnerGas();
error NotNetworkMiddleware();
error NotVault();
/**
* @notice Base parameters needed for slashers' deployment.
* @param isBurnerHook if the burner is needed to be called on a slashing
*/
struct BaseParams {
bool isBurnerHook;
}
/**
* @notice Hints for a slashable stake.
* @param stakeHints hints for the stake checkpoints
* @param cumulativeSlashFromHint hint for the cumulative slash amount at a capture timestamp
*/
struct SlashableStakeHints {
bytes stakeHints;
bytes cumulativeSlashFromHint;
}
/**
* @notice General data for the delegator.
* @param slasherType type of the slasher
* @param data slasher-dependent data for the delegator
*/
struct GeneralDelegatorData {
uint64 slasherType;
bytes data;
}
/**
* @notice Get a gas limit for the burner.
* @return value of the burner gas limit
*/
function BURNER_GAS_LIMIT() external view returns (uint256);
/**
* @notice Get a reserve gas between the gas limit check and the burner's execution.
* @return value of the reserve gas
*/
function BURNER_RESERVE() external view returns (uint256);
/**
* @notice Get the vault factory's address.
* @return address of the vault factory
*/
function VAULT_FACTORY() external view returns (address);
/**
* @notice Get the network middleware service's address.
* @return address of the network middleware service
*/
function NETWORK_MIDDLEWARE_SERVICE() external view returns (address);
/**
* @notice Get the vault's address.
* @return address of the vault to perform slashings on
*/
function vault() external view returns (address);
/**
* @notice Get if the burner is needed to be called on a slashing.
* @return if the burner is a hook
*/
function isBurnerHook() external view returns (bool);
/**
* @notice Get the latest capture timestamp that was slashed on a subnetwork.
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @param operator address of the operator
* @return latest capture timestamp that was slashed
*/
function latestSlashedCaptureTimestamp(bytes32 subnetwork, address operator) external view returns (uint48);
/**
* @notice Get a cumulative slash amount for an operator on a subnetwork until a given timestamp (inclusively) using a hint.
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @param operator address of the operator
* @param timestamp time point to get the cumulative slash amount until (inclusively)
* @param hint hint for the checkpoint index
* @return cumulative slash amount until the given timestamp (inclusively)
*/
function cumulativeSlashAt(bytes32 subnetwork, address operator, uint48 timestamp, bytes memory hint)
external
view
returns (uint256);
/**
* @notice Get a cumulative slash amount for an operator on a subnetwork.
* @param subnetwork full identifier of the subnetwork (address of the network concatenated with the uint96 identifier)
* @param operator address of the operator
* @return cumulative slash amount
*/
function cumulativeSlash(bytes32 subnetwork, address operator) external view returns (uint256);