Skip to content

test: disable rate limit #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 11, 2024
Merged

test: disable rate limit #427

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
db0364f
test(ccip-steward): disable rate limit
DhairyaSethi Oct 11, 2024
96e96f2
test: fix revert upd rate limit to zero
DhairyaSethi Oct 11, 2024
a194c76
test: fix change{enabled,disabled}rateLimit
DhairyaSethi Oct 11, 2024
29ccd61
test: document rate limit update revert code path, rename test
DhairyaSethi Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 100 additions & 1 deletion src/test/TestGhoCcipSteward.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ contract TestGhoCcipSteward is TestGhoBase {
rate: 0
});
vm.prank(RISK_COUNCIL);
vm.expectRevert();
vm.expectRevert('INVALID_RATE_LIMIT_UPDATE');
GHO_CCIP_STEWARD.updateRateLimit(
remoteChainSelector,
invalidConfig.isEnabled,
Expand All @@ -252,6 +252,105 @@ contract TestGhoCcipSteward is TestGhoBase {
);
}

function testDisableRateLimitFromNonZeroToZero() public {
Copy link
Contributor

@miguelmtzinf miguelmtzinf Oct 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can rename to testChangeEnabledRateLimit and test both directions: enabled -> disabled -> enabled

Copy link
Member Author

@DhairyaSethi DhairyaSethi Oct 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as per discussion on slack: it is currently expected behaviour that Steward cannot re-enable disabled rate limits (due to these range checks using the current value as max permittable value) and once disabled, the dao can enable rate limits again by directly interacting with the token pool

test for this behaviour added in - a194c76

RateLimiter.TokenBucket memory outboundConfig = MockUpgradeableLockReleaseTokenPool(
GHO_TOKEN_POOL
).getCurrentOutboundRateLimiterState(remoteChainSelector);
RateLimiter.TokenBucket memory inboundConfig = MockUpgradeableLockReleaseTokenPool(
GHO_TOKEN_POOL
).getCurrentInboundRateLimiterState(remoteChainSelector);

assertTrue(outboundConfig.isEnabled);
assertGt(outboundConfig.capacity, 0);
assertGt(outboundConfig.rate, 0);

assertTrue(inboundConfig.isEnabled);
assertGt(inboundConfig.capacity, 0);
assertGt(inboundConfig.rate, 0);

RateLimiter.Config memory disableLimitConfig = RateLimiter.Config({
isEnabled: false,
capacity: 0,
rate: 0
});

// disable both inbound & outbound config
vm.prank(RISK_COUNCIL);
GHO_CCIP_STEWARD.updateRateLimit(
remoteChainSelector,
disableLimitConfig.isEnabled,
disableLimitConfig.capacity,
disableLimitConfig.rate,
disableLimitConfig.isEnabled,
disableLimitConfig.capacity,
disableLimitConfig.rate
);

outboundConfig = MockUpgradeableLockReleaseTokenPool(GHO_TOKEN_POOL)
.getCurrentOutboundRateLimiterState(remoteChainSelector);
inboundConfig = MockUpgradeableLockReleaseTokenPool(GHO_TOKEN_POOL)
.getCurrentInboundRateLimiterState(remoteChainSelector);

assertFalse(outboundConfig.isEnabled);
assertEq(outboundConfig.capacity, 0);
assertEq(outboundConfig.rate, 0);

assertFalse(inboundConfig.isEnabled);
assertEq(inboundConfig.capacity, 0);
assertEq(inboundConfig.rate, 0);
}

function testDisableRateLimitOnlyOutboundConfig() public {
RateLimiter.TokenBucket memory outboundConfig = MockUpgradeableLockReleaseTokenPool(
GHO_TOKEN_POOL
).getCurrentOutboundRateLimiterState(remoteChainSelector);
RateLimiter.TokenBucket memory inboundConfig = MockUpgradeableLockReleaseTokenPool(
GHO_TOKEN_POOL
).getCurrentInboundRateLimiterState(remoteChainSelector);

assertTrue(outboundConfig.isEnabled);
assertGt(outboundConfig.capacity, 0);
assertGt(outboundConfig.rate, 0);

assertTrue(inboundConfig.isEnabled);
assertGt(inboundConfig.capacity, 0);
assertGt(inboundConfig.rate, 0);

RateLimiter.Config memory disableLimitConfig = RateLimiter.Config({
isEnabled: false,
capacity: 0,
rate: 0
});

// disable only outbound config
vm.prank(RISK_COUNCIL);
GHO_CCIP_STEWARD.updateRateLimit(
remoteChainSelector,
disableLimitConfig.isEnabled,
disableLimitConfig.capacity,
disableLimitConfig.rate,
// preserve inboundConfig
inboundConfig.isEnabled,
inboundConfig.capacity,
inboundConfig.rate
);

RateLimiter.TokenBucket memory outboundConfigNew = MockUpgradeableLockReleaseTokenPool(
GHO_TOKEN_POOL
).getCurrentOutboundRateLimiterState(remoteChainSelector);
RateLimiter.TokenBucket memory inboundConfigNew = MockUpgradeableLockReleaseTokenPool(
GHO_TOKEN_POOL
).getCurrentInboundRateLimiterState(remoteChainSelector);

assertFalse(outboundConfigNew.isEnabled);
assertEq(outboundConfigNew.capacity, 0);
assertEq(outboundConfigNew.rate, 0);

assertTrue(inboundConfigNew.isEnabled);
assertEq(inboundConfigNew.capacity, inboundConfig.capacity);
assertEq(inboundConfigNew.rate, inboundConfig.rate);
}

function testRevertUpdateRateLimitRateGreaterThanCapacity() public {
RateLimiter.Config memory invalidConfig = RateLimiter.Config({
isEnabled: true,
Expand Down
Loading