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(contracts): apply audit results about vesting wallet #342

Merged
merged 1 commit into from
Jul 12, 2024

Conversation

seolaoh
Copy link
Contributor

@seolaoh seolaoh commented Jul 12, 2024

No description provided.

@seolaoh seolaoh self-assigned this Jul 12, 2024
@seolaoh seolaoh requested a review from a team as a code owner July 12, 2024 04:41
Copy link
Contributor

coderabbitai bot commented Jul 12, 2024

Walkthrough

The recent update introduces a new test function to the KromaVestingWalletTest suite, ensuring that the initialization duration is a multiple of the vesting cycle. Additionally, there are refinements in gas cost metrics for existing tests and adjustments in the KromaVestingWallet contract to enforce duration constraints and enhance release functionality.

Changes

File Path Change Summary
packages/contracts/.gas-snapshot Added test_initialize_durationNotMultiple_reverts() and adjusted gas costs for various test cases.
packages/contracts/contracts/test/KromaVestingWallet.t.sol Introduced test_initialize_durationNotMultiple_reverts to test invalid duration initialization.
packages/contracts/contracts/universal/KromaVestingWallet.sol Updated to enforce _durationSeconds being a multiple of VESTING_CYCLE and refined release condition.

Sequence Diagram(s)

sequenceDiagram
    participant Tester as KromaVestingWalletTest
    participant Wallet as KromaVestingWallet

    Tester->>+Wallet: initialize(_beneficiary, _startTimestamp, _durationSeconds)
    alt _durationSeconds not multiple of VESTING_CYCLE
        Wallet-->>-Tester: revert()
    else _durationSeconds is valid
        Wallet-->>-Tester: initialize successfully
    end
Loading
sequenceDiagram
    participant Tester as KromaVestingWalletTest
    participant Wallet as KromaVestingWallet

    Tester->>Wallet: release(timestamp)
    alt timestamp >= start() + duration()
        Wallet-->>Tester: release tokens
    else timestamp < start() + duration()
        Wallet-->>Tester: revert()
    end
Loading

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.
    • @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 as 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.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6db98fc and 4da85c8.

Files selected for processing (3)
  • packages/contracts/.gas-snapshot (1 hunks)
  • packages/contracts/contracts/test/KromaVestingWallet.t.sol (1 hunks)
  • packages/contracts/contracts/universal/KromaVestingWallet.sol (2 hunks)
Additional comments not posted (12)
packages/contracts/contracts/universal/KromaVestingWallet.sol (2)

62-65: LGTM! The duration check ensures integrity.

The added check ensures that _durationSeconds is a multiple of VESTING_CYCLE, which is crucial for the vesting schedule integrity.


102-102: LGTM! Correct change to ensure full vesting.

Changing the condition to >= ensures that the full amount is vested when the timestamp is exactly at the end of the duration.

packages/contracts/contracts/test/KromaVestingWallet.t.sol (1)

79-89: LGTM! Comprehensive test for duration check.

The new test function correctly verifies that the initialization reverts when the duration is not a multiple of the vesting cycle.

packages/contracts/.gas-snapshot (9)

167-167: LGTM! Updated gas cost for test_constructor_succeeds.

The updated gas cost for test_constructor_succeeds is accurately reflected.


168-168: LGTM! Updated gas cost for test_constructor_zeroValues_reverts.

The updated gas cost for test_constructor_zeroValues_reverts is accurately reflected.


169-169: LGTM! Added gas cost for test_initialize_durationNotMultiple_reverts.

The added gas cost for test_initialize_durationNotMultiple_reverts is accurately reflected.


170-170: LGTM! Updated gas cost for test_initialize_succeeds.

The updated gas cost for test_initialize_succeeds is accurately reflected.


171-171: LGTM! Updated gas cost for test_release_afterFullyVested_succeeds.

The updated gas cost for test_release_afterFullyVested_succeeds is accurately reflected.


172-172: LGTM! Updated gas cost for test_release_notBeneficiary_reverts.

The updated gas cost for test_release_notBeneficiary_reverts is accurately reflected.


173-173: LGTM! Updated gas cost for test_release_succeeds.

The updated gas cost for test_release_succeeds is accurately reflected.


174-174: LGTM! Updated gas cost for test_release_tokenAfterFullyVested_succeeds.

The updated gas cost for test_release_tokenAfterFullyVested_succeeds is accurately reflected.


175-175: LGTM! Updated gas cost for test_release_token_succeeds.

The updated gas cost for test_release_token_succeeds is accurately reflected.

@Pangssu Pangssu merged commit 0247393 into dev Jul 12, 2024
2 checks passed
@Pangssu Pangssu deleted the feat/apply-vesting-audit branch July 12, 2024 05:23
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.

4 participants