-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CCIP-4329 modify setChainRateLimiterConfig file for setting multiple … (
#1569) …rate limits (#15386) * modify setChainRateLimiterConfig file for setting multiple rate limits * Update gethwrappers * [Bot] Update changeset file with jira issues * snapshot fix * fix wrappers after merge * fix test that was broken in merge * fix liquidityManager snapshot which is affected by token pool changes * fix broken integration tests from removing critical setup function * add array length check for setChainRateLimitConfigs * formatting and snapshot fix * Update gethwrappers * simplify test setups * Update gethwrappers * update wrappers and snapshots which were broken in merge * Update gethwrappers * update wrappers and snapshot * changeset * snapshot update * Delete contracts/.changeset/orange-buckets-live.md * attempt fix changeset * attempt changeset fix with update pnpm package * re-add function that was removed early in PR to prevent any required tooling changes * update liquidityManager snapshot because of changes to token pools --------- ## Motivation ## Solution --------- Co-authored-by: app-token-issuer-infra-releng[bot] <120227048+app-token-issuer-infra-releng[bot]@users.noreply.github.com>
- Loading branch information
1 parent
06914db
commit 478f0e5
Showing
13 changed files
with
381 additions
and
136 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@chainlink/contracts': patch | ||
--- | ||
|
||
Modify TokenPool.sol function setChainRateLimiterConfig to now accept an array of configs and set sequentially. Requested by front-end. PR issue CCIP-4329 #bugfix |
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
128 changes: 128 additions & 0 deletions
128
contracts/src/v0.8/ccip/test/pools/TokenPool/TokenPool.setChainRateLimiterConfigs.t.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,128 @@ | ||
// SPDX-License-Identifier: BUSL-1.1 | ||
pragma solidity 0.8.24; | ||
|
||
import {RateLimiter} from "../../../libraries/RateLimiter.sol"; | ||
import {TokenPool} from "../../../pools/TokenPool.sol"; | ||
import {TokenPoolSetup} from "./TokenPoolSetup.t.sol"; | ||
|
||
contract TokenPool_setChainRateLimiterConfigs is TokenPoolSetup { | ||
uint64 internal s_remoteChainSelector; | ||
|
||
function setUp() public virtual override { | ||
TokenPoolSetup.setUp(); | ||
|
||
bytes[] memory remotePoolAddresses = new bytes[](1); | ||
remotePoolAddresses[0] = abi.encode(address(2)); | ||
|
||
TokenPool.ChainUpdate[] memory chainUpdates = new TokenPool.ChainUpdate[](1); | ||
s_remoteChainSelector = 123124; | ||
chainUpdates[0] = TokenPool.ChainUpdate({ | ||
remoteChainSelector: s_remoteChainSelector, | ||
remotePoolAddresses: remotePoolAddresses, | ||
remoteTokenAddress: abi.encode(address(3)), | ||
outboundRateLimiterConfig: _getOutboundRateLimiterConfig(), | ||
inboundRateLimiterConfig: _getInboundRateLimiterConfig() | ||
}); | ||
s_tokenPool.applyChainUpdates(new uint64[](0), chainUpdates); | ||
} | ||
|
||
function testFuzz_SetChainRateLimiterConfigs_Success(uint128 capacity, uint128 rate, uint32 newTime) public { | ||
// Cap the lower bound to 4 so 4/2 is still >= 2 | ||
vm.assume(capacity >= 4); | ||
// Cap the lower bound to 2 so 2/2 is still >= 1 | ||
rate = uint128(bound(rate, 2, capacity - 2)); | ||
// Bucket updates only work on increasing time | ||
newTime = uint32(bound(newTime, block.timestamp + 1, type(uint32).max)); | ||
vm.warp(newTime); | ||
|
||
uint256 oldOutboundTokens = s_tokenPool.getCurrentOutboundRateLimiterState(DEST_CHAIN_SELECTOR).tokens; | ||
uint256 oldInboundTokens = s_tokenPool.getCurrentInboundRateLimiterState(DEST_CHAIN_SELECTOR).tokens; | ||
|
||
RateLimiter.Config memory newOutboundConfig = RateLimiter.Config({isEnabled: true, capacity: capacity, rate: rate}); | ||
RateLimiter.Config memory newInboundConfig = | ||
RateLimiter.Config({isEnabled: true, capacity: capacity / 2, rate: rate / 2}); | ||
|
||
uint64[] memory chainSelectors = new uint64[](1); | ||
chainSelectors[0] = DEST_CHAIN_SELECTOR; | ||
|
||
RateLimiter.Config[] memory newOutboundConfigs = new RateLimiter.Config[](1); | ||
newOutboundConfigs[0] = newOutboundConfig; | ||
|
||
RateLimiter.Config[] memory newInboundConfigs = new RateLimiter.Config[](1); | ||
newInboundConfigs[0] = newInboundConfig; | ||
|
||
vm.expectEmit(); | ||
emit RateLimiter.ConfigChanged(newOutboundConfig); | ||
vm.expectEmit(); | ||
emit RateLimiter.ConfigChanged(newInboundConfig); | ||
vm.expectEmit(); | ||
emit TokenPool.ChainConfigured(DEST_CHAIN_SELECTOR, newOutboundConfig, newInboundConfig); | ||
|
||
s_tokenPool.setChainRateLimiterConfigs(chainSelectors, newOutboundConfigs, newInboundConfigs); | ||
|
||
uint256 expectedTokens = RateLimiter._min(newOutboundConfig.capacity, oldOutboundTokens); | ||
|
||
RateLimiter.TokenBucket memory bucket = s_tokenPool.getCurrentOutboundRateLimiterState(DEST_CHAIN_SELECTOR); | ||
assertEq(bucket.capacity, newOutboundConfig.capacity); | ||
assertEq(bucket.rate, newOutboundConfig.rate); | ||
assertEq(bucket.tokens, expectedTokens); | ||
assertEq(bucket.lastUpdated, newTime); | ||
|
||
expectedTokens = RateLimiter._min(newInboundConfig.capacity, oldInboundTokens); | ||
|
||
bucket = s_tokenPool.getCurrentInboundRateLimiterState(DEST_CHAIN_SELECTOR); | ||
assertEq(bucket.capacity, newInboundConfig.capacity); | ||
assertEq(bucket.rate, newInboundConfig.rate); | ||
assertEq(bucket.tokens, expectedTokens); | ||
assertEq(bucket.lastUpdated, newTime); | ||
} | ||
|
||
// Reverts | ||
|
||
function test_OnlyOwnerOrRateLimitAdmin_Revert() public { | ||
uint64[] memory chainSelectors = new uint64[](1); | ||
chainSelectors[0] = DEST_CHAIN_SELECTOR; | ||
|
||
RateLimiter.Config[] memory newOutboundConfigs = new RateLimiter.Config[](1); | ||
newOutboundConfigs[0] = _getOutboundRateLimiterConfig(); | ||
|
||
RateLimiter.Config[] memory newInboundConfigs = new RateLimiter.Config[](1); | ||
newInboundConfigs[0] = _getInboundRateLimiterConfig(); | ||
|
||
vm.startPrank(STRANGER); | ||
|
||
vm.expectRevert(abi.encodeWithSelector(TokenPool.Unauthorized.selector, STRANGER)); | ||
s_tokenPool.setChainRateLimiterConfigs(chainSelectors, newOutboundConfigs, newInboundConfigs); | ||
} | ||
|
||
function test_NonExistentChain_Revert() public { | ||
uint64 wrongChainSelector = 9084102894; | ||
|
||
uint64[] memory chainSelectors = new uint64[](1); | ||
chainSelectors[0] = wrongChainSelector; | ||
|
||
RateLimiter.Config[] memory newOutboundConfigs = new RateLimiter.Config[](1); | ||
RateLimiter.Config[] memory newInboundConfigs = new RateLimiter.Config[](1); | ||
|
||
vm.expectRevert(abi.encodeWithSelector(TokenPool.NonExistentChain.selector, wrongChainSelector)); | ||
s_tokenPool.setChainRateLimiterConfigs(chainSelectors, newOutboundConfigs, newInboundConfigs); | ||
} | ||
|
||
function test_MismatchedArrayLengths_Revert() public { | ||
uint64[] memory chainSelectors = new uint64[](1); | ||
|
||
RateLimiter.Config[] memory newOutboundConfigs = new RateLimiter.Config[](1); | ||
RateLimiter.Config[] memory newInboundConfigs = new RateLimiter.Config[](2); | ||
|
||
// test mismatched array lengths between rate limiters | ||
vm.expectRevert(abi.encodeWithSelector(TokenPool.MismatchedArrayLengths.selector)); | ||
s_tokenPool.setChainRateLimiterConfigs(chainSelectors, newOutboundConfigs, newInboundConfigs); | ||
|
||
newInboundConfigs = new RateLimiter.Config[](1); | ||
chainSelectors = new uint64[](2); | ||
|
||
// test mismatched array lengths between chain selectors and rate limiters | ||
vm.expectRevert(abi.encodeWithSelector(TokenPool.MismatchedArrayLengths.selector)); | ||
s_tokenPool.setChainRateLimiterConfigs(chainSelectors, newOutboundConfigs, newInboundConfigs); | ||
} | ||
} |
18 changes: 16 additions & 2 deletions
18
core/gethwrappers/ccip/generated/burn_from_mint_token_pool/burn_from_mint_token_pool.go
Large diffs are not rendered by default.
Oops, something went wrong.
18 changes: 16 additions & 2 deletions
18
core/gethwrappers/ccip/generated/burn_mint_token_pool/burn_mint_token_pool.go
Large diffs are not rendered by default.
Oops, something went wrong.
18 changes: 16 additions & 2 deletions
18
...hwrappers/ccip/generated/burn_with_from_mint_token_pool/burn_with_from_mint_token_pool.go
Large diffs are not rendered by default.
Oops, something went wrong.
18 changes: 16 additions & 2 deletions
18
core/gethwrappers/ccip/generated/lock_release_token_pool/lock_release_token_pool.go
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
18 changes: 16 additions & 2 deletions
18
core/gethwrappers/ccip/generated/usdc_token_pool/usdc_token_pool.go
Large diffs are not rendered by default.
Oops, something went wrong.
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
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