Skip to content

Commit 914579a

Browse files
authored
chore: event naming consistency (#744)
1 parent 0816ff3 commit 914579a

24 files changed

+88
-84
lines changed

snapshots/Hub.Operations.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"add": "119161",
3-
"draw": "112322",
3+
"draw": "112321",
44
"refreshPremium": "100461",
55
"remove: full": "79522",
66
"remove: partial": "86022",

snapshots/Spoke.Operations.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"borrow: first": "257018",
3-
"borrow: second action, same reserve": "220490",
2+
"borrow: first": "257017",
3+
"borrow: second action, same reserve": "220489",
44
"liquidationCall: full": "326113",
55
"liquidationCall: partial": "349374",
66
"permitReserve + repay (multicall)": "279760",

src/contracts/AaveOracle.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ contract AaveOracle is IAaveOracle {
4040
require(targetSource.decimals() == DECIMALS, InvalidSourceDecimals(reserveId));
4141
_sources[reserveId] = targetSource;
4242
_getSourcePrice(reserveId); // check if the source is valid
43-
emit ReserveSourceUpdated(reserveId, source);
43+
emit UpdateReserveSource(reserveId, source);
4444
}
4545

4646
/// @inheritdoc IPriceOracle

src/contracts/AssetInterestRateStrategy.sol

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ contract AssetInterestRateStrategy is IAssetInterestRateStrategy {
5959

6060
_interestRateData[assetId] = rateData;
6161

62-
emit RateDataUpdate(
62+
emit UpdateRateData(
63+
HUB,
6364
assetId,
6465
rateData.optimalUsageRatio,
6566
rateData.baseVariableBorrowRate,

src/contracts/Hub.sol

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ contract Hub is IHub, AccessManaged {
9898
);
9999

100100
emit AddAsset(assetId, underlying, decimals);
101-
emit AssetConfigUpdate(
101+
emit UpdateAssetConfig(
102102
assetId,
103103
DataTypes.AssetConfig({
104104
feeReceiver: feeReceiver,
@@ -107,7 +107,7 @@ contract Hub is IHub, AccessManaged {
107107
reinvestmentController: address(0)
108108
})
109109
);
110-
emit AssetUpdate(assetId, drawnIndex, drawnRate, lastUpdateTimestamp);
110+
emit UpdateAsset(assetId, drawnIndex, drawnRate, lastUpdateTimestamp);
111111

112112
return assetId;
113113
}
@@ -144,7 +144,7 @@ contract Hub is IHub, AccessManaged {
144144

145145
asset.updateDrawnRate(assetId);
146146

147-
emit AssetConfigUpdate(assetId, config);
147+
emit UpdateAssetConfig(assetId, config);
148148
}
149149

150150
function addSpoke(
@@ -294,12 +294,11 @@ contract Hub is IHub, AccessManaged {
294294
asset.drawnShares -= drawnShares;
295295
spoke.drawnShares -= drawnShares;
296296
_applyPremiumDelta(assetId, asset, spoke, premiumDelta, premiumAmount);
297-
uint256 totalDeficitAmount = drawnAmount + premiumAmount;
298-
asset.deficit += totalDeficitAmount.toUint128();
297+
asset.deficit += (drawnAmount + premiumAmount).toUint128();
299298

300299
asset.updateDrawnRate(assetId);
301300

302-
emit ReportDeficit(assetId, msg.sender, drawnShares, premiumDelta, totalDeficitAmount);
301+
emit ReportDeficit(assetId, msg.sender, drawnShares, premiumDelta, drawnAmount, premiumAmount);
303302

304303
return drawnShares;
305304
}
@@ -629,7 +628,7 @@ contract Hub is IHub, AccessManaged {
629628
spokeData.active = config.active;
630629
spokeData.addCap = config.addCap;
631630
spokeData.drawCap = config.drawCap;
632-
emit SpokeConfigUpdate(assetId, spoke, config);
631+
emit UpdateSpokeConfig(assetId, spoke, config);
633632
}
634633

635634
/**

src/contracts/Spoke.sol

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ contract Spoke is ISpoke, Multicall, AccessManaged, EIP712 {
5858
constructor(address authority_) AccessManaged(authority_) {
5959
require(authority_ != address(0), InvalidAddress());
6060
_liquidationConfig.targetHealthFactor = Constants.HEALTH_FACTOR_LIQUIDATION_THRESHOLD;
61-
emit LiquidationConfigUpdate(_liquidationConfig);
61+
emit UpdateLiquidationConfig(_liquidationConfig);
6262
}
6363

6464
// /////
@@ -72,7 +72,7 @@ contract Spoke is ISpoke, Multicall, AccessManaged, EIP712 {
7272
newOracle != address(0) && oracle.DECIMALS() == Constants.ORACLE_DECIMALS,
7373
InvalidOracle()
7474
);
75-
emit OracleUpdate(newOracle);
75+
emit UpdateOracle(newOracle);
7676
}
7777

7878
function updateReservePriceSource(uint256 reserveId, address priceSource) external restricted {
@@ -90,7 +90,7 @@ contract Spoke is ISpoke, Multicall, AccessManaged, EIP712 {
9090
InvalidLiquidationConfig()
9191
);
9292
_liquidationConfig = config;
93-
emit LiquidationConfigUpdate(config);
93+
emit UpdateLiquidationConfig(config);
9494
}
9595

9696
function addReserve(
@@ -128,7 +128,7 @@ contract Spoke is ISpoke, Multicall, AccessManaged, EIP712 {
128128
_reserveExists[hub][assetId] = true;
129129

130130
emit AddReserve(reserveId, assetId, hub);
131-
emit ReserveConfigUpdate(reserveId, config);
131+
emit UpdateReserveConfig(reserveId, config);
132132
emit AddDynamicReserveConfig(reserveId, dynamicConfigKey, dynamicConfig);
133133

134134
return reserveId;
@@ -145,7 +145,7 @@ contract Spoke is ISpoke, Multicall, AccessManaged, EIP712 {
145145
reserve.frozen = config.frozen;
146146
reserve.borrowable = config.borrowable;
147147
reserve.collateralRisk = config.collateralRisk;
148-
emit ReserveConfigUpdate(reserveId, config);
148+
emit UpdateReserveConfig(reserveId, config);
149149
}
150150

151151
/// @inheritdoc ISpoke
@@ -383,7 +383,7 @@ contract Spoke is ISpoke, Multicall, AccessManaged, EIP712 {
383383
uint256 newUserRiskPremium = _refreshAndValidateUserPosition(onBehalfOf); // validates HF
384384
_notifyRiskPremiumUpdate(onBehalfOf, newUserRiskPremium);
385385
}
386-
emit UsingAsCollateral(reserveId, msg.sender, onBehalfOf, usingAsCollateral);
386+
emit SetUsingAsCollateral(reserveId, msg.sender, onBehalfOf, usingAsCollateral);
387387
}
388388

389389
/// @inheritdoc ISpoke
@@ -679,7 +679,7 @@ contract Spoke is ISpoke, Multicall, AccessManaged, EIP712 {
679679
function _updateReservePriceSource(uint256 reserveId, address priceSource) internal {
680680
require(address(oracle) != address(0), InvalidAddress());
681681
oracle.setReserveSource(reserveId, priceSource);
682-
emit ReservePriceSourceUpdate(reserveId, priceSource);
682+
emit UpdateReservePriceSource(reserveId, priceSource);
683683
}
684684

685685
function _refreshAndValidateUserPosition(address user) internal returns (uint256) {
@@ -938,7 +938,7 @@ contract Spoke is ISpoke, Multicall, AccessManaged, EIP712 {
938938
hub.refreshPremium(assetId, premiumDelta);
939939
emit RefreshPremiumDebt(reserveId, user, premiumDelta);
940940
}
941-
emit UserRiskPremiumUpdate(user, newUserRiskPremium);
941+
emit UpdateUserRiskPremium(user, newUserRiskPremium);
942942
}
943943

944944
/**
@@ -979,7 +979,7 @@ contract Spoke is ISpoke, Multicall, AccessManaged, EIP712 {
979979
// non-zero deficit means user ends up with zero total debt
980980
positionStatus.setBorrowing(reserveId, false);
981981
}
982-
emit UserRiskPremiumUpdate(user, 0);
982+
emit UpdateUserRiskPremium(user, 0);
983983
}
984984

985985
function _refreshDynamicConfig(address user) internal {

src/interfaces/IAaveOracle.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ interface IAaveOracle is IPriceOracle {
1515
* @param reserveId The identifier of the reserve.
1616
* @param source The price feed source of the reserve.
1717
*/
18-
event ReserveSourceUpdated(uint256 indexed reserveId, address indexed source);
18+
event UpdateReserveSource(uint256 indexed reserveId, address indexed source);
1919

2020
/**
2121
* @dev Thrown when the price feed source uses a different number of decimals than the oracle.

src/interfaces/IAssetInterestRateStrategy.sol

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ import {IBasicInterestRateStrategy} from './IBasicInterestRateStrategy.sol';
1212
interface IAssetInterestRateStrategy is IBasicInterestRateStrategy {
1313
/**
1414
* @notice Emitted when new interest rate data is set for an asset.
15+
* @param hub The address of the associated hub.
1516
* @param assetId Identifier of the asset that has new interest rate data set.
1617
* @param optimalUsageRatio The optimal borrow usage ratio, in bps.
1718
* @param baseVariableBorrowRate The base variable borrow rate, in bps.
1819
* @param variableRateSlope1 The slope of the variable interest curve, before hitting the optimal borrow usage ratio, in bps.
1920
* @param variableRateSlope2 The slope of the variable interest curve, after hitting the optimal borrow usage ratio, in bps.
2021
*/
21-
event RateDataUpdate(
22+
event UpdateRateData(
23+
address indexed hub,
2224
uint256 indexed assetId,
2325
uint256 optimalUsageRatio,
2426
uint256 baseVariableBorrowRate,

src/interfaces/IHub.sol

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ import {IHubBase} from 'src/interfaces/IHubBase.sol';
1515
interface IHub is IHubBase, IAccessManaged {
1616
event AddSpoke(uint256 indexed assetId, address indexed spoke);
1717
event AddAsset(uint256 indexed assetId, address indexed underlying, uint8 decimals);
18-
event AssetConfigUpdate(uint256 indexed assetId, DataTypes.AssetConfig config);
19-
event SpokeConfigUpdate(
18+
event UpdateAssetConfig(uint256 indexed assetId, DataTypes.AssetConfig config);
19+
event UpdateSpokeConfig(
2020
uint256 indexed assetId,
2121
address indexed spoke,
2222
DataTypes.SpokeConfig config
2323
);
24-
event AssetUpdate(
24+
event UpdateAsset(
2525
uint256 indexed assetId,
2626
uint256 drawnIndex,
2727
uint256 drawnRate,
@@ -37,7 +37,8 @@ interface IHub is IHubBase, IAccessManaged {
3737
address indexed spoke,
3838
uint256 drawnShares,
3939
DataTypes.PremiumDelta premiumDelta,
40-
uint256 drawnAmount
40+
uint256 drawnAmount,
41+
uint256 premiumAmount
4142
);
4243
event AccrueFees(uint256 indexed assetId, uint256 shares);
4344
event TransferShares(uint256 indexed assetId, uint256 shares, address sender, address receiver);

src/interfaces/ISpoke.sol

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import {ISpokeBase} from 'src/interfaces/ISpokeBase.sol';
1515
*/
1616
interface ISpoke is ISpokeBase, IMulticall, IAccessManaged {
1717
event AddReserve(uint256 indexed reserveId, uint256 indexed assetId, address indexed hub);
18-
event ReserveConfigUpdate(uint256 indexed reserveId, DataTypes.ReserveConfig config);
18+
event UpdateReserveConfig(uint256 indexed reserveId, DataTypes.ReserveConfig config);
1919

2020
/**
2121
* @notice Emitted when a dynamic reserve config is added.
@@ -64,7 +64,7 @@ interface ISpoke is ISpokeBase, IMulticall, IAccessManaged {
6464
* @param user The owner of the position being modified.
6565
* @param usingAsCollateral Boolean whether the reserve is enabled or disabled as collateral.
6666
*/
67-
event UsingAsCollateral(
67+
event SetUsingAsCollateral(
6868
uint256 indexed reserveId,
6969
address indexed caller,
7070
address indexed user,
@@ -76,7 +76,7 @@ interface ISpoke is ISpokeBase, IMulticall, IAccessManaged {
7676
* @param user The owner of the position being modified.
7777
* @param riskPremium The new risk premium (BPS) value of user.
7878
*/
79-
event UserRiskPremiumUpdate(address indexed user, uint256 riskPremium);
79+
event UpdateUserRiskPremium(address indexed user, uint256 riskPremium);
8080

8181
/**
8282
* @notice Emitted on setUserPositionManager or renouncePositionManagerRole action.
@@ -98,9 +98,9 @@ interface ISpoke is ISpokeBase, IMulticall, IAccessManaged {
9898
address indexed user,
9999
DataTypes.PremiumDelta premiumDelta
100100
);
101-
event OracleUpdate(address indexed oracle);
102-
event ReservePriceSourceUpdate(uint256 indexed reserveId, address indexed priceSource);
103-
event LiquidationConfigUpdate(DataTypes.LiquidationConfig config);
101+
event UpdateOracle(address indexed oracle);
102+
event UpdateReservePriceSource(uint256 indexed reserveId, address indexed priceSource);
103+
event UpdateLiquidationConfig(DataTypes.LiquidationConfig config);
104104

105105
error AssetNotListed();
106106
error ReserveExists();

0 commit comments

Comments
 (0)