dashpay / dash-evo-tool

A tool to interact with Evolution
MIT License
4 stars 2 forks source link

feat: withdraws status screen #17

Closed ogabrielides closed 1 week ago

ogabrielides commented 1 week ago

Implemented new withdraw status screen.

Features implemented:

Improvements for the future:

Summary by CodeRabbit

Summary by CodeRabbit

Release Notes

These changes enhance the user experience by providing a dedicated interface for tracking withdrawal statuses and improving task management within the application.

coderabbitai[bot] commented 1 week ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce a new WithdrawsStatusScreen to the application, enhancing the state management and user interface for handling withdrawal statuses. This includes modifications to the AppState, AppContext, and various enums and methods to accommodate the new screen and its functionalities. Additionally, new data structures and methods for managing withdrawal tasks and statuses are defined, ensuring integration with the existing backend task processing flow. The user interface is updated to include a button for accessing the new screen, completing the integration of withdrawal management into the application.

Changes

File Path Change Summary
src/app.rs Added WithdrawsStatusScreen to AppState::new, updated main_screens BTreeMap, modified handle_backend_task to include WithdrawalStatus. Updated logic for context handling.
src/context.rs Added withdraws_contract field to AppContext, modified constructor to load withdrawals contract.
src/platform/mod.rs Introduced withdrawals module, added WithdrawalTask to BackendTask, added WithdrawalStatus to BackendTaskSuccessResult, updated run_backend_task for withdrawal tasks.
src/platform/withdrawals/mod.rs Defined constants for transaction management, introduced WithdrawalsTask enum, added WithdrawRecord and WithdrawStatusData structs, and implemented methods for running and querying withdrawal tasks with error handling.
src/ui/components/left_panel.rs Added a button for "Withdraws Status" in the left panel, ensuring it integrates with existing button rendering logic.
src/ui/mod.rs Introduced withdraws_status_screen module, updated RootScreenType and ScreenType enums to include new variants for withdrawal status.
src/ui/withdraws_status_screen.rs Created WithdrawsStatusScreen struct with methods for UI rendering, data handling, and integration with application context. Implemented methods for displaying withdrawal data and managing UI layout.
testnet_nodes.yml Added a new entry for private_key in the configuration file for testnet nodes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant AppState
    participant AppContext
    participant Backend

    User->>UI: Click "Withdraws Status"
    UI->>AppState: Request WithdrawsStatusScreen
    AppState->>AppContext: Load withdraws_contract
    AppContext->>Backend: Run withdrawal task
    Backend-->>AppContext: Return withdrawal status
    AppContext-->>AppState: Update state with withdrawal status
    AppState-->>UI: Render WithdrawsStatusScreen with data
    UI-->>User: Display withdrawal status

🐇 "In the meadow, a new screen blooms,
For withdrawals, it dispels the glooms.
With buttons bright and data clear,
Hop along, the status is here!
A tale of funds, both near and far,
Our rabbit's journey, a guiding star!" 🌟


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.