mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-22 06:41:44 +01:00
Code Issues Projects Releases Wiki Activity

Start all command descriptions with a verb ("Show", "Set", etc.). Remove unused help texts.

Browse source
This commit is contained in:
practicalswift 2018-01-22 09:55:07 +01:00 • committed by Christian Decker
parent 940819567d
commit 5631054152
10 changed files with 43 additions and 71 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lightningd/chaintopology.c
View file

@ -594,8 +594,7 @@ static void json_dev_blockheight(struct command *cmd,
static const struct json_command dev_blockheight = {
"dev-blockheight",
json_dev_blockheight,
"Find out what block height we have",
"Returns { blockheight: u32 } on success"
"Show current block height"
};
AUTODATA(json_command, &dev_blockheight);
@ -656,8 +655,7 @@ static void json_dev_setfees(struct command *cmd,
static const struct json_command dev_setfees_command = {
"dev-setfees",
json_dev_setfees,
"Set feerate in satoshi-per-kw for {immediate}, {normal} and {slow} (each optional). Returns the value of those three feerates.",
"Allows testing of feerate changes"
"Set feerate in satoshi-per-kw for {immediate}, {normal} and {slow} (each optional) and show the value of those three feerates"
};
AUTODATA(json_command, &dev_setfees_command);

3
lightningd/dev_ping.c
View file

@ -102,7 +102,6 @@ static void json_dev_ping(struct command *cmd,
static const struct json_command dev_ping_command = {
"dev-ping",
json_dev_ping,
"Offer {id} a ping of length {len} asking for {pongbytes}",
"Returns { totlen: u32 } on success"
"Send {peerid} a ping of length {len} asking for {pongbytes}"
};
AUTODATA(json_command, &dev_ping_command);

19
lightningd/gossip_control.c
View file

@ -251,9 +251,10 @@ static void json_listnodes(struct command *cmd, const char *buffer,
}
static const struct json_command listnodes_command = {
"listnodes", json_listnodes,
"List a nodes in our local network view (or all, if no {id})",
"Returns a list of all nodes that we know about"};
"listnodes",
json_listnodes,
"Show all nodes in our local network view"
};
AUTODATA(json_command, &listnodes_command);
static void json_getroute_reply(struct subd *gossip, const u8 *reply, const int *fds,
@ -335,9 +336,9 @@ static void json_getroute(struct command *cmd, const char *buffer, const jsmntok
}
static const struct json_command getroute_command = {
"getroute", json_getroute,
"Return route to {id} for {msatoshi}, using {riskfactor} and optional {cltv} (default 9)",
"Returns a {route} array of {id} {msatoshi} {delay}: msatoshi and delay (in blocks) is cumulative."
"getroute",
json_getroute,
"Show route to {id} for {msatoshi}, using {riskfactor} and optional {cltv} (default 9)"
};
AUTODATA(json_command, &getroute_command);
@ -412,6 +413,8 @@ static void json_listchannels(struct command *cmd, const char *buffer,
}
static const struct json_command listchannels_command = {
"listchannels", json_listchannels, "List all known channels.",
"Returns a 'channels' array with all known channels including their fees."};
"listchannels",
json_listchannels,
"Show all known channels"
};
AUTODATA(json_command, &listchannels_command);

17
lightningd/invoice.c
View file

@ -197,8 +197,7 @@ static void json_invoice(struct command *cmd,
static const struct json_command invoice_command = {
"invoice",
json_invoice,
"Create invoice for {msatoshi} with {label} and {description} with optional {expiry} seconds (default 1 hour)",
"Returns the {payment_hash}, {expires_at} and {bolt11} on success, and {description} if too large for {bolt11}. "
"Create an invoice for {msatoshi} with {label} and {description} with optional {expiry} seconds (default 1 hour)"
};
AUTODATA(json_command, &invoice_command);
@ -259,7 +258,6 @@ static const struct json_command listinvoice_command = {
"listinvoice",
json_listinvoice,
"(DEPRECATED) Show invoice {label} (or all, if no {label}))",
"Returns an array of {label}, {payment_hash}, {msatoshi} (if set), {complete}, {pay_index} (if paid) and {expires_time} on success. ",
.deprecated = true
};
AUTODATA(json_command, &listinvoice_command);
@ -273,8 +271,7 @@ static void json_listinvoices(struct command *cmd,
static const struct json_command listinvoices_command = {
"listinvoices",
json_listinvoices,
"Show invoice {label} (or all, if no {label}))",
"Returns an array of {label}, {payment_hash}, {msatoshi} (if set), {status}, {pay_index} (if paid) and {expires_at} on success. ",
"Show invoice {label} (or all, if no {label})"
};
AUTODATA(json_command, &listinvoices_command);
@ -333,7 +330,6 @@ static const struct json_command delinvoice_command = {
"delinvoice",
json_delinvoice,
"Delete unpaid invoice {label} with {status}",
"Returns {label}, {payment_hash}, {msatoshi} (if set), {status}, {pay_index} (if paid) and {expires_at} on success. "
};
AUTODATA(json_command, &delinvoice_command);
@ -375,8 +371,7 @@ static void json_waitanyinvoice(struct command *cmd,
static const struct json_command waitanyinvoice_command = {
"waitanyinvoice",
json_waitanyinvoice,
"Wait for the next invoice to be paid, after {lastpay_index} (if supplied)))",
"Returns {label}, {payment_hash}, {msatoshi} (if set), {status}, {pay_index} and {expires_at} on success. "
"Wait for the next invoice to be paid, after {lastpay_index} (if supplied)"
};
AUTODATA(json_command, &waitanyinvoice_command);
@ -420,8 +415,7 @@ static void json_waitinvoice(struct command *cmd,
static const struct json_command waitinvoice_command = {
"waitinvoice",
json_waitinvoice,
"Wait for an incoming payment matching the invoice with {label}",
"Returns {label}, {payment_hash}, {msatoshi} (if set), {complete}, {pay_index} and {expires_at} on success"
"Wait for an incoming payment matching the invoice with {label}"
};
AUTODATA(json_command, &waitinvoice_command);
@ -574,7 +568,6 @@ static void json_decodepay(struct command *cmd,
static const struct json_command decodepay_command = {
"decodepay",
json_decodepay,
"Parse and decode {bolt11} if possible, using {description} if necessary",
"Returns a verbose description on success"
"Decode {bolt11}, using {description} if necessary"
};
AUTODATA(json_command, &decodepay_command);

18
lightningd/jsonrpc.c
View file

@ -52,8 +52,7 @@ static void json_help(struct command *cmd,
static const struct json_command help_command = {
"help",
json_help,
"List available commands",
"Returns an array {help} of available commands",
"Show available commands"
};
AUTODATA(json_command, &help_command);
@ -71,8 +70,7 @@ static void json_stop(struct command *cmd,
static const struct json_command stop_command = {
"stop",
json_stop,
"Shutdown the lightningd process",
"What part of shutdown wasn't clear?"
"Shut down the lightningd process"
};
AUTODATA(json_command, &stop_command);
@ -190,8 +188,7 @@ static void json_getlog(struct command *cmd,
static const struct json_command getlog_command = {
"getlog",
json_getlog,
"Get logs, with optional level: [io|debug|info|unusual]",
"Returns log array"
"Show logs, with optional log {level} (info|unusual|debug|io)"
};
AUTODATA(json_command, &getlog_command);
@ -230,8 +227,7 @@ static void json_rhash(struct command *cmd,
static const struct json_command dev_rhash_command = {
"dev-rhash",
json_rhash,
"SHA256 of {secret}",
"Returns a hash value"
"Show SHA256 of {secret}"
};
AUTODATA(json_command, &dev_rhash_command);
@ -244,8 +240,7 @@ static void json_crash(struct command *cmd,
static const struct json_command dev_crash_command = {
"dev-crash",
json_crash,
"Call fatal()",
"Simple crash test for developers"
"Crash lightningd by calling fatal()"
};
AUTODATA(json_command, &dev_crash_command);
#endif /* DEVELOPER */
@ -274,8 +269,7 @@ static void json_getinfo(struct command *cmd,
static const struct json_command getinfo_command = {
"getinfo",
json_getinfo,
"Get general information about this node",
"Returns {id}, {port}, {testnet}, etc."
"Show information about this node"
};
AUTODATA(json_command, &getinfo_command);

1
lightningd/jsonrpc.h
View file

@ -52,7 +52,6 @@ struct json_command {
void (*dispatch)(struct command *,
const char *buffer, const jsmntok_t *params);
const char *description;
const char *help;
bool deprecated;
};

6
lightningd/memdump.c
View file

@ -62,8 +62,7 @@ static void json_memdump(struct command *cmd,
static const struct json_command dev_memdump_command = {
"dev-memdump",
json_memdump,
"Dump the memory objects currently used",
"Debugging tool for memory leaks"
"Show memory objects currently in use"
};
AUTODATA(json_command, &dev_memdump_command);
@ -160,8 +159,7 @@ static void json_memleak(struct command *cmd,
static const struct json_command dev_memleak_command = {
"dev-memleak",
json_memleak,
"Dump the memory objects unreferenced",
"Debugging tool for memory leaks"
"Show unreferenced memory objects"
};
AUTODATA(json_command, &dev_memleak_command);
#endif /* DEVELOPER */

9
lightningd/pay.c
View file

@ -328,8 +328,7 @@ static void json_sendpay(struct command *cmd,
static const struct json_command sendpay_command = {
"sendpay",
json_sendpay,
"Send along {route} in return for preimage of {rhash}",
"Returns the {preimage} on success"
"Send along {route} in return for preimage of {rhash}"
};
AUTODATA(json_command, &sendpay_command);
@ -432,8 +431,7 @@ static void json_pay(struct command *cmd,
static const struct json_command pay_command = {
"pay",
json_pay,
"Send payment specified by {bolt11} with optional {msatoshi} (iff {bolt11} does not have amount), {description} (required if {bolt11} uses description hash) and {riskfactor} (default 1.0)",
"Returns the {preimage} on success"
"Send payment specified by {bolt11} with optional {msatoshi} (if and only if {bolt11} does not have amount), {description} (required if {bolt11} uses description hash) and {riskfactor} (default 1.0)"
};
AUTODATA(json_command, &pay_command);
@ -525,7 +523,6 @@ static void json_listpayments(struct command *cmd, const char *buffer,
static const struct json_command listpayments_command = {
"listpayments",
json_listpayments,
"Get a list of outgoing payments",
"Returns a list of payments with {payment_hash}, {destination}, {msatoshi}, {created_at} and {status} (and {payment_preimage} if {status} is 'complete')"
"Show outgoing payments"
};
AUTODATA(json_command, &listpayments_command);

22
lightningd/peer_control.c
View file

@ -761,8 +761,7 @@ static void json_connect(struct command *cmd,
static const struct json_command connect_command = {
"connect",
json_connect,
"Connect to {id} at {host} (which can end in ':port' if not default)",
"Returns the {id} on success (once channel established)"
"Connect to {id} at {host} (which can end in ':port' if not default)"
};
AUTODATA(json_command, &connect_command);
@ -954,8 +953,7 @@ static void json_listpeers(struct command *cmd,
static const struct json_command listpeers_command = {
"listpeers",
json_listpeers,
"List the current peers, if {level} is set, include {log}s",
"Returns a 'peers' array"
"Show current peers, if {level} is set, include {log}s"
};
AUTODATA(json_command, &listpeers_command);
@ -2661,8 +2659,7 @@ static void json_fund_channel(struct command *cmd,
static const struct json_command fund_channel_command = {
"fundchannel",
json_fund_channel,
"Fund channel with {id} using {satoshi} satoshis",
"Returns {tx} once channel established"
"Fund channel with {id} using {satoshi} satoshis"
};
AUTODATA(json_command, &fund_channel_command);
@ -2727,8 +2724,7 @@ static void json_close(struct command *cmd,
static const struct json_command close_command = {
"close",
json_close,
"Close the channel with peer {id}",
"Returns an empty result on success"
"Close the channel with peer {id}"
};
AUTODATA(json_command, &close_command);
@ -2822,9 +2818,7 @@ static void json_sign_last_tx(struct command *cmd,
static const struct json_command dev_sign_last_tx = {
"dev-sign-last-tx",
json_sign_last_tx,
"Sign and return the last commitment transaction with peer {id}",
"Sign last transaction with peer @id, return as @tx."
" This should never be called outside testing!"
"Sign and show the last commitment transaction with peer {id}"
};
AUTODATA(json_command, &dev_sign_last_tx);
@ -2854,8 +2848,7 @@ static void json_dev_fail(struct command *cmd,
static const struct json_command dev_fail_command = {
"dev-fail",
json_dev_fail,
"Fail with peer {id}",
"Returns {} on success"
"Fail with peer {id}"
};
AUTODATA(json_command, &dev_fail_command);
@ -2906,8 +2899,7 @@ static void json_dev_reenable_commit(struct command *cmd,
static const struct json_command dev_reenable_commit = {
"dev-reenable-commit",
json_dev_reenable_commit,
"Reenable the commit timer on peer {id}",
"Returns {} on success"
"Re-enable the commit timer on peer {id}"
};
AUTODATA(json_command, &dev_reenable_commit);
#endif /* DEVELOPER */

13
wallet/walletrpc.c
View file

@ -306,8 +306,7 @@ static void json_withdraw(struct command *cmd,
static const struct json_command withdraw_command = {
"withdraw",
json_withdraw,
"Send to {destination} address {satoshi} (or 'all') amount via Bitcoin transaction",
"Returns the withdrawal transaction ID"
"Send to {destination} address {satoshi} (or 'all') amount via Bitcoin transaction"
};
AUTODATA(json_command, &withdraw_command);
@ -357,8 +356,7 @@ static void json_newaddr(struct command *cmd,
static const struct json_command newaddr_command = {
"newaddr",
json_newaddr,
"Get a new address to fund a channel",
"Returns {address} a p2sh address"
"Get a new address to fund a channel"
};
AUTODATA(json_command, &newaddr_command);
@ -383,7 +381,8 @@ static void json_listfunds(struct command *cmd, const char *buffer,
}
static const struct json_command listfunds_command = {
"listfunds", json_listfunds,
"List funds available to the daemon to open channels",
"Returns an array of available outputs"};
"listfunds",
json_listfunds,
"Show funds available for opening channels"
};
AUTODATA(json_command, &listfunds_command);