core-lightning/doc/lightning-preapprovekeysend.7.md
Rusty Russell eb6b8551d4 tools/fromschema.py: don't try to handle more complex cases.
We only handle top-level objects with an array of objects:
make sure it is one before we call the routines.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 15:15:41 -06:00

1.8 KiB

lightning-preapprovekeysend -- Ask the HSM to preapprove a keysend payment (low-level)

SYNOPSIS

preapprovekeysend destination payment_hash amount_msat

DESCRIPTION

The preapprovekeysend RPC command submits the destination, payment_hash, and amount_msat parameters to the HSM to check that they are approved as a keysend payment.

destination is a 33 byte, hex-encoded, node ID of the node that the payment should go to.

payment_hash is the unique identifier of a payment.

amount_msat is the amount to send in millisatoshi precision; it can be a whole number, or a whole number with suffix msat or sat, or a three decimal point number with suffix sat, or an 1 to 11 decimal point number suffixed by btc.

Generally the preapprovekeysend request does not need to be made explicitly, it is automatically generated as part of a keysend request.

By default, the HSM will approve all preapprovekeysend requests.

If a remote signer is being used it might decline an preapprovekeysend request because it would exceed velocity controls, is not covered by allowlist controls, was declined manually, or other reasons.

If a remote signer declines a preapprovekeysend request a subsequent attempt to pay the keysend anyway will fail; the signer will refuse to sign the commitment.

RETURN VALUE

On success, an empty object is returned.

AUTHOR

Ken Sedgwick <ken@bonsai.com> is mainly responsible.

SEE ALSO

lightning-keysend(7)

RESOURCES

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