core-lightning/doc/lightning-preapprovekeysend.7.md
ShahanaFarooqui b0da807700 doc: Markdown cleanup
This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json.

- Removing parameter description text
- Adding/removing newlines for cleaner formatting
- Adding ERRORS title wherever needed
- Updating titles for consistency
- Adding resources links
2024-03-19 14:58:59 +10:30

1.4 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.

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