Skip to content

Commit dcb63a7

Browse files
committed
doc: fix base diff doc
1 parent 59c3763 commit dcb63a7

File tree

4 files changed

+23
-19
lines changed

4 files changed

+23
-19
lines changed

contracts/src/v0.8/ccip/pools/GHO/UpgradeableBurnMintTokenPool.sol

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ import {IRouter} from "../../interfaces/IRouter.sol";
1818
/// - Move of allowlist and router definition to initialization stage
1919
/// - Addition of authorized functions to to directly mint/burn liquidity, thereby increasing/reducing the facilitator's bucket level.
2020
/// - Modifications from inherited contract (see contract for more details):
21-
/// - UpgradeableTokenPool: Remove i_token decimal check in constructor
22-
/// - Add storage `__gap` for future upgrades.
21+
/// - UpgradeableTokenPool:
22+
/// - Remove i_token decimal check in constructor
23+
/// - Add storage `__gap` for future upgrades.
2324

2425
/// @dev Pool whitelisting mode is set in the constructor and cannot be modified later.
2526
/// It either accepts any address as originalSender, or only accepts whitelisted originalSender.

contracts/src/v0.8/ccip/pools/GHO/UpgradeableLockReleaseTokenPool.sol

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ import {UpgradeableTokenPool} from "./UpgradeableTokenPool.sol";
2323
/// - Addition of a bridge limit to regulate the maximum amount of tokens that can be transferred out (burned/locked)
2424
/// - Addition of authorized function to update amount of tokens that are currently bridged
2525
/// - Modifications from inherited contract (see contract for more details):
26-
/// - UpgradeableTokenPool: Remove i_token decimal check in constructor
27-
/// - Add storage `__gap` for future upgrades.
26+
/// - UpgradeableTokenPool
27+
/// - Remove i_token decimal check in constructor
28+
/// - Add storage `__gap` for future upgrades.
2829

2930
/// @dev Token pool used for tokens on their native chain. This uses a lock and release mechanism.
3031
/// Because of lock/unlock requiring liquidity, this pool contract also has function to add and remove

contracts/src/v0.8/ccip/pools/GHO/diffs/UpgradeableBurnMintTokenPool_diff.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
```diff
22
diff --git a/src/v0.8/ccip/pools/BurnMintTokenPool.sol b/src/v0.8/ccip/pools/GHO/UpgradeableBurnMintTokenPool.sol
3-
index 30203a4ced..80ef621eff 100644
3+
index 30203a4ced..6c1813f51d 100644
44
--- a/src/v0.8/ccip/pools/BurnMintTokenPool.sol
55
+++ b/src/v0.8/ccip/pools/GHO/UpgradeableBurnMintTokenPool.sol
6-
@@ -1,33 +1,74 @@
6+
@@ -1,33 +1,75 @@
77
// SPDX-License-Identifier: BUSL-1.1
88
-pragma solidity 0.8.24;
99
+pragma solidity ^0.8.0;
@@ -29,8 +29,9 @@ index 30203a4ced..80ef621eff 100644
2929
+/// - Move of allowlist and router definition to initialization stage
3030
+/// - Addition of authorized functions to to directly mint/burn liquidity, thereby increasing/reducing the facilitator's bucket level.
3131
+/// - Modifications from inherited contract (see contract for more details):
32-
+/// - UpgradeableTokenPool: Remove i_token decimal check in constructor
33-
+/// - Add storage `__gap` for future upgrades.
32+
+/// - UpgradeableTokenPool:
33+
+/// - Remove i_token decimal check in constructor
34+
+/// - Add storage `__gap` for future upgrades.
3435

3536
-/// @notice This pool mints and burns a 3rd-party token.
3637
/// @dev Pool whitelisting mode is set in the constructor and cannot be modified later.

contracts/src/v0.8/ccip/pools/GHO/diffs/UpgradeableLockReleaseTokenPool_diff.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
```diff
22
diff --git a/src/v0.8/ccip/pools/LockReleaseTokenPool.sol b/src/v0.8/ccip/pools/GHO/UpgradeableLockReleaseTokenPool.sol
3-
index ecc28a14dd..5d5e055299 100644
3+
index ecc28a14dd..f8ed82bcc7 100644
44
--- a/src/v0.8/ccip/pools/LockReleaseTokenPool.sol
55
+++ b/src/v0.8/ccip/pools/GHO/UpgradeableLockReleaseTokenPool.sol
6-
@@ -1,25 +1,45 @@
6+
@@ -1,25 +1,46 @@
77
// SPDX-License-Identifier: BUSL-1.1
88
-pragma solidity 0.8.24;
99
+pragma solidity ^0.8.0;
@@ -38,8 +38,9 @@ index ecc28a14dd..5d5e055299 100644
3838
+/// - Addition of a bridge limit to regulate the maximum amount of tokens that can be transferred out (burned/locked)
3939
+/// - Addition of authorized function to update amount of tokens that are currently bridged
4040
+/// - Modifications from inherited contract (see contract for more details):
41-
+/// - UpgradeableTokenPool: Remove i_token decimal check in constructor
42-
+/// - Add storage `__gap` for future upgrades.
41+
+/// - UpgradeableTokenPool
42+
+/// - Remove i_token decimal check in constructor
43+
+/// - Add storage `__gap` for future upgrades.
4344
+
4445
+/// @dev Token pool used for tokens on their native chain. This uses a lock and release mechanism.
4546
/// Because of lock/unlock requiring liquidity, this pool contract also has function to add and remove
@@ -59,7 +60,7 @@ index ecc28a14dd..5d5e055299 100644
5960

6061
event LiquidityTransferred(address indexed from, uint256 amount);
6162

62-
@@ -33,30 +53,69 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
63+
@@ -33,30 +54,69 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
6364
/// @notice The address of the rebalancer.
6465
address internal s_rebalancer;
6566

@@ -138,7 +139,7 @@ index ecc28a14dd..5d5e055299 100644
138139
}
139140

140141
/// @notice Release tokens from the pool to the recipient
141-
@@ -64,11 +123,18 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
142+
@@ -64,11 +124,18 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
142143
function releaseOrMint(
143144
Pool.ReleaseOrMintInV1 calldata releaseOrMintIn
144145
) external virtual override returns (Pool.ReleaseOrMintOutV1 memory) {
@@ -159,7 +160,7 @@ index ecc28a14dd..5d5e055299 100644
159160

160161
// Release to the recipient
161162
getToken().safeTransfer(releaseOrMintIn.receiver, localAmount);
162-
@@ -79,9 +145,7 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
163+
@@ -79,9 +146,7 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
163164
}
164165

165166
/// @inheritdoc IERC165
@@ -170,7 +171,7 @@ index ecc28a14dd..5d5e055299 100644
170171
return interfaceId == type(ILiquidityContainer).interfaceId || super.supportsInterface(interfaceId);
171172
}
172173

173-
@@ -93,12 +157,55 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
174+
@@ -93,12 +158,55 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
174175

175176
/// @notice Sets the LiquidityManager address.
176177
/// @dev Only callable by the owner.
@@ -229,7 +230,7 @@ index ecc28a14dd..5d5e055299 100644
229230
/// @notice Checks if the pool can accept liquidity.
230231
/// @return true if the pool can accept liquidity, false otherwise.
231232
function canAcceptLiquidity() external view returns (bool) {
232-
@@ -107,9 +214,7 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
233+
@@ -107,9 +215,7 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
233234

234235
/// @notice Adds liquidity to the pool. The tokens should be approved first.
235236
/// @param amount The amount of liquidity to provide.
@@ -240,7 +241,7 @@ index ecc28a14dd..5d5e055299 100644
240241
if (!i_acceptLiquidity) revert LiquidityNotAccepted();
241242
if (s_rebalancer != msg.sender) revert Unauthorized(msg.sender);
242243

243-
@@ -119,9 +224,7 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
244+
@@ -119,9 +225,7 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
244245

245246
/// @notice Removed liquidity to the pool. The tokens will be sent to msg.sender.
246247
/// @param amount The amount of liquidity to remove.
@@ -251,7 +252,7 @@ index ecc28a14dd..5d5e055299 100644
251252
if (s_rebalancer != msg.sender) revert Unauthorized(msg.sender);
252253

253254
if (i_token.balanceOf(address(this)) < amount) revert InsufficientLiquidity();
254-
@@ -141,7 +244,7 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
255+
@@ -141,7 +245,7 @@ contract LockReleaseTokenPool is TokenPool, ILiquidityContainer, ITypeAndVersion
255256
/// @param from The address of the old pool.
256257
/// @param amount The amount of liquidity to transfer.
257258
function transferLiquidity(address from, uint256 amount) external onlyOwner {

0 commit comments

Comments
 (0)