112 lines
3.3 KiB
C
112 lines
3.3 KiB
C
#ifndef LIGHTNING_LIGHTNINGD_JSONRPC_H
|
|
#define LIGHTNING_LIGHTNINGD_JSONRPC_H
|
|
#include "config.h"
|
|
#include <ccan/autodata/autodata.h>
|
|
#include <ccan/list/list.h>
|
|
#include <common/json.h>
|
|
|
|
struct bitcoin_txid;
|
|
struct wireaddr;
|
|
|
|
/* Context for a command (from JSON, but might outlive the connection!)
|
|
* You can allocate off this for temporary objects. */
|
|
struct command {
|
|
/* The global state */
|
|
struct lightningd *ld;
|
|
/* The 'id' which we need to include in the response. */
|
|
const char *id;
|
|
/* The connection, or NULL if it closed. */
|
|
struct json_connection *jcon;
|
|
/* Have we been marked by command_still_pending? For debugging... */
|
|
bool pending;
|
|
};
|
|
|
|
struct json_connection {
|
|
/* The global state */
|
|
struct lightningd *ld;
|
|
|
|
/* Logging for this json connection. */
|
|
struct log *log;
|
|
|
|
/* The buffer (required to interpret tokens). */
|
|
char *buffer;
|
|
|
|
/* Internal state: */
|
|
/* How much is already filled. */
|
|
size_t used;
|
|
/* How much has just been filled. */
|
|
size_t len_read;
|
|
|
|
/* We've been told to stop. */
|
|
bool stop;
|
|
|
|
/* Current command. */
|
|
struct command *current;
|
|
|
|
struct list_head output;
|
|
const char *outbuf;
|
|
};
|
|
|
|
struct json_command {
|
|
const char *name;
|
|
void (*dispatch)(struct command *,
|
|
const char *buffer, const jsmntok_t *params);
|
|
const char *description;
|
|
bool deprecated;
|
|
const char *verbose;
|
|
};
|
|
|
|
/* Get the parameters (by position or name). Followed by triples of
|
|
* of const char *name, const jsmntok_t **ret_ptr, then NULL.
|
|
*
|
|
* If name starts with '?' it is optional (and will be set to NULL
|
|
* if it's a literal 'null' or not present).
|
|
* Otherwise false is returned, and command_fail already called.
|
|
*/
|
|
bool json_get_params(struct command *cmd,
|
|
const char *buffer, const jsmntok_t param[], ...);
|
|
|
|
struct json_result *null_response(const tal_t *ctx);
|
|
void command_success(struct command *cmd, struct json_result *response);
|
|
void PRINTF_FMT(2, 3) command_fail(struct command *cmd, const char *fmt, ...);
|
|
void PRINTF_FMT(4, 5) command_fail_detailed(struct command *cmd,
|
|
int code,
|
|
const struct json_result *data,
|
|
const char *fmt, ...);
|
|
|
|
/* Mainly for documentation, that we plan to close this later. */
|
|
void command_still_pending(struct command *cmd);
|
|
|
|
/* '"fieldname" : "0289abcdef..."' or "0289abcdef..." if fieldname is NULL */
|
|
void json_add_pubkey(struct json_result *response,
|
|
const char *fieldname,
|
|
const struct pubkey *key);
|
|
|
|
/* '"fieldname" : <hexrev>' or "<hexrev>" if fieldname is NULL */
|
|
void json_add_txid(struct json_result *result, const char *fieldname,
|
|
const struct bitcoin_txid *txid);
|
|
|
|
/* Extract a pubkey from this */
|
|
bool json_tok_pubkey(const char *buffer, const jsmntok_t *tok,
|
|
struct pubkey *pubkey);
|
|
|
|
/* Extract a short_channel_id from this */
|
|
bool json_tok_short_channel_id(const char *buffer, const jsmntok_t *tok,
|
|
struct short_channel_id *scid);
|
|
|
|
/* '"fieldname" : "1234:5:6"' */
|
|
void json_add_short_channel_id(struct json_result *response,
|
|
const char *fieldname,
|
|
const struct short_channel_id *id);
|
|
|
|
/* JSON serialize a network address for a node */
|
|
void json_add_address(struct json_result *response, const char *fieldname,
|
|
const struct wireaddr *addr);
|
|
|
|
|
|
/* For initialization */
|
|
void setup_jsonrpc(struct lightningd *ld, const char *rpc_filename);
|
|
|
|
AUTODATA_TYPE(json_command, struct json_command);
|
|
#endif /* LIGHTNING_LIGHTNINGD_JSONRPC_H */
|