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

[bug]: missing description to wtclient command "session" and "terminate" command option #9583

Open
twofaktor opened this issue Mar 5, 2025 · 4 comments · May be fixed by #9588
Open

[bug]: missing description to wtclient command "session" and "terminate" command option #9583

twofaktor opened this issue Mar 5, 2025 · 4 comments · May be fixed by #9588
Labels
documentation Documentation changes that do not affect code behaviour good first issue Issues suitable for first time contributors to LND rpc Related to the RPC interface up for grabs PRs which have been abandoned by their original authors and can be taken up by someone else watchtower

Comments

@twofaktor
Copy link
Contributor

twofaktor commented Mar 5, 2025

Background

After navigating around the lncli wtclient subcommands, I noticed there are missing descriptions and "how to use" for session and terminate command options

Your environment

  • version of lnd: 0.18.5
  • which operating system: Ubuntu Server Jammy LTS
  • version of btcd, bitcoind, or other backend: bitcoind

Steps to reproduce

Navigate around the lncli wtclient subcommands

Expected behaviour

Detailed description of "how to use" for session and terminate subcommand option

Actual behaviour

Missing information

Screenshots

Image

Possible code lines to be addressed

https://github.com/lightningnetwork/lnd/blob/master/cmd/commands/wtclient.go#L378-L420

@twofaktor twofaktor added bug Unintended code behaviour needs triage labels Mar 5, 2025
@guggero guggero added rpc Related to the RPC interface documentation Documentation changes that do not affect code behaviour up for grabs PRs which have been abandoned by their original authors and can be taken up by someone else good first issue Issues suitable for first time contributors to LND and removed bug Unintended code behaviour needs triage labels Mar 5, 2025
MKVEERENDRA added a commit to MKVEERENDRA/lnd that referenced this issue Mar 7, 2025
wtclient: Add descriptions for session and terminate commands

- Added detailed descriptions for the watchtower client session and terminate commands to improve user guidance.
- Fixed formatting issues as per linter requirements.
- Updated release notes for version 0.19.0.

Fixes lightningnetwork#9583
@MKVEERENDRA MKVEERENDRA linked a pull request Mar 7, 2025 that will close this issue
9 tasks
MKVEERENDRA added a commit to MKVEERENDRA/lnd that referenced this issue Mar 7, 2025
wtclient: Add descriptions for session and terminate commands

- Added detailed descriptions for the watchtower client session and terminate commands to improve user guidance.
- Fixed formatting issues as per linter requirements.
- Updated release notes for version 0.19.0.

Fixes lightningnetwork#9583
@MKVEERENDRA
Copy link

#9588 Pls check this

@twofaktor
Copy link
Contributor Author

twofaktor commented Mar 7, 2025

Checked, see comment

@B1n4ryR41nb0w
Copy link

is this still in the need of a triage?

@shivansh-bhatnagar18
Copy link

@twofaktor The sessionCommands currently contains only the terminate command for the watchtower operations which itself has a command terminate. So added the description accordingly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes that do not affect code behaviour good first issue Issues suitable for first time contributors to LND rpc Related to the RPC interface up for grabs PRs which have been abandoned by their original authors and can be taken up by someone else watchtower
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants