fix(airdrop-token-vesting): improve cliff validation logic

[k-yang]

• consolidate time validation logic errors into InvalidTimeRange
• allow cliff times before current block time, for retroactive grants
• remove Cliff struct

Summary by CodeRabbit

• Refactor
  • Simplified vesting account registration and reward distribution logic.
• Bug Fixes
  • Fixed time range validation in vesting schedules.
• Chores
  • Cleaned up unused error types and improved error handling in vesting processes.

[coderabbitai]

Walkthrough

The recent update streamlines the airdrop token vesting contract by removing dependency on block time for vesting account registration and user rewards. It simplifies error handling by discarding the CliffError and refining the VestingError enum. Additionally, it eliminates the Cliff construct, adjusting the vesting schedule validation to accommodate these changes.

Changes

File Path	Change Summary
.../airdrop-token-vesting/src/contract.rs	Removed env.block.time parameter from functions; updated vesting_schedule.validate calls.
.../airdrop-token-vesting/src/errors.rs	Removed CliffError; modified VestingError enum (changed and added variants).
.../airdrop-token-vesting/src/msg.rs	Removed Timestamp import and Cliff struct; updated error handling and validate method.
.../airdrop-token-vesting/src/testing.rs	Adjusted error handling to reflect changes in VestingError; removed references to CliffError.

🐇✨
A change has come, both far and wide,
No more cliffs where secrets hide.
Time stands still, yet we advance,
In vesting's dance, we take our chance.
Errors shift, and structs fall,
A streamlined code, a joy for all.
🎉🐾

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>.
  • Generate unit-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 55404f2 and 8bd1b53.

Files ignored due to path filters (1)

• Cargo.lock is excluded by: !**/*.lock

Files selected for processing (4)

• contracts/airdrop-token-vesting/src/contract.rs (4 hunks)
• contracts/airdrop-token-vesting/src/errors.rs (2 hunks)
• contracts/airdrop-token-vesting/src/msg.rs (5 hunks)
• contracts/airdrop-token-vesting/src/testing.rs (4 hunks)

Additional comments: 10

contracts/airdrop-token-vesting/src/errors.rs (2)

• 23-26: The InvalidTimeRange error variant now includes cliff_time, which aligns with the PR's objective to refine cliff validation logic. This change enhances the error's descriptiveness by including all relevant time parameters.
• 29-33: The addition of the ExcessiveAmount variant to VestingError is a good practice for explicitly handling cases where the cliff_amount exceeds the vesting_amount. This makes error handling more precise and informative.

contracts/airdrop-token-vesting/src/msg.rs (2)

• 67-70: The update to RewardUserRequest's validate method to include the ExcessiveAmount error is a positive change. It ensures that the cliff_amount does not exceed the vesting_amount, aligning with the PR's objectives for improved error handling.
• 169-193: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [161-187]

The validate method in VestingSchedule has been significantly updated to include checks for start_time, end_time, and cliff_time. This aligns with the PR's objectives to support retroactive grants and improve time validation logic. However, there's a potential redundancy in the checks for cliff_time < start_time and cliff_time > end_time, as these conditions are already covered by the other checks. Consider simplifying this logic to avoid unnecessary complexity.

-                if cliff_time < start_time {
-                    return Err(VestingError::InvalidTimeRange {
-                        start_time: start_time.u64(),
-                        cliff_time: cliff_time.u64(),
-                        end_time: end_time.u64(),
-                    });
-                }

contracts/airdrop-token-vesting/src/contract.rs (2)

• 163-163: The call to vesting_schedule.validate() in the reward_users function aligns with the PR's objectives to improve time validation logic. This ensures that the vesting schedule is validated before proceeding with rewarding users, enhancing the contract's robustness.
• 216-216: Similarly, the call to vesting_schedule.validate() in register_vesting_account ensures that the vesting schedule is validated upon account registration. This is a crucial step for maintaining the integrity of the vesting process.

contracts/airdrop-token-vesting/src/testing.rs (4)

• 3-3: The import of VestingError from crate::errors is correctly updated to reflect the consolidation of error types, aligning with the PR's objective to streamline error handling by using a single InvalidTimeRange error for time validation issues.
• 294-298: The replacement of CliffError::InvalidTime with VestingError::InvalidTimeRange and the adjustment of error handling with updated time parameters in the register_cliff_vesting_account_with_native_token function align with the PR's objective to consolidate time-related validation errors. This change simplifies error management by using a single error type for time validation issues.
• 310-310: The use of VestingError::InvalidTimeRange for handling the case where the end time is less than the start time is consistent with the PR's goal of error handling refinement. This ensures that time validation errors are managed in a unified manner across the contract.
• 324-324: The replacement of CliffError::ExcessiveAmount with VestingError::ExcessiveAmount in the context of cliff amount validation is a logical change that aligns with the PR's objective of error consolidation. This maintains consistency in error handling across different types of validation errors within the contract.

[codecov]

Codecov Report

Attention: Patch coverage is 89.65517% with 3 lines in your changes are missing coverage. Please review.

Project coverage is 87.44%. Comparing base (902b788) to head (8bd1b53).
Report is 11 commits behind head on main.

Additional details and impacted files

Files	Coverage Δ
contracts/airdrop-token-vesting/src/contract.rs	98.15% <100.00%> (ø)
contracts/airdrop-token-vesting/src/errors.rs	100.00% <ø> (ø)
contracts/airdrop-token-vesting/src/testing.rs	98.25% <100.00%> (ø)
contracts/airdrop-token-vesting/src/msg.rs	89.18% <85.71%> (ø)

... and 7 files with indirect coverage changes