Skip to content

docs: fix htlc states description regarding direction#8305

Merged
rustyrussell merged 1 commit into
ElementsProject:masterfrom
daywalker90:htlc-order-fix
Nov 13, 2025
Merged

docs: fix htlc states description regarding direction#8305
rustyrussell merged 1 commit into
ElementsProject:masterfrom
daywalker90:htlc-order-fix

Conversation

@daywalker90
Copy link
Copy Markdown
Collaborator

@daywalker90 daywalker90 commented May 22, 2025

Either i fixed it correctly or alot more is wrong.

From the listhtlcs/wait schema description:

state (string) (one of "SENT_ADD_HTLC", "SENT_ADD_COMMIT", "RCVD_ADD_REVOCATION", "RCVD_ADD_ACK_COMMIT", "SENT_ADD_ACK_REVOCATION", "RCVD_REMOVE_HTLC", "RCVD_REMOVE_COMMIT", "SENT_REMOVE_REVOCATION", "SENT_REMOVE_ACK_COMMIT", "RCVD_REMOVE_ACK_REVOCATION", "RCVD_ADD_HTLC", "RCVD_ADD_COMMIT", "SENT_ADD_REVOCATION", "SENT_ADD_ACK_COMMIT", "RCVD_ADD_ACK_REVOCATION", "SENT_REMOVE_HTLC", "SENT_REMOVE_COMMIT", "RCVD_REMOVE_REVOCATION", "RCVD_REMOVE_ACK_COMMIT", "SENT_REMOVE_ACK_REVOCATION"): The first 10 states are for in, the next 10 are for out.

This does not fit the output of the rpc commands and i believe the sentence should be The first 10 states are for out, the next 10 are for in. (please double check if this is correct!)

I also made the newly added (25.05) htlcs subsystem in wait use the HtlcState primitive and while i was at it added some Display traits.

Important

25.05 FREEZE MAY 05TH: Non-bugfix PRs not ready by this date will wait for 25.08.

RC1 is scheduled on May 12th, RC2 on May 16th, ...

The final release is on MAY 20TH.

Checklist

Before submitting the PR, ensure the following tasks are completed. If an item is not applicable to your PR, please mark it as checked:

  • The changelog has been updated in the relevant commit(s) according to the guidelines.
  • Tests have been added or modified to reflect the changes.
  • Documentation has been reviewed and updated as needed.
  • Related issues have been listed and linked, including any that this PR closes.

@daywalker90 daywalker90 requested a review from cdecker as a code owner May 22, 2025 10:34
Copy link
Copy Markdown
Member

@cdecker cdecker left a comment

Choose a reason for hiding this comment

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

Looking good, it should only impact the human readable outputs and align much better with the docs 👍

ACK

@rustyrussell
Copy link
Copy Markdown
Contributor

Trivial rebase on master.

@rustyrussell
Copy link
Copy Markdown
Contributor

YA trivial rebase

@rustyrussell rustyrussell merged commit e9f3aaf into ElementsProject:master Nov 13, 2025
33 of 38 checks passed
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.

4 participants