lightning-enableoffer -- Command for re-enabling an offer
SYNOPSIS
enableoffer offer_id
DESCRIPTION
The enableoffer RPC command enables an offer, after it has been disabled.
- offer_id (hash): The id we use to identify this offer.
RETURN VALUE
Note: the returned object is the same format as listoffers.
On success, an object is returned, containing:
- offer_id (hash): The merkle hash of the offer.
- active (boolean) (always true): Whether the offer can produce invoices/payments.
- single_use (boolean): Whether the offer is disabled after first successful use.
- bolt12 (string): The bolt12 string representing this offer.
- used (boolean): Whether the offer has had an invoice paid / payment made.
- label (string, optional): The label provided when offer was created.
ERRORS
On failure, one of the following error codes may be returned:
- -32602: Error in given parameters.
- 1006: offer already enabled.
AUTHOR
Rusty Russell <rusty@rustcorp.com.au> is mainly responsible.
SEE ALSO
lightning-offer(7), lightning-disableoffer(7), lightning-listoffers(7)
RESOURCES
Main web site: https://github.com/ElementsProject/lightning
EXAMPLES
Example 1:
Request:
lightning-cli enableoffer -k "offer_id"="offeridl23000002300000230000023000002300000230000023000002300000"
{
"id": "example:enableoffer#1",
"method": "enableoffer",
"params": {
"offer_id": "offeridl23000002300000230000023000002300000230000023000002300000"
}
}
Response:
{
"offer_id": "offeridl23000002300000230000023000002300000230000023000002300000",
"active": true,
"single_use": false,
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
"used": false
}