From a03081b17afdc21f834c83e6a6b638804ddd3b8a Mon Sep 17 00:00:00 2001 From: CheyenneAtapour Date: Wed, 7 Aug 2024 13:11:00 -0700 Subject: [PATCH] fix: comments --- src/contracts/misc/GhoCcipSteward.sol | 3 +-- src/contracts/misc/deps/RateLimiter.sol | 3 +++ src/contracts/misc/interfaces/IGhoCcipSteward.sol | 5 +++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/contracts/misc/GhoCcipSteward.sol b/src/contracts/misc/GhoCcipSteward.sol index 93b7dd66..5c57e311 100644 --- a/src/contracts/misc/GhoCcipSteward.sol +++ b/src/contracts/misc/GhoCcipSteward.sol @@ -41,8 +41,7 @@ contract GhoCcipSteward is RiskCouncilControlled, IGhoCcipSteward { * @param ghoToken The address of the GhoToken * @param ghoTokenPool The address of the Gho CCIP Token Pool * @param riskCouncil The address of the risk council - * @param bridgeLimitEnabled Whether the capability to change bridge limit exists on the pool - * @dev bridgeLimitEnabled is true for Ethereum and false for remote chains + * @param bridgeLimitEnabled Whether the bridge limit feature is supported in the GhoTokenPool */ constructor( address ghoToken, diff --git a/src/contracts/misc/deps/RateLimiter.sol b/src/contracts/misc/deps/RateLimiter.sol index 49950c6c..3cdfd1e7 100644 --- a/src/contracts/misc/deps/RateLimiter.sol +++ b/src/contracts/misc/deps/RateLimiter.sol @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: BUSL-1.1 +pragma solidity ^0.8.0; + /// @notice Implements Token Bucket rate limiting. /// @dev Reduced library from https://github.com/aave/ccip/blob/ccip-gho/contracts/src/v0.8/ccip/libraries/RateLimiter.sol /// @dev uint128 is safe for rate limiter state. diff --git a/src/contracts/misc/interfaces/IGhoCcipSteward.sol b/src/contracts/misc/interfaces/IGhoCcipSteward.sol index 448af438..39bec929 100644 --- a/src/contracts/misc/interfaces/IGhoCcipSteward.sol +++ b/src/contracts/misc/interfaces/IGhoCcipSteward.sol @@ -22,6 +22,7 @@ interface IGhoCcipSteward { /** * @notice Updates the CCIP rate limit config * @dev Only callable by Risk Council + * @dev Rate limit update must be consistent with other pools' rate limit * @param remoteChainSelector The remote chain selector for which the rate limits apply. * @param outboundEnabled True if the outbound rate limiter is enabled. * @param outboundCapacity The outbound rate limiter capacity. @@ -59,8 +60,8 @@ interface IGhoCcipSteward { function GHO_TOKEN_POOL() external view returns (address); /** - * @notice returns whether the bridge limit is enabled - * @dev For use on Ethereum, not remote networks + * @notice Returns whether the bridge limit feature is supported in the GhoTokenPool + * @return True if bridge limit is enabled in the CCIP GhoTokenPool, false otherwise */ function BRIDGE_LIMIT_ENABLED() external view returns (bool);