forked from superform-xyz/superform-core
-
Notifications
You must be signed in to change notification settings - Fork 0
/
BaseRouterImplementation.sol
1188 lines (1031 loc) · 43.9 KB
/
BaseRouterImplementation.sol
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.23;
import { BaseRouter } from "src/BaseRouter.sol";
import { IBaseRouterImplementation } from "src/interfaces/IBaseRouterImplementation.sol";
import { IBaseStateRegistry } from "src/interfaces/IBaseStateRegistry.sol";
import { IPayMaster } from "src/interfaces/IPayMaster.sol";
import { IPaymentHelper } from "src/interfaces/IPaymentHelper.sol";
import { ISuperformFactory } from "src/interfaces/ISuperformFactory.sol";
import { IBaseForm } from "src/interfaces/IBaseForm.sol";
import { IBridgeValidator } from "src/interfaces/IBridgeValidator.sol";
import { ISuperPositions } from "src/interfaces/ISuperPositions.sol";
import { DataLib } from "src/libraries/DataLib.sol";
import { Error } from "src/libraries/Error.sol";
import { IPermit2 } from "src/vendor/dragonfly-xyz/IPermit2.sol";
import { LiquidityHandler } from "src/crosschain-liquidity/LiquidityHandler.sol";
import {
SingleDirectSingleVaultStateReq,
SingleXChainSingleVaultStateReq,
SingleDirectMultiVaultStateReq,
SingleXChainMultiVaultStateReq,
MultiDstSingleVaultStateReq,
MultiDstMultiVaultStateReq,
LiqRequest,
InitSingleVaultData,
InitMultiVaultData,
MultiVaultSFData,
SingleVaultSFData,
AMBMessage,
CallbackType,
TransactionType
} from "src/types/DataTypes.sol";
import { IERC20 } from "openzeppelin-contracts/contracts/interfaces/IERC20.sol";
import { SafeERC20 } from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
import { IERC1155Receiver } from "openzeppelin-contracts/contracts/token/ERC1155/IERC1155Receiver.sol";
import { IERC165 } from "openzeppelin-contracts/contracts/utils/introspection/IERC165.sol";
import { IERC1155Errors } from "openzeppelin-contracts/contracts/interfaces/draft-IERC6093.sol";
/// @title BaseRouterImplementation
/// @dev Extends BaseRouter with standard internal execution functions
/// @author Zeropoint Labs
abstract contract BaseRouterImplementation is IBaseRouterImplementation, BaseRouter, LiquidityHandler {
using SafeERC20 for IERC20;
using DataLib for uint256;
//////////////////////////////////////////////////////////////
// STATE VARIABLES //
//////////////////////////////////////////////////////////////
/// @dev tracks the total payloads
uint256 public payloadIds;
uint256 internal constant ENTIRE_SLIPPAGE = 10_000;
//////////////////////////////////////////////////////////////
// STRUCTS //
//////////////////////////////////////////////////////////////
struct ValidateAndDispatchTokensArgs {
LiqRequest liqRequest;
address superform;
uint64 srcChainId;
uint64 dstChainId;
address srcSender;
bool deposit;
}
struct DirectDepositArgs {
address superform;
uint256 payloadId;
uint256 superformId;
uint256 amount;
uint256 outputAmount;
uint256 maxSlippage;
bool retain4626;
LiqRequest liqData;
address receiverAddress;
bytes extraFormData;
uint256 msgValue;
address srcSender;
}
struct SingleDepositLocalVars {
address superform;
uint256 shares;
}
struct SingleDepositArgs {
address srcSender;
bytes permit2data;
address receiverAddressSP;
InitSingleVaultData vaultData;
}
struct MultiDepositLocalVars {
uint256 len;
address[] superforms;
uint256[] shares;
bool[] mints;
}
struct MultiDepositArgs {
address srcSender;
bytes permit2data;
address receiverAddressSP;
InitMultiVaultData vaultData;
}
struct SingleTokenForwardLocalVars {
IERC20 token;
uint256 txDataLength;
uint256 totalAmount;
uint256 amountIn;
uint8 bridgeId;
address permit2;
}
struct MultiTokenForwardLocalVars {
IERC20 token;
uint256 len;
uint256 totalAmount;
uint256 permit2dataLen;
uint256 targetLen;
uint256[] amountsIn;
uint8[] bridgeIds;
address permit2;
}
//////////////////////////////////////////////////////////////
// CONSTRUCTOR //
//////////////////////////////////////////////////////////////
/// @param superRegistry_ the superform registry contract
constructor(address superRegistry_) BaseRouter(superRegistry_) { }
//////////////////////////////////////////////////////////////
// CORE INTERNAL FUNCTIONS //
//////////////////////////////////////////////////////////////
/// @dev getter for PERMIT2 in case it is not supported or set on a given chain
function _getPermit2() internal view returns (address) {
return superRegistry.PERMIT2();
}
/// @dev returns the address from super registry
function _getAddress(bytes32 id_) internal view returns (address) {
return superRegistry.getAddress(id_);
}
/// @dev handles same-chain single vault deposit
function _singleDirectSingleVaultDeposit(SingleDirectSingleVaultStateReq memory req_) internal virtual {
/// @dev validate superformData
if (
!_validateSuperformData(
req_.superformData.superformId,
req_.superformData.amount,
req_.superformData.outputAmount,
req_.superformData.maxSlippage,
req_.superformData.receiverAddress,
req_.superformData.receiverAddressSP,
CHAIN_ID,
true,
ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY"))),
false
)
) {
revert Error.INVALID_SUPERFORMS_DATA();
}
InitSingleVaultData memory vaultData = InitSingleVaultData(
0,
req_.superformData.superformId,
req_.superformData.amount,
req_.superformData.outputAmount,
req_.superformData.maxSlippage,
req_.superformData.liqRequest,
false,
req_.superformData.retain4626,
req_.superformData.receiverAddress,
req_.superformData.extraFormData
);
/// @dev same chain action & forward residual payment to Paymaster
_directSingleDeposit(
SingleDepositArgs(
msg.sender, req_.superformData.permit2data, req_.superformData.receiverAddressSP, vaultData
)
);
emit Completed();
}
/// @dev handles cross-chain single vault deposit
function _singleXChainSingleVaultDeposit(SingleXChainSingleVaultStateReq memory req_) internal virtual {
/// @dev validate the action
ActionLocalVars memory vars;
vars.srcChainId = CHAIN_ID;
if (vars.srcChainId == req_.dstChainId) revert Error.INVALID_ACTION();
/// @dev validate superformData
if (
!_validateSuperformData(
req_.superformData.superformId,
req_.superformData.amount,
req_.superformData.outputAmount,
req_.superformData.maxSlippage,
req_.superformData.receiverAddress,
req_.superformData.receiverAddressSP,
req_.dstChainId,
true,
ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY"))),
false
)
) {
revert Error.INVALID_SUPERFORMS_DATA();
}
vars.currentPayloadId = ++payloadIds;
InitSingleVaultData memory ambData = InitSingleVaultData(
vars.currentPayloadId,
req_.superformData.superformId,
req_.superformData.amount,
req_.superformData.outputAmount,
req_.superformData.maxSlippage,
req_.superformData.liqRequest,
req_.superformData.hasDstSwap,
req_.superformData.retain4626,
req_.superformData.receiverAddress,
req_.superformData.extraFormData
);
(address superform,,) = req_.superformData.superformId.getSuperform();
(uint256 amountIn, uint8 bridgeId) =
_singleVaultTokenForward(msg.sender, address(0), req_.superformData.permit2data, ambData, true);
LiqRequest memory emptyRequest;
/// @dev dispatch liquidity data
if (
_validateAndDispatchTokens(
ValidateAndDispatchTokensArgs(
req_.superformData.liqRequest, superform, vars.srcChainId, req_.dstChainId, msg.sender, true
)
)
) emptyRequest.interimToken = req_.superformData.liqRequest.interimToken;
/// @dev overrides user set liqData to just contain interimToken in case there is a dstSwap
/// @dev this information is needed in case the dstSwap fails so that we can validate the interimToken in
/// DstSwapper.sol on destination
ambData.liqData = emptyRequest;
uint256[] memory superformIds = new uint256[](1);
superformIds[0] = req_.superformData.superformId;
/// @dev dispatch message information, notice multiVaults is set to 0
_dispatchAmbMessage(
DispatchAMBMessageVars(
TransactionType.DEPOSIT,
abi.encode(ambData),
superformIds,
msg.sender,
req_.ambIds,
0,
vars.srcChainId,
req_.dstChainId,
vars.currentPayloadId
),
req_.superformData.receiverAddressSP
);
emit CrossChainInitiatedDepositSingle(
vars.currentPayloadId, req_.dstChainId, req_.superformData.superformId, amountIn, bridgeId, req_.ambIds
);
}
/// @dev handles same-chain multi vault deposit
function _singleDirectMultiVaultDeposit(SingleDirectMultiVaultStateReq memory req_) internal virtual {
/// @dev validate superformData
if (!_validateSuperformsData(req_.superformData, CHAIN_ID, true)) {
revert Error.INVALID_SUPERFORMS_DATA();
}
InitMultiVaultData memory vaultData = InitMultiVaultData(
0,
req_.superformData.superformIds,
req_.superformData.amounts,
req_.superformData.outputAmounts,
req_.superformData.maxSlippages,
req_.superformData.liqRequests,
new bool[](req_.superformData.amounts.length),
req_.superformData.retain4626s,
req_.superformData.receiverAddress,
req_.superformData.extraFormData
);
/// @dev same chain action & forward residual payment to Paymaster
_directMultiDeposit(
MultiDepositArgs(
msg.sender, req_.superformData.permit2data, req_.superformData.receiverAddressSP, vaultData
)
);
emit Completed();
}
/// @dev handles cross-chain multi vault deposit
function _singleXChainMultiVaultDeposit(SingleXChainMultiVaultStateReq memory req_) internal virtual {
/// @dev validate the action
ActionLocalVars memory vars;
vars.srcChainId = CHAIN_ID;
if (vars.srcChainId == req_.dstChainId) revert Error.INVALID_ACTION();
/// @dev validate superformsData
if (!_validateSuperformsData(req_.superformsData, req_.dstChainId, true)) {
revert Error.INVALID_SUPERFORMS_DATA();
}
vars.currentPayloadId = ++payloadIds;
InitMultiVaultData memory ambData = InitMultiVaultData(
vars.currentPayloadId,
req_.superformsData.superformIds,
req_.superformsData.amounts,
req_.superformsData.outputAmounts,
req_.superformsData.maxSlippages,
req_.superformsData.liqRequests,
req_.superformsData.hasDstSwaps,
req_.superformsData.retain4626s,
req_.superformsData.receiverAddress,
req_.superformsData.extraFormData
);
address superform;
uint256 len = req_.superformsData.superformIds.length;
(uint256[] memory amountsIn, uint8[] memory bridgeIds) =
_multiVaultTokenForward(msg.sender, new address[](0), req_.superformsData.permit2data, ambData, true);
/// @dev empties the liqData after multiVaultTokenForward
ambData.liqData = new LiqRequest[](len);
/// @dev this loop is what allows to deposit to >1 different underlying on destination
/// @dev if a loop fails in a validation the whole chain should be reverted
for (uint256 i; i < len; ++i) {
vars.liqRequest = req_.superformsData.liqRequests[i];
(superform,,) = req_.superformsData.superformIds[i].getSuperform();
/// @dev dispatch liquidity data
if (
_validateAndDispatchTokens(
ValidateAndDispatchTokensArgs(
vars.liqRequest, superform, vars.srcChainId, req_.dstChainId, msg.sender, true
)
)
) ambData.liqData[i].interimToken = vars.liqRequest.interimToken;
}
/// @dev dispatch message information, notice multiVaults is set to 1
_dispatchAmbMessage(
DispatchAMBMessageVars(
TransactionType.DEPOSIT,
abi.encode(ambData),
req_.superformsData.superformIds,
msg.sender,
req_.ambIds,
1,
vars.srcChainId,
req_.dstChainId,
vars.currentPayloadId
),
req_.superformsData.receiverAddressSP
);
emit CrossChainInitiatedDepositMulti(
vars.currentPayloadId, req_.dstChainId, req_.superformsData.superformIds, amountsIn, bridgeIds, req_.ambIds
);
}
/// @dev handles same-chain single vault withdraw
function _singleDirectSingleVaultWithdraw(SingleDirectSingleVaultStateReq memory req_) internal virtual {
/// @dev validate Superform data
if (
!_validateSuperformData(
req_.superformData.superformId,
req_.superformData.amount,
req_.superformData.outputAmount,
req_.superformData.maxSlippage,
req_.superformData.receiverAddress,
req_.superformData.receiverAddressSP,
CHAIN_ID,
false,
ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY"))),
false
)
) {
revert Error.INVALID_SUPERFORMS_DATA();
}
ISuperPositions(_getAddress(keccak256("SUPER_POSITIONS"))).burnSingle(
msg.sender, req_.superformData.superformId, req_.superformData.amount
);
InitSingleVaultData memory vaultData = InitSingleVaultData(
0,
req_.superformData.superformId,
req_.superformData.amount,
req_.superformData.outputAmount,
req_.superformData.maxSlippage,
req_.superformData.liqRequest,
false,
req_.superformData.retain4626,
req_.superformData.receiverAddress,
req_.superformData.extraFormData
);
/// @dev same chain action
_directSingleWithdraw(vaultData, msg.sender);
emit Completed();
}
/// @dev handles cross-chain single vault withdraw
function _singleXChainSingleVaultWithdraw(SingleXChainSingleVaultStateReq memory req_) internal virtual {
/// @dev validate the action
ActionLocalVars memory vars;
vars.srcChainId = CHAIN_ID;
if (vars.srcChainId == req_.dstChainId) {
revert Error.INVALID_ACTION();
}
/// @dev validate the Superforms data
if (
!_validateSuperformData(
req_.superformData.superformId,
req_.superformData.amount,
req_.superformData.outputAmount,
req_.superformData.maxSlippage,
req_.superformData.receiverAddress,
req_.superformData.receiverAddressSP,
req_.dstChainId,
false,
ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY"))),
false
)
) {
revert Error.INVALID_SUPERFORMS_DATA();
}
ISuperPositions(_getAddress(keccak256("SUPER_POSITIONS"))).burnSingle(
msg.sender, req_.superformData.superformId, req_.superformData.amount
);
vars.currentPayloadId = ++payloadIds;
InitSingleVaultData memory ambData = InitSingleVaultData(
vars.currentPayloadId,
req_.superformData.superformId,
req_.superformData.amount,
req_.superformData.outputAmount,
req_.superformData.maxSlippage,
req_.superformData.liqRequest,
false,
req_.superformData.retain4626,
req_.superformData.receiverAddress,
req_.superformData.extraFormData
);
uint256[] memory superformIds = new uint256[](1);
superformIds[0] = req_.superformData.superformId;
/// @dev dispatch message information, notice multiVaults is set to 0
_dispatchAmbMessage(
DispatchAMBMessageVars(
TransactionType.WITHDRAW,
abi.encode(ambData),
superformIds,
msg.sender,
req_.ambIds,
0,
vars.srcChainId,
req_.dstChainId,
vars.currentPayloadId
),
req_.superformData.receiverAddressSP
);
emit CrossChainInitiatedWithdrawSingle(
vars.currentPayloadId, req_.dstChainId, req_.superformData.superformId, req_.ambIds
);
}
/// @dev handles same-chain multi vault withdraw
function _singleDirectMultiVaultWithdraw(SingleDirectMultiVaultStateReq memory req_) internal virtual {
ActionLocalVars memory vars;
vars.srcChainId = CHAIN_ID;
/// @dev validates the Superform data
if (!_validateSuperformsData(req_.superformData, vars.srcChainId, false)) {
revert Error.INVALID_SUPERFORMS_DATA();
}
/// @dev SuperPositions are burnt optimistically here
ISuperPositions(_getAddress(keccak256("SUPER_POSITIONS"))).burnBatch(
msg.sender, req_.superformData.superformIds, req_.superformData.amounts
);
InitMultiVaultData memory vaultData = InitMultiVaultData(
0,
req_.superformData.superformIds,
req_.superformData.amounts,
req_.superformData.outputAmounts,
req_.superformData.maxSlippages,
req_.superformData.liqRequests,
new bool[](req_.superformData.superformIds.length),
req_.superformData.retain4626s,
req_.superformData.receiverAddress,
req_.superformData.extraFormData
);
/// @dev same chain action & forward residual payment to Paymaster
_directMultiWithdraw(vaultData, msg.sender);
emit Completed();
}
/// @dev handles cross-chain multi vault withdraw
function _singleXChainMultiVaultWithdraw(SingleXChainMultiVaultStateReq memory req_) internal virtual {
/// @dev validate the action
ActionLocalVars memory vars;
vars.srcChainId = CHAIN_ID;
if (vars.srcChainId == req_.dstChainId) {
revert Error.INVALID_ACTION();
}
/// @dev validate superformsData
if (!_validateSuperformsData(req_.superformsData, req_.dstChainId, false)) {
revert Error.INVALID_SUPERFORMS_DATA();
}
ISuperPositions(_getAddress(keccak256("SUPER_POSITIONS"))).burnBatch(
msg.sender, req_.superformsData.superformIds, req_.superformsData.amounts
);
vars.currentPayloadId = ++payloadIds;
InitMultiVaultData memory ambData = InitMultiVaultData(
vars.currentPayloadId,
req_.superformsData.superformIds,
req_.superformsData.amounts,
req_.superformsData.outputAmounts,
req_.superformsData.maxSlippages,
req_.superformsData.liqRequests,
new bool[](req_.superformsData.amounts.length),
req_.superformsData.retain4626s,
req_.superformsData.receiverAddress,
req_.superformsData.extraFormData
);
/// @dev dispatch message information, notice multiVaults is set to 1
_dispatchAmbMessage(
DispatchAMBMessageVars(
TransactionType.WITHDRAW,
abi.encode(ambData),
req_.superformsData.superformIds,
msg.sender,
req_.ambIds,
1,
vars.srcChainId,
req_.dstChainId,
vars.currentPayloadId
),
req_.superformsData.receiverAddressSP
);
emit CrossChainInitiatedWithdrawMulti(
vars.currentPayloadId, req_.dstChainId, req_.superformsData.superformIds, req_.ambIds
);
}
function _validateAndDispatchTokens(ValidateAndDispatchTokensArgs memory args_)
internal
virtual
returns (bool hasDstSwap)
{
address bridgeValidator = superRegistry.getBridgeValidator(args_.liqRequest.bridgeId);
/// @dev validates remaining params of txData
hasDstSwap = IBridgeValidator(bridgeValidator).validateTxData(
IBridgeValidator.ValidateTxDataArgs(
args_.liqRequest.txData,
args_.srcChainId,
args_.dstChainId,
args_.liqRequest.liqDstChainId,
args_.deposit,
args_.superform,
args_.srcSender,
args_.liqRequest.token,
args_.liqRequest.interimToken
)
);
/// @dev dispatches tokens through the selected liquidity bridge to the destination contract
_dispatchTokens(
superRegistry.getBridgeAddress(args_.liqRequest.bridgeId),
args_.liqRequest.txData,
args_.liqRequest.token,
IBridgeValidator(bridgeValidator).decodeAmountIn(args_.liqRequest.txData, true),
args_.liqRequest.nativeAmount
);
}
function _dispatchAmbMessage(DispatchAMBMessageVars memory vars_, address receiverAddressSP_) internal virtual {
uint256 txInfo = DataLib.packTxInfo(
uint8(vars_.txType),
uint8(CallbackType.INIT),
vars_.multiVaults,
STATE_REGISTRY_TYPE,
vars_.srcSender,
vars_.srcChainId
);
bytes memory ambMessage = abi.encode(AMBMessage(txInfo, vars_.ambData));
(uint256 fees, bytes memory extraData) = IPaymentHelper(_getAddress(keccak256("PAYMENT_HELPER")))
.calculateAMBData(vars_.dstChainId, vars_.ambIds, ambMessage);
ISuperPositions(_getAddress(keccak256("SUPER_POSITIONS"))).updateTxHistory(
vars_.currentPayloadId, txInfo, receiverAddressSP_
);
/// @dev this call dispatches the message to the AMB bridge through dispatchPayload
IBaseStateRegistry(_getAddress(keccak256("CORE_STATE_REGISTRY"))).dispatchPayload{ value: fees }(
vars_.srcSender, vars_.ambIds, vars_.dstChainId, ambMessage, extraData
);
}
//////////////////////////////////////////////////////////////
// INTERNAL DEPOSIT HELPERS //
//////////////////////////////////////////////////////////////
/// @notice fulfils the final stage of same chain deposit action
function _directDeposit(DirectDepositArgs memory args) internal virtual returns (uint256 shares) {
// @dev deposits token to a given vault and mint vault positions directly through the form
shares = IBaseForm(args.superform).directDepositIntoVault{ value: args.msgValue }(
InitSingleVaultData(
args.payloadId,
args.superformId,
args.amount,
args.outputAmount,
args.maxSlippage,
args.liqData,
false,
args.retain4626,
args.receiverAddress,
args.extraFormData
),
args.srcSender
);
}
/// @notice deposits to single vault on the same chain
/// @dev calls `_directDeposit`
function _directSingleDeposit(SingleDepositArgs memory args_) internal virtual {
SingleDepositLocalVars memory v;
// @dev decode superforms
(v.superform,,) = args_.vaultData.superformId.getSuperform();
_singleVaultTokenForward(args_.srcSender, v.superform, args_.permit2data, args_.vaultData, false);
// @dev deposits token to a given vault and mint vault positions.
v.shares = _directDeposit(
DirectDepositArgs(
v.superform,
args_.vaultData.payloadId,
args_.vaultData.superformId,
args_.vaultData.amount,
args_.vaultData.outputAmount,
args_.vaultData.maxSlippage,
args_.vaultData.retain4626,
args_.vaultData.liqData,
args_.vaultData.receiverAddress,
args_.vaultData.extraFormData,
args_.vaultData.liqData.nativeAmount,
args_.srcSender
)
);
if (v.shares != 0 && !args_.vaultData.retain4626) {
// @dev mint super positions at the end of the deposit action if user doesn't retain 4626
ISuperPositions(_getAddress(keccak256("SUPER_POSITIONS"))).mintSingle(
args_.receiverAddressSP, args_.vaultData.superformId, v.shares
);
}
}
/// @notice deposits to multiple vaults on the same chain
/// @dev loops and call `_directDeposit`
function _directMultiDeposit(MultiDepositArgs memory args_) internal virtual {
MultiDepositLocalVars memory v;
v.len = args_.vaultData.superformIds.length;
v.superforms = new address[](v.len);
v.shares = new uint256[](v.len);
/// @dev decode superforms
v.superforms = DataLib.getSuperforms(args_.vaultData.superformIds);
_multiVaultTokenForward(args_.srcSender, v.superforms, args_.permit2data, args_.vaultData, false);
for (uint256 i; i < v.len; ++i) {
/// @dev deposits token to a given vault and mint vault positions.
v.shares[i] = _directDeposit(
DirectDepositArgs(
v.superforms[i],
args_.vaultData.payloadId,
args_.vaultData.superformIds[i],
args_.vaultData.amounts[i],
args_.vaultData.outputAmounts[i],
args_.vaultData.maxSlippages[i],
args_.vaultData.retain4626s[i],
args_.vaultData.liqData[i],
args_.vaultData.receiverAddress,
args_.vaultData.extraFormData,
args_.vaultData.liqData[i].nativeAmount,
args_.srcSender
)
);
/// @dev if retain4626 is set to True, set the amount of SuperPositions to mint to 0
if (v.shares[i] != 0 && args_.vaultData.retain4626s[i]) {
v.shares[i] = 0;
}
}
/// @dev in direct deposits, SuperPositions are minted right after depositing to vaults
ISuperPositions(_getAddress(keccak256("SUPER_POSITIONS"))).mintBatch(
args_.receiverAddressSP, args_.vaultData.superformIds, v.shares
);
}
//////////////////////////////////////////////////////////////
// INTERNAL WITHDRAW HELPERS //
//////////////////////////////////////////////////////////////
/// @notice fulfils the final stage of same chain withdrawal action
function _directWithdraw(
address superform_,
uint256 payloadId_,
uint256 superformId_,
uint256 amount_,
uint256 outputAmount_,
uint256 maxSlippage_,
LiqRequest memory liqData_,
bool retain4626_,
address receiverAddress_,
bytes memory extraFormData_,
address srcSender_
)
internal
virtual
{
/// @dev in direct withdraws, form is called directly
IBaseForm(superform_).directWithdrawFromVault(
InitSingleVaultData(
payloadId_,
superformId_,
amount_,
outputAmount_,
maxSlippage_,
liqData_,
false,
retain4626_,
receiverAddress_,
extraFormData_
),
srcSender_
);
}
/// @notice withdraws from single vault on the same chain
/// @dev call `_directWithdraw`
function _directSingleWithdraw(InitSingleVaultData memory vaultData_, address srcSender_) internal virtual {
/// @dev decode superforms
(address superform,,) = vaultData_.superformId.getSuperform();
_directWithdraw(
superform,
vaultData_.payloadId,
vaultData_.superformId,
vaultData_.amount,
vaultData_.outputAmount,
vaultData_.maxSlippage,
vaultData_.liqData,
vaultData_.retain4626,
vaultData_.receiverAddress,
vaultData_.extraFormData,
srcSender_
);
}
/// @notice withdraws from multiple vaults on the same chain
/// @dev loops and call `_directWithdraw`
function _directMultiWithdraw(InitMultiVaultData memory vaultData_, address srcSender_) internal virtual {
/// @dev decode superforms
address[] memory superforms = DataLib.getSuperforms(vaultData_.superformIds);
uint256 len = superforms.length;
for (uint256 i; i < len; ++i) {
/// @dev deposits token to a given vault and mint vault positions.
_directWithdraw(
superforms[i],
vaultData_.payloadId,
vaultData_.superformIds[i],
vaultData_.amounts[i],
vaultData_.outputAmounts[i],
vaultData_.maxSlippages[i],
vaultData_.liqData[i],
vaultData_.retain4626s[i],
vaultData_.receiverAddress,
vaultData_.extraFormData,
srcSender_
);
}
}
function _forwardDustToPaymaster(address token_) internal {
if (token_ == address(0)) revert Error.ZERO_ADDRESS();
address paymaster = _getAddress(keccak256("PAYMASTER"));
IERC20 token = IERC20(token_);
uint256 dust = token.balanceOf(address(this));
if (dust != 0) {
token.safeTransfer(paymaster, dust);
emit RouterDustForwardedToPaymaster(token_, dust);
}
}
//////////////////////////////////////////////////////////////
// INTERNAL VALIDATION HELPERS //
//////////////////////////////////////////////////////////////
function _validateSuperformData(
uint256 superformId_,
uint256 amount_,
uint256 outputAmount_,
uint256 maxSlippage_,
address receiverAddress_,
address receiverAddressSP_,
uint64 dstChainId_,
bool isDeposit_,
ISuperformFactory factory_,
bool multi_
)
internal
virtual
returns (bool)
{
/// @dev if same chain, validate if the superform exists on factory
if (dstChainId_ == CHAIN_ID && !factory_.isSuperform(superformId_)) {
return false;
}
/// @dev the dstChainId_ (in the state request) must match the superforms' chainId (superform must exist on
/// destination)
(, uint32 formImplementationId, uint64 sfDstChainId) = superformId_.getSuperform();
if (dstChainId_ != sfDstChainId) return false;
/// @dev 10000 = 100% slippage
if (maxSlippage_ > ENTIRE_SLIPPAGE) return false;
/// @dev amounts can't be 0
if (amount_ == 0 || outputAmount_ == 0) return false;
/// @dev only validate this for non multi case (multi case is validated in _validateSuperformsData)
/// @dev ensure that receiver address is set always
/// @dev in deposits, this is important for receive4626 (on destination). It is also important for refunds on
/// destination
/// @dev in withdraws, this is important for the user to receive their tokens in the liqDstChainId
if (!multi_ && receiverAddress_ == address(0)) {
return false;
}
/// @dev redundant check on same chain, but helpful on xchain actions to halt deposits earlier
if (isDeposit_) {
if (factory_.isFormImplementationPaused(formImplementationId)) {
return false;
}
/// @dev only validate this for non multi case (multi case is validated in _validateSuperformsData)
if (!multi_) {
if (receiverAddressSP_ == address(0)) {
return false;
} else {
/// @dev if receiverAddressSP_ is set and is a contract, it must implement onERC1155Received
_doSafeTransferAcceptanceCheck(receiverAddressSP_);
}
}
}
return true;
}
function _validateSuperformsData(
MultiVaultSFData memory superformsData_,
uint64 dstChainId_,
bool deposit_
)
internal
virtual
returns (bool)
{
uint256 len = superformsData_.amounts.length;
uint256 lenSuperforms = superformsData_.superformIds.length;
uint256 liqRequestsLen = superformsData_.liqRequests.length;
/// @dev empty requests are not allowed, as well as requests with length mismatch
if (len == 0 || liqRequestsLen == 0) return false;
if (len != liqRequestsLen) return false;
/// @dev all other length checks
if (
lenSuperforms != len || lenSuperforms != superformsData_.outputAmounts.length
|| lenSuperforms != superformsData_.maxSlippages.length
|| lenSuperforms != superformsData_.hasDstSwaps.length
|| lenSuperforms != superformsData_.retain4626s.length
) {
return false;
}
/// @dev deposits beyond multi vault limit for a given destination chain blocked
if (lenSuperforms > superRegistry.getVaultLimitPerDestination(dstChainId_)) {
return false;
}
/// @dev since this is a multi case, validate receiverAddress here once
if (superformsData_.receiverAddress == address(0)) {
return false;
}
/// @dev since this is a multi case, validate receiverAddressSP here once
if (deposit_) {
if (superformsData_.receiverAddressSP == address(0)) {
return false;
} else {
/// @dev if receiverAddressSP_ is set and is a contract, it must implement onERC1155Received
_doSafeTransferAcceptanceCheck(superformsData_.receiverAddressSP);
}
}
ISuperformFactory factory = ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY")));
/// @dev slippage, amount, paused status validation
for (uint256 i; i < len; ++i) {
if (
!_validateSuperformData(
superformsData_.superformIds[i],
superformsData_.amounts[i],
superformsData_.outputAmounts[i],
superformsData_.maxSlippages[i],
superformsData_.receiverAddress,
superformsData_.receiverAddressSP,
dstChainId_,
deposit_,
factory,
true
)
) {
return false;
}
/// @dev ensure interimTokens aren't repeated on destination chains
address interimToken = superformsData_.liqRequests[i].interimToken;
if (interimToken != address(0)) {
for (uint256 j; j < i; ++j) {
if (j != i) {
if (interimToken == superformsData_.liqRequests[j].interimToken) {
return false;
}
}
}
}
}
return true;
}
//////////////////////////////////////////////////////////////
// INTERNAL FEE FORWARDING HELPERS //
//////////////////////////////////////////////////////////////
/// @dev forwards the residual payment to Paymaster
function _forwardPayment(uint256 _balanceBefore) internal virtual {
if (address(this).balance < _balanceBefore) revert Error.INSUFFICIENT_BALANCE();
/// @dev deducts what's already available sends what's left in msg.value to Paymaster
uint256 residualPayment = address(this).balance - _balanceBefore;
if (residualPayment != 0) {
IPayMaster(_getAddress(keccak256("PAYMASTER"))).makePayment{ value: residualPayment }(msg.sender);