forked from smartcontractkit/ccip
-
Notifications
You must be signed in to change notification settings - Fork 3
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
1 parent
59a6cb5
commit 95faba9
Showing
7 changed files
with
141 additions
and
272 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
56 changes: 0 additions & 56 deletions
56
contracts/src/v0.8/ccip/pools/GHO/UpgradeableBurnMintTokenPoolOld.sol
This file was deleted.
Oops, something went wrong.
113 changes: 113 additions & 0 deletions
113
contracts/src/v0.8/ccip/pools/GHO/UpgradeableBurnMintTokenPoolV2.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| // SPDX-License-Identifier: BUSL-1.1 | ||
| pragma solidity ^0.8.0; | ||
|
|
||
| import {Initializable} from "solidity-utils/contracts/transparent-proxy/Initializable.sol"; | ||
|
|
||
| import {ITypeAndVersion} from "../../../shared/interfaces/ITypeAndVersion.sol"; | ||
| import {IBurnMintERC20} from "../../../shared/token/ERC20/IBurnMintERC20.sol"; | ||
|
|
||
| import {UpgradeableTokenPool} from "./UpgradeableTokenPool.sol"; | ||
| import {UpgradeableBurnMintTokenPoolAbstract} from "./UpgradeableBurnMintTokenPoolAbstract.sol"; | ||
| import {RateLimiter} from "../../libraries/RateLimiter.sol"; | ||
|
|
||
| import {IRouter} from "../../interfaces/IRouter.sol"; | ||
|
|
||
| /// @title UpgradeableBurnMintTokenPoolV2 | ||
| /// @author Aave Labs | ||
| /// @notice Upgradeable version of Chainlink's CCIP BurnMintTokenPool | ||
| /// @dev Contract adaptations: | ||
| /// - Implementation of Initializable to allow upgrades | ||
| /// - Move of allowlist and router definition to initialization stage | ||
| contract UpgradeableBurnMintTokenPoolV2 is Initializable, UpgradeableBurnMintTokenPoolAbstract, ITypeAndVersion { | ||
| error Unauthorized(address caller); | ||
|
|
||
| string public constant override typeAndVersion = "BurnMintTokenPool 1.4.0"; | ||
|
|
||
| /// @dev The unique burn mint pool flag to signal through EIP 165. | ||
| bytes4 private constant BURN_MINT_INTERFACE_ID = bytes4(keccak256("BurnMintTokenPool")); | ||
|
|
||
| /// @dev Whether or not the pool accepts liquidity. | ||
| /// External liquidity is not required when there is one canonical token deployed to a chain, | ||
| /// and CCIP is facilitating mint/burn on all the other chains, in which case the invariant | ||
| /// balanceOf(pool) on home chain == sum(totalSupply(mint/burn "wrapped" token) on all remote chains) should always hold | ||
| bool internal immutable i_acceptLiquidity; | ||
| /// @notice The address of the rebalancer. | ||
| address internal s_rebalancer; | ||
| /// @notice The address of the rate limiter admin. | ||
| /// @dev Can be address(0) if none is configured. | ||
| address internal s_rateLimitAdmin; | ||
|
|
||
| /// @notice Maximum amount of tokens that can be bridged to other chains | ||
| uint256 private s_bridgeLimit; | ||
| /// @notice Amount of tokens bridged (transferred out) | ||
| /// @dev Must always be equal to or below the bridge limit | ||
| uint256 private s_currentBridged; | ||
| /// @notice The address of the bridge limit admin. | ||
| /// @dev Can be address(0) if none is configured. | ||
| address internal s_bridgeLimitAdmin; | ||
|
|
||
| /// @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( | ||
| address token, | ||
| address armProxy, | ||
| bool allowlistEnabled, | ||
| bool acceptLiquidity | ||
| ) UpgradeableTokenPool(IBurnMintERC20(token), armProxy, allowlistEnabled) { | ||
| i_acceptLiquidity = acceptLiquidity; | ||
| } | ||
|
|
||
| /// @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); | ||
| } | ||
| } | ||
|
|
||
| /// @notice Sets the rate limiter admin address. | ||
| /// @dev Only callable by the owner. | ||
| /// @param rateLimitAdmin The new rate limiter admin address. | ||
| function setRateLimitAdmin(address rateLimitAdmin) external onlyOwner { | ||
| s_rateLimitAdmin = rateLimitAdmin; | ||
| } | ||
|
|
||
| /// @notice Gets the rate limiter admin address. | ||
| function getRateLimitAdmin() external view returns (address) { | ||
| return s_rateLimitAdmin; | ||
| } | ||
|
|
||
| /// @notice Sets the rate limiter admin address. | ||
| /// @dev Only callable by the owner or the rate limiter admin. NOTE: overwrites the normal | ||
| /// onlyAdmin check in the base implementation to also allow the rate limiter admin. | ||
| /// @param remoteChainSelector The remote chain selector for which the rate limits apply. | ||
| /// @param outboundConfig The new outbound rate limiter config. | ||
| /// @param inboundConfig The new inbound rate limiter config. | ||
| function setChainRateLimiterConfig( | ||
| uint64 remoteChainSelector, | ||
| RateLimiter.Config memory outboundConfig, | ||
| RateLimiter.Config memory inboundConfig | ||
| ) external override { | ||
| if (msg.sender != s_rateLimitAdmin && msg.sender != owner()) revert Unauthorized(msg.sender); | ||
|
|
||
| _setRateLimitConfig(remoteChainSelector, outboundConfig, inboundConfig); | ||
| } | ||
|
|
||
| /// @inheritdoc UpgradeableBurnMintTokenPoolAbstract | ||
| function _burn(uint256 amount) internal virtual override { | ||
| IBurnMintERC20(address(i_token)).burn(amount); | ||
| } | ||
| } |
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
Oops, something went wrong.