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

fix gateway typing for new fedimint master #516

Merged
merged 2 commits into from
Sep 9, 2024

Conversation

Kodylow
Copy link
Member

@Kodylow Kodylow commented Sep 9, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced data fetching logic for gateway information, now providing a loading state for improved user feedback.
    • Expanded LightningCard component to include more detailed node information.
    • Updated localization to support new keys for enhanced UI clarity regarding Lightning Node details.
  • Bug Fixes

    • Corrected the data paths for displaying federation names in multiple components to align with the new data structure.
  • Documentation

    • Updated language files to reflect changes in the structure and naming conventions for improved consistency.
  • Chores

    • Refactored code for better readability and maintainability, including the introduction of a new sub-component for standardized information display.

@Kodylow Kodylow requested a review from a team as a code owner September 9, 2024 18:41
Copy link

vercel bot commented Sep 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 9, 2024 6:43pm

Copy link
Contributor

coderabbitai bot commented Sep 9, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

Walkthrough

The changes involve significant updates to the handling of gateway information within a React application. Key modifications include initializing the gatewayInfo state as null, transitioning to an asynchronous data fetching function, and altering the structure of configuration data. Several components have been updated to reflect new data paths for federation names and configuration types. Additionally, the localization JSON file has been modified to enhance the information presented in the UI. The overall structure of interfaces related to gateway configurations and states has been refined for improved type safety.

Changes

Files Change Summary
apps/gateway-ui/src/App.tsx Updated gatewayInfo initialization to null, refactored data fetching to fetchInfoAndConfigs, and added loading state.
apps/gateway-ui/src/GatewayApi.ts Renamed fetchConfig to fetchConfigs and modified its parameter list to remove federationId.
apps/gateway-ui/src/components/federations/FederationsTable.tsx Changed source of name property from federation.config.meta.federation_name to federation.config.global.meta.federation_name.
apps/gateway-ui/src/components/federations/ViewConfig.tsx Changed config type in ViewConfigModalProps from GatewayClientConfig to JsonClientConfig.
apps/gateway-ui/src/components/lightning/LightningCard.tsx Expanded LightningCardProps to include additional required properties and refactored rendering logic using InfoItem sub-component.
apps/gateway-ui/src/components/walletModal/FederationSelector.tsx Updated federation name access path to federation.config.global.meta.federation_name, maintaining fallback.
apps/gateway-ui/src/components/walletModal/receive/ReceiveOnchain.tsx Modified federation name access path to walletModalState.selectedFederation?.config.global.meta.federation_name.
apps/gateway-ui/src/components/walletModal/send/SendEcash.tsx Updated federation name access path to walletModalState.selectedFederation?.config.global.meta.federation_name.
apps/gateway-ui/src/languages/en.json Renamed localization key "card_header" to "card-header" and added new keys for enhanced information in the "info-card" section.
packages/types/src/gateway.ts Modified FederationInfo and GatewayInfo interfaces for type updates, added new properties, and introduced GatewayState enum and LightningMode type.

Tip

New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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.

@Kodylow Kodylow merged commit 1990658 into fedimint:master Sep 9, 2024
2 of 3 checks passed
@Kodylow Kodylow deleted the new-gateway-typing branch September 9, 2024 18:41
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