Skip to content

Commit 83d1069

Browse files
authored
fix: Fix "outbound" spelling typo (#78)
1 parent 90e0be9 commit 83d1069

File tree

6 files changed

+58
-58
lines changed

6 files changed

+58
-58
lines changed

docs/soldoc/src/src/bridges/layerZero/IexecLayerZeroBridge.sol/contract.IexecLayerZeroBridge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ function unpause() external onlyRole(PAUSER_ROLE);
148148
LEVEL 2: Pauses only outbound transfers.
149149

150150
*Can only be called by accounts with PAUSER_ROLE
151-
When outbount transfers are paused:
151+
When outbound transfers are paused:
152152
- All _debit operations (outbound transfers) are blocked
153153
- All _credit operations (inbound transfers) still work
154154
- Users can still receive funds and "exit" their positions

docs/soldoc/src/src/bridges/utils/DualPausableUpgradeable.sol/abstract.DualPausableUpgradeable.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,24 @@ function _getDualPausableStorage() private pure returns (DualPausableStorage sto
3838

3939
### whenOutboundTransfersNotPaused
4040

41-
Use this modifier for functions that should be blocked during outbount transfer pause
41+
Use this modifier for functions that should be blocked during outbound transfer pause
4242

43-
*Modifier for send operations - blocks when outbount transfer is paused*
43+
*Modifier for send operations - blocks when outbound transfer is paused*
4444

4545

4646
```solidity
4747
modifier whenOutboundTransfersNotPaused();
4848
```
4949

50-
### whenOutbountTransfersPaused
50+
### whenOutboundTransfersPaused
5151

52-
Use this modifier for administrative functions that should only work during outbount transfer pause
52+
Use this modifier for administrative functions that should only work during outbound transfer pause
5353

5454
*Modifier to make a function callable only when send operations are paused*
5555

5656

5757
```solidity
58-
modifier whenOutbountTransfersPaused();
58+
modifier whenOutboundTransfersPaused();
5959
```
6060

6161
### __DualPausable_init
@@ -72,13 +72,13 @@ function __DualPausable_init() internal onlyInitializing;
7272
function __DualPausable_init_unchained() internal onlyInitializing;
7373
```
7474

75-
### outbountTransfersPaused
75+
### outboundTransfersPaused
7676

7777
*Returns true if send operations are paused, false otherwise*
7878

7979

8080
```solidity
81-
function outbountTransfersPaused() public view virtual returns (bool);
81+
function outboundTransfersPaused() public view virtual returns (bool);
8282
```
8383

8484
### pauseStatus
@@ -94,30 +94,30 @@ function pauseStatus() public view virtual returns (bool fullyPaused, bool onlyO
9494
|Name|Type|Description|
9595
|----|----|-----------|
9696
|`fullyPaused`|`bool`|True if complete pause is active (blocks all operations)|
97-
|`onlyOutboundTransfersPaused`|`bool`|True if outbount transfer pause is active (blocks only send operations)|
97+
|`onlyOutboundTransfersPaused`|`bool`|True if outbound transfer pause is active (blocks only send operations)|
9898

9999

100-
### _requireOutbountTransfersNotPaused
100+
### _requireOutboundTransfersNotPaused
101101

102102
*Throws if send operations are paused*
103103

104104

105105
```solidity
106-
function _requireOutbountTransfersNotPaused() internal view virtual;
106+
function _requireOutboundTransfersNotPaused() internal view virtual;
107107
```
108108

109-
### _requireOutbountTransfersPaused
109+
### _requireOutboundTransfersPaused
110110

111111
*Throws if send operations are not paused*
112112

113113

114114
```solidity
115-
function _requireOutbountTransfersPaused() internal view virtual;
115+
function _requireOutboundTransfersPaused() internal view virtual;
116116
```
117117

118118
### _pauseOutboundTransfers
119119

120-
*Triggers outbount transfers pause.
120+
*Triggers outbound transfers pause.
121121
Requirements:
122122
- Send operations must not already be paused*
123123

@@ -128,26 +128,26 @@ function _pauseOutboundTransfers() internal virtual whenOutboundTransfersNotPaus
128128

129129
### _unpauseOutboundTransfers
130130

131-
*Unpauses outbount transfers.
131+
*Unpauses outbound transfers.
132132
Requirements:
133133
- Send operations must already be paused*
134134

135135

136136
```solidity
137-
function _unpauseOutboundTransfers() internal virtual whenOutbountTransfersPaused;
137+
function _unpauseOutboundTransfers() internal virtual whenOutboundTransfersPaused;
138138
```
139139

140140
## Events
141141
### OutboundTransfersPaused
142-
*Emitted when outbount transfer pause is triggered by `account`*
142+
*Emitted when outbound transfer pause is triggered by `account`*
143143

144144

145145
```solidity
146146
event OutboundTransfersPaused(address account);
147147
```
148148

149149
### OutboundTransfersUnpaused
150-
*Emitted when outbount transfer pause is lifted by `account`*
150+
*Emitted when outbound transfer pause is lifted by `account`*
151151

152152

153153
```solidity

src/bridges/layerZero/IexecLayerZeroBridge.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ contract IexecLayerZeroBridge is
146146
* @notice LEVEL 2: Pauses only outbound transfers.
147147
* @dev Can only be called by accounts with PAUSER_ROLE
148148
*
149-
* When outbount transfers are paused:
149+
* When outbound transfers are paused:
150150
* - All _debit operations (outbound transfers) are blocked
151151
* - All _credit operations (inbound transfers) still work
152152
* - Users can still receive funds and "exit" their positions

src/bridges/utils/DualPausableUpgradeable.sol

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ abstract contract DualPausableUpgradeable is PausableUpgradeable {
4242
// ============ EVENTS ============
4343

4444
/**
45-
* @dev Emitted when outbount transfer pause is triggered by `account`
45+
* @dev Emitted when outbound transfer pause is triggered by `account`
4646
*/
4747
event OutboundTransfersPaused(address account);
4848

4949
/**
50-
* @dev Emitted when outbount transfer pause is lifted by `account`
50+
* @dev Emitted when outbound transfer pause is lifted by `account`
5151
*/
5252
event OutboundTransfersUnpaused(address account);
5353

@@ -66,20 +66,20 @@ abstract contract DualPausableUpgradeable is PausableUpgradeable {
6666
// ============ MODIFIERS ============
6767

6868
/**
69-
* @dev Modifier for send operations - blocks when outbount transfer is paused
70-
* @notice Use this modifier for functions that should be blocked during outbount transfer pause
69+
* @dev Modifier for send operations - blocks when outbound transfer is paused
70+
* @notice Use this modifier for functions that should be blocked during outbound transfer pause
7171
*/
7272
modifier whenOutboundTransfersNotPaused() {
73-
_requireOutbountTransfersNotPaused();
73+
_requireOutboundTransfersNotPaused();
7474
_;
7575
}
7676

7777
/**
7878
* @dev Modifier to make a function callable only when send operations are paused
79-
* @notice Use this modifier for administrative functions that should only work during outbount transfer pause
79+
* @notice Use this modifier for administrative functions that should only work during outbound transfer pause
8080
*/
81-
modifier whenOutbountTransfersPaused() {
82-
_requireOutbountTransfersPaused();
81+
modifier whenOutboundTransfersPaused() {
82+
_requireOutboundTransfersPaused();
8383
_;
8484
}
8585

@@ -101,43 +101,43 @@ abstract contract DualPausableUpgradeable is PausableUpgradeable {
101101
/**
102102
* @dev Returns true if send operations are paused, false otherwise
103103
*/
104-
function outbountTransfersPaused() public view virtual returns (bool) {
104+
function outboundTransfersPaused() public view virtual returns (bool) {
105105
DualPausableStorage storage $ = _getDualPausableStorage();
106106
return $._outboundTransfersPaused;
107107
}
108108

109109
/**
110110
* @dev Returns the overall operational state of the contract
111111
* @return fullyPaused True if complete pause is active (blocks all operations)
112-
* @return onlyOutboundTransfersPaused True if outbount transfer pause is active (blocks only send operations)
112+
* @return onlyOutboundTransfersPaused True if outbound transfer pause is active (blocks only send operations)
113113
*/
114114
function pauseStatus() public view virtual returns (bool fullyPaused, bool onlyOutboundTransfersPaused) {
115115
fullyPaused = paused();
116-
onlyOutboundTransfersPaused = outbountTransfersPaused();
116+
onlyOutboundTransfersPaused = outboundTransfersPaused();
117117
}
118118

119119
// ============ INTERNAL FUNCTIONS ============
120120

121121
/**
122122
* @dev Throws if send operations are paused
123123
*/
124-
function _requireOutbountTransfersNotPaused() internal view virtual {
125-
if (outbountTransfersPaused()) {
124+
function _requireOutboundTransfersNotPaused() internal view virtual {
125+
if (outboundTransfersPaused()) {
126126
revert EnforcedOutboundTransfersPause();
127127
}
128128
}
129129

130130
/**
131131
* @dev Throws if send operations are not paused
132132
*/
133-
function _requireOutbountTransfersPaused() internal view virtual {
134-
if (!outbountTransfersPaused()) {
133+
function _requireOutboundTransfersPaused() internal view virtual {
134+
if (!outboundTransfersPaused()) {
135135
revert ExpectedOutboundTransfersPause();
136136
}
137137
}
138138

139139
/**
140-
* @dev Triggers outbount transfers pause.
140+
* @dev Triggers outbound transfers pause.
141141
* Requirements:
142142
* - Send operations must not already be paused
143143
*/
@@ -148,11 +148,11 @@ abstract contract DualPausableUpgradeable is PausableUpgradeable {
148148
}
149149

150150
/**
151-
* @dev Unpauses outbount transfers.
151+
* @dev Unpauses outbound transfers.
152152
* Requirements:
153153
* - Send operations must already be paused
154154
*/
155-
function _unpauseOutboundTransfers() internal virtual whenOutbountTransfersPaused {
155+
function _unpauseOutboundTransfers() internal virtual whenOutboundTransfersPaused {
156156
DualPausableStorage storage $ = _getDualPausableStorage();
157157
$._outboundTransfersPaused = false;
158158
emit OutboundTransfersUnpaused(_msgSender());

test/units/bridges/layerZero/IexecLayerZeroBridge.t.sol

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ contract IexecLayerZeroBridgeTest is TestHelperOz5 {
223223
assertEq(rlcCrosschainToken.balanceOf(user1), INITIAL_BALANCE - TRANSFER_AMOUNT);
224224
}
225225

226-
// ============ LEVEL 2 PAUSE TESTS (Outbount transfer pause) ============
226+
// ============ LEVEL 2 PAUSE TESTS (Outbound transfer pause) ============
227227

228228
function test_PauseOutboundTransfers_OnlyPauserRole() public {
229229
vm.expectRevert();
@@ -238,7 +238,7 @@ contract IexecLayerZeroBridgeTest is TestHelperOz5 {
238238

239239
// Verify state
240240
assertFalse(iexecLayerZeroBridgeChainX.paused());
241-
assertTrue(iexecLayerZeroBridgeChainX.outbountTransfersPaused());
241+
assertTrue(iexecLayerZeroBridgeChainX.outboundTransfersPaused());
242242

243243
// Prepare send parameters
244244
(SendParam memory sendParam, MessagingFee memory fee) =
@@ -264,7 +264,7 @@ contract IexecLayerZeroBridgeTest is TestHelperOz5 {
264264

265265
// Should now work normally
266266
assertFalse(iexecLayerZeroBridgeChainX.paused());
267-
assertFalse(iexecLayerZeroBridgeChainX.outbountTransfersPaused());
267+
assertFalse(iexecLayerZeroBridgeChainX.outboundTransfersPaused());
268268

269269
test_SendToken_WhenOperational_WithoutApproval();
270270
}

test/units/bridges/utils/DualPausableUpgradeable.t.sol

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ contract DualPausableUpgradeableTest is Test {
3030
// ============ initialize ============
3131

3232
function test_initialize_SetsCorrectInitialStates() public view {
33-
assertFalse(dualPausable.outbountTransfersPaused(), "Outbound transfers should not be paused initially");
33+
assertFalse(dualPausable.outboundTransfersPaused(), "Outbound transfers should not be paused initially");
3434

3535
(bool fullyPaused, bool onlyOutboundTransfersPaused) = dualPausable.pauseStatus();
3636
assertFalse(fullyPaused, "Contract should not be fully paused initially");
@@ -51,7 +51,7 @@ contract DualPausableUpgradeableTest is Test {
5151
dualPausable.pauseOutboundTransfers();
5252

5353
assertTrue(
54-
dualPausable.outbountTransfersPaused(), "Outbound transfers should be paused after pauseOutboundTransfers"
54+
dualPausable.outboundTransfersPaused(), "Outbound transfers should be paused after pauseOutboundTransfers"
5555
);
5656

5757
vm.expectRevert(DualPausableUpgradeable.EnforcedOutboundTransfersPause.selector);
@@ -82,18 +82,18 @@ contract DualPausableUpgradeableTest is Test {
8282
function test_unpauseOutboundTransfers_RestoresOperations() public {
8383
vm.startPrank(OWNER);
8484
dualPausable.pauseOutboundTransfers();
85-
assertTrue(dualPausable.outbountTransfersPaused(), "Outbound transfers should be paused before unpause");
85+
assertTrue(dualPausable.outboundTransfersPaused(), "Outbound transfers should be paused before unpause");
8686

8787
dualPausable.unpauseOutboundTransfers();
8888
vm.stopPrank();
8989

90-
assertFalse(dualPausable.outbountTransfersPaused(), "Outbound transfers should not be paused after unpause");
90+
assertFalse(dualPausable.outboundTransfersPaused(), "Outbound transfers should not be paused after unpause");
9191

9292
// Operation should work normally
9393
assertTrue(dualPausable.mockOperation(), "Mock operation should succeed after unpause");
9494
}
9595

96-
function test_RevertWhen_OutbountTransfersNotPaused() public {
96+
function test_RevertWhen_OutboundTransfersNotPaused() public {
9797
vm.expectRevert(DualPausableUpgradeable.ExpectedOutboundTransfersPause.selector);
9898
dualPausable.unpauseOutboundTransfers();
9999
}
@@ -125,17 +125,17 @@ contract DualPausableUpgradeableTest is Test {
125125
assertFalse(fullyPaused, "Contract should not be fully paused initially");
126126
assertFalse(onlyOutboundTransfersPaused, "Outbound transfers should not be paused initially");
127127

128-
// After outbount transfer pause
128+
// After outbound transfer pause
129129
vm.prank(OWNER);
130130
dualPausable.pauseOutboundTransfers();
131131

132132
(fullyPaused, onlyOutboundTransfersPaused) = dualPausable.pauseStatus();
133-
assertFalse(fullyPaused, "Contract should not be fully paused during outbount transfer pause");
133+
assertFalse(fullyPaused, "Contract should not be fully paused during outbound transfer pause");
134134
assertTrue(
135-
onlyOutboundTransfersPaused, "Outbound transfers should be paused during outbount transfers pause state"
135+
onlyOutboundTransfersPaused, "Outbound transfers should be paused during outbound transfers pause state"
136136
);
137137

138-
// After full pause (from outbount transfer only pause state)
138+
// After full pause (from outbound transfer only pause state)
139139
vm.prank(OWNER);
140140
dualPausable.pause();
141141

@@ -148,17 +148,17 @@ contract DualPausableUpgradeableTest is Test {
148148

149149
// Make sure `pause()` does not impact `pauseOutboundTransfers()`.
150150
function test_DualPause_PauseFromOnlyOutboundTransfersToFull() public {
151-
// Start with outbount transfer pause
151+
// Start with outbound transfer pause
152152
vm.startPrank(OWNER);
153153
dualPausable.pauseOutboundTransfers();
154-
assertTrue(dualPausable.outbountTransfersPaused());
154+
assertTrue(dualPausable.outboundTransfersPaused());
155155
assertFalse(dualPausable.paused());
156156

157157
dualPausable.pause();
158158
vm.stopPrank();
159159

160160
assertTrue(dualPausable.paused());
161-
assertTrue(dualPausable.outbountTransfersPaused());
161+
assertTrue(dualPausable.outboundTransfersPaused());
162162
}
163163

164164
// Make sure `pauseOutboundTransfers()` does not impact `pause()`.
@@ -167,13 +167,13 @@ contract DualPausableUpgradeableTest is Test {
167167
vm.startPrank(OWNER);
168168
dualPausable.pause();
169169
assertTrue(dualPausable.paused());
170-
assertFalse(dualPausable.outbountTransfersPaused());
170+
assertFalse(dualPausable.outboundTransfersPaused());
171171
// pauseOutboundTransfers
172172
dualPausable.pauseOutboundTransfers();
173173
vm.stopPrank();
174174
// Check status
175175
assertTrue(dualPausable.paused());
176-
assertTrue(dualPausable.outbountTransfersPaused());
176+
assertTrue(dualPausable.outboundTransfersPaused());
177177
}
178178

179179
function test_DualPause_PauseShouldNotImpactOutboundTransfersPause() public {
@@ -182,12 +182,12 @@ contract DualPausableUpgradeableTest is Test {
182182
dualPausable.pause();
183183
dualPausable.pauseOutboundTransfers();
184184
assertTrue(dualPausable.paused());
185-
assertTrue(dualPausable.outbountTransfersPaused());
185+
assertTrue(dualPausable.outboundTransfersPaused());
186186
// unpause
187187
dualPausable.unpause();
188188
assertFalse(dualPausable.paused());
189189
// pauseOutboundTransfers should still be active
190-
assertTrue(dualPausable.outbountTransfersPaused(), "Outbound transfers should remain paused after unpause");
190+
assertTrue(dualPausable.outboundTransfersPaused(), "Outbound transfers should remain paused after unpause");
191191
vm.stopPrank();
192192
}
193193

@@ -197,10 +197,10 @@ contract DualPausableUpgradeableTest is Test {
197197
dualPausable.pause();
198198
dualPausable.pauseOutboundTransfers();
199199
assertTrue(dualPausable.paused());
200-
assertTrue(dualPausable.outbountTransfersPaused());
200+
assertTrue(dualPausable.outboundTransfersPaused());
201201
// unpauseOutboundTransfers
202202
dualPausable.unpauseOutboundTransfers();
203-
assertFalse(dualPausable.outbountTransfersPaused());
203+
assertFalse(dualPausable.outboundTransfersPaused());
204204
// pause should still be active
205205
assertTrue(dualPausable.paused(), "Pause should remain active after unpauseOutboundTransfers");
206206
vm.stopPrank();

0 commit comments

Comments
 (0)