core-lightning/doc/lightning-delforward.7.md
Rusty Russell b2148d0eab docs: handle "added": "version" and "deprecated": "version" from schemas.
This means we will document deprecations and additions, rather than just
pretending they've always been that way!

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-11 12:51:18 +10:30

1.5 KiB

lightning-delforward -- Command for removing a forwarding entry

SYNOPSIS

delforward in_channel in_htlc_id status

DESCRIPTION

The delforward RPC command removes a single forward from listforwards, using the uniquely-identifying in_channel and in_htlc_id (and, as a sanity check, the status) given by that command.

This command is mainly used by the autoclean plugin (see lightningd-config(7)), As these database entries are only kept for your own analysis, removing them has no effect on the running of your node.

You cannot delete forwards which have status offered (i.e. are currently active).

Note: for listforwards entries without an in_htlc_id entry (no longer created in v22.11, but can exist from older versions), a value of 18446744073709551615 can be used, but then it will delete all entries without in_htlc_id for this in_channel and status.

RETURN VALUE

On success, an empty object is returned.

ERRORS

The following errors may be reported:

  • 1401: The forward specified does not exist.

AUTHOR

Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.

SEE ALSO

lightning-autoclean(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning