Browse Source

plugins: add fundchannel plugin, as 'fc'

New plugin which mimics the functionality of the embedded 'fundchannel'.
travis-debug
lisa neigut 5 years ago
committed by Rusty Russell
parent
commit
f433f637ea
  1. 19
      plugins/Makefile
  2. 306
      plugins/fundchannel.c

19
plugins/Makefile

@ -4,6 +4,9 @@ PLUGIN_PAY_OBJS := $(PLUGIN_PAY_SRC:.c=.o)
PLUGIN_AUTOCLEAN_SRC := plugins/autoclean.c
PLUGIN_AUTOCLEAN_OBJS := $(PLUGIN_AUTOCLEAN_SRC:.c=.o)
PLUGIN_FUNDCHANNEL_SRC := plugins/fundchannel.c
PLUGIN_FUNDCHANNEL_OBJS := $(PLUGIN_FUNDCHANNEL_SRC:.c=.o)
PLUGIN_LIB_SRC := plugins/libplugin.c
PLUGIN_LIB_HEADER := plugins/libplugin.h
PLUGIN_LIB_OBJS := $(PLUGIN_LIB_SRC:.c=.o)
@ -43,17 +46,19 @@ plugins/pay: $(PLUGIN_PAY_OBJS) $(PLUGIN_LIB_OBJS) $(PLUGIN_COMMON_OBJS) $(JSMN_
plugins/autoclean: $(PLUGIN_AUTOCLEAN_OBJS) $(PLUGIN_LIB_OBJS) $(PLUGIN_COMMON_OBJS) $(JSMN_OBJS) $(CCAN_OBJS)
$(PLUGIN_PAY_OBJS) $(PLUGIN_AUTOCLEAN_OBJS) $(PLUGIN_LIB_OBJS): $(PLUGIN_LIB_HEADER)
plugins/fundchannel: $(PLUGIN_FUNDCHANNEL_OBJS) $(PLUGIN_LIB_OBJS) $(PLUGIN_COMMON_OBJS) $(JSMN_OBJS) $(CCAN_OBJS)
$(PLUGIN_PAY_OBJS) $(PLUGIN_AUTOCLEAN_OBJS) $(PLUGIN_FUNDCHANNEL_OBJS) $(PLUGIN_LIB_OBJS): $(PLUGIN_LIB_HEADER)
# Make sure these depend on everything.
ALL_PROGRAMS += plugins/pay plugins/autoclean
ALL_OBJS += $(PLUGIN_PAY_OBJS) $(PLUGIN_AUTOCLEAN_OBJS) $(PLUGIN_LIB_OBJS)
ALL_PROGRAMS += plugins/pay plugins/autoclean plugins/fundchannel
ALL_OBJS += $(PLUGIN_PAY_OBJS) $(PLUGIN_AUTOCLEAN_OBJS) $(PLUGIN_FUNDCHANNEL_OBJS) $(PLUGIN_LIB_OBJS)
check-source: $(PLUGIN_PAY_SRC:%=check-src-include-order/%) $(PLUGIN_AUTOCLEAN_SRC:%=check-src-include-order/%)
check-source-bolt: $(PLUGIN_PAY_SRC:%=bolt-check/%) $(PLUGIN_AUTOCLEAN_SRC:%=bolt-check/%)
check-whitespace: $(PLUGIN_PAY_SRC:%=check-whitespace/%) $(PLUGIN_AUTOCLEAN_SRC:%=check-whitespace/%)
check-source: $(PLUGIN_PAY_SRC:%=check-src-include-order/%) $(PLUGIN_AUTOCLEAN_SRC:%=check-src-include-order/%) $(PLUGIN_FUNDCHANNEL_SRC:%=check-src-include-order/%)
check-source-bolt: $(PLUGIN_PAY_SRC:%=bolt-check/%) $(PLUGIN_AUTOCLEAN_SRC:%=bolt-check/%) $(PLUGIN_FUNDCHANNEL_SRC:%=bolt-check/%)
check-whitespace: $(PLUGIN_PAY_SRC:%=check-whitespace/%) $(PLUGIN_AUTOCLEAN_SRC:%=check-whitespace/%) $(PLUGIN_FUNDCHANNEL_SRC:%=check-whitespace/%)
clean: plugin-clean
plugin-clean:
$(RM) $(PLUGIN_PAY_OBJS) $(PLUGIN_AUTOCLEAN_OBJS) $(PLUGIN_LIB_OBJS)
$(RM) $(PLUGIN_PAY_OBJS) $(PLUGIN_AUTOCLEAN_OBJS) $(PLUGIN_FUNDCHANNEL_OBJS) $(PLUGIN_LIB_OBJS)

306
plugins/fundchannel.c

@ -0,0 +1,306 @@
#include <bitcoin/script.h>
#include <ccan/array_size/array_size.h>
#include <ccan/cast/cast.h>
#include <ccan/json_out/json_out.h>
#include <ccan/tal/str/str.h>
#include <common/amount.h>
#include <common/json_tok.h>
#include <common/type_to_string.h>
#include <common/utils.h>
#include <lightningd/json.h>
#include <plugins/libplugin.h>
struct funding_req {
struct amount_sat *funding;
struct node_id *id;
const char *feerate_str;
bool *announce_channel;
u32 *minconf;
// todo: utxos
/* The prepared tx id */
struct bitcoin_txid tx_id;
const char *chanstr;
const u8 *out_script;
/* Failing result (NULL on success) */
/* Raw JSON from RPC output */
const char *error;
};
/* Helper to copy JSON object directly into a json_out */
static void json_out_add_raw_len(struct json_out *jout,
const char *fieldname,
const char *jsonstr, size_t len)
{
char *p;
p = json_out_member_direct(jout, fieldname, len);
memcpy(p, jsonstr, len);
}
/* Helper to add a boolean to a json_out */
static void json_out_addbool(struct json_out *jout,
const char *fieldname,
const bool val)
{
if (val)
json_out_add(jout, fieldname, false, "true");
else
json_out_add(jout, fieldname, false, "false");
}
/* Copy field and member to output, if it exists: return member */
static const jsmntok_t *copy_member(struct json_out *ret,
const char *buf, const jsmntok_t *obj,
const char *membername)
{
const jsmntok_t *m = json_get_member(buf, obj, membername);
if (!m)
return NULL;
/* Literal copy: it's already JSON escaped, and may be a string. */
json_out_add_raw_len(ret, membername,
json_tok_full(buf, m), json_tok_full_len(m));
return m;
}
static struct command_result *send_prior(struct command *cmd,
const char *buf,
const jsmntok_t *error,
struct funding_req *fr)
{
return command_err_raw(cmd, fr->error);
}
static struct command_result *tx_abort(struct command *cmd,
const char *buf,
const jsmntok_t *error,
struct funding_req *fr)
{
struct json_out *ret;
/* We stash the error so we can return it after we've cleaned up */
fr->error = json_strdup(fr, buf, error);
ret = json_out_new(NULL);
json_out_start(ret, NULL, '{');
json_out_addstr(ret, "txid",
type_to_string(tmpctx, struct bitcoin_txid, &fr->tx_id));
json_out_end(ret, '}');
/* We need to call txdiscard, and forward the actual cause for the
* error after we've cleaned up. We swallow any errors returned by
* this call, as we don't really care if it succeeds or not */
return send_outreq(cmd, "txdiscard",
send_prior, send_prior,
cast_const(struct funding_req *, fr),
take(ret));
}
/* We're basically done, we just need to format the output to match
* what the original `fundchannel` returned */
static struct command_result *finish(struct command *cmd,
const char *buf,
const jsmntok_t *result,
struct funding_req *fr)
{
struct json_out *out;
out = json_out_new(NULL);
json_out_start(out, NULL, '{');
copy_member(out, buf, result, "tx");
json_out_addstr(out, "txid",
type_to_string(tmpctx, struct bitcoin_txid, &fr->tx_id));
json_out_addstr(out, "channel_id", fr->chanstr);
json_out_end(out, '}');
return command_success(cmd, out);
}
/* We're ready to broadcast the transaction */
static struct command_result *send_tx(struct command *cmd,
const char *buf,
const jsmntok_t *result,
struct funding_req *fr)
{
struct json_out *ret;
const jsmntok_t *tok;
bool commitments_secured;
/* For sanity's sake, let's check that it's secured */
tok = json_get_member(buf, result, "commitments_secured");
if (!json_to_bool(buf, tok, &commitments_secured) || !commitments_secured)
// TODO: better failure path? this should never fail though.
plugin_err("Commitment not secured.");
/* Stash the channel_id so we can return it when finalized */
tok = json_get_member(buf, result, "channel_id");
fr->chanstr = json_strdup(fr, buf, tok);
ret = json_out_new(NULL);
json_out_start(ret, NULL, '{');
json_out_addstr(ret, "txid",
type_to_string(tmpctx, struct bitcoin_txid, &fr->tx_id));
json_out_end(ret, '}');
return send_outreq(cmd, "txsend",
finish, tx_abort,
cast_const(struct funding_req *, fr),
take(ret));
}
static struct command_result *tx_prepare_done(struct command *cmd,
const char *buf,
const jsmntok_t *result,
struct funding_req *fr)
{
const jsmntok_t *txid_tok;
const jsmntok_t *tx_tok;
struct json_out *ret;
const struct bitcoin_tx *tx;
const char *hex;
u32 outnum;
txid_tok = json_get_member(buf, result, "txid");
if (!txid_tok)
plugin_err("txprepare missing 'txid' field");
tx_tok = json_get_member(buf, result, "unsigned_tx");
if (!tx_tok)
plugin_err("txprepare missing 'unsigned_tx' field");
hex = json_strdup(tmpctx, buf, tx_tok);
tx = bitcoin_tx_from_hex(fr, hex, strlen(hex));
if (!tx)
plugin_err("Unable to parse tx %s", hex);
/* Find the txout */
for (size_t i = 0; i < tx->wtx->num_outputs; i++) {
const u8 *output_script = bitcoin_tx_output_get_script(fr, tx, i);
if (scripteq(output_script, fr->out_script)) {
outnum = i;
break;
}
}
hex = json_strdup(tmpctx, buf, txid_tok);
if (!bitcoin_txid_from_hex(hex, strlen(hex), &fr->tx_id))
plugin_err("Unable to parse txid %s", hex);
ret = json_out_new(NULL);
json_out_start(ret, NULL, '{');
json_out_addstr(ret, "id", type_to_string(tmpctx, struct node_id, fr->id));
/* Note that hex is reused from above */
json_out_addstr(ret, "txid", hex);
json_out_add(ret, "txout", false, "%u", outnum);
json_out_end(ret, '}');
return send_outreq(cmd, "fundchannel_complete",
send_tx, tx_abort,
cast_const(struct funding_req *, fr),
take(ret));
}
static struct command_result *fundchannel_start_done(struct command *cmd,
const char *buf,
const jsmntok_t *result,
struct funding_req *fr)
{
const jsmntok_t *addr_tok, *script_tok;
struct json_out *ret;
addr_tok = json_get_member(buf, result, "funding_address");
script_tok = json_get_member(buf, result, "scriptpubkey");
if (!addr_tok || !script_tok)
plugin_err("Fundchannel start didn't return a funding_address or scriptpubkey? '%.*s'",
result->end - result->start, buf);
/* Save the outscript so we can fund the outnum later */
fr->out_script = json_tok_bin_from_hex(fr, buf, script_tok);
ret = json_out_new(NULL);
json_out_start(ret, NULL, '{');
json_out_add_raw_len(ret, "destination",
json_tok_full(buf, addr_tok), json_tok_full_len(addr_tok));
json_out_addstr(ret, "satoshi", type_to_string(ret, struct amount_sat,
fr->funding));
json_out_addstr(ret, "feerate", fr->feerate_str);
json_out_add(ret, "minconf", false, "%u", *fr->minconf);
json_out_end(ret, '}');
return send_outreq(cmd, "txprepare",
tx_prepare_done, forward_error,
cast_const(struct funding_req *, fr),
take(ret));
}
static struct command_result *json_fundchannel(struct command *cmd,
const char *buf,
const jsmntok_t *params)
{
struct funding_req *rq = tal(cmd, struct funding_req);
struct json_out *ret = json_out_new(NULL);
// TODO: add utxos
if (!param(cmd, buf, params,
p_req("id", param_node_id, &rq->id),
p_req("satoshi", param_sat, &rq->funding),
p_opt("feerate", param_string, &rq->feerate_str),
p_opt_def("announce", param_bool, &rq->announce_channel, true),
p_opt_def("minconf", param_number, &rq->minconf, 1),
NULL))
return NULL;
json_out_start(ret, NULL, '{');
json_out_addstr(ret, "id", type_to_string(tmpctx, struct node_id, rq->id));
json_out_addstr(ret, "satoshi", type_to_string(tmpctx,
struct amount_sat, rq->funding));
if (rq->feerate_str)
json_out_addstr(ret, "feerate", rq->feerate_str);
if (rq->announce_channel)
json_out_addbool(ret, "announce", *rq->announce_channel);
json_out_end(ret, '}');
json_out_finished(ret);
// FIXME: as a nice feature, we should check that the peer
// you want to connect to is connected first. if not, we should
// connect and then call fundchannel start!
return send_outreq(cmd, "fundchannel_start",
fundchannel_start_done, forward_error,
cast_const(struct funding_req *, rq),
take(ret));
}
static void init(struct plugin_conn *rpc,
const char *buf UNUSED, const jsmntok_t *config UNUSED)
{
/* This method left intentionally blank. */
}
// id, satoshi, feerate, announce, minconf, utxos
static const struct plugin_command commands[] = { {
"fc",
"channels",
"Fund channel with {id} using {satoshi} (or 'all'), at optional {feerate}. "
"Only use outputs that have {minconf} confirmations.",
"Initiaties a channel open with node 'id'. Must "
"be connected to the node and have enough funds available at the requested minimum confirmation "
"depth (minconf)",
json_fundchannel
}
};
int main(int argc, char *argv[])
{
setup_locale();
plugin_main(argv, init, PLUGIN_RESTARTABLE, commands, ARRAY_SIZE(commands), NULL);
}
Loading…
Cancel
Save