introduce simple_htlc for communicating HTLCs to hsmd

devrandom · ksedgwic · commit 838872e0033e · 2021-12-14T15:55:39.000-08:00
diff --git a/channeld/channeld.c b/channeld/channeld.c
@@ -1039,27 +1039,20 @@ static struct bitcoin_signature *calc_commitsigs(const tal_t *ctx,
 	// 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));
+	struct simple_htlc **htlcs = tal_arr(tmpctx, struct simple_htlc *, 0);
 	size_t num_entries = tal_count(htlc_map);
 	for (size_t ndx = 0; ndx < num_entries; ++ndx) {
 		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));
+			struct simple_htlc *simple =
+			    new_simple_htlc(NULL,
+					    htlc_state_owner(hh->state),
+					    hh->amount,
+					    &hh->rhash,
+					    hh->expiry.locktime);
+			tal_arr_expand(&htlcs, tal_steal(htlcs, simple));
 		}
 	}
 
@@ -1069,7 +1062,7 @@ static struct bitcoin_signature *calc_commitsigs(const tal_t *ctx,
 						    channel_has(peer->channel,
 								OPT_STATIC_REMOTEKEY),
 						    commit_index,
-						    (const struct existing_htlc **) htlcs,
+						    (const struct simple_htlc **) htlcs,
 						    channel_feerate(peer->channel, REMOTE));
 	msg = hsm_req(tmpctx, take(msg));
 	if (!fromwire_hsmd_sign_tx_reply(msg, commit_sig))
@@ -1755,38 +1748,31 @@ static void handle_peer_commit_sig(struct peer *peer, const u8 *msg)
 
 	// Collect the htlcs for call to hsmd validate.
 	//
-	// We use the existing_htlc to_wire routines, it's unfortunate that
+	// We use the simple_htlc to_wire routines, it's unfortunate that
 	// we have to send a dummy onion_routing_packet ...
 	//
-	struct existing_htlc **htlcs = tal_arr(NULL, 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));
+	struct simple_htlc **htlcs = tal_arr(NULL, struct simple_htlc *, 0);
 	size_t num_entries = tal_count(htlc_map);
 	for (size_t ndx = 0; ndx < num_entries; ++ndx) {
 		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));
+			struct simple_htlc *simple =
+			    new_simple_htlc(NULL,
+					    htlc_state_owner(hh->state),
+					    hh->amount,
+					    &hh->rhash,
+					    hh->expiry.locktime);
+			tal_arr_expand(&htlcs, tal_steal(htlcs, simple));
 		}
 	}
 
 	// Validate the counterparty's signatures, returns old_secret.
 	const u8 * msg2 =
 		towire_hsmd_validate_commitment_tx(NULL,
 						   txs[0],
-						   (const struct existing_htlc **) htlcs,
+						   (const struct simple_htlc **) htlcs,
 						   peer->next_index[LOCAL],
 						   channel_feerate(peer->channel, LOCAL),
 						   &commit_sig,
diff --git a/common/htlc_wire.c b/common/htlc_wire.c
@@ -26,6 +26,20 @@ static struct failed_htlc *failed_htlc_dup(const tal_t *ctx,
 	return newf;
 }
 
+struct simple_htlc *new_simple_htlc(const tal_t *ctx,
+				    enum side side,
+				    struct amount_msat amount,
+				    const struct sha256 *payment_hash,
+				    u32 cltv_expiry)
+{
+	struct simple_htlc *simple = tal(NULL, struct simple_htlc);
+	simple->side = side;
+	simple->amount = amount;
+	simple->payment_hash = *payment_hash;
+	simple->cltv_expiry = cltv_expiry;
+	return simple;
+}
+
 struct existing_htlc *new_existing_htlc(const tal_t *ctx,
 					u64 id,
 					enum htlc_state state,
@@ -108,6 +122,14 @@ void towire_existing_htlc(u8 **pptr, const struct existing_htlc *existing)
 		towire_bool(pptr, false);
 }
 
+void towire_simple_htlc(u8 **pptr, const struct simple_htlc *simple)
+{
+	towire_side(pptr, simple->side);
+	towire_amount_msat(pptr, simple->amount);
+	towire_sha256(pptr, &simple->payment_hash);
+	towire_u32(pptr, simple->cltv_expiry);
+}
+
 void towire_fulfilled_htlc(u8 **pptr, const struct fulfilled_htlc *fulfilled)
 {
 	towire_u64(pptr, fulfilled->id);
@@ -205,6 +227,18 @@ struct existing_htlc *fromwire_existing_htlc(const tal_t *ctx,
 	return existing;
 }
 
+struct simple_htlc *fromwire_simple_htlc(const tal_t *ctx,
+					 const u8 **cursor, size_t *max)
+{
+	struct simple_htlc *simple = tal(ctx, struct simple_htlc);
+
+	simple->side = fromwire_side(cursor, max);
+	simple->amount = fromwire_amount_msat(cursor, max);
+	fromwire_sha256(cursor, max, &simple->payment_hash);
+	simple->cltv_expiry = fromwire_u32(cursor, max);
+	return simple;
+}
+
 void fromwire_fulfilled_htlc(const u8 **cursor, size_t *max,
 			     struct fulfilled_htlc *fulfilled)
 {
diff --git a/common/htlc_wire.h b/common/htlc_wire.h
@@ -63,6 +63,14 @@ struct changed_htlc {
 	u64 id;
 };
 
+/* For signing */
+struct simple_htlc {
+	enum side side;
+	struct amount_msat amount;
+	struct sha256 payment_hash;
+	u32 cltv_expiry;
+};
+
 struct existing_htlc *new_existing_htlc(const tal_t *ctx,
 					u64 id,
 					enum htlc_state state,
@@ -74,8 +82,15 @@ struct existing_htlc *new_existing_htlc(const tal_t *ctx,
 					const struct preimage *preimage TAKES,
 					const struct failed_htlc *failed TAKES);
 
+struct simple_htlc *new_simple_htlc(const tal_t *ctx,
+				    enum side side,
+				    struct amount_msat amount,
+				    const struct sha256 *payment_hash,
+				    u32 cltv_expiry);
+
 void towire_added_htlc(u8 **pptr, const struct added_htlc *added);
 void towire_existing_htlc(u8 **pptr, const struct existing_htlc *existing);
+void towire_simple_htlc(u8 **pptr, const struct simple_htlc *simple);
 void towire_fulfilled_htlc(u8 **pptr, const struct fulfilled_htlc *fulfilled);
 void towire_failed_htlc(u8 **pptr, const struct failed_htlc *failed);
 void towire_changed_htlc(u8 **pptr, const struct changed_htlc *changed);
@@ -86,6 +101,8 @@ void fromwire_added_htlc(const u8 **cursor, size_t *max,
 			 struct added_htlc *added);
 struct existing_htlc *fromwire_existing_htlc(const tal_t *ctx,
 					     const u8 **cursor, size_t *max);
+struct simple_htlc *fromwire_simple_htlc(const tal_t *ctx,
+					 const u8 **cursor, size_t *max);
 void fromwire_fulfilled_htlc(const u8 **cursor, size_t *max,
 			     struct fulfilled_htlc *fulfilled);
 struct failed_htlc *fromwire_failed_htlc(const tal_t *ctx, const u8 **cursor,
diff --git a/hsmd/hsmd_wire.csv b/hsmd/hsmd_wire.csv
@@ -134,8 +134,8 @@ 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,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,num_htlcs,u16,
+msgdata,hsmd_sign_commitment_tx,htlcs,simple_htlc,num_htlcs
 msgdata,hsmd_sign_commitment_tx,feerate,u32,
 
 msgtype,hsmd_sign_commitment_tx_reply,105
@@ -145,8 +145,8 @@ msgdata,hsmd_sign_commitment_tx_reply,sig,bitcoin_signature,
 #include <common/htlc_wire.h>
 msgtype,hsmd_validate_commitment_tx,35
 msgdata,hsmd_validate_commitment_tx,tx,bitcoin_tx,
-msgdata,hsmd_validate_commitment_tx,num_existing_htlcs,u16,
-msgdata,hsmd_validate_commitment_tx,htlcs,existing_htlc,num_existing_htlcs
+msgdata,hsmd_validate_commitment_tx,num_htlcs,u16,
+msgdata,hsmd_validate_commitment_tx,htlcs,simple_htlc,num_htlcs
 msgdata,hsmd_validate_commitment_tx,commit_num,u64,
 msgdata,hsmd_validate_commitment_tx,feerate,u32,
 msgdata,hsmd_validate_commitment_tx,sig,bitcoin_signature,
@@ -202,8 +202,8 @@ 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,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,num_htlcs,u16,
+msgdata,hsmd_sign_remote_commitment_tx,htlcs,simple_htlc,num_htlcs
 msgdata,hsmd_sign_remote_commitment_tx,feerate,u32,
 
 # channeld asks HSM to sign remote HTLC tx.
diff --git a/hsmd/libhsmd.c b/hsmd/libhsmd.c
@@ -1206,7 +1206,7 @@ static u8 *handle_sign_remote_commitment_tx(struct hsmd_client *c, const u8 *msg
 	struct pubkey remote_per_commit;
 	bool option_static_remotekey;
 	u64 commit_num;
-	struct existing_htlc **htlc;
+	struct simple_htlc **htlc;
 	u32 feerate;
 
 	if (!fromwire_hsmd_sign_remote_commitment_tx(tmpctx, msg_in,
@@ -1300,7 +1300,7 @@ 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 existing_htlc **htlc;
+	struct simple_htlc **htlc;
 	u64 commit_num;
 	u32 feerate;
 	struct secrets secrets;
@@ -1347,7 +1347,7 @@ static u8 *handle_sign_commitment_tx(struct hsmd_client *c, const u8 *msg_in)
 static u8 *handle_validate_commitment_tx(struct hsmd_client *c, const u8 *msg_in)
 {
 	struct bitcoin_tx *tx;
-	struct existing_htlc **htlc;
+	struct simple_htlc **htlc;
 	u64 commit_num;
 	u32 feerate;
 	struct bitcoin_signature sig;
diff --git a/lightningd/peer_control.c b/lightningd/peer_control.c
@@ -176,15 +176,15 @@ u8 *p2wpkh_for_keyidx(const tal_t *ctx, struct lightningd *ld, u64 keyidx)
 	return scriptpubkey_p2wpkh(ctx, &shutdownkey);
 }
 
-static struct existing_htlc **collect_htlcs(struct channel *channel, u32 local_feerate) {
+static struct simple_htlc **collect_htlcs(struct channel *channel, u32 local_feerate) {
 	// 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 htlc_in_map *htlcs_in = &channel->peer->ld->htlcs_in;
 	struct htlc_out_map *htlcs_out = &channel->peer->ld->htlcs_out;
-	struct existing_htlc **htlcs = tal_arr(tmpctx, struct existing_htlc *, 0);
+	struct simple_htlc **htlcs = tal_arr(tmpctx, struct simple_htlc *, 0);
 	u8 dummy_onion_routing_packet[TOTAL_PACKET_SIZE(ROUTING_INFO_SIZE)];
 	memset(dummy_onion_routing_packet, 0, sizeof(dummy_onion_routing_packet));
 
@@ -201,18 +201,14 @@ static struct existing_htlc **collect_htlcs(struct channel *channel, u32 local_f
 				    channel->our_config.dust_limit, LOCAL,
 				    channel_has(channel, OPT_ANCHOR_OUTPUTS)))
 			continue;
-		struct existing_htlc *existing =
-			new_existing_htlc(NULL,
-					  hin->dbid,
-					  hin->hstate,
-					  hin->msat,
-					  &hin->payment_hash,
-					  hin->cltv_expiry,
-					  dummy_onion_routing_packet,
-					  NULL,
-					  NULL,
-					  NULL);
-		tal_arr_expand(&htlcs, tal_steal(htlcs, existing));
+		struct simple_htlc *simple =
+		    new_simple_htlc(NULL,
+				    htlc_state_owner(hin->hstate),
+				    hin->msat,
+				    &hin->payment_hash,
+				    hin->cltv_expiry
+				    );
+		tal_arr_expand(&htlcs, tal_steal(htlcs, simple));
 	}
 	const struct htlc_out *hout;
 	struct htlc_out_map_iter outi;
@@ -227,18 +223,14 @@ static struct existing_htlc **collect_htlcs(struct channel *channel, u32 local_f
 				    channel->our_config.dust_limit, LOCAL,
 				    channel_has(channel, OPT_ANCHOR_OUTPUTS)))
 			continue;
-		struct existing_htlc *existing =
-			new_existing_htlc(NULL,
-					  hout->dbid,
-					  hout->hstate,
-					  hout->msat,
-					  &hout->payment_hash,
-					  hout->cltv_expiry,
-					  dummy_onion_routing_packet,
-					  NULL,
-					  NULL,
-					  NULL);
-		tal_arr_expand(&htlcs, tal_steal(htlcs, existing));
+		struct simple_htlc *simple =
+		    new_simple_htlc(NULL,
+				    htlc_state_owner(hout->hstate),
+				    hout->msat,
+				    &hout->payment_hash,
+				    hout->cltv_expiry
+				    );
+		tal_arr_expand(&htlcs, tal_steal(htlcs, simple));
 	}
 	return htlcs;
 }
@@ -253,7 +245,7 @@ static void sign_last_tx(struct channel *channel,
 
 	u64 commit_index = channel->next_index[LOCAL] - 1;
 	u32 local_feerate = get_feerate(channel->fee_states, channel->opener, LOCAL);
-	struct existing_htlc **htlcs = collect_htlcs(channel, local_feerate);
+	struct simple_htlc **htlcs = collect_htlcs(channel, local_feerate);
 
 	assert(!last_tx->wtx->inputs[0].witness);
 	msg = towire_hsmd_sign_commitment_tx(tmpctx,
@@ -263,7 +255,7 @@ static void sign_last_tx(struct channel *channel,
 					     &channel->channel_info
 					     .remote_fundingkey,
 					     commit_index,
-					     (const struct existing_htlc **) htlcs,
+					     (const struct simple_htlc **) htlcs,
 					     local_feerate);
 
 	if (!wire_sync_write(ld->hsm_fd, take(msg)))
diff --git a/lightningd/test/run-invoice-select-inchan.c b/lightningd/test/run-invoice-select-inchan.c
@@ -657,7 +657,7 @@ u8 *towire_errorfmt(const tal_t *ctx UNNEEDED,
 u8 *towire_hsmd_sign_bolt12(const tal_t *ctx UNNEEDED, const wirestring *messagename UNNEEDED, const wirestring *fieldname UNNEEDED, const struct sha256 *merkleroot UNNEEDED, const u8 *publictweak UNNEEDED)
 { fprintf(stderr, "towire_hsmd_sign_bolt12 called!\n"); abort(); }
 /* Generated stub for towire_hsmd_sign_commitment_tx */
-u8 *towire_hsmd_sign_commitment_tx(const tal_t *ctx UNNEEDED, const struct node_id *peer_id UNNEEDED, u64 channel_dbid UNNEEDED, const struct bitcoin_tx *tx UNNEEDED, const struct pubkey *remote_funding_key UNNEEDED, u64 commit_num UNNEEDED, const struct existing_htlc **htlcs UNNEEDED, u32 feerate UNNEEDED)
+u8 *towire_hsmd_sign_commitment_tx(const tal_t *ctx UNNEEDED, const struct node_id *peer_id UNNEEDED, u64 channel_dbid UNNEEDED, const struct bitcoin_tx *tx UNNEEDED, const struct pubkey *remote_funding_key UNNEEDED, u64 commit_num UNNEEDED, const struct simple_htlc **htlcs UNNEEDED, u32 feerate UNNEEDED)
 { fprintf(stderr, "towire_hsmd_sign_commitment_tx called!\n"); abort(); }
 /* Generated stub for towire_hsmd_sign_invoice */
 u8 *towire_hsmd_sign_invoice(const tal_t *ctx UNNEEDED, const u8 *u5bytes UNNEEDED, const u8 *hrp UNNEEDED)
diff --git a/openingd/dualopend.c b/openingd/dualopend.c
@@ -1918,7 +1918,7 @@ static u8 *accepter_commits(struct state *state,
 	}
 
 	/* Make HSM sign it */
-	struct existing_htlc **htlcs = tal_arr(tmpctx, struct existing_htlc *, 0);
+	struct simple_htlc **htlcs = tal_arr(tmpctx, struct simple_htlc *, 0);
 	u32 feerate = 0; // unused since there are no htlcs
 	u64 commit_num = 0;
 	msg = towire_hsmd_sign_remote_commitment_tx(NULL,
@@ -1927,7 +1927,7 @@ static u8 *accepter_commits(struct state *state,
 						    &state->first_per_commitment_point[REMOTE],
 						    true,
 						    commit_num,
-						    (const struct existing_htlc **) htlcs,
+						    (const struct simple_htlc **) htlcs,
 						    feerate);
 	wire_sync_write(HSM_FD, take(msg));
 	msg = wire_sync_read(tmpctx, HSM_FD);
@@ -2517,7 +2517,7 @@ static u8 *opener_commits(struct state *state,
 	 * witness script.  It also needs the amount of the funding output,
 	 * as segwit signatures commit to that as well, even though it doesn't
 	 * explicitly appear in the transaction itself. */
-	struct existing_htlc **htlcs = tal_arr(tmpctx, struct existing_htlc *, 0);
+	struct simple_htlc **htlcs = tal_arr(tmpctx, struct simple_htlc *, 0);
 	u32 feerate = 0; // unused since there are no htlcs
 	u64 commit_num = 0;
 	msg = towire_hsmd_sign_remote_commitment_tx(NULL,
@@ -2526,7 +2526,7 @@ static u8 *opener_commits(struct state *state,
 						   &state->first_per_commitment_point[REMOTE],
 						    true,
 						    commit_num,
-						    (const struct existing_htlc **) htlcs,
+						    (const struct simple_htlc **) htlcs,
 						    feerate);
 
 	wire_sync_write(HSM_FD, take(msg));
diff --git a/openingd/openingd.c b/openingd/openingd.c
diff --git a/tools/generate-wire.py b/tools/generate-wire.py
diff --git a/wallet/test/run-wallet.c b/wallet/test/run-wallet.c
