vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-withdraw.7.md

78 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
lightning-withdraw -- Command for withdrawing funds from the internal wallet
============================================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
Remove useless \
2022-01-26 17:18:49 +00:00
**withdraw** *destination* *satoshi* [*feerate*] [*minconf*] [*utxos*]
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
DESCRIPTION
-----------
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 06:09:48 +01:00
The **withdraw** RPC command sends funds from Core Lightning's internal
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
wallet to the address specified in *destination*.
The address can be of any Bitcoin accepted type, including bech32.
*satoshi* is the amount to be withdrawn from the internal wallet
(expressed, as name suggests, in satoshi). The string *all* can be used
to specify withdrawal of all available funds. Otherwise, it is in
satoshi precision; it can be a whole number, a whole number ending in
*sat*, a whole number ending in *000msat*, or a number with 1 to 8
decimal places ending in *btc*.
*feerate* is an optional feerate to use. It can be one of the strings
*urgent* (aim for next block), *normal* (next 4 blocks or so) or *slow*
doc: Remove non-ASCII character from docs mrkd doesn't like non-ASCII characters in ubuntu:18.04, used for repro-builds. This is the easiest way to sidestep this issue until we deprecate the old ubuntu version.
2021-10-24 10:44:56 +01:00
(next 100 blocks or so) to use lightningd's internal estimates: *normal*
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
is the default.
Otherwise, *feerate* is a number, with an optional suffix: *perkw* means
the number is interpreted as satoshi-per-kilosipa (weight), and *perkb*
means it is interpreted bitcoind-style as satoshi-per-kilobyte. Omitting
the suffix is equivalent to *perkb*.
*minconf* specifies the minimum number of confirmations that used
outputs should have. Default is 1.
rpc: add 'utxos' parameter to txprepare + withdraw Allow a user to select the utxo set that will be added to a transaction, via the `utxos` parameter. Optional. Format for utxos should be of the form ["txid:vout","..."]
2019-08-28 04:35:29 +01:00
*utxos* specifies the utxos to be used to be withdrawn from, as an array
of "txid:vout". These must be drawn from the node's available UTXO set.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01: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 02:10:17 +01: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 22:33:09 +01: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 02:10:17 +01:00
- **tx** (hex): the fully signed bitcoin transaction
- **txid** (txid): the transaction id of *tx*
- **psbt** (string): the PSBT representing the unsigned transaction
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 11:07:59 +01: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 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
On failure, an error is reported and the withdrawal transaction is not
created.
The following error codes may occur:
- -1: Catchall nonspecific error.
- 301: There are not enough funds in the internal wallet (including
fees) to create the transaction.
- 302: The dust limit is not met.
AUTHOR
------
Felix <<fixone@gmail.com>> is mainly responsible.
SEE ALSO
--------
lightning-listfunds(7), lightning-fundchannel(7), lightning-newaddr(7),
doc/lightning-feerates.7.md: Document `feerates` command. Changelog-None
2020-07-12 04:30:35 +01:00
lightning-txprepare(7), lightning-feerates(7).
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01: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 02:33:16 +01:00
docs: handle "added": "version" and "deprecated": "version" from schemas. This means we will document deprecations and additions, rather than just pretending they've always been that way! Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-09 23:51:01 +00:00
[comment]: # ( SHA256STAMP:57a5a6255500599f39425df668368601f24c95e09b7f0174662d7fba54f05374)