search

weweswap / contracts

smart contracts
MIT License
1 stars 4 forks source link

AMM math #83

Open bitcoinbrisbane opened 18 hours ago

bitcoinbrisbane commented 18 hours ago

Closes #81

Summary by CodeRabbit

coderabbitai[bot] commented 18 hours ago

Walkthrough

This pull request introduces new smart contracts and modifies existing ones, focusing on token management and integration with the Uniswap V3 protocol. Key additions include the UniswapV3ViaRouterFomo contract for token swaps, the DynamicEater contract for token vesting and trading, and the MockToken2 for testing purposes. Additionally, a BondingCurve library is added to facilitate price calculations in bonding curves. The deployment configuration is updated to reflect the new contract structure and remove obsolete entries.

Changes

File Path Change Summary
contracts/core/adaptors/UniswapV3ViaRouterFomo.sol Added contract UniswapV3ViaRouterFomo with functions sell, buy, and sellAndBuy.
contracts/core/merge/DynamicEater.sol Added contract DynamicEater, struct Vesting, and multiple functions for token management and vesting.
contracts/core/mocks/MockToken.sol Added new contract MockToken2 implementing ERC20 with standard functions.
contracts/interfaces/IMergeV2.sol Added struct Vesting with properties amount and end.
ignition/deployments/chain-8453/artifacts/DynamicEaterModule#DynamicEater.dbg.json New debug JSON file for DynamicEater.
ignition/deployments/chain-8453/artifacts/DynamicEaterModule#DynamicEater.json New artifact JSON file for DynamicEater contract.
ignition/deployments/chain-8453/artifacts/MergeFactoryModule#MergeFactory.json Removed artifact JSON for MergeFactory.
ignition/deployments/chain-8453/deployed_addresses.json Updated deployed addresses, removing old entries and adding DynamicEater.
ignition/modules/DynamicEaterModule.ts Added new module DynamicEaterModule for contract initialization.
package.json Updated scripts to use yarn and added TypeScript dependencies.
test/DynamicEater.test.ts Added tests for DynamicEater functionality.
contracts/core/BondingCurve.sol Added library BondingCurve with function calculateTokensOut.
.husky/pre-commit Removed pre-commit hook for code formatting.

Assessment against linked issues

Objective Addressed Explanation
Merge ratio starts at slight premium (10-20%) (81) ❓ Implementation details for the premium calculation are not clear.
Merge ratio ends at -50% discount (81) ❓ The discount mechanism is not explicitly defined in the changes.
Use virtual balances to achieve this (81) ✅ The DynamicEater contract utilizes virtual balances for token management.
Send merged coins to the WEWE treasury (81) ❌ There is no implementation for sending merged coins to the treasury.

Possibly related PRs

Suggested labels

enhancement, eat-all-the-tokens

Poem

Hop, hop, here we go,
Dynamic Eater steals the show!
With tokens merged and rates that sway,
In the garden of swaps, we play all day.
A bunny's dream, a treasure trove,
In this code, our magic wove! 🐇✨

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.