Skip to content
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.

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

feat: add new CheckSecrets dripcheck #10479

Merged
merged 1 commit into from May 20, 2024
Merged

Conversation

smartcontracts
Copy link
Contributor

@smartcontracts smartcontracts commented May 9, 2024

Description
Adds a new dripcheck called CheckSecrets that acts somewhat like a timelock contract. Slightly more useful than a traditional timelock because it can be triggered by any account. Very useful if the account is actively being drained which would require using a third-party service like flashbots to circumvent.

@smartcontracts smartcontracts force-pushed the sc/ct-check-secrets branch 2 times, most recently from 900295c to 6c5fc4a Compare May 14, 2024 22:26
Copy link

codecov bot commented May 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.22%. Comparing base (d278707) to head (6841ee3).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff              @@
##           develop   #10479       +/-   ##
============================================
- Coverage    42.36%   29.22%   -13.15%     
============================================
  Files           73       31       -42     
  Lines         4836     2898     -1938     
  Branches       766      614      -152     
============================================
- Hits          2049      847     -1202     
+ Misses        2680     1976      -704     
+ Partials       107       75       -32     
Flag Coverage Δ
cannon-go-tests ?
chain-mon-tests 27.14% <ø> (ø)
common-ts-tests ?
contracts-ts-tests 12.25% <ø> (ø)
core-utils-tests ?
sdk-tests 40.27% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 42 files with indirect coverage changes

@smartcontracts smartcontracts marked this pull request as ready for review May 14, 2024 23:48
@smartcontracts smartcontracts requested a review from a team as a code owner May 14, 2024 23:48
Copy link
Contributor

coderabbitai bot commented May 14, 2024

Walkthrough

Walkthrough

The update introduces a new Solidity contract CheckSecrets that implements the IDripCheck interface, adding the capability to manage and verify secrets for drip functionality. It includes the addition of events, mappings, and functions to handle secret revelation and validation. Corresponding tests in CheckSecretsTest ensure the contract's functionality, covering scenarios like secret revealing, delay handling, and condition verification.

Changes

Files Change Summary
.../dripchecks/CheckSecrets.sol Introduced CheckSecrets contract with secret management features, including new structs, events, mappings, and functions.
.../dripchecks/CheckSecrets.t.sol Added CheckSecretsTest contract to test the functionality of CheckSecrets, including various test cases for secret handling and validation.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 6c5fc4a and 6841ee3.
Files ignored due to path filters (2)
  • packages/contracts-bedrock/snapshots/abi/CheckSecrets.json is excluded by !**/*.json
  • packages/contracts-bedrock/snapshots/storageLayout/CheckSecrets.json is excluded by !**/*.json
Files selected for processing (2)
  • packages/contracts-bedrock/src/periphery/drippie/dripchecks/CheckSecrets.sol (1 hunks)
  • packages/contracts-bedrock/test/periphery/drippie/dripchecks/CheckSecrets.t.sol (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • packages/contracts-bedrock/src/periphery/drippie/dripchecks/CheckSecrets.sol
  • packages/contracts-bedrock/test/periphery/drippie/dripchecks/CheckSecrets.t.sol

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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

@smartcontracts
Copy link
Contributor Author

Going to wait for review from @clabby before merging

@smartcontracts smartcontracts added this pull request to the merge queue May 20, 2024
Merged via the queue into develop with commit 38cd994 May 20, 2024
72 checks passed
@smartcontracts smartcontracts deleted the sc/ct-check-secrets branch May 20, 2024 23:03
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.

None yet

4 participants