Skip to content

Commit

Permalink
doc: expand and fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
DhairyaSethi committed Dec 13, 2024
1 parent 565631d commit 9a2bcd4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,12 @@ contract UpgradeableBurnMintTokenPool is Initializable, UpgradeableBurnMintToken
}

/// @notice This function allows the owner to burn `amount` of the pool's token. This is
/// expected to be called while migrating liquidity to another pool and offboarding this
/// facilitator.
/// @dev New token pool should mint and transfer liquidity to this pool (since it does not
/// hold tokens any point in point, only mints/burns) which can be burnt and hence will reset
/// the facilitator bucket level GHO. This is needed to migrate facilitators, by offboarding
/// this token pool subsequently.
/// expected to be called while migrating facilitators by offboarding this facilitator in
/// favor of a new token pool.
/// @dev New token pool should mint and transfer liquidity to this pool (since this pool
/// does not hold tokens at any point in time) which can be burnt and hence will reduce
/// the facilitator bucket level on GHO. The naming convention mimics that in LockRelease
/// type token pools for the sake of consistency.
/// @param amount The amount of tokens to burn.
function withdrawLiquidity(uint256 amount) external onlyOwner {
IBurnMintERC20(address(i_token)).burn(amount);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
```diff
diff --git a/src/v0.8/ccip/pools/BurnMintTokenPool.sol b/src/v0.8/ccip/pools/GHO/UpgradeableBurnMintTokenPool.sol
index 9af0f22f4c..bbd4d018a5 100644
index 9af0f22f4c..3ce2c5a9ab 100644
--- a/src/v0.8/ccip/pools/BurnMintTokenPool.sol
+++ b/src/v0.8/ccip/pools/GHO/UpgradeableBurnMintTokenPool.sol
@@ -1,28 +1,102 @@
Expand Down Expand Up @@ -107,12 +107,12 @@ index 9af0f22f4c..bbd4d018a5 100644
+ }
+
+ /// @notice This function allows the owner to burn `amount` of the pool's token. This is
+ /// expected to be called while migrating liquidity to another pool and offboarding this
+ /// facilitator.
+ /// @dev New token pool should mint and transfer liquidity to this pool (since it does not
+ /// hold tokens any point in point, only mints/burns) which can be burnt and hence will reset
+ /// the facilitator bucket level GHO. This is needed to migrate facilitators, by offboarding
+ /// this token pool subsequently.
+ /// expected to be called while migrating facilitators by offboarding this facilitator in
+ /// favor of a new token pool.
+ /// @dev New token pool should mint and transfer liquidity to this pool (since this pool
+ /// does not hold tokens at any point in time) which can be burnt and hence will reduce
+ /// the facilitator bucket level on GHO. The naming convention mimics that in LockRelease
+ /// type token pools for the sake of consistency.
+ /// @param amount The amount of tokens to burn.
+ function withdrawLiquidity(uint256 amount) external onlyOwner {
+ IBurnMintERC20(address(i_token)).burn(amount);
Expand Down

0 comments on commit 9a2bcd4

Please sign in to comment.