common/wire: move bitcoin-specific marshalling functions into bitcoin…

… files. We did this originally because these types are referred to in the bolts, and we had no way of injecting the correct include lines into those. Now we do, so there's less excuse for this. Signed-off-by: Rusty Russell <[email protected]>
AdamKorcz · May 18, 2020 · 2722064 · 2722064
1 parent f77d70d
commit 2722064
Show file tree

Hide file tree

Showing 30 changed files with 744 additions and 171 deletions.
diff --git a/bitcoin/block.c b/bitcoin/block.c
@@ -3,6 +3,7 @@
 #include "bitcoin/tx.h"
 #include <ccan/str/hex/hex.h>
 #include <common/type_to_string.h>
+#include <wire/wire.h>
 
 static void sha256_varint(struct sha256_ctx *ctx, u64 val)
 {
@@ -206,3 +207,28 @@ static char *fmt_bitcoin_blkid(const tal_t *ctx,
 	return hexstr;
 }
 REGISTER_TYPE_TO_STRING(bitcoin_blkid, fmt_bitcoin_blkid);
+
+void fromwire_bitcoin_blkid(const u8 **cursor, size_t *max,
+			    struct bitcoin_blkid *blkid)
+{
+	fromwire_sha256_double(cursor, max, &blkid->shad);
+}
+
+void towire_bitcoin_blkid(u8 **pptr, const struct bitcoin_blkid *blkid)
+{
+	towire_sha256_double(pptr, &blkid->shad);
+}
+
+
+void towire_chainparams(u8 **cursor, const struct chainparams *chainparams)
+{
+	towire_bitcoin_blkid(cursor, &chainparams->genesis_blockhash);
+}
+
+void fromwire_chainparams(const u8 **cursor, size_t *max,
+			  const struct chainparams **chainparams)
+{
+	struct bitcoin_blkid genesis;
+	fromwire_bitcoin_blkid(cursor, max, &genesis);
+	*chainparams = chainparams_by_chainhash(&genesis);
+}
diff --git a/bitcoin/block.h b/bitcoin/block.h
@@ -53,4 +53,13 @@ bool bitcoin_blkid_from_hex(const char *hexstr, size_t hexstr_len,
 /* Get hex string of blockid (reversed, a-la bitcoind). */
 bool bitcoin_blkid_to_hex(const struct bitcoin_blkid *blockid,
 			  char *hexstr, size_t hexstr_len);
+
+/* Marshalling/unmarshaling over the wire */
+void towire_bitcoin_blkid(u8 **pptr, const struct bitcoin_blkid *blkid);
+void fromwire_bitcoin_blkid(const u8 **cursor, size_t *max,
+			   struct bitcoin_blkid *blkid);
+void fromwire_chainparams(const u8 **cursor, size_t *max,
+			  const struct chainparams **chainparams);
+void towire_chainparams(u8 **cursor, const struct chainparams *chainparams);
+
 #endif /* LIGHTNING_BITCOIN_BLOCK_H */
diff --git a/bitcoin/chainparams.c b/bitcoin/chainparams.c
@@ -256,3 +256,4 @@ const char *chainparams_get_network_names(const tal_t *ctx)
         tal_append_fmt(&networks_string, ", %s", networks[i].network_name);
     return networks_string;
 }
+
diff --git a/bitcoin/signature.c b/bitcoin/signature.c
@@ -9,6 +9,7 @@
 #include <ccan/mem/mem.h>
 #include <common/type_to_string.h>
 #include <common/utils.h>
+#include <wire/wire.h>
 
 #undef DEBUG
 #ifdef DEBUG
@@ -323,3 +324,19 @@ static char *bitcoin_signature_to_hexstr(const tal_t *ctx,
 	return tal_hexstr(ctx, der, len);
 }
 REGISTER_TYPE_TO_STRING(bitcoin_signature, bitcoin_signature_to_hexstr);
+
+void fromwire_bitcoin_signature(const u8 **cursor, size_t *max,
+				struct bitcoin_signature *sig)
+{
+	fromwire_secp256k1_ecdsa_signature(cursor, max, &sig->s);
+	sig->sighash_type = fromwire_u8(cursor, max);
+	if (!sighash_type_valid(sig->sighash_type))
+		fromwire_fail(cursor, max);
+}
+
+void towire_bitcoin_signature(u8 **pptr, const struct bitcoin_signature *sig)
+{
+	assert(sighash_type_valid(sig->sighash_type));
+	towire_secp256k1_ecdsa_signature(pptr, &sig->s);
+	towire_u8(pptr, sig->sighash_type);
+}
diff --git a/bitcoin/signature.h b/bitcoin/signature.h
@@ -126,4 +126,9 @@ size_t signature_to_der(u8 der[73], const struct bitcoin_signature *sig);
 /* Parse DER encoding into signature sig */
 bool signature_from_der(const u8 *der, size_t len, struct bitcoin_signature *sig);
 
+/* Wire marshalling and unmarshalling */
+void towire_bitcoin_signature(u8 **pptr, const struct bitcoin_signature *sig);
+void fromwire_bitcoin_signature(const u8 **cursor, size_t *max,
+				struct bitcoin_signature *sig);
+
 #endif /* LIGHTNING_BITCOIN_SIGNATURE_H */
diff --git a/bitcoin/test/run-bitcoin_block_from_hex.c b/bitcoin/test/run-bitcoin_block_from_hex.c
@@ -25,9 +25,35 @@ bool amount_sat_eq(struct amount_sat a UNNEEDED, struct amount_sat b UNNEEDED)
 				       struct amount_sat a UNNEEDED,
 				       struct amount_sat b UNNEEDED)
 { fprintf(stderr, "amount_sat_sub called!\n"); abort(); }
+/* Generated stub for fromwire_amount_sat */
+struct amount_sat fromwire_amount_sat(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_amount_sat called!\n"); abort(); }
 /* Generated stub for fromwire_fail */
 const void *fromwire_fail(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
 { fprintf(stderr, "fromwire_fail called!\n"); abort(); }
+/* Generated stub for fromwire_sha256_double */
+void fromwire_sha256_double(const u8 **cursor UNNEEDED, size_t *max UNNEEDED,
+			    struct sha256_double *sha256d UNNEEDED)
+{ fprintf(stderr, "fromwire_sha256_double called!\n"); abort(); }
+/* Generated stub for fromwire_tal_arrn */
+u8 *fromwire_tal_arrn(const tal_t *ctx UNNEEDED,
+		       const u8 **cursor UNNEEDED, size_t *max UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "fromwire_tal_arrn called!\n"); abort(); }
+/* Generated stub for fromwire_u16 */
+u16 fromwire_u16(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_u16 called!\n"); abort(); }
+/* Generated stub for towire_amount_sat */
+void towire_amount_sat(u8 **pptr UNNEEDED, const struct amount_sat sat UNNEEDED)
+{ fprintf(stderr, "towire_amount_sat called!\n"); abort(); }
+/* Generated stub for towire_sha256_double */
+void towire_sha256_double(u8 **pptr UNNEEDED, const struct sha256_double *sha256d UNNEEDED)
+{ fprintf(stderr, "towire_sha256_double called!\n"); abort(); }
+/* Generated stub for towire_u16 */
+void towire_u16(u8 **pptr UNNEEDED, u16 v UNNEEDED)
+{ fprintf(stderr, "towire_u16 called!\n"); abort(); }
+/* Generated stub for towire_u8_array */
+void towire_u8_array(u8 **pptr UNNEEDED, const u8 *arr UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "towire_u8_array called!\n"); abort(); }
 /* AUTOGENERATED MOCKS END */
 
 static const char block[] =

diff --git a/bitcoin/test/run-tx-encode.c b/bitcoin/test/run-tx-encode.c
@@ -26,9 +26,35 @@ bool amount_sat_eq(struct amount_sat a UNNEEDED, struct amount_sat b UNNEEDED)
 				       struct amount_sat a UNNEEDED,
 				       struct amount_sat b UNNEEDED)
 { fprintf(stderr, "amount_sat_sub called!\n"); abort(); }
+/* Generated stub for fromwire_amount_sat */
+struct amount_sat fromwire_amount_sat(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_amount_sat called!\n"); abort(); }
 /* Generated stub for fromwire_fail */
 const void *fromwire_fail(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
 { fprintf(stderr, "fromwire_fail called!\n"); abort(); }
+/* Generated stub for fromwire_sha256_double */
+void fromwire_sha256_double(const u8 **cursor UNNEEDED, size_t *max UNNEEDED,
+			    struct sha256_double *sha256d UNNEEDED)
+{ fprintf(stderr, "fromwire_sha256_double called!\n"); abort(); }
+/* Generated stub for fromwire_tal_arrn */
+u8 *fromwire_tal_arrn(const tal_t *ctx UNNEEDED,
+		       const u8 **cursor UNNEEDED, size_t *max UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "fromwire_tal_arrn called!\n"); abort(); }
+/* Generated stub for fromwire_u16 */
+u16 fromwire_u16(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_u16 called!\n"); abort(); }
+/* Generated stub for towire_amount_sat */
+void towire_amount_sat(u8 **pptr UNNEEDED, const struct amount_sat sat UNNEEDED)
+{ fprintf(stderr, "towire_amount_sat called!\n"); abort(); }
+/* Generated stub for towire_sha256_double */
+void towire_sha256_double(u8 **pptr UNNEEDED, const struct sha256_double *sha256d UNNEEDED)
+{ fprintf(stderr, "towire_sha256_double called!\n"); abort(); }
+/* Generated stub for towire_u16 */
+void towire_u16(u8 **pptr UNNEEDED, u16 v UNNEEDED)
+{ fprintf(stderr, "towire_u16 called!\n"); abort(); }
+/* Generated stub for towire_u8_array */
+void towire_u8_array(u8 **pptr UNNEEDED, const u8 *arr UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "towire_u8_array called!\n"); abort(); }
 /* AUTOGENERATED MOCKS END */
 
 const char extended_tx[] =

diff --git a/bitcoin/tx.c b/bitcoin/tx.c
@@ -586,3 +586,100 @@ static char *fmt_bitcoin_txid(const tal_t *ctx, const struct bitcoin_txid *txid)
 
 REGISTER_TYPE_TO_STRING(bitcoin_tx, fmt_bitcoin_tx);
 REGISTER_TYPE_TO_STRING(bitcoin_txid, fmt_bitcoin_txid);
+
+void fromwire_bitcoin_txid(const u8 **cursor, size_t *max,
+			   struct bitcoin_txid *txid)
+{
+	fromwire_sha256_double(cursor, max, &txid->shad);
+}
+
+struct bitcoin_tx *fromwire_bitcoin_tx(const tal_t *ctx,
+				       const u8 **cursor, size_t *max)
+{
+	struct bitcoin_tx *tx;
+	u16 input_amts_len;
+	size_t i;
+
+	tx = pull_bitcoin_tx(ctx, cursor, max);
+	input_amts_len = fromwire_u16(cursor, max);
+	/* We don't serialize the amounts if they're not *all* populated */
+	if (input_amts_len != tal_count(tx->input_amounts))
+		return tx;
+
+	for (i = 0; i < input_amts_len; i++) {
+		struct amount_sat sat;
+		sat = fromwire_amount_sat(cursor, max);
+		tx->input_amounts[i] =
+			tal_dup(tx, struct amount_sat, &sat);
+	}
+
+	return tx;
+}
+
+void towire_bitcoin_txid(u8 **pptr, const struct bitcoin_txid *txid)
+{
+	towire_sha256_double(pptr, &txid->shad);
+}
+
+void towire_bitcoin_tx(u8 **pptr, const struct bitcoin_tx *tx)
+{
+	size_t i;
+	u8 *lin = linearize_tx(tmpctx, tx);
+	towire_u8_array(pptr, lin, tal_count(lin));
+
+	/* We only want to 'save' the amounts if every amount
+	 * has been populated */
+	for (i = 0; i < tal_count(tx->input_amounts); i++) {
+		if (!tx->input_amounts[i]) {
+			towire_u16(pptr, 0);
+			return;
+		}
+	}
+
+	/* Otherwise, we include the input amount set */
+	towire_u16(pptr, tal_count(tx->input_amounts));
+	for (i = 0; i < tal_count(tx->input_amounts); i++) {
+		assert(tx->input_amounts[i]);
+		towire_amount_sat(pptr, *tx->input_amounts[i]);
+	}
+}
+
+struct bitcoin_tx_output *fromwire_bitcoin_tx_output(const tal_t *ctx,
+						     const u8 **cursor, size_t *max)
+{
+	struct bitcoin_tx_output *output = tal(ctx, struct bitcoin_tx_output);
+	output->amount = fromwire_amount_sat(cursor, max);
+	u16 script_len = fromwire_u16(cursor, max);
+	output->script = fromwire_tal_arrn(output, cursor, max, script_len);
+	if (!*cursor)
+		return tal_free(output);
+	return output;
+}
+
+void towire_bitcoin_tx_output(u8 **pptr, const struct bitcoin_tx_output *output)
+{
+	towire_amount_sat(pptr, output->amount);
+	towire_u16(pptr, tal_count(output->script));
+	towire_u8_array(pptr, output->script, tal_count(output->script));
+}
+
+void towire_witscript(u8 **pptr, const struct witscript *script)
+{
+	if (script == NULL) {
+		towire_u16(pptr, 0);
+	} else {
+		assert(script->ptr != NULL);
+		towire_u16(pptr, tal_count(script->ptr));
+		towire_u8_array(pptr, script->ptr, tal_count(script->ptr));
+	}
+}
+
+struct witscript *fromwire_witscript(const tal_t *ctx, const u8 **cursor, size_t *max)
+{
+	struct witscript *retval = tal(ctx, struct witscript);
+	u16 len = fromwire_u16(cursor, max);
+	retval->ptr = fromwire_tal_arrn(retval, cursor, max, len);
+	if (!*cursor)
+		return tal_free(retval);
+	return retval;
+}
diff --git a/bitcoin/tx.h b/bitcoin/tx.h
@@ -180,4 +180,19 @@ struct amount_sat bitcoin_tx_compute_fee(const struct bitcoin_tx *tx);
 struct amount_sat bitcoin_tx_compute_fee_w_inputs(const struct bitcoin_tx *tx,
 						  struct amount_sat input_val);
 
+/* Wire marshalling and unmarshalling */
+void fromwire_bitcoin_txid(const u8 **cursor, size_t *max,
+			   struct bitcoin_txid *txid);
+struct bitcoin_tx *fromwire_bitcoin_tx(const tal_t *ctx,
+				       const u8 **cursor, size_t *max);
+struct bitcoin_tx_output *fromwire_bitcoin_tx_output(const tal_t *ctx,
+						     const u8 **cursor, size_t *max);
+struct witscript *fromwire_witscript(const tal_t *ctx,
+				     const u8 **cursor, size_t *max);
+
+void towire_bitcoin_txid(u8 **pptr, const struct bitcoin_txid *txid);
+void towire_bitcoin_tx(u8 **pptr, const struct bitcoin_tx *tx);
+void towire_bitcoin_tx_output(u8 **pptr, const struct bitcoin_tx_output *output);
+void towire_witscript(u8 **pptr, const struct witscript *script);
+
 #endif /* LIGHTNING_BITCOIN_TX_H */
diff --git a/closingd/closing_wire.csv b/closingd/closing_wire.csv
@@ -1,3 +1,4 @@
+#include <bitcoin/tx.h>
 #include <common/cryptomsg.h>
 #include <common/htlc_wire.h>
 #include <common/per_peer_state.h>

diff --git a/common/test/run-amount.c b/common/test/run-amount.c
@@ -4,9 +4,49 @@
 #include <wire/wire.h>
 
 /* AUTOGENERATED MOCKS START */
+/* Generated stub for fromwire_amount_sat */
+struct amount_sat fromwire_amount_sat(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_amount_sat called!\n"); abort(); }
 /* Generated stub for fromwire_fail */
 const void *fromwire_fail(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
 { fprintf(stderr, "fromwire_fail called!\n"); abort(); }
+/* Generated stub for fromwire_secp256k1_ecdsa_signature */
+void fromwire_secp256k1_ecdsa_signature(const u8 **cursor UNNEEDED, size_t *max UNNEEDED,
+					secp256k1_ecdsa_signature *signature UNNEEDED)
+{ fprintf(stderr, "fromwire_secp256k1_ecdsa_signature called!\n"); abort(); }
+/* Generated stub for fromwire_sha256_double */
+void fromwire_sha256_double(const u8 **cursor UNNEEDED, size_t *max UNNEEDED,
+			    struct sha256_double *sha256d UNNEEDED)
+{ fprintf(stderr, "fromwire_sha256_double called!\n"); abort(); }
+/* Generated stub for fromwire_tal_arrn */
+u8 *fromwire_tal_arrn(const tal_t *ctx UNNEEDED,
+		       const u8 **cursor UNNEEDED, size_t *max UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "fromwire_tal_arrn called!\n"); abort(); }
+/* Generated stub for fromwire_u16 */
+u16 fromwire_u16(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_u16 called!\n"); abort(); }
+/* Generated stub for fromwire_u8 */
+u8 fromwire_u8(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_u8 called!\n"); abort(); }
+/* Generated stub for towire_amount_sat */
+void towire_amount_sat(u8 **pptr UNNEEDED, const struct amount_sat sat UNNEEDED)
+{ fprintf(stderr, "towire_amount_sat called!\n"); abort(); }
+/* Generated stub for towire_secp256k1_ecdsa_signature */
+void towire_secp256k1_ecdsa_signature(u8 **pptr UNNEEDED,
+			      const secp256k1_ecdsa_signature *signature UNNEEDED)
+{ fprintf(stderr, "towire_secp256k1_ecdsa_signature called!\n"); abort(); }
+/* Generated stub for towire_sha256_double */
+void towire_sha256_double(u8 **pptr UNNEEDED, const struct sha256_double *sha256d UNNEEDED)
+{ fprintf(stderr, "towire_sha256_double called!\n"); abort(); }
+/* Generated stub for towire_u16 */
+void towire_u16(u8 **pptr UNNEEDED, u16 v UNNEEDED)
+{ fprintf(stderr, "towire_u16 called!\n"); abort(); }
+/* Generated stub for towire_u8 */
+void towire_u8(u8 **pptr UNNEEDED, u8 v UNNEEDED)
+{ fprintf(stderr, "towire_u8 called!\n"); abort(); }
+/* Generated stub for towire_u8_array */
+void towire_u8_array(u8 **pptr UNNEEDED, const u8 *arr UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "towire_u8_array called!\n"); abort(); }
 /* AUTOGENERATED MOCKS END */
 
 #define FAIL_MSAT(msatp, str) \

diff --git a/common/test/run-bigsize.c b/common/test/run-bigsize.c
@@ -31,9 +31,30 @@ bool amount_sat_eq(struct amount_sat a UNNEEDED, struct amount_sat b UNNEEDED)
 				       struct amount_sat a UNNEEDED,
 				       struct amount_sat b UNNEEDED)
 { fprintf(stderr, "amount_sat_sub called!\n"); abort(); }
+/* Generated stub for fromwire_amount_sat */
+struct amount_sat fromwire_amount_sat(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_amount_sat called!\n"); abort(); }
 /* Generated stub for fromwire_fail */
 const void *fromwire_fail(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
 { fprintf(stderr, "fromwire_fail called!\n"); abort(); }
+/* Generated stub for fromwire_secp256k1_ecdsa_signature */
+void fromwire_secp256k1_ecdsa_signature(const u8 **cursor UNNEEDED, size_t *max UNNEEDED,
+					secp256k1_ecdsa_signature *signature UNNEEDED)
+{ fprintf(stderr, "fromwire_secp256k1_ecdsa_signature called!\n"); abort(); }
+/* Generated stub for fromwire_sha256_double */
+void fromwire_sha256_double(const u8 **cursor UNNEEDED, size_t *max UNNEEDED,
+			    struct sha256_double *sha256d UNNEEDED)
+{ fprintf(stderr, "fromwire_sha256_double called!\n"); abort(); }
+/* Generated stub for fromwire_tal_arrn */
+u8 *fromwire_tal_arrn(const tal_t *ctx UNNEEDED,
+		       const u8 **cursor UNNEEDED, size_t *max UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "fromwire_tal_arrn called!\n"); abort(); }
+/* Generated stub for fromwire_u16 */
+u16 fromwire_u16(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_u16 called!\n"); abort(); }
+/* Generated stub for fromwire_u8 */
+u8 fromwire_u8(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_u8 called!\n"); abort(); }
 /* Generated stub for json_add_member */
 void json_add_member(struct json_stream *js UNNEEDED,
 		     const char *fieldname UNNEEDED,
@@ -56,6 +77,25 @@ void json_object_end(struct json_stream *js UNNEEDED)
 /* Generated stub for json_object_start */
 void json_object_start(struct json_stream *ks UNNEEDED, const char *fieldname UNNEEDED)
 { fprintf(stderr, "json_object_start called!\n"); abort(); }
+/* Generated stub for towire_amount_sat */
+void towire_amount_sat(u8 **pptr UNNEEDED, const struct amount_sat sat UNNEEDED)
+{ fprintf(stderr, "towire_amount_sat called!\n"); abort(); }
+/* Generated stub for towire_secp256k1_ecdsa_signature */
+void towire_secp256k1_ecdsa_signature(u8 **pptr UNNEEDED,
+			      const secp256k1_ecdsa_signature *signature UNNEEDED)
+{ fprintf(stderr, "towire_secp256k1_ecdsa_signature called!\n"); abort(); }
+/* Generated stub for towire_sha256_double */
+void towire_sha256_double(u8 **pptr UNNEEDED, const struct sha256_double *sha256d UNNEEDED)
+{ fprintf(stderr, "towire_sha256_double called!\n"); abort(); }
+/* Generated stub for towire_u16 */
+void towire_u16(u8 **pptr UNNEEDED, u16 v UNNEEDED)
+{ fprintf(stderr, "towire_u16 called!\n"); abort(); }
+/* Generated stub for towire_u8 */
+void towire_u8(u8 **pptr UNNEEDED, u8 v UNNEEDED)
+{ fprintf(stderr, "towire_u8 called!\n"); abort(); }
+/* Generated stub for towire_u8_array */
+void towire_u8_array(u8 **pptr UNNEEDED, const u8 *arr UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "towire_u8_array called!\n"); abort(); }
 /* AUTOGENERATED MOCKS END */
 
 /* BOLT #1:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -256,3 +256,4 @@ const char chainparams_get_network_names(const tal_t ctx)
		tal_append_fmt(&networks_string, ", %s", networks[i].network_name);
		return networks_string;
		}