Merge pull request #6 from deryacog/new_main

All merge tb scripts and latest version of loopix

.gitignore

@@ -5,3 +5,22 @@ femme
 dist/
 simul/
 venv
+
+*/__pycache__/
+
+mergetb/mergetb_data/
+mergetb/metrics/
+metrics/plots/
+simul_data/
+
+*/plots/*
+mergetb/*/plots/*
+mergetb/*/raw_data/*
+!mergetb/*/raw_data/.gitkeep
+mergetb/rename/*
+!mergetb/rename/.gitkeep
+
+average_data.json
+raw_metrics.json
+
+logs.txt

Dockerfile.fledger

@@ -4,10 +4,12 @@ RUN apt update && apt install -y patchelf ca-certificates
 
 COPY target-common/release/fledger fledger
 RUN patchelf --set-interpreter /usr/lib64/ld-linux-x86-64.so.2 fledger
-
+EXPOSE 0-65535/udp
 FROM debian:bookworm-slim
 WORKDIR /fledger
 COPY --from=0 fledger /fledger/fledger
 COPY --from=0 /etc/ssl /etc/ssl
 
+RUN mkdir /fledger/data
+
 ENTRYPOINT ["/fledger/fledger", "-vv"]

Makefile

@@ -105,4 +105,4 @@ clean:
 	for c in ${CARGOS}; do \
 		echo "Cleaning $$c"; \
 		( cd $$c && cargo clean ) ; \
-	done
+	done

README.md

@@ -1,5 +1,42 @@
 # Fledger - the fast, fun, easy ledger
 
+## Student Project 24
+- The loopix module implemented for this project and be found in ./flmodules/src/loopix, see readme on [here](https://github.com/fledg-re/flmodules/src/loopix/README.md).
+- The scripts that were used to run experiments as well as data processing can be found in ./mergetb: [here](https://github.com/fledg-re/mergetb/README.md).
+- The latex for the report can be found and compiled in [here](https://github.com/fledg-re/mergetb/blob/main/report/).
+
+### Runnning the code
+Rust  binary can be built with the following command:
+```bash
+cd cli/fledger && cargo build -r
+```
+
+Note that the main is configured to run a simulation with multiples node and will not work as a single node. A single node can be run with the following command:
+```bash
+  ./target-common/release/fledger --config <directory to save configs> \
+    --name <name of the node> \
+    --n-clients <number of loopix clients> \
+    --duplicates <number of duplicates> \
+    --path-len <path length> \
+    --retry <number of retries> \
+    --start_loopix_time <start time> \
+    --save_new_metrics_file <save new metrics file> \
+    --token <token> 
+```
+where token is api key for ipinfo.io.
+
+To run multiples nodes, you can use the the script:
+```bash
+./start_simul.sh
+```
+
+### Changes to Fledger
+Aside from the loopix module, and the cli/src/main.rs minor changes have been made to the code.
+
+Notably there are some changes int the web proxy module and docker files.
+
+
+## Fledger
 Fledger's main goal is to create a web3 experience in the browser without the
 need for proxies.
 Once the code starts in your browser, it will connect to other browsers,

cli/fledger/Cargo.toml

@@ -27,4 +27,5 @@ webrtc-util = "0.9"
 x25519-dalek = {version = "2", features = ["serde"]}
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
-serde_yaml = "0.8"
+serde_yaml = "0.8"
+prometheus = "0.13.4"