Add BLS benchmarks to CI (#187)

* Make imports explicit
* Help prints when no subcommand is specified
* Added benchmarks to CI
* Updated logbook

Author: bwbush

.github/workflows/crypto-benchmarks-rs.yaml

@@ -0,0 +1,41 @@
+name: "crypto-benchmarks-rs"
+
+on:
+  pull_request:
+    paths:
+      - "crypto-benchmarks.rs/**"
+  push:
+    branches:
+      - main
+    paths:
+      - "crypto-benchmarks.rs/**"
+
+jobs:
+
+  crypto-benchmarks-rs-test:
+    name: "Test"
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Test Rust packages
+        working-directory: crypto-benchmarks.rs
+        run: |
+          cargo test
+          if [ $? -ne 0 ]; then
+            echo "Cargo test failed"
+            exit 1
+          fi
+
+  crypto-benchmarks-rs-benchmark:
+    name: "Benchmark"
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Test Rust packages
+        working-directory: crypto-benchmarks.rs
+        run: |
+          if ! cargo bench -- --noplot --sample-size 20 --quiet
+          then
+            echo "Cargo benchmarks failed"
+            exit 1
+          fi

Logbook.md

@@ -1,5 +1,14 @@
 # Leios logbook
 
+## 2025-02-12
+
+### Added BLS crypto to CI
+
+The CI job [crypto-benchmarks-rs](.github/workflows/crypto-benchmarks-rs.yaml) does the following:
+
+- Runs the tests for the BLS reference implementation
+- Runs the BLS vote and certificate benchmarks
+
 ## 2025-02-11
 
 ### Reference implementation and benchmarking BLS certificates

crypto-benchmarks.rs/Cargo.toml

@@ -3,6 +3,14 @@ name = "leios_crypto_benchmarks"
 version = "0.1.0"
 edition = "2021"
 
+[lib]
+bench = false
+
+[[bin]]
+name = "leios_crypto_benchmarks"
+path = "src/main.rs"
+bench = false
+
 [dependencies]
 bitvec = "1.0.1"
 blst = "0.3.13"

crypto-benchmarks.rs/benches/serialization_bench.rs

@@ -1,12 +1,14 @@
 use criterion::{criterion_group, criterion_main, Criterion};
 use quickcheck::{Arbitrary, Gen};
 
-use leios_crypto_benchmarks::cert::*;
+use leios_crypto_benchmarks::cert::{gen_cert, Cert};
 use leios_crypto_benchmarks::key::Reg;
-use leios_crypto_benchmarks::primitive::*;
-use leios_crypto_benchmarks::realism::*;
-use leios_crypto_benchmarks::registry::*;
-use leios_crypto_benchmarks::vote::*;
+use leios_crypto_benchmarks::primitive::arbitrary_stake_distribution;
+use leios_crypto_benchmarks::realism::{
+    realistic_pool_count, realistic_total_stake, realistic_voters,
+};
+use leios_crypto_benchmarks::registry::{arbitrary_pools, Registry};
+use leios_crypto_benchmarks::vote::{arbitrary_votes, Vote};
 
 fn benchmark_serialize_reg(c: &mut Criterion) {
     let g = &mut Gen::new(10);

crypto-benchmarks.rs/benches/sortition_bench.rs

@@ -4,7 +4,7 @@ use num_rational::Ratio;
 use num_traits::{FromPrimitive, One};
 use quickcheck::{Arbitrary, Gen};
 
-use leios_crypto_benchmarks::sortition::*;
+use leios_crypto_benchmarks::sortition::{leader_check, ln_1_minus, voter_check};
 
 fn arbitrary_f(g: &mut Gen) -> Ratio<BigInt> {
     Ratio::new(

crypto-benchmarks.rs/benches/vote_bench.rs

@@ -7,8 +7,12 @@ use leios_crypto_benchmarks::key::{check_pop, key_gen, SecKey};
 use leios_crypto_benchmarks::primitive::{
     arbitrary_poolkeyhash, arbitrary_stake_distribution, EbHash, Eid,
 };
-use leios_crypto_benchmarks::realism::*;
-use leios_crypto_benchmarks::vote::*;
+use leios_crypto_benchmarks::realism::{
+    realistic_pool_count, realistic_total_stake, realistic_voters,
+};
+use leios_crypto_benchmarks::vote::{
+    arbitrary_votes, gen_vote_nonpersistent, gen_vote_persistent, verify_vote,
+};
 
 fn benchmark_check_pop(c: &mut Criterion) {
     c.bench_function("key::check_pop", |b| {

crypto-benchmarks.rs/benches/vrf_bench.rs

@@ -1,6 +1,6 @@
 use criterion::{criterion_group, criterion_main, Criterion};
 
-use leios_crypto_benchmarks::vrf::*;
+use leios_crypto_benchmarks::vrf::{sk_random, sk_to_pk_point, vrf_prove, vrf_verify};
 
 fn benchmark_prove(c: &mut Criterion) {
     let sk = sk_random();

crypto-benchmarks.rs/src/cert.rs

@@ -6,9 +6,9 @@ use std::collections::{BTreeMap, HashSet};
 use crate::bls_vote;
 use crate::key::Sig;
 use crate::primitive::{Coin, CoinFraction, EbHash, Eid, PoolKeyhash};
-use crate::registry::*;
+use crate::registry::{PersistentId, Registry};
 use crate::sortition::voter_check;
-use crate::vote::*;
+use crate::vote::{do_voting, Vote};
 
 #[derive(PartialEq, Eq, Debug, Clone, Serialize, Deserialize)]
 pub struct Cert {

crypto-benchmarks.rs/src/key.rs

@@ -9,7 +9,7 @@ use std::hash::{Hash, Hasher};
 use crate::bls_util;
 use crate::bls_vote;
 use crate::primitive::{arbitrary_poolkeyhash, KesSig, PoolKeyhash};
-use crate::util::*;
+use crate::util::{arbitrary_fixed_bytes, deserialize_fixed_bytes, serialize_fixed_bytes};
 
 #[derive(Clone, Debug)]
 pub struct SecKey(pub(crate) SecretKey);

crypto-benchmarks.rs/src/main.rs

@@ -9,16 +9,23 @@ use std::io::{Error, ErrorKind};
 use std::path::PathBuf;
 use std::process;
 
-use leios_crypto_benchmarks::cert::*;
+use leios_crypto_benchmarks::cert::{gen_cert, verify_cert, weigh_cert, Cert};
 use leios_crypto_benchmarks::fait_accompli::FaSortition;
-use leios_crypto_benchmarks::key::*;
-use leios_crypto_benchmarks::primitive::*;
-use leios_crypto_benchmarks::registry::*;
-use leios_crypto_benchmarks::sortition::*;
-use leios_crypto_benchmarks::vote::*;
+use leios_crypto_benchmarks::key::{
+    check_pop, key_gen, sign_message, verify_message, PoP, PubKey, Reg, SecKey, Sig,
+};
+use leios_crypto_benchmarks::primitive::{
+    arbitrary_poolkeyhash, arbitrary_stake_distribution, Coin, EbHash, Eid, KesSig,
+    PoolKeyhash,
+};
+use leios_crypto_benchmarks::registry::{arbitrary_pools, PoolInfo, Registry};
+use leios_crypto_benchmarks::sortition::voter_check;
+use leios_crypto_benchmarks::vote::{
+    do_voting, gen_sigma_eid, gen_vote_nonpersistent, verify_vote, Vote,
+};
 
 #[derive(Parser)]
-#[command(version, about, long_about = None)]
+#[command(version, about, long_about = None, arg_required_else_help=true)]
 struct Cli {
     name: Option<String>,
     #[arg(long)]