[bug]: add CLI examples for TaprootAssetChannels Service to web API docs #1496
Description
We have the TaprootAssetChannels Service (https://lightning.engineering/api-docs/category/taprootassetchannels-service/) with the following commands:
- AddInvoice
- SendPayment
- EncodeCustomRecords
- FundChannel
- DecodeAssetPayReq
Documentation for all of these say # There is no CLI command for this RPC.
I can get the docs with
4d44bef66ecb:/$ litcli ln
NAME:
litcli ln - Interact with the Lightning Network.
USAGE:
litcli ln command [command options] [arguments...]
COMMANDS:
Channels:
fundchannel Open a Taproot Asset channel with a node on the Lightning Network.
Invoices:
addinvoice Add a new invoice to receive Taproot Assets.
Payments:
sendpayment Send a payment over Lightning, potentially using a mulit-asset channel as the first hop
payinvoice Pay an invoice over lightning using an asset.
decodeassetinvoice Decodes an LN invoice and displays the invoice's amount in asset units specified by an asset ID
OPTIONS:
--help, -h show help
4d44bef66ecb:/$
and then more specific info with something like
4d44bef66ecb:/$ litcli ln addinvoice -h
NAME:
litcli ln addinvoice - Add a new invoice to receive Taproot Assets.
USAGE:
litcli ln addinvoice [command options] asset_id asset_amount
CATEGORY:
Invoices
DESCRIPTION:
Add a new invoice, expressing intent for a future payment, received in
Taproot Assets.
OPTIONS:
--memo value a description of the payment to attach along with the invoice (default="")
--preimage value the hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage. If not set, a random preimage will be created.
--amt value the amt of satoshis in this invoice (default: 0)
--amt_msat value the amt of millisatoshis in this invoice (default: 0)
--description_hash value SHA-256 hash of the description of the payment. Used if the purpose of payment cannot naturally fit within the memo. If provided this will be used instead of the description(memo) field in the encoded invoice.
--fallback_addr value fallback on-chain address that can be used in case the lightning payment fails
--expiry value the invoice's expiry time in seconds. If not specified, an expiry of 86400 seconds (24 hours) is implied. (default: 0)
--cltv_expiry_delta value The minimum CLTV delta to use for the final hop. If this is set to 0, the default value is used. The default value for cltv_expiry_delta is configured by the 'bitcoin.timelockdelta' option. (default: 0)
--private encode routing hints in the invoice with private channels in order to assist the payer in reaching you. If amt and amt_msat are zero, a large number of hints with these channels can be included, which might not be desirable.
--amp creates an AMP invoice. If true, preimage should not be set.
--blind creates an invoice that contains blinded paths. Note that invoices with blinded paths will be signed using a random ephemeral key so as not to reveal the real node ID of this node.
--min_real_blinded_hops --blind The minimum number of real hops to use in a blinded path. This option will only be used if --blind has also been set. (default: 0)
--num_blinded_hops --blind The number of hops to use for each blinded path included in the invoice. This option will only be used if --blind has also been set. Dummy hops will be used to pad paths shorter than this. (default: 0)
--max_blinded_paths --blind The maximum number of blinded paths to add to an invoice. This option will only be used if --blind has also been set. (default: 0)
--blinded_path_omit_node value The pub key (in hex) of a node not to use on a blinded path. The flag may be specified multiple times.
--asset_id value the asset ID of the asset to receive
--asset_amount value the amount of assets to receive (default: 0)
--rfq_peer_pubkey value (optional) the public key of the peer to ask for a quote when converting from assets to sats for the invoice; must be set if there are multiple channels with the same asset ID present
4d44bef66ecb:/$
but no new user is going to have a clue how to find that command.