Merge pull request #138 from synonymdev/signet-support

Signet support

Author: Jasonvdb

example/utils/constants.ts

@@ -36,4 +36,5 @@ export const customPeers = {
 			protocol: 'tcp',
 		},
 	],
+	bitcoinSignet: [],
 };

example/utils/helpers.ts

@@ -14,6 +14,7 @@ import RNFS from 'react-native-fs';
 import * as bip32 from 'bip32';
 import * as bip39 from 'bip39';
 import { ENetworks } from '@synonymdev/react-native-ldk/dist/utils/types';
+import networks from '@synonymdev/react-native-ldk/dist/utils/networks';
 import ldk from '@synonymdev/react-native-ldk/dist/ldk';
 import Clipboard from '@react-native-clipboard/clipboard';
 
@@ -125,13 +126,15 @@ export const getNetwork = (
 ): bitcoin.networks.Network => {
 	switch (network) {
 		case 'bitcoin':
-			return bitcoin.networks.bitcoin;
+			return networks.bitcoin;
 		case 'bitcoinTestnet':
-			return bitcoin.networks.testnet;
+			return networks.testnet;
 		case 'bitcoinRegtest':
-			return bitcoin.networks.regtest;
+			return networks.regtest;
+		case 'bitcoinSignet':
+			return networks.signet;
 		default:
-			return bitcoin.networks.regtest;
+			return networks.regtest;
 	}
 };
 
@@ -209,6 +212,8 @@ export const ldkNetwork = (network: TAvailableNetworks): ENetworks => {
 			return ENetworks.testnet;
 		case 'bitcoin':
 			return ENetworks.mainnet;
+		case 'bitcoinSignet':
+			return ENetworks.signet;
 	}
 };
 

lib/android/src/main/java/com/reactnativeldk/Helpers.kt

@@ -81,7 +81,7 @@ val Invoice.asJson: WritableMap
         result.putHexString("payment_secret", payment_secret())
         result.putInt("timestamp", timestamp().toInt())
         result.putHexString("features", features()?.write())
-        result.putInt("currency", currency().ordinal)
+        result.putString("currency", currencyString(currency()))
         result.putString("to_str", signedInv.to_str())
 
         val hints = Arguments.createArray()
@@ -377,13 +377,25 @@ fun UserConfig.mergeWithMap(map: ReadableMap): UserConfig {
 /// Helper for returning real network and currency as a tuple from a string
 fun getNetwork(chain: String): Pair<Network, Currency> {
     return when (chain) {
-        "regtest" -> Pair(Network.LDKNetwork_Regtest, Currency.LDKCurrency_Regtest)
-        "testnet" -> Pair(Network.LDKNetwork_Testnet, Currency.LDKCurrency_BitcoinTestnet)
         "mainnet" -> Pair(Network.LDKNetwork_Bitcoin, Currency.LDKCurrency_Bitcoin)
+        "testnet" -> Pair(Network.LDKNetwork_Testnet, Currency.LDKCurrency_BitcoinTestnet)
+        "regtest" -> Pair(Network.LDKNetwork_Regtest, Currency.LDKCurrency_Regtest)
+        "signet" -> Pair(Network.LDKNetwork_Signet, Currency.LDKCurrency_Signet)
         else -> Pair(Network.LDKNetwork_Bitcoin, Currency.LDKCurrency_Bitcoin)
     }
 }
 
+fun currencyString(currency: Currency): String {
+    return when (currency) {
+        Currency.LDKCurrency_Bitcoin -> "Bitcoin"
+        Currency.LDKCurrency_BitcoinTestnet -> "BitcoinTestnet"
+        Currency.LDKCurrency_Regtest -> "Regtest"
+        Currency.LDKCurrency_Simnet -> "Simnet"
+        Currency.LDKCurrency_Signet -> "Signet"
+        else -> "Unknown"
+    }
+}
+
 fun mergeObj(obj1: JSONObject, obj2: HashMap<String, Any>): HashMap<String, Any> {
     val newObj = HashMap<String, Any>()
 

lib/android/src/main/java/com/reactnativeldk/LdkModule.kt

@@ -271,7 +271,7 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
         }
 
         if (networkGraph == null) {
-            var ldkNetwork = getNetwork(network);
+            val ldkNetwork = getNetwork(network);
             networkGraph = NetworkGraph.of(ldkNetwork.first, logger.logger)
 
             LdkEventEmitter.send(EventTypes.native_log, "Failed to load cached network graph from disk. Will sync from scratch.")
@@ -294,7 +294,7 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
         rapidGossipSync = RapidGossipSync.of(networkGraph, logger.logger)
 
         //If it's been more than 24 hours then we need to update RGS
-        var timestamp = if (networkGraph!!._last_rapid_gossip_sync_timestamp is Option_u32Z.Some) (networkGraph!!._last_rapid_gossip_sync_timestamp as Option_u32Z.Some).some.toLong() else 0 // (networkGraph!!._last_rapid_gossip_sync_timestamp as Option_u32Z.Some).some
+        val timestamp = if (networkGraph!!._last_rapid_gossip_sync_timestamp is Option_u32Z.Some) (networkGraph!!._last_rapid_gossip_sync_timestamp as Option_u32Z.Some).some.toLong() else 0 // (networkGraph!!._last_rapid_gossip_sync_timestamp as Option_u32Z.Some).some
         val hoursDiffSinceLastRGS = (System.currentTimeMillis() / 1000 - timestamp) / 60 / 60
         if (hoursDiffSinceLastRGS < 24) {
             LdkEventEmitter.send(EventTypes.native_log, "Skipping rapid gossip sync. Last updated $hoursDiffSinceLastRGS hours ago.")
@@ -354,23 +354,8 @@ class LdkModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
             return handleReject(promise, LdkErrors.init_storage_path)
         }
 
-        when (network) {
-            "regtest" -> {
-                ldkNetwork = Network.LDKNetwork_Regtest
-                ldkCurrency = Currency.LDKCurrency_Regtest
-            }
-            "testnet" -> {
-                ldkNetwork = Network.LDKNetwork_Testnet
-                ldkCurrency = Currency.LDKCurrency_BitcoinTestnet
-            }
-            "mainnet" -> {
-                ldkNetwork = Network.LDKNetwork_Bitcoin
-                ldkCurrency = Currency.LDKCurrency_Bitcoin
-            }
-            else -> {
-                return handleReject(promise, LdkErrors.invalid_network)
-            }
-        }
+        ldkNetwork = getNetwork(network).first
+        ldkCurrency = getNetwork(network).second
 
         val enableP2PGossip = rapidGossipSync == null
 

lib/ios/Helpers.swift

@@ -26,23 +26,6 @@ func handleReject(_ reject: RCTPromiseRejectBlock, _ ldkError: LdkErrors, _ erro
     reject(ldkError.rawValue, message ?? ldkError.rawValue, NSError(domain: ldkError.rawValue, code: ldkError.hashValue))
 }
 
-func currencyString(_ currency: Currency) -> String {
-    switch currency {
-    case .Bitcoin:
-        return "Bitcoin"
-    case .BitcoinTestnet:
-        return "BitcoinTestnet"
-    case .Regtest:
-        return "Regtest"
-    case .Simnet:
-        return "Simnet"
-    case .Signet:
-        return "Signet"
-    @unknown default:
-        return "Unknown"
-    }
-}
-
 /// Loads the cached scorer from disk or creates a new one
 /// - Parameters:
 ///   - path
@@ -438,17 +421,36 @@ func handlePaymentSendFailure(_ reject: RCTPromiseRejectBlock, error: Bindings.P
 /// - Returns: network and currency tuple
 func getNetwork(_ network: String) -> (Network, Currency)? {
     switch network {
-    case "regtest":
-        return (Network.Regtest, Currency.Regtest)
-    case "testnet":
-        return (Network.Testnet, Currency.BitcoinTestnet)
     case "mainnet":
         return (Network.Bitcoin, Currency.Bitcoin)
+    case "testnet":
+        return (Network.Testnet, Currency.BitcoinTestnet)
+    case "regtest":
+        return (Network.Regtest, Currency.Regtest)
+    case "signet":
+        return (Network.Signet, Currency.Signet)
     default:
         return nil
     }
 }
 
+func currencyString(_ currency: Currency) -> String {
+    switch currency {
+    case .Bitcoin:
+        return "Bitcoin"
+    case .BitcoinTestnet:
+        return "BitcoinTestnet"
+    case .Regtest:
+        return "Regtest"
+    case .Simnet:
+        return "Simnet"
+    case .Signet:
+        return "Signet"
+    @unknown default:
+        return "Unknown"
+    }
+}
+
 func mergeObj(_ obj1: [String: Any], _ obj2: [String: Any]) -> [String: Any] {
     var newObj = obj1
     obj2.keys.forEach { key in

lib/src/lightning-manager.ts

@@ -61,7 +61,7 @@ import {
 	startParamCheck,
 } from './utils/helpers';
 import * as bitcoin from 'bitcoinjs-lib';
-import { networks } from 'bitcoinjs-lib';
+import networks from './utils/networks';
 import { EmitterSubscription } from 'react-native';
 
 //TODO startup steps
@@ -384,7 +384,7 @@ class LightningManager {
 		// Step 7: Read ChannelMonitors state from disk
 		// Handled in initChannelManager below
 
-		if (network !== 'mainnet') {
+		if (network !== ENetworks.mainnet) {
 			//RGS only currently working for mainnet
 			rapidGossipSyncUrl = '';
 		}

lib/src/mock.ts

@@ -1,3 +1,5 @@
+import { ENetworks } from './utils/types';
+
 export * from './utils/types';
 
 const noop = (): void => {};
@@ -50,7 +52,7 @@ export default {
 	backupSubscriptions: {},
 	backupSubscriptionsId: 1,
 	backupSubscriptionsDebounceTimer: 1,
-	network: 'mainnet',
+	network: ENetworks.mainnet,
 	baseStoragePath: '/ldk/',
 	logFilePath: '/ldk/wallet0bitcoinldkaccount/logs/1.log',
 };

lib/src/utils/helpers.ts

@@ -1,8 +1,7 @@
 import { ENetworks, TLdkStart } from './types';
 import { err, ok, Result } from './result';
 import * as bitcoin from 'bitcoinjs-lib';
-import { networks } from 'bitcoinjs-lib';
-
+import networks from './networks';
 /**
  * This method runs a check on each parameter passed to the start method
  * to ensure that they are providing the expected data.
@@ -31,15 +30,12 @@ export const startParamCheck = async ({
 		if (typeof network !== 'string') {
 			return err('network must be a string.');
 		}
-		if (
-			!(
-				network === ENetworks.mainnet ||
-				network === ENetworks.testnet ||
-				network === ENetworks.regtest
-			)
-		) {
+
+		if (!Object.values(ENetworks).includes(network)) {
 			return err(
-				`The provided network (${network}) is invalid. It must be either '${ENetworks.mainnet}', '${ENetworks.testnet}' or '${ENetworks.regtest}'.`,
+				`The provided network (${network}) is invalid. It must on of the following: '${Object.values(
+					ENetworks,
+				).join(', ')}'.`,
 			);
 		}
 
@@ -90,7 +86,7 @@ export const startParamCheck = async ({
 		}
 
 		// Test getTransactionData response if using mainnet or testnet.
-		if (network !== ENetworks.regtest) {
+		if (network === ENetworks.mainnet || network === ENetworks.testnet) {
 			const expectedData = {
 				[ENetworks.mainnet]: {
 					txid: '0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098',

lib/src/utils/networks.ts

@@ -0,0 +1,23 @@
+import * as bitcoin from 'bitcoinjs-lib';
+import { ENetworks } from './types';
+
+const networks: {
+	[ENetworks.mainnet]: bitcoin.networks.Network;
+	[ENetworks.testnet]: bitcoin.networks.Network;
+	[ENetworks.regtest]: bitcoin.networks.Network;
+	[ENetworks.signet]: bitcoin.networks.Network;
+} = {
+	...bitcoin.networks,
+	signet: {
+		messagePrefix: '\x18Bitcoin Signed Message:\n',
+		bech32: 'ts',
+		bip32: {
+			public: 0x043587cf,
+			private: 0x04358394,
+		},
+		pubKeyHash: 0x7d,
+		scriptHash: 0x6e,
+		wif: 0xef,
+	},
+};
+export default networks;

lib/src/utils/types.ts

@@ -1,9 +1,16 @@
 export enum ENetworks {
+	signet = 'signet',
 	regtest = 'regtest',
 	testnet = 'testnet',
-	mainnet = 'mainnet',
+	mainnet = 'bitcoin',
 }
 
+export type TAvailableNetworks =
+	| 'bitcoin'
+	| 'bitcoinTestnet'
+	| 'bitcoinRegtest'
+	| 'bitcoinSignet';
+
 export enum EEventTypes {
 	ldk_log = 'ldk_log',
 	native_log = 'native_log',
@@ -496,11 +503,6 @@ export const DefaultLdkDataShape: TLdkData = {
 	[ELdkData.payments_sent]: [],
 };
 
-export type TAvailableNetworks =
-	| 'bitcoin'
-	| 'bitcoinTestnet'
-	| 'bitcoinRegtest';
-
 export type TAccount = {
 	name: string;
 	seed: string;