aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-24 01:24:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Use dedicated type for error codes

Browse Source 
Before this patch we used `int` for error codes. The problem with
`int` is that we try to pass it to/from wire and the size of `int` is
not defined by the standard. So a sender with 4-byte `int` would write
4 bytes to the wire and a receiver with 2-byte `int` (for example) would
read just 2 bytes from the wire.

To resolve this:

* Introduce an error code type with a known size:
  `typedef s32 errcode_t`.

* Change all error code macros to constants of type `errcode_t`.
  Constants also play better with gdb - it would visualize the name of
  the constant instead of the numeric value.

* Change all functions that take error codes to take the new type
  `errcode_t` instead of `int`.

* Introduce towire / fromwire functions to send / receive the newly added
  type `errcode_t` and use it instead of `towire_int()`.

In addition:

* Remove the now unneeded `towire_int()`.

* Replace a hardcoded error code `-2` with a new constant
  `INVOICE_EXPIRED_DURING_WAIT` (903).

Changelog-Changed: The waitinvoice command would now return error code 903 to designate that the invoice expired during wait, instead of the previous -2
This commit is contained in:
Vasil Dimov
2020-01-26 13:52:29 +01:00
committed by ZmnSCPxj, ZmnSCPxj jxPCSmnZ
parent 295ca2a436
commit 55173a56b7
29 changed files with 187 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/lightning-waitinvoice.7 generated
View File

@@ -16,14 +16,18 @@ On success, an invoice description will be returned as per
\fBlightning-listinvoice\fR(7)\. The \fIstatus\fR field will be \fIpaid\fR\.
If the invoice is deleted while unpaid, or the invoice does not exist,
this command will return with an error with code -1\.
On error the returned object will contain \fBcode\fR and \fBmessage\fR properties,
with \fBcode\fR being one of the following:
.RS
.IP \[bu]
-32602: If the given parameters are wrong\.
.IP \[bu]
-1: If the invoice is deleted while unpaid, or the invoice does not exist\.
.IP \[bu]
903: If the invoice expires before being paid, or is already expired\.
If the invoice expires before being paid, or is already expired, this
command will return with an error with code -2, with the data being the
invoice data as per \fBlistinvoice\fR\.
.RE
.SH AUTHOR
Christian Decker \fI<decker.christian@gmail.com\fR> is mainly
@@ -38,7 +42,3 @@ responsible\.
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
.HL
Last updated 2019-04-07 14:23:17 CEST

10
doc/lightning-waitinvoice.7.md
View File

@@ -18,12 +18,12 @@ RETURN VALUE
On success, an invoice description will be returned as per
lightning-listinvoice(7). The *status* field will be *paid*.
If the invoice is deleted while unpaid, or the invoice does not exist,
this command will return with an error with code -1.
On error the returned object will contain `code` and `message` properties,
with `code` being one of the following:
If the invoice expires before being paid, or is already expired, this
command will return with an error with code -2, with the data being the
invoice data as per **listinvoice**.
- -32602: If the given parameters are wrong.
- -1: If the invoice is deleted while unpaid, or the invoice does not exist.
- 903: If the invoice expires before being paid, or is already expired.
AUTHOR
------