Initial commit

Author: sigma67

Diff for: .gitignore

@@ -0,0 +1,14 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Rust template
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+.idea

Diff for: Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "exonum-bench"
+version = "0.1.0"
+authors = ["sigma67 <[email protected]>"]
+edition = "2018"
+license = "Apache 2.0"
+
+[dependencies]
+exonum = { version = "0.11.0", path = "../exonum/exonum" }
+exonum-crypto = { version = "0.11.0", path = "../exonum/components/crypto" }
+exonum-derive = { version = "0.11.0", path = "../exonum/components/derive" }
+exonum-merkledb = { version = "0.11.0", path = "../exonum/components/merkledb" }
+exonum-configuration = { version = "0.11.0", path = "../exonum/services/configuration" }
+serde = "1.0.10"
+serde_derive = "1.0.10"
+serde_json = "1.0.2"
+failure = "0.1.5"
+protobuf = "2.6.0"
+reqwest = "0.9.14"
+tokio = "0.1.18"
+futures = "0.1.26"
+rand = "0.6"
+
+[build-dependencies]
+exonum-build = { version = "0.11.0", path = "../exonum/components/build" }
+
+[features]
+default = ["with-serde"]
+with-serde = []

Diff for: README.md

@@ -0,0 +1,49 @@
+# exonum-timestamping benchmark
+Simple client-based benchmarking tool for the [exonum-timestamping service](https://github.com/exonum/exonum/tree/master/examples/timestamping).
+
+This tool was built from the need to have a **high-throughput and efficient benchmarking tool** for the Exonum blockchain. Using the nodeJS client for Exonum resulted in inconsistent results and would often be bottlenecked by the sending client.
+
+By reusing the [transactions schema](https://github.com/sigma67/exonum-bench/tree/master/src/transactions.rs) from the Rust service implementation it becomes possible to properly benchmark the blockchain. 
+
+An adjusted frontend for the timestamping service with deployment and benchmarking scripts can be found at https://bitbucket.org/sigma67/exonum-log-timestamping/
+
+## Research Paper
+You can find the associated research paper here: 
+
+[A secure and auditable logging infrastructure based on a permissioned blockchain](https://www.sciencedirect.com/science/article/pii/S0167404818313907)
+
+## Prerequisites
+Initially you need to set up at least 4 instances of the Exonum blockchain with the timestamping service by following the instructions in examples/timestamping/README.md
+```sh
+# clone the main Exonum repository v0.11
+git clone https://github.com/exonum/exonum/ --branch "0-11-1-release" --depth 1
+
+cd exonum/examples/timestamping/backend
+cargo install
+```
+
+To install the frontend, run 
+```sh
+git clone https://bitbucket.org/sigma67/exonum-log-timestamping/ --depth 1
+npm install
+npm run build
+npm start -- --port=2268 --api-root=http://127.0.0.1:8200
+```
+
+## Build the benchmarking tool
+```sh
+# Clone this repository
+git clone https://github.com/sigma67/exonum-bench
+cargo install
+```
+For the build to succeed, the main exonum repository needs to be present in the same parent directory.
+## Run
+The benchmarking tool sends a specific number of transactions to the configured blockchain node per second.
+```
+# Send 100 transactions per second for 60 seconds
+exonum-bench 100 60 1
+```
+
+There is also an automated script for remote benchmarking spread across all blockchain nodes at https://bitbucket.org/sigma67/exonum-log-timestamping/src/master/deploy/run_benchmark.sh.
+
+This results in a more realistic benchmark since all blockchain nodes receive an equal amount of transactions.

Diff for: build.rs

@@ -0,0 +1,12 @@
+extern crate exonum_build;
+
+use exonum_build::{get_exonum_protobuf_files_path, protobuf_generate};
+
+fn main() {
+    let exonum_protos = get_exonum_protobuf_files_path();
+    protobuf_generate(
+        "src/proto",
+        &["src/proto", &exonum_protos],
+        "protobuf_mod.rs",
+    );
+}

Diff for: src/api.rs

@@ -0,0 +1,74 @@
+use serde_json;
+use serde_json::json;
+
+use reqwest::{r#async::Client, Response, StatusCode};
+//for async
+use tokio;
+use futures::{stream, Future, Stream};
+
+const URL: &str = "http://localhost:8200/api/explorer/v1/transactions";
+const PARALLEL_REQUESTS: usize = 100;
+
+pub fn post(data: &String) -> String{
+    let client = reqwest::Client::new();
+
+    let query = &json!({ "tx_body": data });
+
+    //println!("POST {}", url);
+
+    let builder = client.post(&URL.to_string());
+    //println!("Body: {}", serde_json::to_string_pretty(&query).unwrap());
+    let builder = builder.json(&query);
+    let response = builder.send().expect("Unable to send request");
+
+    self::response_to_api_result(response)
+}
+
+pub fn post_async(items: Vec<String>) {
+    let client = Client::new();
+    let bodies = stream::iter_ok(items)
+        .map(move |item| {
+            let json = &json!({ "tx_body": item });
+            client
+                .post(&URL.to_string())
+                .json(json)
+                .send()
+                .and_then(|res| res.into_body().concat2().from_err())
+        })
+        .buffer_unordered(PARALLEL_REQUESTS);
+
+    let work = bodies
+        .for_each(|b| {
+            Ok(())
+        })
+        .map_err(|e| panic!("Error while processing: {}", e));
+
+    tokio::run(work);
+}
+
+pub fn post_batch(data: Vec<String>){
+}
+
+/// Converts reqwest Response to api::Result.
+fn response_to_api_result(response: Response) -> String
+{
+    fn extract_description(body: &str) -> Option<String> {
+        match serde_json::from_str::<serde_json::Value>(body).ok()? {
+            serde_json::Value::Object(ref object) if object.contains_key("description") => {
+                Some(object["description"].as_str()?.to_owned())
+            }
+            serde_json::Value::String(string) => Some(string),
+            _ => None,
+        }
+    }
+
+    fn error(mut response: Response) -> String {
+        let body = response.text().expect("Unable to get response text");
+        extract_description(&body).unwrap_or(body)
+    }
+
+    match response.status() {
+        StatusCode::OK => String::from("OK"),
+        _ => error(response),
+    }.parse().unwrap()
+}

Diff for: src/main.rs

@@ -0,0 +1,93 @@
+// Copyright 2019 Benedikt Putz
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#[macro_use]
+extern crate serde_derive;
+#[macro_use]
+extern crate exonum_derive;
+
+use exonum::{
+    crypto::{gen_keypair, hash, PublicKey, SecretKey},
+    messages::{to_hex_string},
+};
+use std::env;
+use rand::Rng;
+use std::time::{SystemTime};
+use std::thread;
+use std::time;
+use std::slice::Chunks;
+
+mod proto;
+mod schema;
+mod transactions;
+mod api;
+
+use transactions::{ TxTimestamp };
+use schema::Timestamp;
+
+fn main() {
+    let args: Vec<String> = env::args().collect();
+    if args.len() < 3 {
+        println!("Insufficient arguments. Please specify (1) number of tx per time unit, (2) total duration of test, (3) time unit (i.e. 1 sec).");
+        return;
+    }
+    //benchmark parameters
+    let count = args[1].parse::<usize>().unwrap();
+    let seconds = args[2].parse::<usize>().unwrap();
+    let wait = args[3].parse::<u64>().unwrap();
+
+    //create transactions
+    let mut txs : Vec<String> = vec![String::new(); count*seconds];
+    let mut rng = rand::thread_rng();
+    let keypair = gen_keypair();
+
+    for i in 1..(count*seconds) {
+        let x: u64 = rng.gen();
+        if i == 1 {println!("{}", &x.to_string())}
+        let tx = self::create_transaction(&keypair.0, &keypair.1, x.to_string());
+        //api::post(&tx);
+        txs[i] = tx;
+    }
+
+    //create chunks
+    let posts = txs.chunks(count);
+    let mut items : Vec<Vec<String>> = Vec::with_capacity(seconds);
+    for p in posts {
+        items.push(p.to_vec());
+    }
+
+    //post transactions
+    let start = SystemTime::now();
+    for p in items {
+        let pre = SystemTime::now();
+        api::post_async(p);
+        let passed = SystemTime::now().duration_since(pre).unwrap();
+        println!("{} for posting", passed.as_millis());
+        if passed.as_millis() < u128::from(wait) {
+            thread::sleep(time::Duration::from_millis(wait) - passed);
+        }
+    }
+
+    let end= SystemTime::now();
+    println!("Sent {} transactions in {}ms",
+             (count*seconds).to_string(),
+             end.duration_since(start).expect("").as_millis().to_string());
+}
+
+fn create_transaction(public: &PublicKey, secret: &SecretKey, payload: String) -> String {
+    let content = Timestamp::new(&hash(payload.as_bytes()), "metadata");
+    let tx = TxTimestamp::sign(&public, content, &secret);
+    let data = to_hex_string(&tx);
+    data
+}

Diff for: src/proto/mod.rs

@@ -0,0 +1,24 @@
+// Copyright 2019 The Exonum Team
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Module of the rust-protobuf generated files.
+
+#![allow(bare_trait_objects)]
+#![allow(renamed_and_removed_lints)]
+
+pub use self::timestamping::{Timestamp, TxTimestamp};
+
+include!(concat!(env!("OUT_DIR"), "/protobuf_mod.rs"));
+
+use exonum::proto::schema::*;

Diff for: src/proto/timestamping.proto

@@ -0,0 +1,27 @@
+// Copyright 2019 The Exonum Team
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+import "helpers.proto";
+import "google/protobuf/timestamp.proto";
+
+// Stores content's hash and some metadata about it.
+message Timestamp {
+  exonum.Hash content_hash = 1;
+  string metadata = 2;
+}
+
+/// Timestamping transaction.
+message TxTimestamp { Timestamp content = 1; }

Diff for: src/schema.rs

@@ -0,0 +1,23 @@
+use super::proto;
+use exonum::crypto::Hash;
+
+/// Stores content's hash and some metadata about it.
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, ProtobufConvert)]
+#[exonum(pb = "proto::Timestamp")]
+pub struct Timestamp {
+    /// Hash of the content.
+    pub content_hash: Hash,
+
+    /// Additional metadata.
+    pub metadata: String,
+}
+
+impl Timestamp {
+    /// Create new Timestamp.
+    pub fn new(&content_hash: &Hash, metadata: &str) -> Self {
+        Self {
+            content_hash,
+            metadata: metadata.to_owned(),
+        }
+    }
+}