Commit Graph

888 Commits

Author SHA1 Message Date
Douglas Roark
5e23dccb3b Add cross-compile instructions for Raspberry Pi (#1263)
These are basic instructions that lead to the build process completing without error (after a known error occurs and is rectified). For now, the final results are untested.
2018-04-03 16:10:13 +02:00
ZmnSCPxj
26f7014813 payalgo: Add maximum delay.
Fixes: #1086
2018-04-03 04:29:48 +00:00
ZmnSCPxj
bc5fc692d1 pay: Let sendpay modify the recorded msatoshi of payments. 2018-03-30 15:40:32 +02:00
Rusty Russell
a85ead7058 invoice: allow numeric labels again.
Fixes: #1291
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-03-30 00:01:10 +02:00
Mark Beckwith
217d4f99eb Added link to macOS in install index.
Also, technically, the name of the current version of the OS is macOS, so I
updated it.
2018-03-26 01:05:11 +00:00
Rusty Russell
880c19eb4e doc: document restrictions on invoice RPC.
In particular: label must be a string, and description cannot use any
the JSON unicode escapes, which should be unnecessary with UTF-8
anyway.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-03-26 00:20:53 +00:00
practicalswift
0bf1b01425 Fix typos 2018-03-25 15:53:01 +02:00
conanoc
cbe0b2d3a8 Update Install.md to add Mac section (#1225)
* Update Install.md to add Mac section
2018-03-22 13:41:29 +01:00
Douglas Schilling Landgraf
35e85ab901
Documentation (#1238)
* build: update INSTALL.md to include Fedora #1028

* doc: Add TOC to INSTALL.md

* doc: Use lower case for anchors in TOC and minor changes

- anchors require lower case
- TOC doesn't work with dots, using OS names

* doc: improving FreeBSD doc

- Add missing packages: gmp and asciidoc
- Include step gmake install
2018-03-21 20:56:57 +01:00
ZmnSCPxj
159e736fc1 invoices: Implement autocleaninvoice. 2018-03-20 17:25:51 +01:00
ZmnSCPxj
3b0081aebb invoices: Add delexpiredinvoice command. 2018-03-20 17:25:51 +01:00
ZmnSCPxj
7443bf5ed5 doc: Update for latest 'pay' command. 2018-03-19 00:27:55 +00:00
ZmnSCPxj
39d8f64226 doc: Update manpages for change in return value. 2018-03-16 01:24:43 +00:00
Rusty Russell
a935ae0711 doc: Link STLYE.md from HACKING.md
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-03-16 00:16:10 +00:00
Rusty Russell
08f4d48b0f Add some Style.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-03-16 00:16:10 +00:00
ZmnSCPxj
8fd71ad654 doc: Update sendpay and waitsendpay manpages. 2018-03-14 05:33:09 +00:00
Jan Sarenik
9b3e8f0bd3 bitcoin.bib: Add Satoshi paper URL and date
Date according to Wikipedia which cites other source.
2018-03-04 03:22:32 +01:00
Jan Sarenik
fd338c0689 doc: More plain-text improvements to HACKING.md and INSTALL.md
This time the rendered output is slightly different, but mostly
because long preformatted lines are wrapped and contain an extra
continuation backslash now.
2018-03-04 03:21:59 +01:00
Jan Sarenik
960548f311 doc: Reflow HACKING.md and INSTALL.md without textual change
See previous commit 9504a77b for a script to prove there is no
change in the rendered file, just readability plain-text
improvements.
2018-03-04 03:21:59 +01:00
ZmnSCPxj
6c9d81ef42 payalgo: Remove reporting PAY_TRY_ANOTHER_ROUTE and PAY_UNPARSEABLE_ONION.
These error codes will cause `pay` to retry, so `pay` will never
actually report those error codes.
Those error codes will only get reported at the `sendpay` level.
2018-02-27 13:38:32 +01:00
Igor Cota
694fb41ef6 Update INSTALL.md 2018-02-27 13:32:51 +01:00
Igor Cota
642cff84ea Update INSTALL.md
Add Android build instructions
2018-02-27 13:32:51 +01:00
ZmnSCPxj
1cf32f9f05 doc: Update manpage for getroute and pay for route randomization. 2018-02-26 02:36:27 +00:00
ZmnSCPxj
38535fc36c payalgo: Create a new failure for paying expired invoice. 2018-02-18 13:51:37 +01:00
ZmnSCPxj
4e382ebd94 doc: Mention keyword arguments, update pay to mention use of null. 2018-02-12 09:30:16 +01:00
ZmnSCPxj
203c222f57 doc: Update to add fee limit to pay. 2018-02-09 12:44:33 +01:00
practicalswift
4f4756bd20 Fix a-vs-an typos 2018-02-08 22:49:34 +01:00
ZmnSCPxj
d4478458dd pay: Change origin_index to erring_index, start with local node = 0. 2018-02-06 17:05:12 +01:00
ZmnSCPxj
b7c9029fe3 doc: Update for new error codes of sendpay. 2018-02-06 17:05:12 +01:00
Sjors Provoost
e4d719a421 [doc] install: add libsodium-dev 2018-02-05 10:48:52 +00:00
ZmnSCPxj
ba24fe0ba3 doc: Update manpage for waitinvoice. 2018-02-05 08:52:42 +00:00
ZmnSCPxj
4255e4186d HACKING: Add subtleties. 2018-02-03 17:54:57 +01:00
luca vaccaro
d36fa33c9b Explain table vars (#792)
* Database Table vars

Explain Database Table vars and bip32_max_index variable.
2018-01-28 01:41:31 +01:00
William Casarin
5b4a62d822 doc: some sqlite db info for HACKING
Signed-off-by: William Casarin <jb55@jb55.com>
2018-01-26 01:20:07 +00:00
William Casarin
8aee38162c doc: Nix{,OS} build instructions
Signed-off-by: William Casarin <jb55@jb55.com>
2018-01-26 01:02:51 +00:00
practicalswift
17aaa1d235 Fix lightning typos 2018-01-26 01:02:15 +00:00
practicalswift
96d093fb30 Fix typos 2018-01-24 17:29:40 +01:00
Carl Dong
feb734086b build: Update INSTALL.md to include FreeBSD. 2018-01-23 16:10:19 +01:00
ZmnSCPxj
940819567d lightning-cli: Add support for null argument. 2018-01-23 12:21:56 +01:00
Rusty Russell
5e0a5c9111 JSONRPC: delinvoice: have a status argument.
delinvoice was orginally documented to only allow deletion of unpaid
invoices, but there might be reasons to delete paid ones or unexpired ones.

But we have to avoid the race where someone pays as it's deleted: the
easiest way is to have the caller tell us the status, and fail if
it's wrong.

Fixes: #477
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-19 22:23:45 +00:00
Rusty Russell
bd010d4b96 listinvoices: deprecate 'complete' in favor of 'status' trinary.
[ Manpage regen fixup by Christian Decker ]
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-19 22:23:45 +00:00
Rusty Russell
1a641c823c JSONRPC: Make listinvoice an deprecated alias for listinvoices.
This matches the other names, and also the return value is about to change.

This will be removed before release!

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-19 22:23:45 +00:00
Rusty Russell
461207b886 getroute: document cltv argument.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-19 22:23:45 +00:00
Christian Decker
f298c6b03e doc: Adding generate listpayments man page 2018-01-18 20:53:11 +01:00
practicalswift
aefc887521 Fix typos 2018-01-18 20:50:07 +01:00
ianthius
2d5c958617 Python is a needed dependency here
Make seems to require python as well as python3.
2018-01-18 11:41:56 +01:00
ZmnSCPxj, ZmnSCPxj jxPCSmnZ
be0b76f03d INSTALL.md: Add automake as dependency.
Fixes: #624
2018-01-17 16:17:32 +01:00
windsok
710e91f255 update invoice manpage to match current RPC and CLI interface 2018-01-16 13:15:32 +01:00
Rusty Russell
1950583612 subdaemon: make debugging a bit easier.
Use a volatile global, so debugger can flip it easily.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-15 19:26:08 +00:00
William Casarin
3e3dbfdd1b hacking: document subdaemon debugging
Signed-off-by: William Casarin <jb55@jb55.com>
2018-01-15 19:26:08 +00:00
Rusty Russell
6d7c8c8dd0 doc: manpages for pay, listpayments and decodepay.
Also contains some help message clarifications.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-14 23:10:10 +00:00
Rusty Russell
2f2fb0c2a1 invoice: add msatoshi_received field.
Paid invoices need to know how much was actually paid: both for the case
where no 'msatoshi' amount was specified, and for the normal case, where
clients are permitted to overpay in order to help them disguise their
payments.

While we migrate the db, we leave this field as 0 for old paid
invoices.  This is unhelpful for accounting, but at least clearly
indicates what happened if we find this in the wild.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-14 23:10:10 +00:00
Rusty Russell
66885163c9 JSON: Rename rhash to payment_hash in delinvoice, invoice, listinvoice, waitinvoice, waitanyinvoice.
'rhash' is the old terminology, but 'payment_preimage' and
'payment_hash' were decided on for the BOLTs, so we should fix that here.

We still use rhash internally, but that's much easier to fix.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-14 23:10:10 +00:00
Rusty Russell
f031120903 doc: update return values of delinvoice, invoice, listinvoice, waitinvoice, waitanyinvoice.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-14 23:10:10 +00:00
ZmnSCPxj
816298123f invoice: Allow "any" msatoshi, for amountless invoices.
Fixes: #534
2018-01-12 01:43:55 +00:00
Rusty Russell
758317387e HACKING.md: describe take() in more detail.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-10 03:58:46 +00:00
Rusty Russell
9b129f7fb5 doc/HACKING.md: update.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-01-10 03:58:46 +00:00
ZmnSCPxj
5eceaa7be9 invoice: Modify waitanyinvoice interface to use pay_index. 2018-01-03 01:12:49 +00:00
practicalswift
aee3661b35 Fix typos (repeated words) 2017-12-28 16:04:38 +01:00
practicalswift
61c47c09d0 Fix typos 2017-12-08 13:07:20 +01:00
Rusty Russell
45e9f35988 docs: Note that we need 0.15 (for estimatesmartfee with CONSERVATIVE/ECONOMCIAL flags)
Closes: #392
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-04 10:06:34 +01:00
Damian Mee
211791f6d2 Lightning daemon path fixed 2017-11-20 22:14:07 +01:00
Rusty Russell
ebba5f85a2 handshaked: remove.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-10-20 18:31:32 +02:00
Rusty Russell
9da5abc39c docs: update, move into doc/
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-08-29 17:54:14 +02:00
Christian Decker
da31675537 doc: Adding compiled manpage 2017-02-27 14:55:53 +01:00
Christian Decker
51a22c4274 doc: Fixed two small mistakes in the getroute documentation
Two arguments were flipped and riskfactor was missing in the error
message returned from the JSON.
2017-02-22 21:46:07 +10:30
Rusty Russell
2fb2e757ae doc: add lightning-waitinvoice man page.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 10:39:43 +10:30
Rusty Russell
69079e51a9 doc: move Makefile parts into doc/
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 10:38:42 +10:30
Rusty Russell
df59cef3af doc: rename waitinvoice manpage to waitanyinvoice.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-01-23 10:28:32 +10:30
Rusty Russell
2452df315a doc: manpages for the various lightning RPC calls.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2016-09-06 16:47:41 +09:30
Denis Gorbachev
8f18ca977b Minor fixes 2016-01-22 09:09:33 +10:30
Rusty Russell
5de21f80de Regenerate PDF.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-11-20 06:45:19 +10:30
Douglas Roark
6394d2de16 Minor "Reaching the Ground With Lightning" fixes.
- Added a reference to BIP112 and to the deployment of BIP68.
- Minor typo, grammar and formatting fixes.
2015-11-18 09:54:41 +10:30
Rusty Russell
2ab9e3bd7f doc/deployable-lightning: corrections and fixes.
1) Note incorrect label in txs in Fig1 of LN paper.
2) "an atomic-swap an on-chain.." -> "an atomic-swap *to* an on-chain"
3) "By using a dual anchor and escape transactions" -> "By using a rebalanced single anchor"
4) References to appendices fixed.
5) Move escape transaction scripts out to escape appendix.
6) Fix URL in bibliography (missing comma).

Reported-by: John Newbery
Closes: #11
Closes: #12
Reported-by:
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-10-19 10:54:49 +10:30
Rusty Russell
bc056fbc4d doc/deployable-lightning: point out that Fig 4 is simplified.
Fixes #4

Reported-by: Pierre <pm+lists@acinq.fr>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-09-15 04:23:25 +09:30
Rusty Russell
71c56e0360 doc: biblopgraphy update
Thanks to Anthony Towns for digging this up.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-09-11 10:20:47 +09:30
pm47
a97d390128 fixed typos in pdf 2015-08-18 12:03:28 +02:00
Rusty Russell
6883d28f6d doc: move dual anchor with escapes to Appendix B.
Draft 0.2; we use a single-sided anchor now, for simplicity.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-08-08 20:43:43 +09:30
Rusty Russell
88ca0c91d9 doc: document HTLC 2drop optimization.
We can save an opcode in both HTLC send and receive scripts by using
OP_2DROP instead of OP_DROP twice.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-08-07 12:45:30 +09:30
Rusty Russell
f693979384 doc: fix KEY-A typo, add missing delay.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-07-29 16:22:20 +09:30
Rusty Russell
8a127ab8a9 doc: clarify wording on section 3.1
StephenM347 on #lightning-dev indicated it could be clearer that
this is all about changing commitment transactions.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-07-24 16:00:07 +09:30
Rusty Russell
305b8cd27d doc: switch signatures around in escape and commit input scripts.
Because of the way we form the redeemscripts, it's easier to have it
push B's sig then A's.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-07-24 15:59:58 +09:30
Rusty Russell
da503c1ee1 doc: simplify anchor output script, fix users.
It's slightly clearer to do the "2" outside the branch.

Also, spending it requires the extra 0 due to OP_CHECKMULTISIG bug.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-07-20 16:39:52 +09:30
Rusty Russell
d93eee22f5 doc: add figures from LN draft (thanks Joseph!).
Also clean up references to Appendix A.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-07-20 14:07:40 +09:30
Rusty Russell
73ba5acca9 doc: fix flaw in escape transactions.
As reported by mmeijeri on r/Bitcoin:

https://www.reddit.com/r/Bitcoin/comments/3dlxw4/reaching_the_ground_with_lightning_lightning/ct80xpp

As the signature doesn't cover the input itself, you could replace the
secret key from the escape transaction with 0, and it will use the "A and B"
branch of the output.

(This also fixes a bug in the anchor output where the OP_IF consumed the
secret).

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-07-20 14:07:25 +09:30
Rusty Russell
ce4bdb9fe1 doc: fix error in fast-escape redeemscript.
Reported by killerstorm on reddit:
https://www.reddit.com/r/Bitcoin/comments/3dlxw4/reaching_the_ground_with_lightning_lightning/ct6jyim

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-07-18 20:40:30 +09:30
Rusty Russell
d9c29387d1 doc: typo from roasbeef on reddit.
https://www.reddit.com/r/Bitcoin/comments/3dlxw4/reaching_the_ground_with_lightning_lightning/ct78mk9

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-07-18 19:32:37 +09:30
Rusty Russell
e4921b9bc6 Add documentation.
First up, a draft of a paper showing the differences between the LN draft
and this.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2015-07-18 10:46:53 +09:30