feat: introduces a killswitch for the diamond (EmergencyPauseFacet v1.0.0)

[0xDEnYO]

Which Jira task belongs to this PR?

Why did I implement it this way?

Checklist before requesting a review

• [x] I have performed a self-review of my code
• [ ] This pull request is as small as possible and only tackles one problem
• [x] I have added tests that cover the functionality / test the bug
• [x] I have updated any required documentation
• [x] If this requires a contract version change, I have updated the version number in the source file

Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)

• [ ] I have checked that any arbitrary calls to external contracts are validated and or restricted
• [ ] I have checked that any privileged calls (i.e. storage modifications) are validated and or restricted
• [ ] I have ensured that any new contracts have had AT A MINIMUM 1 preliminary audit conducted on by <company/auditor>

[0xDEnYO]

Looks good. Has this been audited?

no, sujith will check it this or next week

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@0xDEnYO has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 9e6782465449622ac2ba8092411cd203efd66096 and 3d7dcd29348d18fccbaf3acdba75a3bb5c653d2c.

Walkthrough

The recent changes introduce an EmergencyPauseFacet contract that allows authorized users to manage contract functionalities by pausing operations during emergencies. Key updates include the implementation of emergency facet management, access control for critical functions, and comprehensive testing to validate the functionality of the emergency pause and unpause mechanisms. Additionally, a GitHub Actions workflow for manual emergency pausing and various deployment updates related to the new facet have been included, enhancing the resilience of the diamond architecture in handling critical situations.

Changes

Files	Change Summary
src/Facets/EmergencyPauseFacet.sol	Introduced the EmergencyPauseFacet contract, which includes functions for removing facets, pausing and unpausing the diamond, and error handling.
test/solidity/Facets/EmergencyPauseFacet.local.t.sol	Added a test suite for EmergencyPauseFacet, validating the pause and unpause functionalities and ensuring access control for authorized users.
.github/workflows/diamondEmergencyPause.yml	Created a GitHub Actions workflow for manual emergency pausing of the diamond contract, requiring user confirmation and team membership checks.
audit/auditLog.json	Added audit entries for the EmergencyPauseFacet contract and a new audit log entry.
deployments/arbitrum.diamond.staging.json	Updated the deployment file to include the EmergencyPauseFacet and other new facets in the LiFiDiamond structure.
deployments/arbitrum.staging.json	Added the EmergencyPauseFacet entry with its address.
deployments/optimism.diamond.staging.json	Updated to include the EmergencyPauseFacet and new facets in the LiFiDiamond section.
deployments/optimism.staging.json	Added the EmergencyPauseFacet entry with its address.
script/helperFunctions.sh	Enhanced logging and error handling, added new functions for Discord messaging and user info retrieval.
script/tasks/diamondEMERGENCYPause.sh	Introduced a script for managing emergency actions on diamond contracts, allowing pausing, unpausing, or facet removal.
script/utils/diamondEMERGENCYPauseGitHub.sh	Created a script for executing the pause action via GitHub actions, including retry mechanisms and network handling.

Possibly related PRs

• #789: The changes in this PR involve deploying to a new network (Kaia), which may relate to the EmergencyPauseFacet if it includes similar functionalities or integrations with the diamond architecture.
• #806: This PR also involves deploying to a new layer (X Layer), which could be relevant to the EmergencyPauseFacet if it pertains to managing facets or emergency functionalities in a diamond architecture.
• #812: This PR introduces the LiFiDEXAggregator, which may interact with the EmergencyPauseFacet if it involves emergency management or operational functionalities within the diamond architecture.
• #819: Similar to #812, this PR focuses on deploying the LiFiDEXAggregator to additional networks, which could relate to the EmergencyPauseFacet if it involves emergency management across those networks.

Suggested labels

AuditNotRequired

Suggested reviewers

• 0xDEnYO

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[lifi-action-bot]

Test Coverage Report

Line Coverage: 78.39% (1695 / 2162 lines) Function Coverage: 84.66% ( 359 / 424 functions) Branch Coverage: 51.25% ( 266 / 519 branches) Test coverage (78.39%) is above min threshold (74%). Check passed.