Fixes/chaos

[bitcoinbrisbane]

Creating new PR to test CodeRabbit

Summary by CodeRabbit

Release Notes

• New Features

  • Added command-line instructions for blockchain interactions, including NFT minting and asset transfers.
  • Introduced a table of contract addresses for easy reference.
  • New refund functions for CHAOS tokens added to the Farm contract.
  • Implemented a mock Farm contract for testing purposes.

• Bug Fixes

  • Simplified the emergency withdrawal function for better usability.

• Documentation

  • Enhanced README with detailed command usage and contract address information.

• Tests

  • Added tests for the ChaosToken and Farm contract interactions, ensuring expected behaviors and functionality.

[coderabbitai[bot]]

Walkthrough

The changes involve significant modifications across several smart contracts and related files. Key alterations include the introduction of new command-line instructions for blockchain interactions, the restructuring of the Farm contract to enhance clarity and security, and the transition of the ChaosToken from ERC777 to ERC20. Additionally, new mock contracts for testing have been added, while some interfaces and mock implementations have been removed or updated. The documentation has been enhanced with a new section for contract addresses, and various testing files have been introduced or refined to ensure proper functionality.

Changes

File Path	Change Summary
README.md	Added command-line instructions for blockchain operations and a new section for contract addresses.
contracts/core/Farm.sol	Removed ICHAOS interface, implemented IWeweReceiver, updated constructor, modified several functions to use _self, simplified emergencyWithdraw, added refund functions.
contracts/core/mocks/MockChaos.sol	Deleted mock contract that simulated interactions with the ICHAOS interface.
contracts/core/mocks/MockFarm.sol	Introduced a new mock contract implementing IFarm for testing purposes.
contracts/core/mocks/MockLPToken.sol	Modified approve function to include logging for better visibility.
contracts/interfaces/IApproveAndCall.sol	Added IApproveAndCall interface for token approval and deposit functionality.
contracts/interfaces/ICHAOS.sol	Deleted interface for ICHAOS, removing structures and functions related to liquidity pools.
contracts/interfaces/IFarm.sol	Added new structures and functions, including UserInfo, PoolInfo, and refund mechanisms, along with updated event declarations.
contracts/interfaces/IOwnable.sol	Introduced interface for ownership management.
contracts/token/ChaosToken.sol	Transitioned from ERC777 to ERC20, added max supply constraint, and updated minting functionality.
ignition/deployments/.../ChaosToken.dbg.json	Deleted debug information file for ChaosToken.
ignition/deployments/.../ChaosToken.json	Deleted artifact file for ChaosToken, indicating complete removal from the codebase.
ignition/deployments/.../Farm.dbg.json	Updated build information reference in debug file for Farm.
ignition/deployments/.../Farm.json	Corrected typographical errors in event and function names.
ignition/deployments/.../Migration.dbg.json	Deleted debug configuration file for Migration.
ignition/deployments/deployed_addresses.json	Updated address for FarmModule#Farm.
ignition/deployments/journal.jsonl	Added deployment details for Migration, ChaosToken, and Farm contracts.
ignition/modules/Farm.ts	Changed CHAOS_ADDRESS from dynamic import to hardcoded value.
test/Chaos.test.ts	Introduced tests for ChaosToken, focusing on deployment and interaction with Farm.
test/Farm.test.ts	Enhanced testing logic for Farm, refined assertions, and standardized account handling.

Poem

In the meadow where the code does bloom,
Changes hop, dispelling gloom.
Tokens dance from ERC777's sway,
To ERC20, brightening the day.
With new commands and tests in sight,
Our blockchain dreams take flight! 🐇✨

---

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 1c3ceb43bcfe8017076e62c9d8d4df7a9091d9b2 and 24f6f432de28df4ce6517f499f323e6ddf78964b.

Files selected for processing (2)

* contracts/core/Farm.sol (9 hunks) * contracts/token/ChaosToken.sol (1 hunks)

Files skipped from review as they are similar to previous changes (1)

* contracts/core/Farm.sol

Additional comments not posted (5)

contracts/token/ChaosToken.sol (5)

`4-6`: **LGTM!** The import statements have been updated correctly to reflect the change from ERC777 to ERC20. The addition of `IOwnable.sol` and `IFarm.sol` imports is also consistent with the contract's intended functionality. --- `9-11`: **LGTM!** The contract declaration change from ERC777 to ERC20 is a good simplification of the token's functionality. The addition of `_maxSupply` is a crucial feature for managing token issuance and preventing inflation. The addition of `_farm` state variable is also consistent with the contract's intended functionality to interact with a farming contract. --- `13-13`: **LGTM!** The constructor has been updated correctly to remove the `defaultOperators` parameter, which is consistent with the change from ERC777 to ERC20. Initializing the token with only its name and symbol is sufficient for an ERC20 token. --- `19-22`: **LGTM!** The updates to the `mint` function are crucial for managing token issuance and preventing inflation. Enforcing the maximum supply constraint and directing minted tokens to the `_farm` address enhances the contract's integration with the farming mechanism. Requiring the `_farm` address to be set before minting is also a good security measure to prevent unauthorized minting. --- `24-28`: **LGTM!** The addition of the requirement for the `_farm` address to be set before executing `collectEmmisions` is a good security measure. It reinforces the dependency on the farming contract and prevents unauthorized calls to the farming contract.

--- 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.