-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
768 additions
and
133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletions
6
...ip/pools/UpgradeableBurnMintTokenPool.sol → ...ools/GHO/UpgradeableBurnMintTokenPool.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
.../UpgradeableBurnMintTokenPoolAbstract.sol → .../UpgradeableBurnMintTokenPoolAbstract.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 6 additions & 6 deletions
12
...pools/UpgradeableLockReleaseTokenPool.sol → ...s/GHO/UpgradeableLockReleaseTokenPool.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 8 additions & 8 deletions
16
.../v0.8/ccip/pools/UpgradeableTokenPool.sol → ...8/ccip/pools/GHO/UpgradeableTokenPool.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
21 changes: 21 additions & 0 deletions
21
contracts/src/v0.8/ccip/pools/GHO/diffs/BurnMintTokenPoolAbstract_diff.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| ```diff | ||
| diff --git a/src/v0.8/ccip/pools/BurnMintTokenPoolAbstract.sol b/src/v0.8/ccip/pools/UpgradeableBurnMintTokenPoolAbstract.sol | ||
| index f5eb135186..651965e40b 100644 | ||
| --- a/src/v0.8/ccip/pools/BurnMintTokenPoolAbstract.sol | ||
| +++ b/src/v0.8/ccip/pools/UpgradeableBurnMintTokenPoolAbstract.sol | ||
| @@ -1,11 +1,11 @@ | ||
| // SPDX-License-Identifier: BUSL-1.1 | ||
| -pragma solidity 0.8.19; | ||
| +pragma solidity ^0.8.0; | ||
|
|
||
| import {IBurnMintERC20} from "../../shared/token/ERC20/IBurnMintERC20.sol"; | ||
|
|
||
| -import {TokenPool} from "./TokenPool.sol"; | ||
| +import {UpgradeableTokenPool} from "./UpgradeableTokenPool.sol"; | ||
|
|
||
| -abstract contract BurnMintTokenPoolAbstract is TokenPool { | ||
| +abstract contract UpgradeableBurnMintTokenPoolAbstract is UpgradeableTokenPool { | ||
| /// @notice Contains the specific burn call for a pool. | ||
| /// @dev overriding this method allows us to create pools with different burn signatures | ||
| /// without duplicating the underlying logic. | ||
| ``` |
87 changes: 87 additions & 0 deletions
87
contracts/src/v0.8/ccip/pools/GHO/diffs/BurnMintTokenPool_diff.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| ```diff | ||
| diff --git a/src/v0.8/ccip/pools/BurnMintTokenPool.sol b/src/v0.8/ccip/pools/UpgradeableBurnMintTokenPool.sol | ||
| index 9af0f22f4c..f07f8c3a28 100644 | ||
| --- a/src/v0.8/ccip/pools/BurnMintTokenPool.sol | ||
| +++ b/src/v0.8/ccip/pools/UpgradeableBurnMintTokenPool.sol | ||
| @@ -1,29 +1,66 @@ | ||
| // SPDX-License-Identifier: BUSL-1.1 | ||
| -pragma solidity 0.8.19; | ||
| +pragma solidity ^0.8.0; | ||
|
|
||
| import {ITypeAndVersion} from "../../shared/interfaces/ITypeAndVersion.sol"; | ||
| import {IBurnMintERC20} from "../../shared/token/ERC20/IBurnMintERC20.sol"; | ||
|
|
||
| -import {TokenPool} from "./TokenPool.sol"; | ||
| -import {BurnMintTokenPoolAbstract} from "./BurnMintTokenPoolAbstract.sol"; | ||
| +import {UpgradeableTokenPool} from "./UpgradeableTokenPool.sol"; | ||
| +import {UpgradeableBurnMintTokenPoolAbstract} from "./UpgradeableBurnMintTokenPoolAbstract.sol"; | ||
|
|
||
| -/// @notice This pool mints and burns a 3rd-party token. | ||
| -/// @dev Pool whitelisting mode is set in the constructor and cannot be modified later. | ||
| -/// It either accepts any address as originalSender, or only accepts whitelisted originalSender. | ||
| -/// The only way to change whitelisting mode is to deploy a new pool. | ||
| -/// If that is expected, please make sure the token's burner/minter roles are adjustable. | ||
| -contract BurnMintTokenPool is BurnMintTokenPoolAbstract, ITypeAndVersion { | ||
| +import {IRouter} from "../interfaces/IRouter.sol"; | ||
| +import {VersionedInitializable} from "./VersionedInitializable.sol"; | ||
| + | ||
| +/// @title UpgradeableBurnMintTokenPool | ||
| +/// @author Aave Labs | ||
| +/// @notice Upgradeable version of Chainlink's CCIP BurnMintTokenPool | ||
| +/// @dev Contract adaptations: | ||
| +/// - Implementation of VersionedInitializable to allow upgrades | ||
| +/// - Move of allowlist and router definition to initialization stage | ||
| +contract UpgradeableBurnMintTokenPool is VersionedInitializable, UpgradeableBurnMintTokenPoolAbstract, ITypeAndVersion { | ||
| string public constant override typeAndVersion = "BurnMintTokenPool 1.4.0"; | ||
|
|
||
| + /// @dev Constructor | ||
| + /// @param token The bridgeable token that is managed by this pool. | ||
| + /// @param armProxy The address of the arm proxy | ||
| + /// @param allowlistEnabled True if pool is set to access-controlled mode, false otherwise | ||
| constructor( | ||
| - IBurnMintERC20 token, | ||
| - address[] memory allowlist, | ||
| + address token, | ||
| address armProxy, | ||
| - address router | ||
| - ) TokenPool(token, allowlist, armProxy, router) {} | ||
| + bool allowlistEnabled | ||
| + ) UpgradeableTokenPool(IBurnMintERC20(token), armProxy, allowlistEnabled) {} | ||
|
|
||
| - /// @inheritdoc BurnMintTokenPoolAbstract | ||
| + /// @dev Initializer | ||
| + /// @dev The address passed as `owner` must accept ownership after initialization. | ||
| + /// @dev The `allowlist` is only effective if pool is set to access-controlled mode | ||
| + /// @param owner The address of the owner | ||
| + /// @param allowlist A set of addresses allowed to trigger lockOrBurn as original senders | ||
| + /// @param router The address of the router | ||
| + function initialize(address owner, address[] memory allowlist, address router) public virtual initializer { | ||
| + if (owner == address(0)) revert ZeroAddressNotAllowed(); | ||
| + if (router == address(0)) revert ZeroAddressNotAllowed(); | ||
| + _transferOwnership(owner); | ||
| + | ||
| + s_router = IRouter(router); | ||
| + | ||
| + // Pool can be set as permissioned or permissionless at deployment time only to save hot-path gas. | ||
| + if (i_allowlistEnabled) { | ||
| + _applyAllowListUpdates(new address[](0), allowlist); | ||
| + } | ||
| + } | ||
| + | ||
| + /// @inheritdoc UpgradeableBurnMintTokenPoolAbstract | ||
| function _burn(uint256 amount) internal virtual override { | ||
| IBurnMintERC20(address(i_token)).burn(amount); | ||
| } | ||
| + | ||
| + /// @notice Returns the revision number | ||
| + /// @return The revision number | ||
| + function REVISION() public pure virtual returns (uint256) { | ||
| + return 1; | ||
| + } | ||
| + | ||
| + /// @inheritdoc VersionedInitializable | ||
| + function getRevision() internal pure virtual override returns (uint256) { | ||
| + return REVISION(); | ||
| + } | ||
| } | ||
| ``` |
Oops, something went wrong.