mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
d0f6e8c8a6
core-lightning/doc
History
Rusty Russell b45b731c55 doc/schemas: fixes for request schemas. 
Types are fixed, in particular:

* rename "OutputDesc" to more consistent "outputdesc".
* rename "utxo" to more consistent "outpoint".
* it's "boolean" not "bool".
* "number" means int or float, usually it should be u32.

Specific commands:

* close `id` can be by channel id, scid.
* close `feerange` is a feerate type.
* datastore/deldatastore/listdatastore `key` can be singleton.
* delexpiredinvoice: `maxexpirytime` is not required, is a u64.
* invoice/delinvoice/listinvoice `label` can be an integer
* fundpsbt: many fields are u32 not number (JSON for int or float).
* invoice: `msatoshi` can be "any".
* invoice: `expiry` has a type (now must be numeric).
* invoice: `exposeprivatechannels` can be bool or array of scids.
* invoice: `deschashonly` added
* keysend: there's no "float" type, use "number" or "u32" etc.
* keysend: `routehints` is a valid arg, as is `extratlvs` (EXPERIMENTAL_FEATURES)
* listdatastore: `key` is not required.
* newaddr: `addresstype` can be "all"
* pay: `exemptfee` is "msat", new fields `locaofferid` and `exclude`
* sendonion: was mis-formatted, missed `localofferid` and `groupid` fields.
* sendpay: add `localofferid` and `groupid` params.
* signpsbt: add `signonly` param.
* txprepare "outptus" typo.
* waitsendpay: add `groupid` and  fix `partid` type.
* withdraw: `destination` is a bitcoin address, not a pubkey.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-02 09:46:01 +10:30
..
release-notes
schemas doc/schemas: fixes for request schemas. 2022-04-02 09:46:01 +10:30
.gitignore
BACKUP.md doc: remove ambiguity for functionality enabled after a release version 2022-03-10 10:24:34 +10:30
bitcoin.bib
CHANGELOG.md docs: Add configuration for the sphinx documentation generator 2019-02-18 02:42:29 +00:00
commit-tx.eps
commit-tx.svg
conf.py docs: Remove explicit markdown configuration for rtd 2021-08-31 11:46:17 -05:00
deployable-lightning.lyx
deployable-lightning.pdf
dual-anchor-diag1.eps
dual-anchor-diag1.svg
dual-anchor-diag2.eps
dual-anchor-diag2.svg
dual-anchor-diag3.eps
dual-anchor-diag3.svg
dual-anchor-diag4.eps
dual-anchor-diag4.svg
dual-anchor-final.eps
dual-anchor-final.svg
dual-anchor-take2.svg
dual-anchor.svg
FAQ.md doc: update faq and docs for IP discovery 2022-03-12 16:35:09 +10:30
FUZZING.md doc: add a document about our fuzz testing integration 2020-10-21 19:34:39 +02:00
HACKING.md doc: update ubuntu install instructions 2022-03-18 13:09:37 +10:30
htlc.eps
htlc.svg
index.rst lightningd: new setchannel command. 2022-03-22 18:45:41 +10:30
INSTALL.md doc: update ubuntu install instructions 2022-03-18 13:09:37 +10:30
lightning-addgossip.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-autocleaninvoice.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-check.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-checkmessage.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-cli.1.md doc: Remove non-ASCII character from docs 2021-10-31 16:57:56 +01:00
lightning-close.7.md shutdown: don't allow shutdown to p2pkh or p2sh addresses for anchor outputs. 2022-04-02 09:40:18 +10:30
lightning-connect.7.md connect: delay return until all subds ready. 2022-03-23 13:20:12 +10:30
lightning-createinvoice.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-createonion.7.md lightningd: allow 'style' 'legacy' for clboss compat (with deprecated_apis). 2022-03-24 13:19:10 +10:30
lightning-datastore.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-decode.7.md bolt11: support payment_metadata. 2022-04-02 09:40:18 +10:30
lightning-decodepay.7.md bolt11: support payment_metadata. 2022-04-02 09:40:18 +10:30
lightning-deldatastore.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-delexpiredinvoice.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-delinvoice.7.md delinvoice: allow desconly arg to only remove the description. 2022-03-29 10:04:16 +10:30
lightning-delpay.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-disableoffer.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-disconnect.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-feerates.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-fetchinvoice.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-fundchannel_cancel.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-fundchannel_complete.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-fundchannel_start.7.md Add more warnings to fundchannel_start 2022-03-24 14:11:40 +10:30
lightning-fundchannel.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-funderupdate.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-fundpsbt.7.md fundpsbt: deprecate reserve=true/false usage. 2022-04-02 09:46:01 +10:30
lightning-getinfo.7.md doc: add details about: log-level, experimental options and features field returned by listnodes, 2022-03-01 09:38:40 +10:30
lightning-getlog.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-getroute.7.md lightningd: allow 'style' 'legacy' for clboss compat (with deprecated_apis). 2022-03-24 13:19:10 +10:30
lightning-getsharedsecret.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-help.7.md fix: Remove \ from help documentation 2022-03-20 08:42:20 +10:30
lightning-hsmtool.8.md doc: fix 2021-06-30 09:43:23 +09:30
lightning-invoice.7.md lightningd: deprecate invoice expiry suffixes. 2022-04-02 09:46:01 +10:30
lightning-keysend.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-listchannels.7.md doc: add details about: log-level, experimental options and features field returned by listnodes, 2022-03-01 09:38:40 +10:30
lightning-listconfigs.7 Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-listconfigs.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-listdatastore.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-listforwards.7.md lightningd: add "style" to listforwards. 2022-03-31 19:38:05 +10:30
lightning-listfunds.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-listinvoices.7.md delinvoice: allow desconly arg to only remove the description. 2022-03-29 10:04:16 +10:30
lightning-listnodes.7.md doc: add details about: log-level, experimental options and features field returned by listnodes, 2022-03-01 09:38:40 +10:30
lightning-listoffers.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-listpays.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-listpeers.7.md setchannel: add minhtlc 2022-03-22 18:45:41 +10:30
lightning-listsendpays.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-listtransactions.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-multifundchannel.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-multiwithdraw.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-newaddr.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-notifications.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-offer.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-offerout.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-openchannel_abort.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-openchannel_bump.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-openchannel_init.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-openchannel_signed.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-openchannel_update.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-parsefeerate.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-pay.7.md grpc: Map sendonion and createonion 2022-04-02 09:46:01 +10:30
lightning-ping.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-plugin.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-reserveinputs.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-sendcustommsg.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-sendinvoice.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-sendonion.7.md doc: add partid to sendonion schema. 2022-03-31 19:38:05 +10:30
lightning-sendonionmessage.7.md doc: fix sendonionmessage documentation. 2022-03-16 11:24:42 +10:30
lightning-sendpay.7.md sendpay: add payment_metadata argument. 2022-04-02 09:40:18 +10:30
lightning-sendpsbt.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-setchannel.7.md lightningd: make setchannelfee handle multiple channels per peer. 2022-03-23 13:20:12 +10:30
lightning-setchannelfee.7.md lightningd: make setchannelfee handle multiple channels per peer. 2022-03-23 13:20:12 +10:30
lightning-signmessage.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-signpsbt.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-stop.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-txdiscard.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-txprepare.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-txsend.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-unreserveinputs.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-utxopsbt.7.md fundpsbt: deprecate reserve=true/false usage. 2022-04-02 09:46:01 +10:30
lightning-waitanyinvoice.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-waitblockheight.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-waitinvoice.7.md jsonschema: Formatting json schema and regenerate docs 2021-11-28 10:55:48 +10:30
lightning-waitsendpay.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightning-withdraw.7.md Remove useless \ 2022-02-10 12:05:44 +10:30
lightningd-config.5.md lightningd: deprecate setchannelfee, use setchannel in tests. 2022-03-22 18:45:41 +10:30
lightningd.8.md doc: document the errors code 2021-12-15 12:24:54 +10:30
ln-draft-fig1.eps
ln-draft-fig2.eps
Makefile lightningd: new setchannel command. 2022-03-22 18:45:41 +10:30
MAKING-RELEASES.md doc/MAKING-RELEASES.md: advice on updating python package versions. 2021-07-30 19:17:47 +02:00
PLUGINS.md lightningd: allow 'style' 'legacy' for clboss compat (with deprecated_apis). 2022-03-24 13:19:10 +10:30
REPRODUCIBLE.md docs: Update the repro-build docs to the new docker-based system 2020-09-09 20:22:42 +09:30
STYLE.md doc: document how to try to write JSON schemas. 2021-06-25 09:49:33 +09:30
TOR.md Goofy af tor.md systemd syntax update (#5059) 2022-03-13 10:30:11 +10:30
undoc-flags.json plugin-funder: fix typos in option lease-fee-base-msat and funder-fuzz-percent 2022-03-01 09:38:40 +10:30