96 white lists

[bitcoinbrisbane]

Summary by CodeRabbit

• New Features

  • Updated command examples in the README for improved clarity and usability.
  • Added a new section for "Example proofs" in the README.
  • Introduced a Merkle tree-based proof system for enhanced access control in the DynamicEater contract.
  • Added a new JSON file for storing cryptographic proofs.

• Bug Fixes

  • Removed outdated command parameters to simplify user commands.

• Documentation

  • Enhanced README documentation with clearer command examples.

• Chores

  • Updated package dependencies to include libraries for Merkle trees and hashing.
  • Removed deprecated contract and module files related to the Market Merge functionality.

• Tests

  • Revised test cases for the DynamicEater contract to reflect new merging functionality and conditions.
  • Skipped tests for the MarketMerge functionality due to the removal of related contracts.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This pull request introduces several changes across multiple files, primarily focusing on the transition from a whitelist mechanism to a Merkle tree-based proof system in the DynamicEater contract. The README.md file is updated with new command examples and a new section for example proofs. The MergeFactory contract is modified to remove the WithMarket merge type, and the MergeWithMarket contract is deleted. Additionally, new dependencies related to Merkle trees are added, and test cases are updated to reflect these changes.

Changes

File	Change Summary
README.md	Updated command examples by removing the --asset parameter from simple-swap and mint-nft-position commands. Added a new section titled "Example proofs."
contracts/core/merge/DynamicEater.sol	Added bytes32 public merkleRoot;, replaced mapping(address => uint256) public whiteList;, removed addWhiteList, added setMerkleRoot, mergeWithProof, and _validateLeaf. Updated onlyWhiteListed modifier.
contracts/core/merge/MergeFactory.sol	Updated MergeType enum to include DynamicEater, removed createMerge, and updated createMergeWith to accept a MergeType parameter.
contracts/core/merge/MergeWithMarket.sol	Contract removed.
contracts/libraries/BondingCurve.sol	Updated comments in calculateTokensOut for clarity without altering functionality.
data/proof.json	New JSON file added containing an array of objects with address and proofHex fields.
ignition/modules/MergeWithMarket.ts	Module removed.
package.json	Added new dependencies: @openzeppelin/merkle-tree, keccak256, and merkletreejs.
scripts/merklegen.js	Implemented Merkle tree functionality using OpenZeppelin library, created a Merkle tree from a whitelist, and logged the root hash and proofs.
test/DynamicEater.test.ts	Modified tests to focus on merging functionality with the Merkle root and added new tests for merging with proof.
test/MarketMerge.test.ts	Skipped the "MarketMerge" test suite, noting that the contracts have been deleted.

Possibly related PRs

• #50: Modifies the README.md file, adding command examples and updating existing commands.
• #61: Updates the README.md file with changes to command examples.
• #62: Removes the --asset parameter from commands in the README.md file.
• #67: Introduces the MergeFactory contract and its functionalities related to merging operations.
• #76: Introduces vesting logic in the Eater contract, relating to merging functionality.
• #77: Updates the MergeWithMarket contract and its functionalities in the context of merging operations.

Suggested labels

eat-all-the-tokens, SC

🐰 In the meadow, changes bloom,
A Merkle tree dispels the gloom.
Commands refined, proofs in sight,
Hop along, it's a joyous night!
With every merge, the tokens play,
A brighter path, let’s hop away! 🌟

---

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.