Skip to content

Ccip rate limit management#3438

Open
gfletcher-cll wants to merge 6 commits intomainfrom
ccip-rate-limit-management
Open

Ccip rate limit management#3438
gfletcher-cll wants to merge 6 commits intomainfrom
ccip-rate-limit-management

Conversation

@gfletcher-cll
Copy link
Collaborator

This pull request introduces a comprehensive new "Rate Limit Management" documentation section for CCIP, aimed at operators and administrators managing cross-chain token transfer limits. The changes add a new sidebar folder with multiple detailed pages covering the conceptual model, permissions, inspection, configuration, emergency actions, and operational scenarios for CCIP rate limits. The documentation is structured to guide users through understanding, configuring, and safely managing rate limits, with special attention to operational risk and best practices.

New Documentation Section: Rate Limit Management

Sidebar and Navigation

  • Added a new "Rate Limit Management" section to the CCIP sidebar, including pages for overview, conceptual explanation, permissions, inspection, decimals, updates, emergency actions, common scenarios, and multisig execution.

Concepts and Operations

  • Added an overview page describing the purpose, scope, and risk considerations of CCIP rate limits, emphasizing their operator-level impact and the need for careful management.
  • Added a conceptual page explaining how rate limits work as capacity buckets, the difference between inbound and outbound limits, and the significance of each configuration parameter.
  • Added a permissions and prerequisites page detailing the required rateLimitAdmin role, how it is granted, and the operational responsibilities of administrators.
  • Added a page on inspecting current rate limit configurations, including contract methods, required information (token pool address, chain selector), and interpreting on-chain state.

Practical Guidance and Incident Response

  • Added a page on handling emergency actions, outlining how to quickly lock down a lane by setting minimal capacity and refill values, and considerations for restoring normal operation.
  • Added a scenarios page with worked examples for common token types (18- and 6-decimal tokens), pausing lanes, and fully removing rate limits, including how to recalculate values for each use case.
  • Added a page on executing rate limit changes with a multisig, including transaction structure, verification steps, and the ABI for the relevant contract function.

@gfletcher-cll gfletcher-cll requested a review from a team as a code owner February 6, 2026 23:21
@vercel
Copy link

vercel bot commented Feb 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview Feb 6, 2026 11:55pm

Request Review

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

👋 gfletcher-cll, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant