mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00

Matt Whitlock 09d52b3cb4 doc: escape more naughty underscores

The only time underscores aren't special in Markdown is when they appear
in preformatted text. We have gotten away with not escaping underscores
where an asterisk-enclosed span or the paragraph ends before the next
underscore appears, but this is fragile and bad practice. Conversely,
there are many places where we have not escaped underscores but needed
to.

Escape all underscores that do not appear in preformatted blocks or
preformatted spans and are not themselves delineating emphasized spans.

The changes in this commit are exactly the result of executing the
following Bash code:

```bash
e=':x;'           	# begin loop
e+='s/^'          	# anchor match at beginning of line
e+='('            	# begin capturing subexpression
	e+='('    	# begin list of alternatives
		e+='[^`_\\]|'        	# any mundane character, or
		e+='`([^`\\]|\\.)*`|'	# backtick-enclosed span, or
		e+='\b_|_\b|'        	# underscore at boundary, or
		e+='\\.'             	# backslash-escaped character
	e+=')*'   	# any number of the preceding alternatives
e+=')'            	# end capturing subexpression
e+='\B_\B/\1\\_/;'	# escape non-formatting underscore
e+='tx'           	# repeat loop if we escaped an underscore

escape_underscores=(
	sed

	# use extended regular expressions
	-E

	# skip over indented blocks (following an empty line)
	-e '/^$/{:i;n;/^( {4,}|\t)/bi}'

	# skip over preformatted blocks
	-e '/^\s*```/,/^\s*```/{p;d}'

	# skip over generated sections
	-e '/GENERATE-FROM-SCHEMA-START/,/GENERATE-FROM-SCHEMA-END/{p;d}'

	# escape underscores
	-e "${e}"
)

"${escape_underscores[@]}" -i doc/*.[0-9].md
```

Changelog-None

2022-12-12 15:34:00 +10:30

2.9 KiB

Raw Blame History

lightning-openchannel_bump -- Command to initiate a channel RBF

SYNOPSIS

openchannel_bump channel_id amount initalpsbt [funding_feerate]

DESCRIPTION

openchannel_bump is a RPC command which initiates a channel RBF (Replace-By-Fee) for the specified channel. It uses the openchannel protocol which allows for interactive transaction construction.

id is the id of the channel to RBF.

amount is the satoshi value that we will contribute to the channel. This value will be added to the provided PSBT in the output which is encumbered by the 2-of-2 script for this channel.

initialpsbt is the funded, incomplete PSBT that specifies the UTXOs and change output for our channel contribution. It can be updated, see openchannel_update; initialpsbt must have at least one input. Must have the Non-Witness UTXO (PSBT_IN_NON_WITNESS_UTXO) set for every input. An error (code 309) will be returned if this requirement is not met.

funding_feerate is an optional field. Sets the feerate for the funding transaction. Defaults to 1/64th greater than the last feerate used for this channel.

Warning: bumping a leased channel will lose the lease.

RETURN VALUE

On success, an object is returned, containing:

channel_id (hex): the channel id of the channel (always 64 characters)
psbt (string): the (incomplete) PSBT of the RBF transaction
commitments_secured (boolean): whether the psbt is complete (always false)
funding_serial (u64): the serial_id of the funding output in the psbt

If the peer does not support option_dual_fund, this command will return an error.

If the channel is not in a state that is eligible for RBF, this command will return an error.

On error the returned object will contain code and message properties, with code being one of the following:

-32602: If the given parameters are wrong.
-1: Catchall nonspecific error.
300: The amount exceeded the maximum configured funding amount.
301: The provided PSBT cannot afford the funding amount.
305: Peer is not connected.
309: PSBT missing required fields
311: Unknown channel id.
312: Channel in an invalid state

AUTHOR

@niftynei <niftynei@gmail.com> is mainly responsible.

RESOURCES

Main web site: https://github.com/ElementsProject/lightning comment: # ( SHA256STAMP:3cba5d1c16925322754eae979e956132e8b94e40da0dee6925037a8854d9b791)

2.9 KiB Raw Blame History