Extend hsmd API to pass HTLCs in hsmd_sign_commitment_tx and hsmd_sign_remote_commitment_tx.

Author: ksedgwic

channeld/channeld.c

@@ -1061,23 +1061,42 @@ static struct bitcoin_signature *calc_commitsigs(const tal_t *ctx,
 	const u8 *msg;
 	struct bitcoin_signature *htlc_sigs;
 
+	// Collect the htlcs for call to hsmd.
+	//
+	// We use the existing_htlc to_wire routines, it's unfortunate that
+	// we have to send a dummy onion_routing_packet ...
+	//
+	struct existing_htlc **htlcs = tal_arr(tmpctx, struct existing_htlc *, 0);
+	u8 dummy_onion_routing_packet[TOTAL_PACKET_SIZE(ROUTING_INFO_SIZE)];
+	memset(dummy_onion_routing_packet, 0, sizeof(dummy_onion_routing_packet));
 	size_t num_entries = tal_count(htlc_map);
-	struct sha256 *rhashes = tal_arrz(tmpctx, struct sha256, num_entries);
-	size_t nrhash = 0;
 	for (size_t ndx = 0; ndx < num_entries; ++ndx) {
-		if (htlc_map[ndx]) {
-			memcpy(&rhashes[nrhash], &htlc_map[ndx]->rhash, sizeof(rhashes[nrhash]));
-			++nrhash;
+		struct htlc const *hh = htlc_map[ndx];
+		if (hh) {
+			status_debug("HTLC[%lu]=%" PRIu64 ", %s",
+				     ndx, hh->id, htlc_state_name(hh->state));
+			struct existing_htlc *existing =
+				new_existing_htlc(NULL,
+						  hh->id,
+						  hh->state,
+						  hh->amount,
+						  &hh->rhash,
+						  hh->expiry.locktime,
+						  dummy_onion_routing_packet,
+						  NULL,
+						  NULL,
+						  NULL);
+			tal_arr_expand(&htlcs, tal_steal(htlcs, existing));
 		}
 	}
-	tal_resize(&rhashes, nrhash);
 
 	msg = towire_hsmd_sign_remote_commitment_tx(NULL, txs[0],
 						   &peer->channel->funding_pubkey[REMOTE],
 						   &peer->remote_per_commit,
-						   peer->channel->option_static_remotekey,
-						   rhashes, commit_index);
-
+						    peer->channel->option_static_remotekey,
+						    commit_index,
+						    (const struct existing_htlc **) htlcs,
+						    channel_feerate(peer->channel, REMOTE));
 	msg = hsm_req(tmpctx, take(msg));
 	if (!fromwire_hsmd_sign_tx_reply(msg, commit_sig))
 		status_failed(STATUS_FAIL_HSM_IO,

contrib/remote_hsmd/hsmd.c

@@ -751,15 +751,16 @@ static struct io_plan *handle_sign_commitment_tx(struct io_conn *conn,
 	struct node_id peer_id;
 	u64 dbid;
 	struct bitcoin_tx *tx;
-	struct bitcoin_signature sig;
-	struct sha256 *rhashes;
+	struct existing_htlc **htlc;
 	u64 commit_num;
+	u32 feerate;
+	struct bitcoin_signature sig;
 
 	if (!fromwire_hsmd_sign_commitment_tx(tmpctx, msg_in,
 					     &peer_id, &dbid,
 					     &tx,
 					     &remote_funding_pubkey,
-					     &rhashes, &commit_num))
+					     &commit_num, &htlc, &feerate))
 		return bad_req(conn, c, msg_in);
 
 	tx->chainparams = c->chainparams;
@@ -793,7 +794,7 @@ static struct io_plan *handle_sign_commitment_tx(struct io_conn *conn,
 		// This is a unilateral close from our side.
 		proxy_stat rv = proxy_handle_sign_commitment_tx(
 			tx, &remote_funding_pubkey, &peer_id, dbid,
-			rhashes, commit_num, &sig);
+			htlc, commit_num, feerate,  &sig);
 		if (PROXY_PERMANENT(rv))
 			status_failed(STATUS_FAIL_INTERNAL_ERROR,
 				      "proxy_%s failed: %s", __FUNCTION__,
@@ -893,15 +894,17 @@ static struct io_plan *handle_sign_remote_commitment_tx(struct io_conn *conn,
 	struct bitcoin_signature sig;
 	struct pubkey remote_per_commit;
 	bool option_static_remotekey;
-	struct sha256 *rhashes;
 	u64 commit_num;
+	struct existing_htlc **htlc;
+	u32 feerate;
 
 	if (!fromwire_hsmd_sign_remote_commitment_tx(tmpctx, msg_in,
 						    &tx,
 						    &remote_funding_pubkey,
 						    &remote_per_commit,
 						    &option_static_remotekey,
-						    &rhashes, &commit_num))
+						    &commit_num,
+						    &htlc, &feerate))
 		bad_req(conn, c, msg_in);
 	tx->chainparams = c->chainparams;
 
@@ -915,7 +918,7 @@ static struct io_plan *handle_sign_remote_commitment_tx(struct io_conn *conn,
 		tx, &remote_funding_pubkey,
 		&c->id, c->dbid,
 		&remote_per_commit,
-		rhashes, commit_num,
+		htlc, commit_num, feerate,
 		&sig);
 	if (PROXY_PERMANENT(rv))
 		status_failed(STATUS_FAIL_INTERNAL_ERROR,

contrib/remote_hsmd/proxy.cc

@@ -746,24 +746,27 @@ proxy_stat proxy_handle_sign_remote_commitment_tx(
 	struct node_id *peer_id,
 	u64 dbid,
 	const struct pubkey *remote_per_commit,
-	struct sha256 *rhashes, u64 commit_num,
+	struct existing_htlc **htlcs,
+	u64 commit_num, u32 feerate,
 	struct bitcoin_signature *o_sig)
 {
 	STATUS_DEBUG(
 		"%s:%d %s { "
 		"\"self_id\":%s, \"peer_id\":%s, \"dbid\":%" PRIu64 ", "
 		"\"counterparty_funding_pubkey\":%s, "
 		"\"remote_per_commit\":%s, \"tx\":%s, "
-		"\"rhashes\":%s, \"commit_num\":%" PRIu64 " }",
+		"\"htlcs\":%s, "
+		"\"commit_num\":%" PRIu64 ", "
+		"\"feerate\":%d }",
 		__FILE__, __LINE__, __FUNCTION__,
 		dump_node_id(&self_id).c_str(),
 		dump_node_id(peer_id).c_str(),
 		dbid,
 		dump_pubkey(counterparty_funding_pubkey).c_str(),
 		dump_pubkey(remote_per_commit).c_str(),
 		dump_tx(tx).c_str(),
-		dump_rhashes(rhashes, tal_count(rhashes)).c_str(),
-		commit_num
+		dump_htlcs((const struct existing_htlc **) htlcs, tal_count(htlcs)).c_str(),
+		commit_num, feerate
 		);
 
 	last_message = "";
@@ -773,8 +776,15 @@ proxy_stat proxy_handle_sign_remote_commitment_tx(
 	marshal_pubkey(remote_per_commit,
 		       req.mutable_remote_per_commit_point());
 	marshal_single_input_tx(tx, NULL, req.mutable_tx());
-	marshal_rhashes(rhashes, req.mutable_payment_hashes());
+	for (size_t ii = 0; ii < tal_count(htlcs); ++ii) {
+		if (htlc_state_owner(htlcs[ii]->state) == REMOTE) {
+			marshal_htlc(htlcs[ii], req.add_offered_htlcs());
+		} else {
+			marshal_htlc(htlcs[ii], req.add_received_htlcs());
+		}
+	}
 	req.set_commit_num(commit_num);
+	req.set_feerate_sat_per_kw(feerate);
 
 	ClientContext context;
 	SignatureReply rsp;
@@ -1073,31 +1083,41 @@ proxy_stat proxy_handle_sign_commitment_tx(
 	const struct pubkey *counterparty_funding_pubkey,
 	struct node_id *peer_id,
 	u64 dbid,
-	struct sha256 *rhashes, u64 commit_num,
+	struct existing_htlc **htlcs,
+	u64 commit_num, u32 feerate,
 	struct bitcoin_signature *o_sig)
 {
 	STATUS_DEBUG(
 		"%s:%d %s { "
 		"\"self_id\":%s, \"peer_id\":%s, \"dbid\":%" PRIu64 ", "
 		"\"counterparty_funding_pubkey\":%s, \"tx\":%s, "
-		"\"rhashes\":%s, \"commit_num\":%" PRIu64 " }",
+		"\"htlcs\":%s, "
+		"\"commit_num\":%" PRIu64 ", "
+		"\"feerate\":%d }",
 		__FILE__, __LINE__, __FUNCTION__,
 		dump_node_id(&self_id).c_str(),
 		dump_node_id(peer_id).c_str(),
 		dbid,
 		dump_pubkey(counterparty_funding_pubkey).c_str(),
 		dump_tx(tx).c_str(),
-		dump_rhashes(rhashes, tal_count(rhashes)).c_str(),
-		commit_num
+		dump_htlcs((const struct existing_htlc **) htlcs, tal_count(htlcs)).c_str(),
+		commit_num, feerate
 		);
 
 	last_message = "";
 	SignHolderCommitmentTxRequest req;
 	marshal_node_id(&self_id, req.mutable_node_id());
 	marshal_channel_nonce(peer_id, dbid, req.mutable_channel_nonce());
 	marshal_single_input_tx(tx, NULL, req.mutable_tx());
-	marshal_rhashes(rhashes, req.mutable_payment_hashes());
+	for (size_t ii = 0; ii < tal_count(htlcs); ++ii) {
+		if (htlc_state_owner(htlcs[ii]->state) == LOCAL) {
+			marshal_htlc(htlcs[ii], req.add_offered_htlcs());
+		} else {
+			marshal_htlc(htlcs[ii], req.add_received_htlcs());
+		}
+	}
 	req.set_commit_num(commit_num);
+	req.set_feerate_sat_per_kw(feerate);
 
 	ClientContext context;
 	SignatureReply rsp;

contrib/remote_hsmd/proxy.hpp

@@ -90,8 +90,9 @@ proxy_stat proxy_handle_sign_remote_commitment_tx(
 	struct node_id *peer_id,
 	u64 dbid,
 	const struct pubkey *remote_per_commit,
-	struct sha256 *rhashes,
+	struct existing_htlc **htlc,
 	u64 commit_num,
+	u32 feerate,
 	struct bitcoin_signature *o_sig);
 
 proxy_stat proxy_handle_get_per_commitment_point(
@@ -128,8 +129,9 @@ proxy_stat proxy_handle_sign_commitment_tx(
 	const struct pubkey *remote_funding_pubkey,
 	struct node_id *peer_id,
 	u64 dbid,
-	struct sha256 *rhashes,
+	struct existing_htlc **htlc,
 	u64 commit_num,
+	u32 feerate,
 	struct bitcoin_signature *o_sig);
 
 proxy_stat proxy_handle_validate_commitment_tx(

hsmd/hsmd_wire.csv

@@ -133,9 +133,10 @@ msgdata,hsmd_sign_commitment_tx,peer_id,node_id,
 msgdata,hsmd_sign_commitment_tx,channel_dbid,u64,
 msgdata,hsmd_sign_commitment_tx,tx,bitcoin_tx,
 msgdata,hsmd_sign_commitment_tx,remote_funding_key,pubkey,
-msgdata,hsmd_sign_commitment_tx,num_htlc_rhash,u16,
-msgdata,hsmd_sign_commitment_tx,htlc_rhash,sha256,num_htlc_rhash
 msgdata,hsmd_sign_commitment_tx,commit_num,u64,
+msgdata,hsmd_sign_commitment_tx,num_existing_htlcs,u16,
+msgdata,hsmd_sign_commitment_tx,htlcs,existing_htlc,num_existing_htlcs
+msgdata,hsmd_sign_commitment_tx,feerate,u32,
 
 msgtype,hsmd_sign_commitment_tx_reply,105
 msgdata,hsmd_sign_commitment_tx_reply,sig,bitcoin_signature,
@@ -200,9 +201,10 @@ msgdata,hsmd_sign_remote_commitment_tx,tx,bitcoin_tx,
 msgdata,hsmd_sign_remote_commitment_tx,remote_funding_key,pubkey,
 msgdata,hsmd_sign_remote_commitment_tx,remote_per_commit,pubkey,
 msgdata,hsmd_sign_remote_commitment_tx,option_static_remotekey,bool,
-msgdata,hsmd_sign_remote_commitment_tx,num_htlc_rhash,u16,
-msgdata,hsmd_sign_remote_commitment_tx,htlc_rhash,sha256,num_htlc_rhash
 msgdata,hsmd_sign_remote_commitment_tx,commit_num,u64,
+msgdata,hsmd_sign_remote_commitment_tx,num_existing_htlcs,u16,
+msgdata,hsmd_sign_remote_commitment_tx,htlcs,existing_htlc,num_existing_htlcs
+msgdata,hsmd_sign_remote_commitment_tx,feerate,u32,
 
 # channeld asks HSM to sign remote HTLC tx.
 msgtype,hsmd_sign_remote_htlc_tx,20

hsmd/libhsmd.c

@@ -1290,16 +1290,17 @@ static u8 *handle_sign_commitment_tx(struct hsmd_client *c, const u8 *msg_in)
 	struct secret channel_seed;
 	struct bitcoin_tx *tx;
 	struct bitcoin_signature sig;
-	struct sha256 *rhashes;
+	struct existing_htlc **htlc;
 	u64 commit_num;
+	u32 feerate;
 	struct secrets secrets;
 	const u8 *funding_wscript;
 
 	if (!fromwire_hsmd_sign_commitment_tx(tmpctx, msg_in,
 					     &peer_id, &dbid,
 					     &tx,
 					     &remote_funding_pubkey,
-					     &rhashes, &commit_num))
+					     &commit_num, &htlc, &feerate))
 		return hsmd_status_malformed_request(c, msg_in);
 
 	tx->chainparams = c->chainparams;