chore: update fedimint gateway types

[tvolk131]

Summary by CodeRabbit

• New Features

  • Enhanced state management in the Admin component with new properties for gateway information, improving clarity and functionality.
  • Introduced updated interfaces related to gateway functionality, providing more specific properties and allowing for greater flexibility.

• Bug Fixes

  • Resolved issues related to the initialization of gateway properties, ensuring accurate data handling.

• Documentation

  • Improved clarity on gateway state properties and their intended use within the application.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the state management and structure of gateway functionality in the application. The App.tsx file's gatewayInfo state has been expanded with new properties to improve data clarity. Simultaneously, the gateway.ts file has seen a significant restructuring of interfaces, including renaming and property adjustments to improve consistency and flexibility, particularly concerning routing fees and gateway states.

Changes

Files	Change Summary
apps/gateway-ui/src/App.tsx	Updated the gatewayInfo state in the Admin component to include new properties (version_hash, lightning_pub_key, lightning_alias, route_hints) and additional state attributes (network, block_height, synced_to_chain).
packages/types/src/gateway.ts	Replaced the Gateway interface with LightningGateway, updated fees to RoutingFees, transformed RouteHint into an array type, added optional properties, and enhanced GatewayInfo with new attributes.

Sequence Diagram(s)

sequenceDiagram
    participant Admin
    participant GatewayInfo

    Admin->>GatewayInfo: Initialize gatewayInfo with new properties
    GatewayInfo-->>Admin: Returns initialized state
    Admin->>GatewayInfo: Update gatewayInfo with routing fees
    GatewayInfo-->>Admin: Returns updated state

Loading

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5dc4336 and e7462cc.

Files selected for processing (2)

• apps/gateway-ui/src/App.tsx (1 hunks)
• packages/types/src/gateway.ts (1 hunks)

Additional comments not posted (7)

packages/types/src/gateway.ts (6)

4-13: LGTM!

The LightningGateway interface is well-defined and consistent with the intended functionality.

---

16-16: LGTM!

Transforming RouteHint into a type alias for an array of RouteHintHop objects simplifies the definition.

---

18-25: LGTM!

The RouteHintHop interface is well-defined with appropriate properties and optional fields for flexibility.

---

28-28: LGTM!

Renaming Fees to RoutingFees provides better context and clarity.

---

37-38: LGTM!

Making channel_id and routing_fees optional in FederationInfo increases flexibility.

---

42-52: LGTM!

The updates to GatewayInfo enhance state information and ensure consistency with the new RoutingFees type.

apps/gateway-ui/src/App.tsx (1)

28-41: LGTM!

The updates to the gatewayInfo state initialization improve clarity and explicitly define expected properties and their initial values.

---

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
• Mastodon
• Reddit
• LinkedIn

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]

is this backwards compatible for joining 0.3 federations? think those still have the old gateway info stuff

[Kodylow]

can you update and confirm the backwards compat issue @tvolk131