X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;ds=sidebyside;f=lightning-c-bindings%2Fsrc%2Fbitcoin%2Fnetwork.rs;h=78565a1c19f30e25d7af30a2dd63d139b22629e0;hb=HEAD;hp=52cb2ce68a26dbdf81cccc50702568a9aa449722;hpb=1495575b517c90da925698da14f627bf0d5b313f;p=ldk-c-bindings

diff --git a/lightning-c-bindings/src/bitcoin/network.rs b/lightning-c-bindings/src/bitcoin/network.rs
index 52cb2ce..78565a1 100644
--- a/lightning-c-bindings/src/bitcoin/network.rs
+++ b/lightning-c-bindings/src/bitcoin/network.rs
@@ -1,10 +1,17 @@
+//! A C-mapped version fo bitcoin::network::constants::Network
+
 use bitcoin::network::constants::Network as BitcoinNetwork;
 
 #[repr(C)]
+/// An enum representing the possible Bitcoin or test networks which we can run on
 pub enum Network {
+	/// The main Bitcoin blockchain.
 	Bitcoin,
+	/// The testnet3 blockchain.
 	Testnet,
+	/// A local test blockchain.
 	Regtest,
+	/// A blockchain on which blocks are signed instead of mined.
 	Signet,
 }
 
@@ -17,12 +24,13 @@ impl Network {
 			Network::Signet => BitcoinNetwork::Signet,
 		}
 	}
-	pub(crate) fn from_bitcoin(net: BitcoinNetwork) -> Self {
+	pub(crate) fn from_bitcoin(net: &BitcoinNetwork) -> Self {
 		match net {
 			BitcoinNetwork::Bitcoin => Network::Bitcoin,
 			BitcoinNetwork::Testnet => Network::Testnet,
 			BitcoinNetwork::Regtest => Network::Regtest,
 			BitcoinNetwork::Signet => Network::Signet,
+			_ => unreachable!(),
 		}
 	}
 }