Skip to content

Commit 33aee33

Browse files
tbwebb22tbwebb22
committed
make depositExecution events more descriptive
1 parent 8fbd3e4 commit 33aee33

File tree

8 files changed

+52
-17
lines changed

8 files changed

+52
-17
lines changed

‎contracts/interfaces/ICounterfactualDeposit.sol‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,12 @@ interface ICounterfactualDeposit {
1515
/// @dev EIP-712 signature does not recover to the expected signer. SpokePool only.
1616
error InvalidSignature();
1717

18-
event DepositExecuted(address indexed depositAddress, uint256 amount, bytes32 nonce);
19-
event AdminWithdraw(address indexed depositAddress, address indexed token, address indexed to, uint256 amount);
20-
event UserWithdraw(address indexed depositAddress, address indexed token, address indexed to, uint256 amount);
18+
event CounterfactualDepositExecuted(
19+
uint256 amount,
20+
bytes32 nonce,
21+
address executionFeeRecipient,
22+
uint256 executionFee
23+
);
24+
event AdminWithdraw(address indexed token, address indexed to, uint256 amount);
25+
event UserWithdraw(address indexed token, address indexed to, uint256 amount);
2126
}

‎contracts/periphery/counterfactual/CounterfactualDepositBase.sol‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ abstract contract CounterfactualDepositBase is ICounterfactualDeposit {
3333
function _adminWithdraw(address adminWithdrawAddress, address token, address to, uint256 amount) internal {
3434
if (msg.sender != adminWithdrawAddress) revert Unauthorized();
3535
IERC20(token).safeTransfer(to, amount);
36-
emit AdminWithdraw(address(this), token, to, amount);
36+
emit AdminWithdraw(token, to, amount);
3737
}
3838

3939
/**
@@ -46,6 +46,6 @@ abstract contract CounterfactualDepositBase is ICounterfactualDeposit {
4646
function _userWithdraw(address userWithdrawAddress, address token, address to, uint256 amount) internal {
4747
if (msg.sender != userWithdrawAddress) revert Unauthorized();
4848
IERC20(token).safeTransfer(to, amount);
49-
emit UserWithdraw(address(this), token, to, amount);
49+
emit UserWithdraw(token, to, amount);
5050
}
5151
}

‎contracts/periphery/counterfactual/CounterfactualDepositCCTP.sol‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,12 @@ contract CounterfactualDepositCCTP is CounterfactualDepositBase {
130130
signature
131131
);
132132

133-
emit DepositExecuted(address(this), depositAmount, nonce);
133+
emit CounterfactualDepositExecuted(
134+
depositAmount,
135+
nonce,
136+
executionFeeRecipient,
137+
params.executionParams.executionFee
138+
);
134139
}
135140

136141
/**

‎contracts/periphery/counterfactual/CounterfactualDepositOFT.sol‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,12 @@ contract CounterfactualDepositOFT is CounterfactualDepositBase {
129129

130130
ISponsoredOFTSrcPeriphery(oftSrcPeriphery).deposit{ value: msg.value }(quote, signature);
131131

132-
emit DepositExecuted(address(this), depositAmount, nonce);
132+
emit CounterfactualDepositExecuted(
133+
depositAmount,
134+
nonce,
135+
executionFeeRecipient,
136+
params.executionParams.executionFee
137+
);
133138
}
134139

135140
/**

‎contracts/periphery/counterfactual/CounterfactualDepositSpokePool.sol‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,12 @@ contract CounterfactualDepositSpokePool is CounterfactualDepositBase, EIP712 {
138138
params.depositParams.message
139139
);
140140

141-
emit DepositExecuted(address(this), depositAmount, bytes32(0));
141+
emit CounterfactualDepositExecuted(
142+
depositAmount,
143+
bytes32(0),
144+
executionFeeRecipient,
145+
params.executionParams.executionFee
146+
);
142147
}
143148

144149
/**

‎test/evm/foundry/local/CounterfactualDepositCCTP.t.sol‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,12 @@ contract CounterfactualDepositTest is Test {
151151
burnToken.transfer(depositAddress, amount);
152152

153153
vm.expectEmit(true, true, true, true);
154-
emit ICounterfactualDeposit.DepositExecuted(depositAddress, expectedDeposit, nonce);
154+
emit ICounterfactualDeposit.CounterfactualDepositExecuted(
155+
expectedDeposit,
156+
nonce,
157+
relayer,
158+
defaultParams.executionParams.executionFee
159+
);
155160

156161
bytes memory executeCalldata = abi.encodeCall(
157162
CounterfactualDepositCCTP.executeDeposit,
@@ -274,7 +279,7 @@ contract CounterfactualDepositTest is Test {
274279
wrongToken.mint(depositAddress, 100e18);
275280

276281
vm.expectEmit(true, true, true, true);
277-
emit ICounterfactualDeposit.AdminWithdraw(depositAddress, address(wrongToken), admin, 100e18);
282+
emit ICounterfactualDeposit.AdminWithdraw(address(wrongToken), admin, 100e18);
278283

279284
vm.prank(admin);
280285
CounterfactualDepositCCTP(depositAddress).adminWithdraw(defaultParams, address(wrongToken), admin, 100e18);
@@ -302,7 +307,7 @@ contract CounterfactualDepositTest is Test {
302307
burnToken.transfer(depositAddress, 100e6);
303308

304309
vm.expectEmit(true, true, true, true);
305-
emit ICounterfactualDeposit.UserWithdraw(depositAddress, address(burnToken), user, 100e6);
310+
emit ICounterfactualDeposit.UserWithdraw(address(burnToken), user, 100e6);
306311

307312
vm.prank(user);
308313
CounterfactualDepositCCTP(depositAddress).userWithdraw(defaultParams, address(burnToken), user, 100e6);

‎test/evm/foundry/local/CounterfactualDepositOFT.t.sol‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,12 @@ contract CounterfactualOFTDepositTest is Test {
134134
token.transfer(depositAddress, amount);
135135

136136
vm.expectEmit(true, true, true, true);
137-
emit ICounterfactualDeposit.DepositExecuted(depositAddress, expectedDeposit, nonce);
137+
emit ICounterfactualDeposit.CounterfactualDepositExecuted(
138+
expectedDeposit,
139+
nonce,
140+
relayer,
141+
defaultParams.executionParams.executionFee
142+
);
138143

139144
bytes memory executeCalldata = abi.encodeCall(
140145
CounterfactualDepositOFT.executeDeposit,
@@ -320,7 +325,7 @@ contract CounterfactualOFTDepositTest is Test {
320325
wrongToken.mint(depositAddress, 100e18);
321326

322327
vm.expectEmit(true, true, true, true);
323-
emit ICounterfactualDeposit.AdminWithdraw(depositAddress, address(wrongToken), admin, 100e18);
328+
emit ICounterfactualDeposit.AdminWithdraw(address(wrongToken), admin, 100e18);
324329

325330
vm.prank(admin);
326331
CounterfactualDepositOFT(depositAddress).adminWithdraw(defaultParams, address(wrongToken), admin, 100e18);
@@ -347,7 +352,7 @@ contract CounterfactualOFTDepositTest is Test {
347352
token.transfer(depositAddress, 100e6);
348353

349354
vm.expectEmit(true, true, true, true);
350-
emit ICounterfactualDeposit.UserWithdraw(depositAddress, address(token), user, 100e6);
355+
emit ICounterfactualDeposit.UserWithdraw(address(token), user, 100e6);
351356

352357
vm.prank(user);
353358
CounterfactualDepositOFT(depositAddress).userWithdraw(defaultParams, address(token), user, 100e6);

‎test/evm/foundry/local/CounterfactualDepositSpokePool.t.sol‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,12 @@ contract CounterfactualSpokePoolDepositTest is Test {
189189
inputToken.transfer(depositAddress, inputAmount);
190190

191191
vm.expectEmit(true, true, true, true);
192-
emit ICounterfactualDeposit.DepositExecuted(depositAddress, expectedDeposit, bytes32(0));
192+
emit ICounterfactualDeposit.CounterfactualDepositExecuted(
193+
expectedDeposit,
194+
bytes32(0),
195+
relayer,
196+
defaultParams.executionParams.executionFee
197+
);
193198

194199
bytes memory executeCalldata = abi.encodeCall(
195200
CounterfactualDepositSpokePool.executeDeposit,
@@ -522,7 +527,7 @@ contract CounterfactualSpokePoolDepositTest is Test {
522527
wrongToken.mint(depositAddress, 100e18);
523528

524529
vm.expectEmit(true, true, true, true);
525-
emit ICounterfactualDeposit.AdminWithdraw(depositAddress, address(wrongToken), admin, 100e18);
530+
emit ICounterfactualDeposit.AdminWithdraw(address(wrongToken), admin, 100e18);
526531

527532
vm.prank(admin);
528533
CounterfactualDepositSpokePool(depositAddress).adminWithdraw(defaultParams, address(wrongToken), admin, 100e18);
@@ -549,7 +554,7 @@ contract CounterfactualSpokePoolDepositTest is Test {
549554
inputToken.transfer(depositAddress, 100e6);
550555

551556
vm.expectEmit(true, true, true, true);
552-
emit ICounterfactualDeposit.UserWithdraw(depositAddress, address(inputToken), user, 100e6);
557+
emit ICounterfactualDeposit.UserWithdraw(address(inputToken), user, 100e6);
553558

554559
vm.prank(user);
555560
CounterfactualDepositSpokePool(depositAddress).userWithdraw(defaultParams, address(inputToken), user, 100e6);

0 commit comments

Comments
 (0)