Support output descriptor

NBitcoin.Tests/Generators/CryptoGenerator.cs

@@ -95,5 +95,24 @@ from raw in Gen.NonEmptyListOf(PrimitiveGenerator.RandomBytes(4))
 			select NBitcoin.KeyPath.FromBytes(flattenBytes);
 
 		public static Gen<ExtPubKey> ExtPubKey() => ExtKey().Select(ek => ek.Neuter());
+
+		public static Gen<BitcoinExtPubKey> BitcoinExtPubKey() =>
+			from extKey in ExtPubKey()
+			from network in ChainParamsGenerator.NetworkGen()
+			select new BitcoinExtPubKey(extKey, network);
+
+		public static Gen<BitcoinExtKey> BitcoinExtKey() =>
+			from extKey in ExtKey()
+			from network in ChainParamsGenerator.NetworkGen()
+			select new BitcoinExtKey(extKey, network);
+
+		public static Gen<RootedKeyPath> RootedKeyPath() =>
+			from parentFingerPrint in HDFingerPrint()
+			from kp in KeyPath()
+			select new RootedKeyPath(parentFingerPrint, kp);
+
+		public static Gen<HDFingerprint> HDFingerPrint() =>
+			from x in PrimitiveGenerator.UInt32()
+			select new HDFingerprint(x);
 	}
-}
+}

NBitcoin.Tests/Generators/OutputDescriptorGenerator.cs

@@ -0,0 +1,112 @@
+using System.Collections.Generic;
+using System.Linq;
+using FsCheck;
+using NBitcoin.Altcoins;
+using NBitcoin.Scripting;
+
+#nullable enable
+namespace NBitcoin.Tests.Generators
+{
+	public class OutputDescriptorGenerator : OutputDescriptorGeneratorBase
+	{
+
+		public static Arbitrary<OutputDescriptor> OutputDescriptorArb() =>
+			Arb.From(OutputDescriptorGen());
+	}
+
+	public class RegtestOutputDescriptorGenerator : OutputDescriptorGeneratorBase
+	{
+		public static Arbitrary<OutputDescriptor> OutputDescriptorArb() =>
+			Arb.From(OutputDescriptorGen(Network.RegTest));
+	}
+
+	public class OutputDescriptorGeneratorBase
+	{
+		public static Gen<OutputDescriptor> OutputDescriptorGen(Network? n = null) =>
+			Gen.OneOf(
+				AddrOutputDescriptorGen(n),
+				RawOutputDescriptorGen(),
+				PKOutputDescriptorGen(n),
+				PKHOutputDescriptorGen(n),
+				WPKHOutputDescriptorGen(n),
+				ComboOutputDescriptorGen(n),
+				MultisigOutputDescriptorGen(3, n), // top level multisig can not have more than 3 pubkeys.
+				SHOutputDescriptorGen(n),
+				WSHOutputDescriptorGen(n)
+				);
+		private static Gen<OutputDescriptor> AddrOutputDescriptorGen(Network? n = null) =>
+			from addr in n is null ? AddressGenerator.RandomAddress() : AddressGenerator.RandomAddress(n)
+			select OutputDescriptor.NewAddr(addr);
+
+		private static Gen<OutputDescriptor> RawOutputDescriptorGen() =>
+			from addr in ScriptGenerator.RandomScriptSig()
+			where addr._Script.Length > 0
+			select OutputDescriptor.NewRaw(addr);
+		private static Gen<OutputDescriptor> PKOutputDescriptorGen(Network? n = null) =>
+			from pkProvider in PubKeyProviderGen(n)
+			select OutputDescriptor.NewPK(pkProvider);
+
+		private static Gen<OutputDescriptor> PKHOutputDescriptorGen(Network? n = null) =>
+			from pkProvider in PubKeyProviderGen(n)
+			select OutputDescriptor.NewPKH(pkProvider);
+
+		private static Gen<OutputDescriptor> WPKHOutputDescriptorGen(Network? n = null) =>
+			from pkProvider in PubKeyProviderGen(n)
+			select OutputDescriptor.NewWPKH(pkProvider);
+
+		private static Gen<OutputDescriptor> ComboOutputDescriptorGen(Network? n = null) =>
+			from pkProvider in PubKeyProviderGen(n)
+			select OutputDescriptor.NewCombo(pkProvider);
+
+		private static Gen<OutputDescriptor> MultisigOutputDescriptorGen(int maxN, Network? network = null) =>
+			from n in Gen.Choose(2, maxN)
+			from m in Gen.Choose(2, n).Select(i => (uint)i)
+			from pkProviders in Gen.ArrayOf(n, PubKeyProviderGen(network))
+			from isSorted in Arb.Generate<bool>()
+			select OutputDescriptor.NewMulti(m, pkProviders, isSorted);
+
+		private static Gen<OutputDescriptor> WSHInnerGen(int maxMultisigN, Network? n = null) =>
+			Gen.OneOf(
+				PKOutputDescriptorGen(n),
+				PKHOutputDescriptorGen(n),
+				MultisigOutputDescriptorGen(maxMultisigN, n)
+				);
+		private static Gen<OutputDescriptor> InnerOutputDescriptorGen(int maxMultisigN, Network? n = null) =>
+			Gen.OneOf(
+				WPKHOutputDescriptorGen(n),
+				WSHInnerGen(maxMultisigN, n)
+				);
+
+		// For sh-nested script, max multisig Number is 15.
+		private static Gen<OutputDescriptor> SHOutputDescriptorGen(Network? n = null) =>
+			from inner in Gen.OneOf(InnerOutputDescriptorGen(15, n), WSHOutputDescriptorGen(n))
+			select OutputDescriptor.NewSH(inner);
+
+		private static Gen<OutputDescriptor> WSHOutputDescriptorGen(Network? n = null) =>
+			from inner in WSHInnerGen(20, n)
+			select OutputDescriptor.NewWSH(inner);
+
+		#region pubkey providers
+
+		private static Gen<PubKeyProvider> PubKeyProviderGen(Network? n = null) =>
+			Gen.OneOf(OriginPubKeyProviderGen(n), ConstPubKeyProviderGen(), HDPubKeyProviderGen(n));
+
+		private static Gen<PubKeyProvider> OriginPubKeyProviderGen(Network? n = null) =>
+			from keyOrigin in CryptoGenerator.RootedKeyPath()
+			from inner in Gen.OneOf(ConstPubKeyProviderGen(), HDPubKeyProviderGen(n))
+			select PubKeyProvider.NewOrigin(keyOrigin, inner);
+
+		private static Gen<PubKeyProvider> ConstPubKeyProviderGen() =>
+			from pk in CryptoGenerator.PublicKey()
+			select PubKeyProvider.NewConst(pk);
+
+		private static Gen<PubKeyProvider> HDPubKeyProviderGen(Network? n = null) =>
+			from extPk in n is null ? CryptoGenerator.BitcoinExtPubKey() : CryptoGenerator.ExtPubKey().Select(e => new BitcoinExtPubKey(e, n))
+			from kp in CryptoGenerator.KeyPath()
+			from t in Arb.Generate<PubKeyProvider.DeriveType>()
+			select PubKeyProvider.NewHD(extPk, kp, t);
+
+		# endregion
+	}
+}
+#nullable disable

NBitcoin.Tests/Helpers/PrimitiveUtils.cs

@@ -0,0 +1,43 @@
+
+using System.Collections.Generic;
+
+namespace NBitcoin.Tests.Helpers
+{
+	internal static class PrimitiveUtils
+	{
+		internal static Coin RandomCoin(Money amount, Script scriptPubKey, bool p2sh)
+		{
+			var outpoint = RandOutpoint();
+			if(!p2sh)
+				return new Coin(outpoint, new TxOut(amount, scriptPubKey));
+			return new ScriptCoin(outpoint, new TxOut(amount, scriptPubKey.Hash), scriptPubKey);
+		}
+		internal static Coin RandomCoin(Money amount, Key receiver)
+		{
+			return RandomCoin(amount, receiver.PubKey.GetAddress(ScriptPubKeyType.Legacy, Network.Main));
+		}
+		internal static Coin RandomCoin(Money amount, IDestination receiver)
+		{
+			var outpoint = RandOutpoint();
+			return new Coin(outpoint, new TxOut(amount, receiver));
+		}
+
+		internal static List<ScriptCoin> GetRandomCoinsForAllScriptType(Money amount, Script scriptPubKey)
+		{
+			return new List<ScriptCoin> {
+				RandomCoin(Money.Coins(0.5m), scriptPubKey, true) as ScriptCoin,
+				new ScriptCoin(RandomCoin(Money.Coins(0.5m), scriptPubKey.WitHash), scriptPubKey),
+				new ScriptCoin(RandomCoin(Money.Coins(0.5m), scriptPubKey.WitHash.ScriptPubKey.Hash), scriptPubKey)
+			};
+		}
+
+		internal static OutPoint RandOutpoint()
+		{
+			return new OutPoint(Rand(), 0);
+		}
+		internal static uint256 Rand()
+		{
+			return new uint256(RandomUtils.GetBytes(32));
+		}
+	}
+}