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

feat: disable when env vars detected + BitcoinRpcKind #492

Merged
merged 2 commits into from
Aug 15, 2024

Conversation

Kodylow
Copy link
Member

@Kodylow Kodylow commented Aug 14, 2024

Prevent people from fucking up their bitcoin configuration if they've properly set it in the .env

image

Summary by CodeRabbit

  • New Features

    • Enhanced Bitcoin settings form with dynamic state management for network and Bitcoin RPC settings.
    • Introduced a selection element for various Bitcoin RPC types.
  • UI Improvements

    • Updated labels to clarify the source of Bitcoin RPC settings, improving user understanding.
  • Localization Updates

    • Revised language strings for clearer guidance on Bitcoin RPC settings and added new distinctions for Bitcoin RPC types.
  • Enhancements

    • New enumeration for Bitcoin RPC types to improve configuration options within the app.

@Kodylow Kodylow requested review from a team as code owners August 14, 2024 18:29
Copy link
Contributor

coderabbitai bot commented Aug 14, 2024

Walkthrough

Walkthrough

The changes enhance the BitcoinSettingsForm component by introducing new props to manage the disabled state of form controls based on external parameters. This improvement increases interactivity and clarity in Bitcoin network and RPC configurations. Additionally, localization strings have been updated for better user guidance, and a new BitcoinRpcKind enum has been introduced to categorize different Bitcoin RPC types.

Changes

File Change Summary
apps/guardian-ui/src/components/setup/screens/setConfiguration/BitcoinSettingsForm.tsx Added props to manage the disabled state of form controls and updated UI elements for clarity regarding external settings.
apps/guardian-ui/src/components/setup/screens/setConfiguration/SetConfiguration.tsx Introduced state variables to track parameter sources and passed new props to the BitcoinSettingsForm component.
apps/guardian-ui/src/languages/en.json Updated existing strings for clarity and added new keys to enhance localization related to Bitcoin RPC settings.
packages/types/src/bitcoin.ts Introduced a new BitcoinRpcKind enum to represent different Bitcoin RPC client types, expanding existing functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SetConfig
    participant BitcoinSettingsForm

    User->>SetConfig: Input wallet parameters
    SetConfig->>BitcoinSettingsForm: Passes networkSetFromParams, bitcoinSetFromParams
    BitcoinSettingsForm->>BitcoinSettingsForm: Set controls disabled based on params
    BitcoinSettingsForm->>User: Display updated form
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 41e5b30 and 7d2f539.

Files selected for processing (1)
  • packages/types/src/bitcoin.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/types/src/bitcoin.ts

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@Kodylow Kodylow changed the title feat: disable bitcoin inputs when env vars detected feat: disable when env vars detected + BitcoinRpcKind Aug 15, 2024
Copy link
Contributor

@elsirion elsirion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Kodylow Kodylow merged commit 6c4c8f6 into fedimint:master Aug 15, 2024
1 check passed
@Kodylow Kodylow deleted the bitcoin-rpc-kind branch August 15, 2024 18:40
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.

2 participants