Add derivations for all types from BIP86 base

Author: sangbida

bitcoin/tx.c

@@ -940,7 +940,6 @@ size_t bitcoin_tx_input_witness_weight(enum utxotype utxotype)
 		/* In practice, these predate anchors, so: */
 		return 1 + 1 + bitcoin_tx_input_sig_weight();
 	case UTXO_P2TR:
-	case UTXO_P2TR_BIP86:
 		return 1 + 64;
 	}
 	abort();

bitcoin/tx.h

@@ -57,8 +57,6 @@ enum utxotype {
 	UTXO_P2WSH_FROM_CLOSE = 3,
 	/* "p2tr" addresses. */
 	UTXO_P2TR = 4,
-	/* "bip86" addresses (P2TR with BIP86 derivation). */
-	UTXO_P2TR_BIP86 = 5,
 };
 
 struct bitcoin_tx_output *new_tx_output(const tal_t *ctx,

common/utxo.c

@@ -47,8 +47,6 @@ const char *utxotype_to_str(enum utxotype utxotype)
 		return "p2wsh_from_close";
 	case UTXO_P2TR:
 		return "p2tr";
-	case UTXO_P2TR_BIP86:
-		return "p2tr_bip86";
 	}
 	abort();
 }

contrib/msggen/msggen/schema.json

@@ -25994,13 +25994,12 @@
           "addresstype": {
             "type": "string",
             "description": [
-              "It specifies the type of address wanted; currently *bech32* (e.g. `tb1qu9j4lg5f9rgjyfhvfd905vw46eg39czmktxqgg` on bitcoin testnet or `bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej` on bitcoin mainnet), *p2tr* taproot addresses, or *bip86* for BIP86-derived taproot addresses. The special value *all* generates all known address types for the same underlying key."
+              "It specifies the type of address wanted; currently *bech32* (e.g. `tb1qu9j4lg5f9rgjyfhvfd905vw46eg39czmktxqgg` on bitcoin testnet or `bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej` on bitcoin mainnet) or *p2tr* taproot addresses. For wallets created from a mnemonic, addresses are derived using BIP86 derivation. The special value *all* generates both address types for the same underlying key."
             ],
             "default": "*bech32* address",
             "enum": [
               "bech32",
               "p2tr",
-              "bip86",
               "all"
             ]
           }
@@ -26014,7 +26013,7 @@
             "added": "v23.08",
             "type": "string",
             "description": [
-              "The taproot address (returned for both 'p2tr' and 'bip86' addresstype)."
+              "The taproot address (returned for 'p2tr' addresstype)."
             ]
           },
           "bech32": {
@@ -26062,18 +26061,6 @@
           "response": {
             "p2tr": "bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
           }
-        },
-        {
-          "request": {
-            "id": "example:newaddr#3",
-            "method": "newaddr",
-            "params": {
-              "addresstype": "bip86"
-            }
-          },
-          "response": {
-            "p2tr": "bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
-          }
         }
       ]
     },

doc/schemas/newaddr.json

@@ -17,13 +17,12 @@
       "addresstype": {
         "type": "string",
         "description": [
-          "It specifies the type of address wanted; currently *bech32* (e.g. `tb1qu9j4lg5f9rgjyfhvfd905vw46eg39czmktxqgg` on bitcoin testnet or `bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej` on bitcoin mainnet), *p2tr* taproot addresses, or *bip86* for BIP86-derived taproot addresses. The special value *all* generates all known address types for the same underlying key."
+          "It specifies the type of address wanted; currently *bech32* (e.g. `tb1qu9j4lg5f9rgjyfhvfd905vw46eg39czmktxqgg` on bitcoin testnet or `bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej` on bitcoin mainnet) or *p2tr* taproot addresses. For wallets created from a mnemonic, addresses are derived using BIP86 derivation. The special value *all* generates both address types for the same underlying key."
         ],
         "default": "*bech32* address",
         "enum": [
           "bech32",
           "p2tr",
-          "bip86",
           "all"
         ]
       }
@@ -37,7 +36,7 @@
         "added": "v23.08",
         "type": "string",
         "description": [
-          "The taproot address (returned for both 'p2tr' and 'bip86' addresstype)."
+          "The taproot address (returned for 'p2tr' addresstype)."
         ]
       },
       "bech32": {
@@ -85,18 +84,6 @@
       "response": {
         "p2tr": "bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
       }
-    },
-    {
-      "request": {
-        "id": "example:newaddr#3",
-        "method": "newaddr",
-        "params": {
-          "addresstype": "bip86"
-        }
-      },
-      "response": {
-        "p2tr": "bcrt1p2gppccw6ywewmg74qqxxmqfdpjds3rpr0mf22y9tm9xcc0muggwsea9nkf"
-      }
     }
   ]
 }

hsmd/hsmd.c

@@ -309,15 +309,12 @@ static void create_hsm(int fd, const char *passphrase)
 	char *mnemonic = NULL;
 	struct sha256 seed_hash;
 
-	status_debug("HSM: Starting create_hsm with passphrase=%s", passphrase ? "provided" : "none");
 
 	/* Initialize wally tal context for libwally operations */
 
-	status_debug("HSM: Initialized wally tal context");
 
 	/* Generate random entropy for new mnemonic */
 	randombytes_buf(entropy, sizeof(entropy));
-	status_debug("HSM: Generated random entropy");
 
 
 	/* Generate mnemonic from entropy */
@@ -330,7 +327,6 @@ static void create_hsm(int fd, const char *passphrase)
 		hsmd_send_init_reply_failure(HSM_SECRET_ERR_SEED_DERIVATION_FAILED, STATUS_FAIL_INTERNAL_ERROR,
 			                        "Failed to generate mnemonic from entropy");
 	}
-	status_debug("HSM: Generated mnemonic from entropy");
 
 	if (!mnemonic) {
 		unlink_noerr("hsm_secret");
@@ -344,7 +340,6 @@ static void create_hsm(int fd, const char *passphrase)
 		hsmd_send_init_reply_failure(HSM_SECRET_ERR_SEED_DERIVATION_FAILED, STATUS_FAIL_INTERNAL_ERROR,
 			                        "Failed to derive seed hash from mnemonic");
 	}
-	status_debug("HSM: Derived seed hash from mnemonic");
 
 	/* Create hsm_secret format: seed_hash (32 bytes) + mnemonic */
 	hsm_secret_len = PASSPHRASE_HASH_LEN + strlen(mnemonic);
@@ -354,7 +349,6 @@ static void create_hsm(int fd, const char *passphrase)
 	memcpy(hsm_secret_data, &seed_hash, PASSPHRASE_HASH_LEN);
 	/* Copy mnemonic after seed hash */
 	memcpy(hsm_secret_data + PASSPHRASE_HASH_LEN, mnemonic, strlen(mnemonic));
-	status_debug("HSM: Created hsm_secret data structure");
 
 	/* Derive the actual secret from mnemonic + passphrase for our global hsm_secret */
 	u8 bip32_seed[BIP39_SEED_LEN_512];
@@ -368,7 +362,6 @@ static void create_hsm(int fd, const char *passphrase)
 		hsmd_send_init_reply_failure(HSM_SECRET_ERR_SEED_DERIVATION_FAILED, STATUS_FAIL_INTERNAL_ERROR,
 			                        "Failed to derive seed from mnemonic");
 	}
-	status_debug("HSM: Derived BIP32 seed from mnemonic");
 
 	/* Store the full BIP32 seed */
 	hsm_secret.secret_data = tal_dup_arr(tmpctx, u8, bip32_seed, bip32_seed_len, 0);
@@ -383,7 +376,6 @@ static void create_hsm(int fd, const char *passphrase)
 		status_failed(STATUS_FAIL_INTERNAL_ERROR,
 		              "writing: %s", strerror(errno));
 	}
-	status_debug("HSM: Successfully wrote hsm_secret to file");
 }
 
 /*~ We store our root secret in a "hsm_secret" file (like all of Core Lightning,
@@ -400,14 +392,12 @@ static void maybe_create_new_hsm(const char *passphrase)
 	if (fd < 0) {
 		/* If this is not the first time we've run, it will exist. */
 		if (errno == EEXIST) {
-			status_debug("HSM: hsm_secret file already exists, skipping creation");
 			return;
 		}
 		status_failed(STATUS_FAIL_INTERNAL_ERROR,
 		              "creating: %s", strerror(errno));
 	}
 
-	status_debug("HSM: Creating new hsm_secret file");
 
 	/*~ Store the seed in clear. New hsm_secret files will use mnemonic format
 	 * with passphrases, not encrypted 32-byte secrets. */
@@ -472,7 +462,6 @@ static void load_hsm(const char *passphrase)
 				 passphrase, &err);
 	tal_wally_end(tmpctx);
 	if (!hsms) {
-		status_debug("HSM: Failed to load hsm_secret: %s", hsm_secret_error_str(err));
 		hsmd_send_init_reply_failure(err, STATUS_FAIL_INTERNAL_ERROR,
 			                        "Failed to load hsm_secret: %s", hsm_secret_error_str(err));
 	}
@@ -490,6 +479,7 @@ static void load_hsm(const char *passphrase)
 	if (hsms->mnemonic) {
 		hsm_secret.mnemonic = tal_strdup(NULL, hsms->mnemonic);
 	}
+	
 }
 
 /*~ We have a pre-init call in developer mode, to set dev flags */
@@ -512,8 +502,6 @@ static struct io_plan *preinit_hsm(struct io_conn *conn,
 	if (tlv->warn_on_overgrind)
 		dev_warn_on_overgrind = *tlv->warn_on_overgrind;
 
-	status_debug("preinit: dev_fail_preapprove = %u, dev_no_preapprove_check = %u, dev_warn_on_overgrind = %u",
-		     dev_fail_preapprove, dev_no_preapprove_check, dev_warn_on_overgrind);
 	/* We don't send a reply, just read next */
 	return client_read_next(conn, c);
 }
@@ -591,7 +579,7 @@ static struct io_plan *init_hsm(struct io_conn *conn,
 	/* This was tallocated off NULL, and memleak complains if we don't free it */
 	tal_free(tlvs);
 	return req_reply(conn, c, hsmd_init(hsm_secret.secret_data, hsm_secret.secret_len, hsmd_mutual_version,
-					    bip32_key_version));
+					    bip32_key_version, hsm_secret.type));
 }
 
 /*~ Since we process requests then service them in strict order, and because
@@ -645,7 +633,6 @@ static struct io_plan *pass_client_hsmfd(struct io_conn *conn,
 		status_failed(STATUS_FAIL_INTERNAL_ERROR, "creating fds: %s",
 			      strerror(errno));
 
-	status_debug("new_client: %"PRIu64, dbid);
 	new_client(c, c->chainparams, &id, dbid, capabilities, fds[0]);
 
 	/*~ We stash this in a global, because we need to get both the fd and

hsmd/hsmd_wire.csv

@@ -46,6 +46,10 @@ msgdata,hsmd_init_reply_v4,hsm_capabilities,u32,num_hsm_capabilities
 msgdata,hsmd_init_reply_v4,node_id,node_id,
 msgdata,hsmd_init_reply_v4,bip32,ext_key,
 msgdata,hsmd_init_reply_v4,bolt12,pubkey,
+msgdata,hsmd_init_reply_v4,tlvs,hsmd_init_reply_v4_tlvs,
+# TLV to indicate HSM secret type
+tlvtype,hsmd_init_reply_v4_tlvs,hsm_secret_type,1
+tlvdata,hsmd_init_reply_v4_tlvs,hsm_secret_type,hsm_type,u8,
 
 # HSM initialization failure response
 msgtype,hsmd_init_reply_failure,115

hsmd/libhsmd.c

@@ -2387,7 +2387,7 @@ u8 *hsmd_handle_client_message(const tal_t *ctx, struct hsmd_client *client,
 }
 
 u8 *hsmd_init(const u8 *secret_data, size_t secret_len, const u64 hsmd_version,
-	      struct bip32_key_version bip32_key_version)
+	      struct bip32_key_version bip32_key_version, u8 hsm_secret_type)
 {
 	u8 bip32_seed[BIP32_ENTROPY_LEN_256];
 	struct pubkey key, bolt12;
@@ -2546,10 +2546,15 @@ u8 *hsmd_init(const u8 *secret_data, size_t secret_len, const u64 hsmd_version,
 	 * And version is 4: we offer limited compatibility (or at least,
 	 * incompatibility detection) with alternate implementations.
 	 */
+	/* Create TLV with HSM secret type */
+	struct tlv_hsmd_init_reply_v4_tlvs *tlvs = tlv_hsmd_init_reply_v4_tlvs_new(tmpctx);
+	tlvs->hsm_secret_type = tal(tlvs, u8);
+	*tlvs->hsm_secret_type = hsm_secret_type;
+	
 	return take(towire_hsmd_init_reply_v4(
 			    NULL, hsmd_version, caps,
 			    &node_id, &secretstuff.bip32,
-			    &bolt12));
+			    &bolt12, tlvs));
 }
 
 /* BIP86 key derivation functions moved from hsmd.c */

hsmd/libhsmd.h

@@ -48,7 +48,7 @@ struct hsmd_client {
  * `lightningd`.
  */
 u8 *hsmd_init(const u8 *secret_data, size_t secret_len, const u64 hsmd_version,
-	      struct bip32_key_version bip32_key_version);
+	      struct bip32_key_version bip32_key_version, u8 hsm_secret_type);
 
 struct hsmd_client *hsmd_client_new_main(const tal_t *ctx, u64 capabilities,
 					 void *extra);

lightningd/hsm_control.c

@@ -151,11 +151,12 @@ struct ext_key *hsm_init(struct lightningd *ld)
 	}
 
 	/* Check for successful init reply */
+	struct tlv_hsmd_init_reply_v4_tlvs *tlvs;
 	if (fromwire_hsmd_init_reply_v4(ld, msg,
 					&hsm_version,
 					&ld->hsm_capabilities,
 					&ld->our_nodeid, bip32_base,
-					&unused)) {
+					&unused, &tlvs)) {
 		/* nothing to do. */
 	} else {
 		/* Unknown message type */
@@ -193,20 +194,43 @@ struct ext_key *hsm_init(struct lightningd *ld)
 		fatal("--experimental-splicing needs HSM capable of signing splices!");
 	}
 
-	/* Try to get BIP86 base key from HSM (works only for mnemonic secrets) */
-	ld->bip86_base = tal(ld, struct ext_key);
-	msg = towire_hsmd_derive_bip86_key(NULL, 0, false);
-	const u8 *reply = hsm_sync_req(tmpctx, ld, take(msg));
-	if (fromwire_hsmd_derive_bip86_key_reply(reply, ld->bip86_base)) {
-		/* BIP86 derivation succeeded - we have a mnemonic-based secret */
-		log_info(ld->log, "Using BIP86 for new addresses, BIP32 for channels (mnemonic HSM secret)");
-		/* Keep bip32_base for channel operations, database, etc. */
+	/* Check if we have a mnemonic-based HSM secret from TLV */
+	bool is_mnemonic_secret = false;
+	if (tlvs && tlvs->hsm_secret_type) {
+		u8 secret_type = *tlvs->hsm_secret_type;
+		log_info(ld->log, "DEBUG: HSM secret type from TLV: %u", secret_type);
+		is_mnemonic_secret = (secret_type == 2 || secret_type == 3); /* HSM_SECRET_MNEMONIC_NO_PASS or HSM_SECRET_MNEMONIC_WITH_PASS */
 	} else {
-		/* BIP86 derivation failed - we have a legacy secret */
+		log_info(ld->log, "DEBUG: No HSM secret type TLV found, assuming legacy secret");
+	}
+
+	if (is_mnemonic_secret) {
+		/* Try to get BIP86 base key from HSM (works only for mnemonic secrets) */
+		ld->bip86_base = tal(ld, struct ext_key);
+		msg = towire_hsmd_derive_bip86_key(NULL, 0, false);
+		const u8 *reply = hsm_sync_req(tmpctx, ld, take(msg));
+		log_info(ld->log, "DEBUG: Attempting BIP86 derivation from HSM (mnemonic secret)");
+		if (fromwire_hsmd_derive_bip86_key_reply(reply, ld->bip86_base)) {
+			/* BIP86 derivation succeeded */
+			log_info(ld->log, "DEBUG: BIP86 derivation succeeded, bip86_base is set");
+			log_info(ld->log, "Using BIP86 for new addresses, BIP32 for channels (mnemonic HSM secret)");
+			/* Keep bip32_base for channel operations, database, etc. */
+		} else {
+			/* BIP86 derivation failed unexpectedly */
+			log_info(ld->log, "DEBUG: BIP86 derivation failed unexpectedly for mnemonic secret");
+			ld->bip86_base = tal_free(ld->bip86_base);
+		}
+	} else {
+		/* Legacy HSM secret - don't attempt BIP86 derivation */
+		log_info(ld->log, "DEBUG: Legacy HSM secret detected, skipping BIP86 derivation");
 		log_info(ld->log, "Using BIP32 derivation for all operations (legacy HSM secret)");
-		ld->bip86_base = tal_free(ld->bip86_base);
-		/* bip32_base was already set by the HSM init reply */
+		ld->bip86_base = NULL;
 	}
+	log_info(ld->log, "DEBUG: Final bip86_base state: %s", ld->bip86_base ? "NOT NULL" : "NULL");
+
+	/* Free the TLV structure to prevent memory leak */
+	if (tlvs)
+		tal_free(tlvs);
 
 	/* This is equivalent to makesecret("bolt12-invoice-base") */
 	msg = towire_hsmd_derive_secret(NULL, tal_dup_arr(tmpctx, u8,