map: make the struct public

gossip_map/Cargo.toml

@@ -1,16 +1,22 @@
 [package]
 name = "clightningrpc_gossip_map"
-version = "0.1.0"
+version = "0.0.1-beta.2"
 edition = "2021"
+description = "Crate that provides a plugin API to give the possibility to implement a plugin in Rust"
+license = "CC0-1.0"
+homepage = "https://github.com/laanwj/rust-clightning-rpc"
+repository = "https://github.com/laanwj/rust-clightning-rpc.git"
+keywords = [ "plugin", "cln", "rpc", "lightning", "bitcoin" ]
+readme = "README.md"
 
 [dependencies]
 anyhow = "1"
 log = "0.4.21"
 byteorder = "1.4.3"
 hex = "0.4.3"
 bitcoin = { version = "0.30.0" }
-fundamentals = { git = "https://github.com/lnspec-tools/ln-fundamentals.git", branch = "macros/fix_fixed_read" }
-fundamentals-derive = { git = "https://github.com/lnspec-tools/ln-fundamentals.git", branch = "macros/fix_fixed_read" }
+fundamentals = { version = "0.0.1-alpha.4" }
+fundamentals-derive = { version = "0.0.1-alpha.2"}
 
 [dev-dependencies]
 anyhow = "1.0.70"

gossip_map/README.md

@@ -0,0 +1,16 @@
+# gossip map
+
+Core Lightning Gossip Map parser to access the gossip map with rust.
+
+## Example
+
+``` rust
+fn main() {
+    let path = concat!(env!("CARGO_MANIFEST_DIR"), "/../contrib/gossip_store");
+    let pubkey = "03e2408a49f07d2f4083a47344138ef89e7617e63919202c92aa8d49b574a560ae";
+    let map = GossipMap::from_file(path);
+    assert!(map.is_ok(), "{:?}", map);
+    let map = map.unwrap();
+    assert!(map.get_node(pubkey).is_some(), "node with id `{pubkey}` not found!");
+}
+```

gossip_map/src/lib.rs

@@ -26,11 +26,10 @@
 /// Gossip map implementation, that allow you to manage the gossip_store
 /// written by core lightning.
 #[derive(Debug)]
-struct GossipMap {
-    // FIXME: make this optional
-    path: String,
+pub struct GossipMap {
+    path: Option<String>,
     version: u8,
     stream: Option<BufReader<File>>,
     nodes: HashMap<GossipNodeId, GossipNode>,
     channels: HashMap<ShortChannelId, GossipChannel>,
     orphan_channel_updates: HashMap<ShortChannelId, ChannelUpdate>,
@@ -41,7 +40,7 @@
     pub fn new(version: u8) -> Self {
         log::debug!("gossip map version `{version}`");
         GossipMap {
-            path: "".to_owned(),
+            path: None,
             version,
             stream: None,
             nodes: HashMap::new(),
@@ -55,7 +54,7 @@
         let gossip_store = File::open(file_name)?;
         let stream = BufReader::new(gossip_store);
         let mut gossip_map = GossipMap {
-            path: file_name.to_owned(),
+            path: Some(file_name.to_owned()),
             version: 0,
             stream: Some(stream),
             nodes: HashMap::new(),
@@ -76,13 +75,21 @@
     }
 
     /// add a node announcement message inside the gossip map
-    fn add_node_announcement(&mut self, node_announce: NodeAnnouncement) {}
+    fn add_node_announcement(&mut self, node_announce: NodeAnnouncement) {
+        unimplemented!()
+    }
 
     /// add a channel announcement message inside the gossip map.
-    fn add_channel_announcement(&mut self, channel_announce: ChannelAnnouncement) {}
+    fn add_channel_announcement(&mut self, channel_announce: ChannelAnnouncement) {
+        unimplemented!()
+    }
 
     fn refresh(&mut self) -> anyhow::Result<()> {
-        let gossip_store = File::open(self.path.clone())?;
+        let gossip_store = File::open(
+            self.path
+                .as_ref()
+                .ok_or(anyhow::anyhow!("Gossip map not found"))?,
+        )?;
         let mut stream = BufReader::new(gossip_store);
 
         let version = u8::from_wire(&mut stream)? as u16;