Merge branch 'main' into dnut/fix/shred-network/keepup

.github/workflows/check.yml

@@ -176,6 +176,26 @@ jobs:
       - name: run
         run: ./zig-out/bin/fuzz allocators 19 10000
 
+  ledger_fuzz:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    runs-on: ${{matrix.os}}
+    timeout-minutes: 60
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: setup zig
+        uses: mlugg/setup-zig@v1
+        with:
+          version: 0.13.0
+      - name: build
+        run: zig build -Doptimize=ReleaseSafe -Dno-run fuzz
+      - name: run
+        run: ./zig-out/bin/fuzz ledger 19 10000
+
   # benchmarks:
   #   if: ${{ github.ref != 'refs/heads/main' }}
   #   strategy:

docs/CONTRIBUTING.md

@@ -31,6 +31,23 @@ There are two main guidelines to keep in mind when naming interfaces and interfa
   - As an example, a generic implementation of `std.Random` which is a pseudo-random number generator should be named `prng` (ie this is relevant when making appropriate use of `std.Random.DefaultPrng`).
   - As another example, an instance of `std.heap.GeneralPurposeAllocator(config)` should be called `gpa_state`, `std.heap.ArenaAllocator` `arena_state`, and so on.
 
+#### Method Parameters
+The first parameter of a method should be named `self`. The type should be the name of the struct. 
+For example:
+
+```zig
+const MyStruct = struct {
+    state: u8,
+
+    fn write(self: *MyStruct, new_state: u8) void {
+        self.state = new_state;
+    }
+};
+```
+
+If the type name is not available (for example in anonymous structs), define `const Self = @This()` 
+and use that as the type.
+
 ### Files as Structs
 We prohibit usage of files as instantiable struct types in the codebase.
 

scripts/benchmark_server.py

@@ -1,3 +1,7 @@
+# doc:
+# this script scrapes the results/metrics directory for json files
+# and generates a graph for each metric in the json file
+
 import os
 import json
 import plotly.express as px

scripts/collect_benchmarks.sh

@@ -1,7 +1,13 @@
 #!/usr/bin/env bash
 
-# crontab -e
-# 0 5 * * * bash /home/ubuntu/benchmarks/sig/scripts/collect_benchmarks.sh
+# doc:
+# this script will pull the latest change of the local repo
+# and run the benchmark to collect metrics which are
+# saved as results/output.json file. they are then
+# moved to results/metrics/output-{commit}-{timestamp}.json
+#
+# these output files are then compared/visualized using the
+# scripts/benchmark_server.py script
 
 # now in the scripts/ dir
 cd "$(dirname "$0")"
@@ -22,7 +28,8 @@ if ls $result_file 1> /dev/null 2>&1; then
   echo "Results for commit $git_commit already exist. Skipping benchmark."
 else
   # Run the benchmark only if the result file doesn't exist
-  zig build -Doptimize=ReleaseSafe benchmark -- --metrics all
+  zig build -Doptimize=ReleaseSafe -Dno-run benchmark
+  ./zig-out/bin/benchmark --metrics -e -f all
 
   mv results/output.json "${result_dir}/output-${git_commit}-${timestamp}.json"
   echo "Benchmark results saved to ${result_dir}/output-${git_commit}-${timestamp}.json"

scripts/cron_jobs/setup_benchmarks.sh

@@ -0,0 +1,13 @@
+# doc:
+# this script will modify your server's crontab
+# to run the collect_benchmarks.sh script at 6am everyday
+
+SCRIPT_DIR=$(dirname "$(readlink -f "$0")")/..
+
+# 6am everyday
+(crontab -l; echo "\
+0 6 * * * . $HOME/.bashrc; (bash $SCRIPT_DIR/collect_benchmarks.sh) 2>&1 | logger -t sig_bench \
+") | crontab
+
+echo "Cron job added. Current crontab:"
+crontab -l