mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
4cfd972407
core-lightning/doc/lightning-newaddr.7.md

62 lines
1.8 KiB
Markdown
Raw Normal View History

doc: update c-lightning to Core Lightning almost everywhere. Mostly comments and docs: some places are actually paths, which I have avoided changing. We may migrate them slowly, particularly when they're user-visible. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-06 07:09:48 +02:00
lightning-newaddr -- Command for generating a new address to be used by Core Lightning
======================================================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
SYNOPSIS
--------
Remove useless \
2022-01-26 18:18:49 +01:00
**newaddr** [ *addresstype* ]
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
DESCRIPTION
-----------
The **newaddr** RPC command generates a new address which can
doc: update c-lightning to Core Lightning almost everywhere. Mostly comments and docs: some places are actually paths, which I have avoided changing. We may migrate them slowly, particularly when they're user-visible. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-04-06 07:09:48 +02:00
subsequently be used to fund channels managed by the Core Lightning node.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
The funding transaction needs to be confirmed before funds can be used.
*addresstype* specifies the type of address wanted; i.e. *p2sh-segwit*
doc: Fix minor markup issues in the newaddr manpage
2021-02-10 11:54:27 +01:00
(e.g. `2MxaozoqWwiUcuD9KKgUSrLFDafLqimT9Ta` on bitcoin testnet or
`3MZxzq3jBSKNQ2e7dzneo9hy4FvNzmMmt3` on bitcoin mainnet) or *bech32*
(e.g. `tb1qu9j4lg5f9rgjyfhvfd905vw46eg39czmktxqgg` on bitcoin testnet
or `bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej` on
bitcoin mainnet). The special value *all* generates both address types
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
for the same underlying key.
doc: Fix minor markup issues in the newaddr manpage
2021-02-10 11:54:27 +01:00
If no *addresstype* is specified the address generated is a *bech32* address.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
Update lightning-newaddr.7.md Added a sentence to explain which command to use to send an on-chain payment _from_ the CLN wallet.
2022-07-06 20:07:38 +02:00
To send an on-chain payment _from_ the Core Lightning node wallet, use `withdraw`.
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
RETURN VALUE
------------
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 23:33:09 +02:00
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
- **bech32** (string, optional): The bech32 (native segwit) address
- **p2sh-segwit** (string, optional): The p2sh-wrapped address
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 12:07:59 +02:00
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
ERRORS
------
If an unrecognized address type is requested an error message will be
returned.
AUTHOR
------
Felix <<fixone@gmail.com>> is mainly responsible.
SEE ALSO
--------
added documentation of commands listnodes, sendpsbt Some grammar mistake was fixed as suggest and more command docs were added. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-13 18:19:35 +02:00
lightning-listfunds(7), lightning-fundchannel(7), lightning-withdraw(7), lightning-listtransactions(7)
doc/manpages: replace asciidoc by markdown
2019-08-10 01:54:18 +02:00
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 03:33:16 +02:00
doc: escape output types (esp `short_channel_id`). We can also remove the listpeers closer hack, which was removed from the schema already. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-08 03:08:00 +02:00
[comment]: # ( SHA256STAMP:e9650b5f1f4374007c8fde63dae2ac9981c952ed8074aabade39fcc0ebe21333)
Reference in New Issue Copy Permalink