Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: tweak fees collection #2

Merged
merged 7 commits into from
Sep 4, 2024

Conversation

mantricjavier
Copy link
Collaborator

@mantricjavier mantricjavier commented Sep 4, 2024

Description and Motivation

Replaces the bonding manager solution to collect fees with the fee collector contract (to be done).

Related Issues


Checklist:

  • I have read MANTRA's contribution guidelines.
  • My pull request has a sound title and description (not something vague like Update index.md)
  • All existing and new tests are passing.
  • I updated/added relevant documentation.
  • The code is formatted properly cargo fmt --all --.
  • Clippy doesn't report any issues cargo clippy -- -D warnings.
  • I have regenerated the schemas if needed with just schemas.

Summary by CodeRabbit

  • New Features

    • Updated issue templates to reflect the rebranding from "White Whale" to "MANTRA DEX," enhancing clarity and relevance for users.
    • Introduced comprehensive documentation in the README for MANTRA DEX, detailing architecture, components, and operational guidelines.
  • Bug Fixes

    • Adjusted links and references in templates and documentation to direct users to the appropriate MANTRA DEX resources.
  • Chores

    • Updated workspace configuration and dependencies in the project files to reflect the new structure and branding.
  • Documentation

    • Enhanced README and issue templates to align with new branding and improve user engagement.

Copy link

coderabbitai bot commented Sep 4, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The overall changes involve a comprehensive rebranding of the project from "White Whale" to "MANTRA DEX." This includes updates to issue templates, documentation, contract configurations, and various source files to reflect the new identity. Key modifications involve the renaming of components, adjustments to import paths, and the restructuring of dependencies, particularly focusing on fee management and simplifying functionality related to swap routes.

Changes

Files Change Summary
.github/ISSUE_TEMPLATE/*.md Updated project name, links, and descriptions to reflect the transition to MANTRA DEX.
Cargo.toml Modified workspace members and updated homepage, repository, and dependencies for MANTRA DEX.
README.md Introduced comprehensive documentation for MANTRA DEX, detailing architecture and operational guidelines.
contracts/epoch-manager/*.rs Updated import paths and references from White Whale to MANTRA, focusing on epoch management.
contracts/incentive-manager/*.rs Refactored imports, updated fee handling logic, and simplified contract structure for incentives.
contracts/pool-manager/*.rs Adjusted import paths, removed swap route functionalities, and restructured fee management logic.
contracts/pool-manager/schema/*.json Updated schemas to reflect new parameters and removed swap route definitions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Contract
    participant FeeCollector

    User->>Contract: Provide Liquidity
    Contract->>FeeCollector: Send Fee
    FeeCollector-->>Contract: Acknowledge Receipt
    Contract-->>User: Confirm Liquidity Provided
Loading

🐰 In the meadow, hopping with glee,
"MANTRA DEX" is the place to be!
With fees now clear and routes anew,
Our contracts dance in a fresh, bright hue.
So join the fun, don’t delay,
For bunnies and friends, it’s a joyful day! 🐇✨


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 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 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 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@mantricjavier
Copy link
Collaborator Author

@coderabbitai review

Copy link

coderabbitai bot commented Sep 4, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@mantricjavier
Copy link
Collaborator Author

@coderabbitai summary

Copy link

coderabbitai bot commented Sep 4, 2024

Actions performed

Summary regeneration triggered.

@mantricjavier mantricjavier merged commit f333e52 into main Sep 4, 2024
@mantricjavier mantricjavier deleted the refactor/tweak-fees-collection branch September 4, 2024 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant