#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include struct withdrawal { struct command *cmd; struct wallet_tx wtx; u8 *destination; const char *hextx; }; /** * wallet_withdrawal_broadcast - The tx has been broadcast (or it failed) * * This is the final step in the withdrawal. We either successfully * broadcast the withdrawal transaction or it failed somehow. So we * report success or a broadcast failure. Upon success we also mark * the used outputs as spent, and add the change output to our pool of * available outputs. */ static void wallet_withdrawal_broadcast(struct bitcoind *bitcoind UNUSED, int exitstatus, const char *msg, struct withdrawal *withdraw) { struct command *cmd = withdraw->cmd; struct lightningd *ld = withdraw->cmd->ld; struct amount_sat change = AMOUNT_SAT(0); /* Massage output into shape so it doesn't kill the JSON serialization */ char *output = tal_strjoin(cmd, tal_strsplit(cmd, msg, "\n", STR_NO_EMPTY), " ", STR_NO_TRAIL); if (exitstatus == 0) { /* Mark used outputs as spent */ wallet_confirm_utxos(ld->wallet, withdraw->wtx.utxos); /* Parse the tx and extract the change output. We * generated the hex tx, so this should always work */ struct bitcoin_tx *tx = bitcoin_tx_from_hex(withdraw, withdraw->hextx, strlen(withdraw->hextx)); assert(tx != NULL); /* Extract the change output and add it to the DB */ wallet_extract_owned_outputs(ld->wallet, tx, NULL, &change); /* Note normally, change_satoshi == withdraw->wtx.change, but * not if we're actually making a payment to ourselves! */ assert(amount_sat_greater_eq(change, withdraw->wtx.change)); struct json_stream *response = json_stream_success(cmd); json_object_start(response, NULL); json_add_string(response, "tx", withdraw->hextx); json_add_string(response, "txid", output); json_object_end(response); was_pending(command_success(cmd, response)); } else { was_pending(command_fail(cmd, LIGHTNINGD, "Error broadcasting transaction: %s", output)); } } /** * json_withdraw - Entrypoint for the withdrawal flow * * A user has requested a withdrawal over the JSON-RPC, parse the * request, select coins and a change key. Then send the request to * the HSM to generate the signatures. */ static struct command_result *json_withdraw(struct command *cmd, const char *buffer, const jsmntok_t *obj UNNEEDED, const jsmntok_t *params) { const jsmntok_t *desttok; struct withdrawal *withdraw = tal(cmd, struct withdrawal); u32 *feerate_per_kw; struct bitcoin_tx *tx; struct ext_key ext; struct pubkey pubkey; enum address_parse_result addr_parse; struct command_result *res; u32 *minconf, maxheight; withdraw->cmd = cmd; wtx_init(cmd, &withdraw->wtx, AMOUNT_SAT(-1ULL)); if (!param(cmd, buffer, params, p_req("destination", param_tok, &desttok), p_req("satoshi", param_wtx, &withdraw->wtx), p_opt("feerate", param_feerate, &feerate_per_kw), p_opt_def("minconf", param_number, &minconf, 1), NULL)) return command_param_failed(); if (!feerate_per_kw) { res = param_feerate_estimate(cmd, &feerate_per_kw, FEERATE_NORMAL); if (res) return res; } /* Parse address. */ addr_parse = json_tok_address_scriptpubkey(cmd, get_chainparams(cmd->ld), buffer, desttok, (const u8**)(&withdraw->destination)); /* Check that destination address could be understood. */ if (addr_parse == ADDRESS_PARSE_UNRECOGNIZED) { return command_fail(cmd, LIGHTNINGD, "Could not parse destination address"); } /* Check address given is compatible with the chain we are on. */ if (addr_parse == ADDRESS_PARSE_WRONG_NETWORK) { return command_fail(cmd, LIGHTNINGD, "Destination address is not on network %s", get_chainparams(cmd->ld)->network_name); } maxheight = minconf_to_maxheight(*minconf, cmd->ld); res = wtx_select_utxos(&withdraw->wtx, *feerate_per_kw, tal_count(withdraw->destination), maxheight); if (res) return res; if (bip32_key_from_parent(cmd->ld->wallet->bip32_base, withdraw->wtx.change_key_index, BIP32_FLAG_KEY_PUBLIC, &ext) != WALLY_OK) { return command_fail(cmd, LIGHTNINGD, "Keys generation failure"); } if (!secp256k1_ec_pubkey_parse(secp256k1_ctx, &pubkey.pubkey, ext.pub_key, sizeof(ext.pub_key))) { return command_fail(cmd, LIGHTNINGD, "Key parsing failure"); } txfilter_add_derkey(cmd->ld->owned_txfilter, ext.pub_key); u8 *msg = towire_hsm_sign_withdrawal(cmd, withdraw->wtx.amount, withdraw->wtx.change, withdraw->wtx.change_key_index, withdraw->destination, withdraw->wtx.utxos); if (!wire_sync_write(cmd->ld->hsm_fd, take(msg))) fatal("Could not write sign_withdrawal to HSM: %s", strerror(errno)); msg = wire_sync_read(cmd, cmd->ld->hsm_fd); if (!fromwire_hsm_sign_withdrawal_reply(msg, msg, &tx)) fatal("HSM gave bad sign_withdrawal_reply %s", tal_hex(withdraw, msg)); /* Now broadcast the transaction */ withdraw->hextx = tal_hex(withdraw, linearize_tx(cmd, tx)); bitcoind_sendrawtx(cmd->ld->topology->bitcoind, withdraw->hextx, wallet_withdrawal_broadcast, withdraw); return command_still_pending(cmd); } static const struct json_command withdraw_command = { "withdraw", json_withdraw, "Send to {destination} address {satoshi} (or 'all') amount via Bitcoin " "transaction, at optional {feerate}", false, "Send funds from the internal wallet to the specified address. Either " "specify a number of satoshis to send or 'all' to sweep all funds in the " "internal wallet to the address. Only use outputs that have at least " "{minconf} confirmations." }; AUTODATA(json_command, &withdraw_command); /* May return NULL if encoding error occurs. */ static char * encode_pubkey_to_addr(const tal_t *ctx, const struct lightningd *ld, const struct pubkey *pubkey, bool is_p2sh_p2wpkh, /* Output: redeemscript to use to redeem outputs * paying to the address. * May be NULL if redeemscript is do not care. */ u8 **out_redeemscript) { char *out; const char *hrp; struct sha256 h; struct ripemd160 h160; u8 *redeemscript; bool ok; if (is_p2sh_p2wpkh) { redeemscript = bitcoin_redeem_p2sh_p2wpkh(ctx, pubkey); sha256(&h, redeemscript, tal_count(redeemscript)); ripemd160(&h160, h.u.u8, sizeof(h)); out = p2sh_to_base58(ctx, get_chainparams(ld)->testnet, &h160); } else { hrp = get_chainparams(ld)->bip173_name; /* out buffer is 73 + strlen(human readable part), * see common/bech32.h*/ out = tal_arr(ctx, char, 73 + strlen(hrp)); pubkey_to_hash160(pubkey, &h160); /* I am uncertain why this is so for direct SegWit * outputs, but this is how listaddrs worked prior to * this code being refactored. */ redeemscript = tal_dup_arr(ctx, u8, (u8 *) &h160, sizeof(h160), 0); ok = segwit_addr_encode(out, hrp, 0, h160.u.u8, sizeof(h160)); if (!ok) out = tal_free(out); } if (out_redeemscript) *out_redeemscript = redeemscript; else tal_free(redeemscript); return out; } /* Returns NULL if the script is not a P2WPKH */ static char * encode_scriptpubkey_to_addr(const tal_t *ctx, const struct lightningd *ld, const u8 *scriptPubkey) { char *out; const char *hrp; size_t scriptLen = tal_bytelen(scriptPubkey); bool ok; if (scriptLen != 22 || scriptPubkey[0] != 0x00 || scriptPubkey[1] != 0x14) return NULL; hrp = get_chainparams(ld)->bip173_name; out = tal_arr(ctx, char, 73 + strlen(hrp)); ok = segwit_addr_encode(out, hrp, 0, scriptPubkey + 2, scriptLen - 2); if (!ok) return tal_free(out); return out; } enum addrtype { ADDR_P2SH_SEGWIT = 1, ADDR_BECH32 = 2, ADDR_ALL = (ADDR_P2SH_SEGWIT + ADDR_BECH32) }; /* Extract bool indicating "p2sh-segwit" or "bech32" */ static struct command_result *param_newaddr(struct command *cmd, const char *name, const char *buffer, const jsmntok_t *tok, enum addrtype **addrtype) { *addrtype = tal(cmd, enum addrtype); if (json_tok_streq(buffer, tok, "p2sh-segwit")) **addrtype = ADDR_P2SH_SEGWIT; else if (json_tok_streq(buffer, tok, "bech32")) **addrtype = ADDR_BECH32; else if (json_tok_streq(buffer, tok, "all")) **addrtype = ADDR_ALL; else return command_fail(cmd, JSONRPC2_INVALID_PARAMS, "'%s' should be 'bech32', 'p2sh-segwit' or 'all', not '%.*s'", name, tok->end - tok->start, buffer + tok->start); return NULL; } static struct command_result *json_newaddr(struct command *cmd, const char *buffer, const jsmntok_t *obj UNNEEDED, const jsmntok_t *params) { struct json_stream *response; struct ext_key ext; struct pubkey pubkey; enum addrtype *addrtype; s64 keyidx; char *p2sh, *bech32; if (!param(cmd, buffer, params, p_opt_def("addresstype", param_newaddr, &addrtype, ADDR_BECH32), NULL)) return command_param_failed(); keyidx = wallet_get_newindex(cmd->ld); if (keyidx < 0) { return command_fail(cmd, LIGHTNINGD, "Keys exhausted "); } if (bip32_key_from_parent(cmd->ld->wallet->bip32_base, keyidx, BIP32_FLAG_KEY_PUBLIC, &ext) != WALLY_OK) { return command_fail(cmd, LIGHTNINGD, "Keys generation failure"); } if (!secp256k1_ec_pubkey_parse(secp256k1_ctx, &pubkey.pubkey, ext.pub_key, sizeof(ext.pub_key))) { return command_fail(cmd, LIGHTNINGD, "Key parsing failure"); } txfilter_add_derkey(cmd->ld->owned_txfilter, ext.pub_key); p2sh = encode_pubkey_to_addr(cmd, cmd->ld, &pubkey, true, NULL); bech32 = encode_pubkey_to_addr(cmd, cmd->ld, &pubkey, false, NULL); if (!p2sh || !bech32) { return command_fail(cmd, LIGHTNINGD, "p2wpkh address encoding failure."); } response = json_stream_success(cmd); json_object_start(response, NULL); if (deprecated_apis) json_add_string(response, "address", bech32 ? bech32 : p2sh); if (*addrtype & ADDR_BECH32) json_add_string(response, "bech32", bech32); if (*addrtype & ADDR_P2SH_SEGWIT) json_add_string(response, "p2sh-segwit", p2sh); json_object_end(response); return command_success(cmd, response); } static const struct json_command newaddr_command = { "newaddr", json_newaddr, "Get a new {bech32, p2sh-segwit} (or all) address to fund a channel (default is bech32)", false, "Generates a new address (or both) that belongs to the internal wallet. Funds sent to these addresses will be managed by lightningd. Use `withdraw` to withdraw funds to an external wallet." }; AUTODATA(json_command, &newaddr_command); static struct command_result *json_listaddrs(struct command *cmd, const char *buffer, const jsmntok_t *obj UNNEEDED, const jsmntok_t *params) { struct json_stream *response; struct ext_key ext; struct pubkey pubkey; u64 *bip32_max_index; if (!param(cmd, buffer, params, p_opt("bip32_max_index", param_u64, &bip32_max_index), NULL)) return command_param_failed(); if (!bip32_max_index) { bip32_max_index = tal(cmd, u64); *bip32_max_index = db_get_intvar(cmd->ld->wallet->db, "bip32_max_index", 0); } response = json_stream_success(cmd); json_object_start(response, NULL); json_array_start(response, "addresses"); for (s64 keyidx = 0; keyidx <= *bip32_max_index; keyidx++) { if(keyidx == BIP32_INITIAL_HARDENED_CHILD){ break; } if (bip32_key_from_parent(cmd->ld->wallet->bip32_base, keyidx, BIP32_FLAG_KEY_PUBLIC, &ext) != WALLY_OK) { abort(); } if (!secp256k1_ec_pubkey_parse(secp256k1_ctx, &pubkey.pubkey, ext.pub_key, sizeof(ext.pub_key))) { abort(); } // p2sh u8 *redeemscript_p2sh; char *out_p2sh = encode_pubkey_to_addr(cmd, cmd->ld, &pubkey, true, &redeemscript_p2sh); // bech32 : p2wpkh u8 *redeemscript_p2wpkh; char *out_p2wpkh = encode_pubkey_to_addr(cmd, cmd->ld, &pubkey, false, &redeemscript_p2wpkh); if (!out_p2wpkh) { abort(); } // outputs json_object_start(response, NULL); json_add_u64(response, "keyidx", keyidx); json_add_pubkey(response, "pubkey", &pubkey); json_add_string(response, "p2sh", out_p2sh); json_add_hex_talarr(response, "p2sh_redeemscript", redeemscript_p2sh); json_add_string(response, "bech32", out_p2wpkh); json_add_hex_talarr(response, "bech32_redeemscript", redeemscript_p2wpkh); json_object_end(response); } json_array_end(response); json_object_end(response); return command_success(cmd, response); } static const struct json_command listaddrs_command = { "dev-listaddrs", json_listaddrs, "Show addresses list up to derivation {index} (default is the last bip32 index)", false, "Show addresses of your internal wallet. Use `newaddr` to generate a new address." }; AUTODATA(json_command, &listaddrs_command); static struct command_result *json_listfunds(struct command *cmd, const char *buffer, const jsmntok_t *obj UNNEEDED, const jsmntok_t *params) { struct json_stream *response; struct peer *p; struct utxo **utxos; char* out; struct pubkey funding_pubkey; if (!param(cmd, buffer, params, NULL)) return command_param_failed(); utxos = wallet_get_utxos(cmd, cmd->ld->wallet, output_state_available); response = json_stream_success(cmd); json_object_start(response, NULL); json_array_start(response, "outputs"); for (size_t i = 0; i < tal_count(utxos); i++) { json_object_start(response, NULL); json_add_txid(response, "txid", &utxos[i]->txid); json_add_num(response, "output", utxos[i]->outnum); json_add_amount_sat(response, utxos[i]->amount, "value", "amount_msat"); /* @close_info is for outputs that are not yet claimable */ if (utxos[i]->close_info == NULL) { bip32_pubkey(cmd->ld->wallet->bip32_base, &funding_pubkey, utxos[i]->keyindex); out = encode_pubkey_to_addr(cmd, cmd->ld, &funding_pubkey, utxos[i]->is_p2sh, NULL); if (!out) { return command_fail(cmd, LIGHTNINGD, "p2wpkh address encoding failure."); } json_add_string(response, "address", out); } else if (utxos[i]->scriptPubkey != NULL) { out = encode_scriptpubkey_to_addr( cmd, cmd->ld, utxos[i]->scriptPubkey); if (out) json_add_string(response, "address", out); } if (utxos[i]->spendheight) json_add_string(response, "status", "spent"); else if (utxos[i]->blockheight) json_add_string(response, "status", "confirmed"); else json_add_string(response, "status", "unconfirmed"); json_object_end(response); } json_array_end(response); /* Add funds that are allocated to channels */ json_array_start(response, "channels"); list_for_each(&cmd->ld->peers, p, list) { struct channel *c; list_for_each(&p->channels, c, list) { json_object_start(response, NULL); json_add_pubkey(response, "peer_id", &p->id); if (c->scid) json_add_short_channel_id(response, "short_channel_id", c->scid); json_add_amount_sat(response, amount_msat_to_sat_round_down(c->our_msat), "channel_sat", "our_amount_msat"); json_add_amount_sat(response, c->funding, "channel_total_sat", "amount_msat"); json_add_txid(response, "funding_txid", &c->funding_txid); json_object_end(response); } } json_array_end(response); json_object_end(response); return command_success(cmd, response); } static const struct json_command listfunds_command = { "listfunds", json_listfunds, "Show available funds from the internal wallet", false, "Returns a list of funds (outputs) that can be used by the internal wallet to open new channels or can be withdrawn, using the `withdraw` command, to another wallet." }; AUTODATA(json_command, &listfunds_command); struct txo_rescan { struct command *cmd; struct utxo **utxos; struct json_stream *response; }; static void process_utxo_result(struct bitcoind *bitcoind, const struct bitcoin_tx_output *txout, void *arg) { struct txo_rescan *rescan = arg; struct json_stream *response = rescan->response; struct utxo *u = rescan->utxos[0]; enum output_status newstate = txout == NULL ? output_state_spent : output_state_available; json_object_start(rescan->response, NULL); json_add_txid(response, "txid", &u->txid); json_add_num(response, "output", u->outnum); json_add_num(response, "oldstate", u->status); json_add_num(response, "newstate", newstate); json_object_end(rescan->response); wallet_update_output_status(bitcoind->ld->wallet, &u->txid, u->outnum, u->status, newstate); /* Remove the utxo we just resolved */ rescan->utxos[0] = rescan->utxos[tal_count(rescan->utxos) - 1]; tal_resize(&rescan->utxos, tal_count(rescan->utxos) - 1); if (tal_count(rescan->utxos) == 0) { /* Complete the response */ json_array_end(rescan->response); json_object_end(rescan->response); was_pending(command_success(rescan->cmd, rescan->response)); } else { bitcoind_gettxout( bitcoind->ld->topology->bitcoind, &rescan->utxos[0]->txid, rescan->utxos[0]->outnum, process_utxo_result, rescan); } } static struct command_result *json_dev_rescan_outputs(struct command *cmd, const char *buffer, const jsmntok_t *obj UNNEEDED, const jsmntok_t *params) { struct txo_rescan *rescan = tal(cmd, struct txo_rescan); if (!param(cmd, buffer, params, NULL)) return command_param_failed(); rescan->response = json_stream_success(cmd); rescan->cmd = cmd; /* Open the result structure so we can incrementally add results */ json_object_start(rescan->response, NULL); json_array_start(rescan->response, "outputs"); rescan->utxos = wallet_get_utxos(rescan, cmd->ld->wallet, output_state_any); if (tal_count(rescan->utxos) == 0) { json_array_end(rescan->response); json_object_end(rescan->response); return command_success(cmd, rescan->response); } bitcoind_gettxout(cmd->ld->topology->bitcoind, &rescan->utxos[0]->txid, rescan->utxos[0]->outnum, process_utxo_result, rescan); return command_still_pending(cmd); } static const struct json_command dev_rescan_output_command = { "dev-rescan-outputs", json_dev_rescan_outputs, "Synchronize the state of our funds with bitcoind", false, "For each output stored in the internal wallet ask `bitcoind` whether we are in sync with its state (spent vs. unspent)" }; AUTODATA(json_command, &dev_rescan_output_command);