Add support for litecoin p2sh-segwit and bech32 address types

bitcoin/base58.c

@@ -5,6 +5,7 @@
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 #include "address.h"
 #include "base58.h"
+#include "chainparams.h"
 #include "privkey.h"
 #include "pubkey.h"
 #include "shadouble.h"
@@ -35,16 +36,16 @@ static char *to_base58(const tal_t *ctx, u8 version,
 	}
 }
 
-char *bitcoin_to_base58(const tal_t *ctx, bool test_net,
+char *bitcoin_to_base58(const tal_t *ctx, u8 version,
 			const struct bitcoin_address *addr)
 {
-	return to_base58(ctx, test_net ? 111 : 0, &addr->addr);
+	return to_base58(ctx, version, &addr->addr);
 }
 
-char *p2sh_to_base58(const tal_t *ctx, bool test_net,
+char *p2sh_to_base58(const tal_t *ctx, u8 version,
 		     const struct ripemd160 *p2sh)
 {
-	return to_base58(ctx, test_net ? 196 : 5, p2sh);
+	return to_base58(ctx, version, p2sh);
 }
 
 static bool from_base58(u8 *version,
@@ -69,36 +70,36 @@ bool bitcoin_from_base58(bool *test_net,
 			 struct bitcoin_address *addr,
 			 const char *base58, size_t len)
 {
+	const struct chainparams *params;
 	u8 version;
 
 	if (!from_base58(&version, &addr->addr, base58, len))
 		return false;
 
-	if (version == 111)
-		*test_net = true;
-	else if (version == 0)
-		*test_net = false;
-	else
-		return false;
-	return true;
+	params = chainparams_by_p2pkh_version(version);
+	if (params) {
+		*test_net = params->testnet;
+		return true;
+	}
+	return false;
 }
 
 bool p2sh_from_base58(bool *test_net,
 		      struct ripemd160 *p2sh,
 		      const char *base58, size_t len)
 {
+	const struct chainparams *params;
 	u8 version;
 
 	if (!from_base58(&version, p2sh, base58, len))
 		return false;
 
-	if (version == 196)
-		*test_net = true;
-	else if (version == 5)
-		*test_net = false;
-	else
-		return false;
-	return true;
+	params = chainparams_by_p2sh_version(version);
+	if (params) {
+		*test_net = params->testnet;
+		return true;
+	}
+	return false;
 }
 
 bool key_from_base58(const char *base58, size_t base58_len,

bitcoin/base58.h

@@ -25,14 +25,14 @@ struct bitcoin_address;
 #define BASE58_KEY_MAX_LEN 53
 
 /* Bitcoin address encoded in base58, with version and checksum */
-char *bitcoin_to_base58(const tal_t *ctx, bool test_net,
+char *bitcoin_to_base58(const tal_t *ctx, u8 version,
 			const struct bitcoin_address *addr);
 bool bitcoin_from_base58(bool *test_net,
 			 struct bitcoin_address *addr,
 			 const char *base58, size_t len);
 
 /* P2SH address encoded as base58, with version and checksum */
-char *p2sh_to_base58(const tal_t *ctx, bool test_net,
+char *p2sh_to_base58(const tal_t *ctx, u8 version,
 		     const struct ripemd160 *p2sh);
 bool p2sh_from_base58(bool *test_net,
 		      struct ripemd160 *p2sh,

bitcoin/chainparams.c

@@ -21,6 +21,8 @@ const struct chainparams networks[] = {
      .max_payment_msat = 0xFFFFFFFFULL,
      /* "Lightning Charge Powers Developers & Blockstream Store" */
      .when_lightning_became_cool = 504500,
+     .p2pkh_version = 0,
+     .p2sh_version = 5,
      .testnet = false},
     {.network_name = "regtest",
      .bip173_name = "bcrt",
@@ -32,6 +34,8 @@ const struct chainparams networks[] = {
      .max_funding_satoshi = (1 << 24) - 1,
      .max_payment_msat = 0xFFFFFFFFULL,
      .when_lightning_became_cool = 1,
+     .p2pkh_version = 111,
+     .p2sh_version = 196,
      .testnet = true},
     {.network_name = "testnet",
      .bip173_name = "tb",
@@ -42,6 +46,8 @@ const struct chainparams networks[] = {
      .dust_limit = 546,
      .max_funding_satoshi = (1 << 24) - 1,
      .max_payment_msat = 0xFFFFFFFFULL,
+     .p2pkh_version = 111,
+     .p2sh_version = 196,
      .testnet = true},
     {.network_name = "litecoin",
      .bip173_name = "ltc",
@@ -53,6 +59,8 @@ const struct chainparams networks[] = {
      .max_funding_satoshi = 60 * ((1 << 24) - 1),
      .max_payment_msat = 60 * 0xFFFFFFFFULL,
      .when_lightning_became_cool = 1320000,
+     .p2pkh_version = 48,
+     .p2sh_version = 50,
      .testnet = false},
     {.network_name = "litecoin-testnet",
      .bip173_name = "tltc",
@@ -64,9 +72,25 @@ const struct chainparams networks[] = {
      .max_funding_satoshi = 60 * ((1 << 24) - 1),
      .max_payment_msat = 60 * 0xFFFFFFFFULL,
      .when_lightning_became_cool = 1,
+     .p2pkh_version = 111,
+     .p2sh_version = 58,
      .testnet = true}
 };
 
+int chainparams_count(void)
+{
+	return ARRAY_SIZE(networks);
+}
+
+const struct chainparams *chainparams_by_index(const int index)
+{
+	if (index >= ARRAY_SIZE(networks) || index < 0) {
+		return NULL;
+	} else {
+		return &networks[index];
+	}
+}
+
 const struct chainparams *chainparams_for_network(const char *network_name)
 {
 	for (size_t i = 0; i < ARRAY_SIZE(networks); i++) {
@@ -96,3 +120,23 @@ const struct chainparams *chainparams_by_bip173(const char *bip173_name)
 	}
 	return NULL;
 }
+
+const struct chainparams *chainparams_by_p2pkh_version(const u8 version)
+{
+	for (size_t i = 0; i < ARRAY_SIZE(networks); i++) {
+		if (version == networks[i].p2pkh_version) {
+			return &networks[i];
+		}
+	}
+	return NULL;
+}
+
+const struct chainparams *chainparams_by_p2sh_version(const u8 version)
+{
+	for (size_t i = 0; i < ARRAY_SIZE(networks); i++) {
+		if (version == networks[i].p2sh_version) {
+			return &networks[i];
+		}
+	}
+	return NULL;
+}

bitcoin/chainparams.h

@@ -17,11 +17,23 @@ struct chainparams {
 	const u64 max_funding_satoshi;
 	const u64 max_payment_msat;
 	const u32 when_lightning_became_cool;
+	const u8 p2pkh_version;
+	const u8 p2sh_version;
 
 	/* Whether this is a test network or not */
 	const bool testnet;
 };
 
+/**
+ * chainparams_count - Returns the number of supported networks
+ */
+int chainparams_count(void);
+
+/**
+ * chainparams_by_index - Helper to get a network by its numeric index
+ */
+const struct chainparams *chainparams_by_index(const int index);
+
 /**
  * chainparams_for_network - Look up blockchain parameters by its name
  */
@@ -39,4 +51,14 @@ const struct chainparams *chainparams_by_bip173(const char *bip173_name);
  */
 const struct chainparams *chainparams_by_chainhash(const struct bitcoin_blkid *chain_hash);
 
+/**
+ * chainparams_by_p2pkh_version: Helper to get a network by its p2pkh version
+ */
+const struct chainparams *chainparams_by_p2pkh_version(const u8 version);
+
+/**
+ * chainparams_by_p2sh_version: Helper to get a network by its p2sh version
+ */
+const struct chainparams *chainparams_by_p2sh_version(const u8 version);
+
 #endif /* LIGHTNING_BITCOIN_CHAINPARAMS_H */

devtools/bolt11-cli.c

@@ -120,12 +120,12 @@ int main(int argc, char *argv[])
 		printf("fallback: %s\n", tal_hex(ctx, b11->fallbacks[i]));
                 if (is_p2pkh(b11->fallbacks[i], &pkh)) {
 			printf("fallback-P2PKH: %s\n",
-			       bitcoin_to_base58(ctx, b11->chain->testnet,
+			       bitcoin_to_base58(ctx, b11->chain->p2pkh_version,
 						 &pkh));
                 } else if (is_p2sh(b11->fallbacks[i], &sh)) {
 			printf("fallback-P2SH: %s\n",
 			       p2sh_to_base58(ctx,
-					      b11->chain->testnet,
+					      b11->chain->p2sh_version,
 					      &sh));
                 } else if (is_p2wpkh(b11->fallbacks[i], &pkh)) {
                         char out[73 + strlen(b11->chain->bip173_name)];

lightningd/invoice.c

@@ -515,11 +515,11 @@ static void json_add_fallback(struct json_result *response,
 	if (is_p2pkh(fallback, &pkh)) {
 		json_add_string(response, "type", "P2PKH");
 		json_add_string(response, "addr",
-				bitcoin_to_base58(tmpctx, chain->testnet, &pkh));
+				bitcoin_to_base58(tmpctx, chain->p2pkh_version, &pkh));
 	} else if (is_p2sh(fallback, &sh)) {
 		json_add_string(response, "type", "P2SH");
 		json_add_string(response, "addr",
-				p2sh_to_base58(tmpctx, chain->testnet, &sh));
+				p2sh_to_base58(tmpctx, chain->p2sh_version, &sh));
 	} else if (is_p2wpkh(fallback, &pkh)) {
 		char out[73 + strlen(chain->bip173_name)];
 		json_add_string(response, "type", "P2WPKH");

lightningd/jsonrpc.c

@@ -659,12 +659,11 @@ static const char* segwit_addr_net_decode(int *witness_version,
 				   size_t *witness_program_len,
 				   const char *addrz)
 {
-	const char *network[] = { "bc", "tb", "bcrt" };
-	for (int i = 0; i < sizeof(network) / sizeof(*network); ++i) {
+	for (int i = 0; i < chainparams_count(); ++i) {
 		if (segwit_addr_decode(witness_version,
 				       witness_program, witness_program_len,
-				       network[i], addrz))
-			return network[i];
+				       chainparams_by_index(i)->bip173_name, addrz))
+			return chainparams_by_index(i)->bip173_name;
 	}
 
 	return NULL;

wallet/walletrpc.c

@@ -190,7 +190,7 @@ encode_pubkey_to_addr(const tal_t *ctx,
 		sha256(&h, redeemscript, tal_count(redeemscript));
 		ripemd160(&h160, h.u.u8, sizeof(h));
 		out = p2sh_to_base58(ctx,
-				     get_chainparams(ld)->testnet,
+				     get_chainparams(ld)->p2sh_version,
 				     &h160);
 	} else {
 		hrp = get_chainparams(ld)->bip173_name;