Skip to content

lib/types: define boarding types - #13

Merged
Roasbeef merged 1 commit into
lightninglabs:mainfrom
ellemouton:boarding
Nov 22, 2025
Merged

lib/types: define boarding types#13
Roasbeef merged 1 commit into
lightninglabs:mainfrom
ellemouton:boarding

Conversation

@ellemouton

Copy link
Copy Markdown
Member

Define the various types that both client and server will need during boarding.

@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello @ellemouton, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new file, lib/types/boarding.go, which defines a suite of Go data structures essential for facilitating the 'boarding' process within the system. These types are designed to streamline and standardize the exchange of information between clients and the server, covering everything from initial client requests to detailed batch transaction outputs and operator terms. The changes aim to establish a clear and robust foundation for managing virtual UTXOs (VTXOs) and related operations, ensuring consistency and clarity in the system's core interactions.

Highlights

  • New Type Definitions: Introduced a comprehensive set of Go data structures within lib/types/boarding.go to standardize client-server communication during the 'boarding' process.
  • Client Request Aggregation: Defined JoinRoundRequest to encapsulate various client intentions, including requests for new VTXOs, boarding UTXOs, leaving the Ark, and forfeiting VTXOs.
  • Batch Transaction Information: Added structures like BatchOutputInfo, ConnectorOutputInfo, and ClientBatchInfo to provide detailed information about batch transaction outputs and their relevance to individual clients.
  • Signature and Delay Handling: Included types such as BoardingInputSignature and ForfeitTxSig for managing client signatures, and incorporated BoardingExitDelay and VTXOExitDelay in OperatorTerms to specify minimum CSV delays.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new file with type definitions for the boarding process. The new types are well-defined and clearly commented, which is great for maintainability. I have a couple of minor suggestions to fix a typo and a misleading comment to further improve clarity.

Comment thread lib/types/boarding.go
Comment on lines +156 to +157
// SignerKey is they key that the operator will use for the Musig2
// signing sessions for this batch output.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

There's a typo in the comment. It should be 'the' instead of 'they'.

Suggested change
// SignerKey is they key that the operator will use for the Musig2
// signing sessions for this batch output.
// SignerKey is the key that the operator will use for the Musig2
// signing sessions for this batch output.

@Roasbeef Roasbeef left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM 🪣

@Roasbeef
Roasbeef merged commit d0a9b75 into lightninglabs:main Nov 22, 2025
15 of 16 checks passed
@ellemouton
ellemouton deleted the boarding branch November 23, 2025 15:05
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.

3 participants