Skip to content

Commit

Permalink
fix: comments
Browse files Browse the repository at this point in the history
  • Loading branch information
CheyenneAtapour committed Aug 7, 2024
1 parent d538a77 commit a03081b
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
3 changes: 1 addition & 2 deletions src/contracts/misc/GhoCcipSteward.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
3 changes: 3 additions & 0 deletions src/contracts/misc/deps/RateLimiter.sol
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
5 changes: 3 additions & 2 deletions src/contracts/misc/interfaces/IGhoCcipSteward.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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);

Expand Down

0 comments on commit a03081b

Please sign in to comment.