-
Notifications
You must be signed in to change notification settings - Fork 44
/
Copy pathPaymentHelper.sol
1149 lines (964 loc) · 41.5 KB
/
PaymentHelper.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 { IPaymentHelperV2 as IPaymentHelper } from "src/interfaces/IPaymentHelperV2.sol";
import { ISuperRBAC } from "src/interfaces/ISuperRBAC.sol";
import { ISuperRegistry } from "src/interfaces/ISuperRegistry.sol";
import { ISuperformFactory } from "src/interfaces/ISuperformFactory.sol";
import { IBaseStateRegistry } from "src/interfaces/IBaseStateRegistry.sol";
import { IAmbImplementation } from "src/interfaces/IAmbImplementation.sol";
import { Error } from "src/libraries/Error.sol";
import { DataLib } from "src/libraries/DataLib.sol";
import { ProofLib } from "src/libraries/ProofLib.sol";
import { ArrayCastLib } from "src/libraries/ArrayCastLib.sol";
import {
SingleDirectSingleVaultStateReq,
SingleXChainSingleVaultStateReq,
SingleDirectMultiVaultStateReq,
SingleXChainMultiVaultStateReq,
MultiDstSingleVaultStateReq,
MultiDstMultiVaultStateReq,
LiqRequest,
AMBMessage,
MultiVaultSFData,
SingleVaultSFData,
AMBExtraData,
InitMultiVaultData,
InitSingleVaultData,
ReturnMultiData,
ReturnSingleData
} from "src/types/DataTypes.sol";
import { AggregatorV3Interface } from "src/vendor/chainlink/AggregatorV3Interface.sol";
/// @dev interface to read public variable from state registry
interface ReadOnlyBaseRegistry is IBaseStateRegistry {
function payloadsCount() external view returns (uint256);
}
/// @title PaymentHelper
/// @dev Helps estimate the cost for the entire transaction lifecycle
/// @author ZeroPoint Labs
contract PaymentHelper is IPaymentHelper {
using DataLib for uint256;
using ArrayCastLib for LiqRequest;
using ArrayCastLib for bool;
using ProofLib for bytes;
using ProofLib for AMBMessage;
//////////////////////////////////////////////////////////////
// CONSTANTS //
//////////////////////////////////////////////////////////////
uint256 private constant PROOF_LENGTH = 160;
uint8 private constant MIN_FEED_PRECISION = 8;
uint8 private constant MAX_FEED_PRECISION = 18;
uint32 private constant TIMELOCK_FORM_ID = 2;
uint256 private constant MAX_UINT256 = type(uint256).max;
ISuperRegistry public immutable superRegistry;
uint64 public immutable CHAIN_ID;
//////////////////////////////////////////////////////////////
// STATE VARIABLES //
//////////////////////////////////////////////////////////////
/// @dev xchain params
mapping(uint64 chainId => AggregatorV3Interface) public nativeFeedOracle;
mapping(uint64 chainId => AggregatorV3Interface) public gasPriceOracle;
mapping(uint64 chainId => uint256 gasForSwap) public swapGasUsed;
mapping(uint64 chainId => uint256 gasForUpdateDeposit) public updateDepositGasUsed;
mapping(uint64 chainId => uint256 gasForUpdateWithdraw) public updateWithdrawGasUsed;
mapping(uint64 chainId => uint256 gasForDeposit) public depositGasUsed;
mapping(uint64 chainId => uint256 gasForWithdraw) public withdrawGasUsed;
mapping(uint64 chainId => uint256 defaultNativePrice) public nativePrice;
mapping(uint64 chainId => uint256 defaultGasPrice) public gasPrice;
mapping(uint64 chainId => uint256 gasPerByte) public gasPerByte;
mapping(uint64 chainId => uint256 gasForAck) public ackGasCost;
mapping(uint64 chainId => uint256 gasForTimelock) public timelockCost;
mapping(uint64 chainId => uint256 gasForEmergency) public emergencyCost;
/// @dev register transmuter params
bytes public extraDataForTransmuter;
//////////////////////////////////////////////////////////////
// STRUCTS //
//////////////////////////////////////////////////////////////
struct EstimateAckCostVars {
uint256 currPayloadId;
uint256 payloadHeader;
uint8 callbackType;
bytes payloadBody;
uint8[] ackAmbIds;
uint8 isMulti;
uint64 srcChainId;
bytes message;
}
struct LocalEstimateVars {
uint256 len;
uint256 superformIdsLen;
uint256 totalGas;
uint256 ambFees;
bool paused;
}
struct CalculateAmountsReq {
uint256 i;
uint64[] dstChainIds;
uint8[] ambIds;
MultiVaultSFData[] superformsData;
SingleVaultSFData[] superformData;
ISuperformFactory factory;
bool isDeposit;
}
//////////////////////////////////////////////////////////////
// MODIFIERS //
//////////////////////////////////////////////////////////////
modifier onlyProtocolAdmin() {
if (!ISuperRBAC(_getAddress(keccak256("SUPER_RBAC"))).hasProtocolAdminRole(msg.sender)) {
revert Error.NOT_PROTOCOL_ADMIN();
}
_;
}
modifier onlyPaymentAdmin() {
if (
!ISuperRBAC(superRegistry.getAddress(keccak256("SUPER_RBAC"))).hasRole(
keccak256("PAYMENT_ADMIN_ROLE"), msg.sender
)
) {
revert Error.NOT_PAYMENT_ADMIN();
}
_;
}
//////////////////////////////////////////////////////////////
// CONSTRUCTOR //
//////////////////////////////////////////////////////////////
constructor(address superRegistry_) {
if (superRegistry_ == address(0)) {
revert Error.ZERO_ADDRESS();
}
if (block.chainid > type(uint64).max) {
revert Error.BLOCK_CHAIN_ID_OUT_OF_BOUNDS();
}
CHAIN_ID = uint64(block.chainid);
superRegistry = ISuperRegistry(superRegistry_);
}
//////////////////////////////////////////////////////////////
// EXTERNAL VIEW FUNCTIONS //
//////////////////////////////////////////////////////////////
/// @inheritdoc IPaymentHelper
function calculateAMBData(
uint64 dstChainId_,
uint8[] calldata ambIds_,
bytes memory message_
)
external
view
override
returns (uint256 totalFees, bytes memory extraData)
{
(uint256[] memory gasPerAMB, bytes[] memory extraDataPerAMB, uint256 fees) =
_estimateAMBFeesReturnExtraData(dstChainId_, ambIds_, message_);
extraData = abi.encode(AMBExtraData(gasPerAMB, extraDataPerAMB));
totalFees = fees;
}
/// @inheritdoc IPaymentHelper
function getRegisterTransmuterAMBData() external view override returns (bytes memory) {
return extraDataForTransmuter;
}
/// @inheritdoc IPaymentHelper
function estimateMultiDstMultiVault(
MultiDstMultiVaultStateReq calldata req_,
bool isDeposit_
)
external
view
override
returns (uint256 liqAmount, uint256 srcAmount, uint256 dstAmount, uint256 totalAmount)
{
uint256 len = req_.dstChainIds.length;
uint256 liqAmountIndex;
uint256 srcAmountIndex;
uint256 dstAmountIndex;
ISuperformFactory factory = ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY")));
SingleVaultSFData[] memory temp;
for (uint256 i; i < len; ++i) {
(liqAmountIndex, srcAmountIndex, dstAmountIndex) = _calculateAmounts(
CalculateAmountsReq(i, req_.dstChainIds, req_.ambIds[i], req_.superformsData, temp, factory, isDeposit_)
);
liqAmount += liqAmountIndex;
srcAmount += srcAmountIndex;
dstAmount += dstAmountIndex;
}
totalAmount = srcAmount + dstAmount + liqAmount;
}
/// @inheritdoc IPaymentHelper
function estimateMultiDstSingleVault(
MultiDstSingleVaultStateReq calldata req_,
bool isDeposit_
)
external
view
override
returns (uint256 liqAmount, uint256 srcAmount, uint256 dstAmount, uint256 totalAmount)
{
uint256 len = req_.dstChainIds.length;
uint256 liqAmountIndex;
uint256 srcAmountIndex;
uint256 dstAmountIndex;
ISuperformFactory factory = ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY")));
MultiVaultSFData[] memory temp;
for (uint256 i; i < len; ++i) {
(liqAmountIndex, srcAmountIndex, dstAmountIndex) = _calculateAmounts(
CalculateAmountsReq(i, req_.dstChainIds, req_.ambIds[i], temp, req_.superformsData, factory, isDeposit_)
);
liqAmount += liqAmountIndex;
srcAmount += srcAmountIndex;
dstAmount += dstAmountIndex;
}
totalAmount = srcAmount + dstAmount + liqAmount;
}
/// @inheritdoc IPaymentHelper
function estimateSingleXChainMultiVault(
SingleXChainMultiVaultStateReq calldata req_,
bool isDeposit_
)
external
view
override
returns (uint256 liqAmount, uint256 srcAmount, uint256 dstAmount, uint256 totalAmount)
{
ISuperformFactory factory = ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY")));
uint64[] memory dstChainIds = new uint64[](1);
dstChainIds[0] = req_.dstChainId;
SingleVaultSFData[] memory temp;
MultiVaultSFData[] memory sfData = new MultiVaultSFData[](1);
sfData[0] = req_.superformsData;
(liqAmount, srcAmount, dstAmount) =
_calculateAmounts(CalculateAmountsReq(0, dstChainIds, req_.ambIds, sfData, temp, factory, isDeposit_));
totalAmount = srcAmount + dstAmount + liqAmount;
}
/// @inheritdoc IPaymentHelper
function estimateSingleXChainSingleVault(
SingleXChainSingleVaultStateReq calldata req_,
bool isDeposit_
)
external
view
override
returns (uint256 liqAmount, uint256 srcAmount, uint256 dstAmount, uint256 totalAmount)
{
ISuperformFactory factory = ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY")));
uint64[] memory dstChainIds = new uint64[](1);
dstChainIds[0] = req_.dstChainId;
MultiVaultSFData[] memory temp;
SingleVaultSFData[] memory sfData = new SingleVaultSFData[](1);
sfData[0] = req_.superformData;
(liqAmount, srcAmount, dstAmount) =
_calculateAmounts(CalculateAmountsReq(0, dstChainIds, req_.ambIds, temp, sfData, factory, isDeposit_));
totalAmount = srcAmount + dstAmount + liqAmount;
}
/// @inheritdoc IPaymentHelper
function estimateSingleDirectSingleVault(
SingleDirectSingleVaultStateReq calldata req_,
bool isDeposit_
)
external
view
override
returns (uint256 liqAmount, uint256 dstOrSameChainAmt, uint256 totalAmount)
{
ISuperformFactory factory = ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY")));
uint64[] memory dstChainIds = new uint64[](1);
dstChainIds[0] = CHAIN_ID;
SingleVaultSFData[] memory sfData = new SingleVaultSFData[](1);
sfData[0] = req_.superformData;
MultiVaultSFData[] memory temp;
uint8[] memory ambIds;
(liqAmount,, dstOrSameChainAmt) =
_calculateAmounts(CalculateAmountsReq(0, dstChainIds, ambIds, temp, sfData, factory, isDeposit_));
totalAmount = liqAmount + dstOrSameChainAmt;
}
/// @inheritdoc IPaymentHelper
function estimateSingleDirectMultiVault(
SingleDirectMultiVaultStateReq calldata req_,
bool isDeposit_
)
external
view
override
returns (uint256 liqAmount, uint256 dstOrSameChainAmt, uint256 totalAmount)
{
ISuperformFactory factory = ISuperformFactory(_getAddress(keccak256("SUPERFORM_FACTORY")));
uint64[] memory dstChainIds = new uint64[](1);
dstChainIds[0] = CHAIN_ID;
SingleVaultSFData[] memory temp;
MultiVaultSFData[] memory sfData = new MultiVaultSFData[](1);
sfData[0] = req_.superformData;
uint8[] memory ambIds;
(liqAmount,, dstOrSameChainAmt) =
_calculateAmounts(CalculateAmountsReq(0, dstChainIds, ambIds, sfData, temp, factory, isDeposit_));
totalAmount = liqAmount + dstOrSameChainAmt;
}
/// @inheritdoc IPaymentHelper
function estimateAMBFees(
uint8[] memory ambIds_,
uint64 dstChainId_,
bytes memory message_,
bytes[] memory extraData_
)
public
view
override
returns (uint256 totalFees, uint256[] memory)
{
uint256 len = ambIds_.length;
uint256[] memory fees = new uint256[](len);
/// @dev just checks the estimate for sending message from src -> dst
if (CHAIN_ID != dstChainId_) {
for (uint256 i; i < len; ++i) {
fees[i] = IAmbImplementation(superRegistry.getAmbAddress(ambIds_[i])).estimateFees(
dstChainId_, message_, extraData_[i]
);
totalFees += fees[i];
}
}
return (totalFees, fees);
}
/// @inheritdoc IPaymentHelper
function estimateAckCost(uint256 payloadId_) external view override returns (uint256 totalFees) {
EstimateAckCostVars memory v;
IBaseStateRegistry coreStateRegistry = IBaseStateRegistry(_getAddress(keccak256("CORE_STATE_REGISTRY")));
v.currPayloadId = coreStateRegistry.payloadsCount();
if (payloadId_ > v.currPayloadId) revert Error.INVALID_PAYLOAD_ID();
v.payloadHeader = coreStateRegistry.payloadHeader(payloadId_);
v.payloadBody = coreStateRegistry.payloadBody(payloadId_);
(, v.callbackType, v.isMulti,,, v.srcChainId) = DataLib.decodeTxInfo(v.payloadHeader);
/// if callback type is return then return 0
if (v.callbackType != 0) return 0;
if (v.isMulti == 1) {
InitMultiVaultData memory data = abi.decode(v.payloadBody, (InitMultiVaultData));
v.payloadBody = abi.encode(ReturnMultiData(v.currPayloadId, data.superformIds, data.amounts));
} else {
InitSingleVaultData memory data = abi.decode(v.payloadBody, (InitSingleVaultData));
v.payloadBody = abi.encode(ReturnSingleData(v.currPayloadId, data.superformId, data.amount));
}
v.ackAmbIds = coreStateRegistry.getMessageAMB(payloadId_);
v.message = abi.encode(AMBMessage(coreStateRegistry.payloadHeader(payloadId_), v.payloadBody));
return _estimateAMBFees(v.ackAmbIds, v.srcChainId, v.message);
}
/// @inheritdoc IPaymentHelper
function estimateAckCostDefault(
bool multi,
uint8[] memory ackAmbIds,
uint64 srcChainId
)
public
view
override
returns (uint256 totalFees)
{
bytes memory payloadBody;
if (multi) {
uint256 vaultLimitPerDst = superRegistry.getVaultLimitPerDestination(srcChainId);
uint256[] memory maxUints = new uint256[](vaultLimitPerDst);
for (uint256 i; i < vaultLimitPerDst; ++i) {
maxUints[i] = type(uint256).max;
}
payloadBody = abi.encode(ReturnMultiData(type(uint256).max, maxUints, maxUints));
} else {
payloadBody = abi.encode(ReturnSingleData(type(uint256).max, type(uint256).max, type(uint256).max));
}
return _estimateAMBFees(ackAmbIds, srcChainId, abi.encode(AMBMessage(type(uint256).max, payloadBody)));
}
/// @inheritdoc IPaymentHelper
function estimateAckCostDefaultNativeSource(
bool multi,
uint8[] memory ackAmbIds,
uint64 srcChainId
)
external
view
override
returns (uint256)
{
return _convertToSrcNativeAmount(srcChainId, estimateAckCostDefault(multi, ackAmbIds, srcChainId));
}
//////////////////////////////////////////////////////////////
// EXTERNAL WRITE FUNCTIONS //
//////////////////////////////////////////////////////////////
/// @inheritdoc IPaymentHelper
function addRemoteChain(uint64 chainId_, PaymentHelperConfig calldata config_) public override onlyProtocolAdmin {
_addRemoteChain(chainId_, config_);
}
/// @inheritdoc IPaymentHelper
function addRemoteChains(
uint64[] calldata chainIds_,
PaymentHelperConfig[] calldata configs_
)
external
override
onlyProtocolAdmin
{
uint256 len = chainIds_.length;
if (len == 0) revert Error.ZERO_INPUT_VALUE();
if (len != configs_.length) revert Error.ARRAY_LENGTH_MISMATCH();
for (uint256 i; i < len; ++i) {
_addRemoteChain(chainIds_[i], configs_[i]);
}
}
/// @inheritdoc IPaymentHelper
function updateRemoteChain(
uint64 chainId_,
uint256 configType_,
bytes memory config_
)
external
override
onlyPaymentAdmin
{
_updateRemoteChain(chainId_, configType_, config_);
}
/// @inheritdoc IPaymentHelper
function batchUpdateRemoteChain(
uint64 chainId_,
uint256[] calldata configTypes_,
bytes[] calldata configs_
)
external
override
onlyPaymentAdmin
{
_batchUpdateRemoteChain(chainId_, configTypes_, configs_);
}
/// @inheritdoc IPaymentHelper
function batchUpdateRemoteChains(
uint64[] calldata chainIds_,
uint256[][] calldata configTypes_,
bytes[][] calldata configs_
)
external
override
onlyPaymentAdmin
{
uint256 len = chainIds_.length;
if (len == 0) revert Error.ZERO_INPUT_VALUE();
if (!(len == configTypes_.length && len == configs_.length)) revert Error.ARRAY_LENGTH_MISMATCH();
for (uint256 i; i < len; ++i) {
_batchUpdateRemoteChain(chainIds_[i], configTypes_[i], configs_[i]);
}
}
/// @inheritdoc IPaymentHelper
function updateRegisterAERC20Params(bytes memory extraDataForTransmuter_) external onlyPaymentAdmin {
extraDataForTransmuter = extraDataForTransmuter_;
}
//////////////////////////////////////////////////////////////
// INTERNAL FUNCTIONS //
//////////////////////////////////////////////////////////////
function _getOracleDecimals(AggregatorV3Interface oracle_) internal view returns (uint8) {
return oracle_.decimals();
}
/// @dev PROTOCOL_ADMIN can perform the configuration of a remote chain for the first time
function _addRemoteChain(uint64 chainId_, PaymentHelperConfig calldata config_) internal {
if (config_.nativeFeedOracle != address(0)) {
AggregatorV3Interface nativeFeedOracleContract = AggregatorV3Interface(config_.nativeFeedOracle);
uint256 oraclePrecision = _getOracleDecimals(nativeFeedOracleContract);
if (oraclePrecision < MIN_FEED_PRECISION || oraclePrecision > MAX_FEED_PRECISION) {
revert Error.CHAINLINK_UNSUPPORTED_DECIMAL();
}
nativeFeedOracle[chainId_] = nativeFeedOracleContract;
}
if (config_.gasPriceOracle != address(0)) {
AggregatorV3Interface gasPriceOracleContract = AggregatorV3Interface(config_.gasPriceOracle);
uint256 oraclePrecision = _getOracleDecimals(gasPriceOracleContract);
if (oraclePrecision < MIN_FEED_PRECISION || oraclePrecision > MAX_FEED_PRECISION) {
revert Error.CHAINLINK_UNSUPPORTED_DECIMAL();
}
gasPriceOracle[chainId_] = gasPriceOracleContract;
}
swapGasUsed[chainId_] = config_.swapGasUsed;
updateDepositGasUsed[chainId_] = config_.updateDepositGasUsed;
depositGasUsed[chainId_] = config_.depositGasUsed;
withdrawGasUsed[chainId_] = config_.withdrawGasUsed;
nativePrice[chainId_] = config_.defaultNativePrice;
gasPrice[chainId_] = config_.defaultGasPrice;
gasPerByte[chainId_] = config_.dstGasPerByte;
ackGasCost[chainId_] = config_.ackGasCost;
timelockCost[chainId_] = config_.timelockCost;
emergencyCost[chainId_] = config_.emergencyCost;
updateWithdrawGasUsed[chainId_] = config_.updateWithdrawGasUsed;
emit ChainConfigAdded(chainId_, config_);
}
/// @dev PAYMENT_ADMIN can update the configuration of a remote chain on a need basis
function _updateRemoteChain(uint64 chainId_, uint256 configType_, bytes memory config_) internal {
/// @dev Type 1: DST TOKEN PRICE FEED ORACLE
if (configType_ == 1) {
AggregatorV3Interface nativeFeedOracleContract = AggregatorV3Interface(abi.decode(config_, (address)));
/// @dev allows setting price feed to address(0), equivalent for resetting native price
if (address(nativeFeedOracleContract) != address(0)) {
uint256 oraclePrecision = _getOracleDecimals(nativeFeedOracleContract);
if (oraclePrecision < MIN_FEED_PRECISION || oraclePrecision > MAX_FEED_PRECISION) {
revert Error.CHAINLINK_UNSUPPORTED_DECIMAL();
}
}
nativeFeedOracle[chainId_] = nativeFeedOracleContract;
}
/// @dev Type 2: DST GAS PRICE ORACLE
if (configType_ == 2) {
AggregatorV3Interface gasPriceOracleContract = AggregatorV3Interface(abi.decode(config_, (address)));
/// @dev allows setting gas price to address(0), equivalent for resetting gas price
if (address(gasPriceOracleContract) != address(0)) {
uint256 oraclePrecision = _getOracleDecimals(gasPriceOracleContract);
if (oraclePrecision < MIN_FEED_PRECISION || oraclePrecision > MAX_FEED_PRECISION) {
revert Error.CHAINLINK_UNSUPPORTED_DECIMAL();
}
}
gasPriceOracle[chainId_] = gasPriceOracleContract;
}
/// @dev Type 3: SWAP GAS USED
if (configType_ == 3) {
swapGasUsed[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 4: PAYLOAD UPDATE DEPOSIT GAS COST PER TX
if (configType_ == 4) {
updateDepositGasUsed[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 5: DEPOSIT GAS COST PER TX
if (configType_ == 5) {
depositGasUsed[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 6: WITHDRAW GAS COST PER TX
if (configType_ == 6) {
withdrawGasUsed[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 7: DEFAULT NATIVE PRICE
if (configType_ == 7) {
nativePrice[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 8: DEFAULT GAS PRICE
if (configType_ == 8) {
gasPrice[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 9: GAS PRICE PER Byte of Message
if (configType_ == 9) {
gasPerByte[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 10: ACK GAS COST
if (configType_ == 10) {
ackGasCost[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 11: TIMELOCK PROCESSING COST
if (configType_ == 11) {
timelockCost[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 12: EMERGENCY PROCESSING COST
if (configType_ == 12) {
emergencyCost[chainId_] = abi.decode(config_, (uint256));
}
/// @dev Type 13: PAYLOAD UPDATE WITHDRAW GAS COST PER TX
if (configType_ == 13) {
updateWithdrawGasUsed[chainId_] = abi.decode(config_, (uint256));
}
emit ChainConfigUpdated(chainId_, configType_, config_);
}
/// @dev batch updates the configuration of a remote chain. Performed by PAYMENT_ADMIN
function _batchUpdateRemoteChain(
uint64 chainId_,
uint256[] calldata configTypes_,
bytes[] calldata configs_
)
internal
{
uint256 len = configTypes_.length;
if (len == 0) revert Error.ZERO_INPUT_VALUE();
if (len != configs_.length) revert Error.ARRAY_LENGTH_MISMATCH();
for (uint256 i; i < len; ++i) {
_updateRemoteChain(chainId_, configTypes_[i], configs_[i]);
}
}
/// @dev helps generate extra data per amb
function _generateExtraData(
uint64 dstChainId_,
uint8[] memory ambIds_,
bytes memory message_
)
internal
view
returns (bytes[] memory extraDataPerAMB)
{
AMBMessage memory ambIdEncodedMessage = abi.decode(message_, (AMBMessage));
ambIdEncodedMessage.params = abi.encode(ambIds_, ambIdEncodedMessage.params);
uint256 len = ambIds_.length;
uint256 gasReqPerByte = gasPerByte[dstChainId_];
uint256 totalDstGasReqInWei = abi.encode(ambIdEncodedMessage).length * gasReqPerByte;
/// @dev proof length is always of fixed length
uint256 totalDstGasReqInWeiForProof = PROOF_LENGTH * gasReqPerByte;
extraDataPerAMB = new bytes[](len);
for (uint256 i; i < len; ++i) {
uint256 gasReq = i != 0 ? totalDstGasReqInWeiForProof : totalDstGasReqInWei;
extraDataPerAMB[i] = IAmbImplementation(superRegistry.getAmbAddress(ambIds_[i])).generateExtraData(gasReq);
}
}
/// @dev helps estimate the cross-chain message costs
function _estimateAMBFees(
uint8[] memory ambIds_,
uint64 dstChainId_,
bytes memory message_
)
internal
view
returns (uint256 totalFees)
{
uint256 len = ambIds_.length;
bytes[] memory extraDataPerAMB = _generateExtraData(dstChainId_, ambIds_, message_);
AMBMessage memory ambIdEncodedMessage = abi.decode(message_, (AMBMessage));
ambIdEncodedMessage.params = abi.encode(ambIds_, ambIdEncodedMessage.params);
bytes memory proof_ = abi.encode(AMBMessage(MAX_UINT256, abi.encode(keccak256(message_))));
/// @dev just checks the estimate for sending message from src -> dst
/// @dev only ambIds_[0] = primary amb (rest of the ambs send only the proof)
if (CHAIN_ID != dstChainId_) {
for (uint256 i; i < len; ++i) {
uint256 tempFee = IAmbImplementation(superRegistry.getAmbAddress(ambIds_[i])).estimateFees(
dstChainId_, i != 0 ? proof_ : abi.encode(ambIdEncodedMessage), extraDataPerAMB[i]
);
totalFees += tempFee;
}
}
}
/// @dev helps estimate the cross-chain message costs
function _estimateAMBFeesReturnExtraData(
uint64 dstChainId_,
uint8[] calldata ambIds_,
bytes memory message_
)
internal
view
returns (uint256[] memory feeSplitUp, bytes[] memory extraDataPerAMB, uint256 totalFees)
{
AMBMessage memory ambIdEncodedMessage = abi.decode(message_, (AMBMessage));
ambIdEncodedMessage.params = abi.encode(ambIds_, ambIdEncodedMessage.params);
uint256 len = ambIds_.length;
extraDataPerAMB = _generateExtraData(dstChainId_, ambIds_, message_);
feeSplitUp = new uint256[](len);
bytes memory proof_ = abi.encode(AMBMessage(MAX_UINT256, abi.encode(keccak256(message_))));
/// @dev just checks the estimate for sending message from src -> dst
if (CHAIN_ID != dstChainId_) {
for (uint256 i; i < len; ++i) {
uint256 tempFee = IAmbImplementation(superRegistry.getAmbAddress(ambIds_[i])).estimateFees(
dstChainId_, i != 0 ? proof_ : abi.encode(ambIdEncodedMessage), extraDataPerAMB[i]
);
totalFees += tempFee;
feeSplitUp[i] = tempFee;
}
}
}
/// @dev helps estimate the liq amount involved in the tx
function _estimateLiqAmount(LiqRequest[] memory req_) internal pure returns (uint256 liqAmount) {
uint256 len = req_.length;
for (uint256 i; i < len; ++i) {
liqAmount += req_[i].nativeAmount;
}
}
/// @dev helps estimate the dst chain swap gas limit (if multi-tx is involved)
function _estimateSwapFees(
uint64 dstChainId_,
bool[] memory hasDstSwaps_
)
internal
view
returns (uint256 gasUsed)
{
uint256 totalSwaps;
if (CHAIN_ID == dstChainId_) {
return 0;
}
uint256 len = hasDstSwaps_.length;
for (uint256 i; i < len; ++i) {
/// @dev checks if hasDstSwap is true
if (hasDstSwaps_[i]) {
++totalSwaps;
}
}
if (totalSwaps == 0) {
return 0;
}
return totalSwaps * swapGasUsed[dstChainId_];
}
/// @dev helps estimate the dst chain update payload gas limit
function _estimateUpdateDepositCost(
uint64 dstChainId_,
uint256 vaultsCount_
)
internal
view
returns (uint256 gasUsed)
{
return vaultsCount_ * updateDepositGasUsed[dstChainId_];
}
/// @dev helps estimate the dst chain update payload gas limit
function _estimateUpdateWithdrawCost(
uint64 dstChainId_,
LiqRequest[] memory liqRequests_
)
internal
view
returns (uint256 gasUsed)
{
uint256 len = liqRequests_.length;
for (uint256 i; i < len; i++) {
/// @dev liqRequests[i].token on withdraws is the desired token
/// @dev if token is address(0) -> user wants settlement without any liq data
/// @dev this means that if no txData is present and token is different than address(0) an update is
/// required in destination
if (liqRequests_[i].txData.length == 0 && liqRequests_[i].token != address(0)) {
gasUsed += updateWithdrawGasUsed[dstChainId_];
}
}
}
/// @dev helps estimate the dst chain processing cost including the dst->src message cost
/// @dev assumes that withdrawals optimisically succeed
function _estimateDstExecutionCost(
bool isDeposit_,
uint64 dstChainId_,
uint256 vaultsCount_
)
internal
view
returns (uint256 gasUsed)
{
uint256 executionGasPerVault = isDeposit_ ? depositGasUsed[dstChainId_] : withdrawGasUsed[dstChainId_];
gasUsed = executionGasPerVault * vaultsCount_;
}
/// @dev helps estimate the src chain processing fee
function _estimateAckProcessingCost(uint256 vaultsCount_) internal view returns (uint256 nativeFee) {
uint256 gasCost = vaultsCount_ * ackGasCost[CHAIN_ID];
return gasCost * _getGasPrice(CHAIN_ID);
}
/// @dev generates the amb message for single vault data
function _generateSingleVaultMessage(SingleVaultSFData memory sfData_)
internal
view
returns (bytes memory message_)
{
bytes memory ambData = abi.encode(
InitSingleVaultData(
_getNextPayloadId(),
sfData_.superformId,
sfData_.amount,
sfData_.outputAmount,
sfData_.maxSlippage,
sfData_.liqRequest,
sfData_.hasDstSwap,
sfData_.retain4626,
sfData_.receiverAddress,
sfData_.extraFormData
)
);
message_ = abi.encode(AMBMessage(MAX_UINT256, ambData));
}
/// @dev generates the amb message for multi vault data
function _generateMultiVaultMessage(MultiVaultSFData memory sfData_)
internal
view
returns (bytes memory message_)
{
bytes memory ambData = abi.encode(
InitMultiVaultData(
_getNextPayloadId(),
sfData_.superformIds,
sfData_.amounts,
sfData_.outputAmounts,
sfData_.maxSlippages,
sfData_.liqRequests,
sfData_.hasDstSwaps,
sfData_.retain4626s,
sfData_.receiverAddress,
sfData_.extraFormData
)
);
message_ = abi.encode(AMBMessage(MAX_UINT256, ambData));
}
/// @dev helps convert the dst gas fee into src chain native fee
/// @dev https://docs.soliditylang.org/en/v0.8.4/units-and-global-variables.html#ether-units
/// @dev all native tokens should be 18 decimals across all EVMs
function _convertToNativeFee(
uint64 dstChainId_,
uint256 dstGas_,
bool xChain_
)
internal
view
returns (uint256 nativeFee)
{
/// @dev gas fee * gas price (to get the gas amounts in dst chain's native token)
/// @dev gas price is 9 decimal (in gwei)
/// @dev assumption: all evm native tokens are 18 decimals
uint256 dstNativeFee = dstGas_ * _getGasPrice(dstChainId_);
if (dstNativeFee == 0) {
return 0;
}
if (!xChain_) {
return dstNativeFee;
}
/// @dev converts the gas to pay in terms of native token to usd value
/// @dev native token price is 8 decimal
uint256 dstUsdValue = dstNativeFee * _getNativeTokenPrice(dstChainId_); // native token price - 8 decimal
if (dstUsdValue == 0) {
return 0;
}
/// @dev converts the usd value to source chain's native token
/// @dev native token price is 8 decimal which cancels the 8 decimal multiplied in previous step
uint256 nativeTokenPrice = _getNativeTokenPrice(CHAIN_ID); // native token price - 8 decimal
if (nativeTokenPrice == 0) revert Error.INVALID_NATIVE_TOKEN_PRICE();
nativeFee = (dstUsdValue) / nativeTokenPrice;
}
/// @dev helps convert a native token of one chain to another
/// @dev https://docs.soliditylang.org/en/v0.8.4/units-and-global-variables.html#ether-units
/// @dev all native tokens should be 18 decimals across all EVMs
function _convertToSrcNativeAmount(
uint64 srcChainId_,
uint256 dstAmount_
)
internal
view
returns (uint256 nativeFee)
{
if (dstAmount_ == 0) {
return 0;
}
/// @dev converts the native token value to usd value
/// @dev dstAmount_ is 18 decimal
/// @dev native token price is 8 decimal
uint256 dstUsdValue = dstAmount_ * _getNativeTokenPrice(CHAIN_ID);
if (dstUsdValue == 0) {
return 0;
}
/// @dev converts the usd value to source chain's native token
/// @dev native token price is 8 decimal which cancels the 8 decimal multiplied in previous step
uint256 nativeTokenPrice = _getNativeTokenPrice(srcChainId_);
if (nativeTokenPrice == 0) revert Error.INVALID_NATIVE_TOKEN_PRICE();
nativeFee = dstUsdValue / nativeTokenPrice;
}
/// @dev helps generate the new payload id
/// @dev next payload id = current payload id + 1
function _getNextPayloadId() internal view returns (uint256 nextPayloadId) {
nextPayloadId = ReadOnlyBaseRegistry(_getAddress(keccak256("CORE_STATE_REGISTRY"))).payloadsCount();
++nextPayloadId;
}
/// @dev helps return the current gas price of different networks
/// @return native token price
function _getGasPrice(uint64 chainId_) internal view returns (uint256) {