doc/schemas: create close schema.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
parent
0b48dd79ac
commit
5d7203ed6b
|
@ -83,13 +83,23 @@ if the peer is offline and we are waiting\.
|
||||||
|
|
||||||
.SH RETURN VALUE
|
.SH RETURN VALUE
|
||||||
|
|
||||||
On success, an object with fields \fItx\fR and \fItxid\fR containing the closing
|
On success, an object is returned, containing:
|
||||||
transaction are returned\. It will also have a field \fItype\fR which is
|
|
||||||
either the JSON string \fImutual\fR or the JSON string \fIunilateral\fR\. A
|
|
||||||
\fImutual\fR close means that we could negotiate a close with the peer,
|
|
||||||
while a \fIunilateral\fR close means that the \fIforce\fR flag was set and we
|
|
||||||
had to close the channel without waiting for the counterparty\.
|
|
||||||
|
|
||||||
|
.RS
|
||||||
|
.IP \[bu]
|
||||||
|
\fBtype\fR (string): Whether we successfully negotiated a mutual close, closed without them, or discarded not-yet-opened channel (one of "mutual", "unilateral", "unopened")
|
||||||
|
|
||||||
|
.RE
|
||||||
|
|
||||||
|
If \fBtype\fR is "mutual" or "unilateral":
|
||||||
|
|
||||||
|
.RS
|
||||||
|
.IP \[bu]
|
||||||
|
\fBtx\fR (hex): the raw bitcoin transaction used to close the channel (if it was open)
|
||||||
|
.IP \[bu]
|
||||||
|
\fBtxid\fR (txid): the transaction id of the \fItx\fR field
|
||||||
|
|
||||||
|
.RE
|
||||||
|
|
||||||
A unilateral close may still occur at any time if the peer did not
|
A unilateral close may still occur at any time if the peer did not
|
||||||
behave correctly during the close negotiation\.
|
behave correctly during the close negotiation\.
|
||||||
|
@ -110,4 +120,4 @@ ZmnSCPxj \fI<ZmnSCPxj@protonmail.com\fR> is mainly responsible\.
|
||||||
|
|
||||||
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
|
||||||
|
|
||||||
\" SHA256STAMP:c8a4fe414eeb72880346601be2e73f1ad6decb31b4d4e291549d8b339e47b68d
|
\" SHA256STAMP:507a9ca707e244eef65c5e16daa5a4d7ba8f59e93e988d252f7e854ae9f44781
|
||||||
|
|
|
@ -74,12 +74,14 @@ if the peer is offline and we are waiting.
|
||||||
RETURN VALUE
|
RETURN VALUE
|
||||||
------------
|
------------
|
||||||
|
|
||||||
On success, an object with fields *tx* and *txid* containing the closing
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
||||||
transaction are returned. It will also have a field *type* which is
|
On success, an object is returned, containing:
|
||||||
either the JSON string *mutual* or the JSON string *unilateral*. A
|
- **type** (string): Whether we successfully negotiated a mutual close, closed without them, or discarded not-yet-opened channel (one of "mutual", "unilateral", "unopened")
|
||||||
*mutual* close means that we could negotiate a close with the peer,
|
|
||||||
while a *unilateral* close means that the *force* flag was set and we
|
If **type** is "mutual" or "unilateral":
|
||||||
had to close the channel without waiting for the counterparty.
|
- **tx** (hex): the raw bitcoin transaction used to close the channel (if it was open)
|
||||||
|
- **txid** (txid): the transaction id of the *tx* field
|
||||||
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
||||||
|
|
||||||
A unilateral close may still occur at any time if the peer did not
|
A unilateral close may still occur at any time if the peer did not
|
||||||
behave correctly during the close negotiation.
|
behave correctly during the close negotiation.
|
||||||
|
@ -102,3 +104,4 @@ RESOURCES
|
||||||
|
|
||||||
Main web site: <https://github.com/ElementsProject/lightning>
|
Main web site: <https://github.com/ElementsProject/lightning>
|
||||||
|
|
||||||
|
[comment]: # ( SHA256STAMP:9159304cd705d8135c32e12bd029c0e95baff0d495e6f9092a75888dab2f5fb3)
|
||||||
|
|
|
@ -0,0 +1,41 @@
|
||||||
|
{
|
||||||
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||||
|
"type": "object",
|
||||||
|
"required": [ "type" ],
|
||||||
|
"properties": {
|
||||||
|
"type": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [ "mutual", "unilateral", "unopened" ],
|
||||||
|
"description": "Whether we successfully negotiated a mutual close, closed without them, or discarded not-yet-opened channel"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"if": {
|
||||||
|
"properties": {
|
||||||
|
"type": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [ "mutual", "unilateral" ]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"then": {
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [ "tx", "txid" ],
|
||||||
|
"properties": {
|
||||||
|
"type": { },
|
||||||
|
"tx": {
|
||||||
|
"type": "hex",
|
||||||
|
"description": "the raw bitcoin transaction used to close the channel (if it was open)"
|
||||||
|
},
|
||||||
|
"txid": {
|
||||||
|
"type": "txid",
|
||||||
|
"description": "the transaction id of the *tx* field"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"else": {
|
||||||
|
"additionalProperties": false,
|
||||||
|
"properties": {
|
||||||
|
"type": { }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue