102 change to allow deltas on merge

[bitcoinbrisbane]

Fixes #102

Summary by CodeRabbit

• New Features

  • Enhanced tracking of merged amounts with a new public variable for total merged tokens.
  • Updated merging logic to include validation for allocations and improved handling of merged amounts.

• Bug Fixes

  • Improved error messages for revert conditions in the merging process.
  • Expanded test coverage for various merging scenarios, ensuring accurate tracking and validation.

• Chores

  • Temporarily disabled tests for the "Farm" contract to address execution issues.

[coderabbitai[bot]]

Walkthrough

The pull request introduces changes to the DynamicEater contract, primarily altering variable visibility and enhancing the logic of the _merge and mergeWithProof functions. The _totalMerged variable is now public and renamed to totalMerged, allowing broader access. The _merge function has been updated to accurately track merged amounts for each vesting account. Additionally, the mergeWithProof function now includes an allocation parameter for better validation of merge requests. The test suite has also been updated to reflect these changes, ensuring comprehensive coverage of the new functionality.

Changes

File	Change Summary
contracts/core/merge/DynamicEater.sol	- Changed _totalMerged from internal to public as totalMerged. - Updated _merge logic to track merged amounts. - Modified mergeWithProof to include allocation parameter and added validation checks.
test/DynamicEater.test.ts	- Added assertions for totalMerged and updated tests for mergeWithProof to include new parameter. - Enhanced test coverage for merging scenarios.
test/Farm.test.ts	- Added .skip to several describe and it blocks, disabling tests related to the "Farm" contract.

Assessment against linked issues

Objective	Addressed	Explanation
Expose _totalMerged for the front end	✅
Allow holders to merge multiple times	❓	The implementation details on multiple merges are unclear.
Enable merging the delta between TotalMerged and Merge Cap	❌	No specific changes to handle delta merging were implemented.

Possibly related PRs

• #97: Changes in the DynamicEater contract regarding the introduction of a maximum supply for tokens and adjustments to the _merge function are directly related to the modifications made in the main PR.
• #101: Update to the onlyWhiteListed modifier in the DynamicEater contract aligns with the main PR's focus on improving merging logic and validation processes.

Suggested labels

enhancement, SC

Poem

🐇 In the garden where tokens play,
The DynamicEater finds its way.
With totalMerged now in sight,
Merging amounts feels just right.
With proofs and checks, we hop along,
Validating merges, where we belong! 🌼

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.