Basic app skeleton and block parsing

Author: dr-orlovsky

.gitignore

@@ -0,0 +1,20 @@
+.idea
+
+# Compiled files
+*.o
+*.so
+*.rlib
+*.dll
+
+# Executables
+*.exe
+
+# Generated by Cargo
+/target/
+
+/target
+**/*.rs.bk
+Cargo.lock
+
+# Rust code coverage-specific
+/kcov-build/

Cargo.toml

@@ -0,0 +1,28 @@
+[package]
+name = "bpdump"
+description = "Bitcoin protocol Swiss army knife - like `tcpdump`, but for LNP/BP stack"
+version = "0.1.0"
+license = "MIT"
+authors = ["Dr Maxim Orlovsky <[email protected]>"]
+keywords = [ "bitcoin", "lightning", "blockchain" ]
+readme = "README.md"
+edition = "2018"
+
+[dependencies]
+yaml = "0.3.0"
+bitcoin = "~0.19.0"
+bech32 = "~0.6.0"
+bitcoin-bech32 = "~0.9.0"
+bitcoin_hashes = "~0.3.0"
+
+[patch.crates-io]
+bitcoin = { git = "https://github.com/pandoracore/rust-bitcoin.git", branch = "generic-reader" }
+
+[dependencies.secp256k1]
+version = "~0.12.0" # We require this version because of compatibility issues with bitcoin 0.18.0
+features = [ "rand" ]
+
+[dependencies.clap]
+version = "~2.33"
+default-features = true
+features = [ "yaml" ]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Storm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,7 @@
+# Bitcoin protocol Swiss army knife - like `tcpdump`, but for LNP/BP stack
+
+WIP
+
+```sh
+$ cargo run --package bpdump --features yaml --bin bpdump block sample_data/blk00000.dat
+```

cli.yml

@@ -0,0 +1,35 @@
+name: bpdump
+version: "0.1.0"
+author: Dr Maxim Orlovsky <[email protected]>
+about: Bitcoin protocol dumping tool - like TCP dump, but for LNP/BP stack
+args:
+  - COMMAND:
+      help: command to perform
+      index: 1
+      required: true
+      possible_values:
+        - block
+        - tx
+  - INPUT:
+      help: Sets the input file to use (otherwise uses STDIN)
+      required: false
+      index: 2
+  - OUTPUT:
+      help: Sets output file to dump the information (otherwise uses STDOUT)
+      required: false
+      index: 3
+      requires: [ 'INPUT' ]
+  - verbose:
+      short: v
+      multiple: true
+      help: Sets the level of verbosity
+  - format:
+      short: f
+      multiple: false
+      takes_value: true
+      help: Defines output format
+      value_names:
+        - csv
+        - yaml
+        - json
+        - text

sample_data/blk00000.dat

@@ -0,0 +1,75 @@
+#[macro_use]
+extern crate clap;
+extern crate bitcoin;
+
+use std::fs::File;
+use std::io;
+use clap::{App, ArgMatches};
+use std::io::BufRead;
+use bitcoin::network::stream_reader::StreamReader;
+use bitcoin::{Block, BitcoinHash};
+
+
+#[cfg(feature = "yaml")]
+fn main() -> std::io::Result<()> {
+    eprintln!("\nBitcoin protocol dumping tool\n");
+
+    let yaml = load_yaml!("../cli.yml");
+    let matches = App::from_yaml(yaml).get_matches();
+
+    match matches.value_of("COMMAND").unwrap() {
+        "block" => parse_block(matches),
+        _ => unreachable!(),
+    }
+}
+
+#[cfg(not(feature = "yaml"))]
+fn main() {
+    // As stated above, if clap is not compiled with the YAML feature, it is disabled.
+    eprintln!("YAML feature is disabled.");
+    eprintln!("Pass --features yaml to cargo when trying this example.");
+}
+
+fn parse_block(matches: ArgMatches) -> std::io::Result<()> {
+    let filename = matches.value_of("INPUT");
+    eprintln!("Parsing block file {}", filename.unwrap_or("STDIN"));
+
+    let mut stdin;
+    let buf_reader: Box<BufRead> = match filename {
+        Some(name) => Box::new(io::BufReader::new(File::open(name)?)),
+        None => {
+            stdin = io::stdin();
+            Box::new(stdin.lock())
+        },
+    };
+    let mut stream_reader = StreamReader::new(Box::new(buf_reader), None);
+
+    let mut blkno = 0;
+    loop {
+        // Reading magick number
+        match stream_reader.read_next::<u32>() {
+            Ok(0xD9B4BEF9) => (),
+            _ => {
+                eprintln!("No magick number found");
+                break;
+            }
+        }
+        // Skipping block length
+        eprintln!("Magick number ok");
+        let _ = stream_reader.read_next::<u32>();
+        // Reading block
+        match stream_reader.read_next::<Block>() {
+            Err(err) => {
+                eprintln!("{}", err);
+                break;
+            },
+            Ok(block) => {
+                eprintln!("* read block no {}, id {}", blkno, block.bitcoin_hash());
+                println!("{:#?}", block.header);
+                println!("{:#?}", block.txdata[0]);
+                blkno += 1;
+            },
+        }
+    }
+    Ok(())
+}