Added MPC-BAM implementation of https://eprint.iacr.org/archive/2024/1950/20250601:081848. Also improved error handling, expanded test suite, fixed spelling

Author: nadav-fireblocks

.gitlab-ci.yml

@@ -1,7 +1,7 @@
 default:
-  image: docker.io/ubuntu:20.04
+  image: registry.gitlab.com/fireblocks/external-docker-images/ubuntu:22.04
   tags:
-    - dev-common-runner
+    - kub-builders
   before_script:
     - apt update
     - DEBIAN_FRONTEND=noninteractive apt install -y build-essential cmake pkg-config uuid-dev libssl-dev libsecp256k1-dev

CMakeLists.txt

@@ -1,6 +1,8 @@
 cmake_minimum_required(VERSION 3.13)
 project(mpc-lib LANGUAGES C CXX)
 
+option(MPC_LIB_BUILD_BENCHMARKS "Build benchmarking targets (requires Google Benchmark)" OFF)
+
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
@@ -16,3 +18,7 @@ if(${CMAKE_SOURCE_DIR} STREQUAL ${PROJECT_SOURCE_DIR} AND NOT MPC_LIB_SKIP_TESTS
     enable_testing()
     add_subdirectory(test)
 endif()
+
+if(MPC_LIB_BUILD_BENCHMARKS)
+    add_subdirectory(benchmarks)
+endif()

README.md

@@ -32,6 +32,31 @@ To execute the test suite, run the command from the same build folder:
 make test
 ```
 
+### Benchmarks and Profiling
+
+Build the BAM signing benchmark by enabling the benchmark option during configuration:
+```sh
+cmake -S . -B build -DMPC_LIB_BUILD_BENCHMARKS=ON
+cmake --build build --target bam_sign_benchmark
+```
+
+Run the benchmark executable to measure `bam_key_sign` throughput (use `--benchmark_filter` to focus on a specific algorithm):
+```sh
+./build/benchmarks/bam_sign_benchmark --benchmark_filter=stark
+```
+
+To profile the benchmark and visualize the results:
+1. Record samples with Linux `perf` (install `hotspot` or another viewer once):
+   ```sh
+   perf record -F 999 -g ./build/benchmarks/bam_sign_benchmark --benchmark_filter=secp256k1_default
+   ```
+2. Open the generated `perf.data` in a graphical viewer, e.g.:
+   ```sh
+   hotspot perf.data        # Qt GUI with flame graphs
+   # or convert to Speedscope
+   perf script | speedscope
+   ```
+
 ## Usage
 
 A few examples for running a full signing process can be found in the [tests section](https://github.com/fireblocks/mpc-lib/tree/main/test/cosigner)

benchmarks/CMakeLists.txt

@@ -0,0 +1,3 @@
+add_executable(bam_sign_benchmark bam_sign_benchmark.cpp)
+target_link_libraries(bam_sign_benchmark cosigner uuid)
+target_include_directories(bam_sign_benchmark PRIVATE ${CMAKE_SOURCE_DIR}/include)

benchmarks/bam_sign_benchmark.cpp

@@ -0,0 +1,15 @@
+FROM debian:bookworm-slim
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update && apt install -y \
+    build-essential \
+    uuid-dev \
+    libssl-dev \
+    libsecp256k1-dev \
+    cmake \
+    && rm -rf /var/lib/apt/lists/* \
+    && rm -rf /var/cache/apt/archives/*
+
+COPY . /usr/src/mpc-lib/
+WORKDIR /usr/src/mpc-lib

docker/Dockerfile.bookworm

@@ -1,4 +1,4 @@
-FROM ubuntu:24.04
+FROM ubuntu:focal
 
 ENV DEBIAN_FRONTEND=noninteractive
 

docker/Dockerfile.24.04 docker/Dockerfile.focaldocker/Dockerfile.24.04 renamed to docker/Dockerfile.focal

@@ -0,0 +1,15 @@
+FROM ubuntu:jammy
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update && apt install -y \
+    build-essential \
+    uuid-dev \
+    libssl-dev \
+    libsecp256k1-dev \
+    cmake \
+    && rm -rf /var/lib/apt/lists/* \
+    && rm -rf /var/cache/apt/archives/*
+
+COPY . /usr/src/mpc-lib/
+WORKDIR /usr/src/mpc-lib/

docker/Dockerfile.jammy

@@ -15,7 +15,7 @@ fi
 
 input_base_name=$(basename ${Dockerfile})
 prefix=$(echo ${input_base_name}| awk '{split($0,a,"."); print a[1]}')
-tag=$(echo ${input_base_name} | sed "s/^${prefix}\.//" )
+tag=$(echo ${input_base_name}| awk '{split($0,a,"."); print a[2]}')
 
 if [ x${prefix} != "xDockerfile" ]; then
     echo "Must Select a valid Dockerfile"
@@ -33,11 +33,10 @@ CURRENT_DIR=`pwd`
 
 cd ${SCRIPT_DIR}/..
 
-docker build --network=host -f ${CURRENT_DIR}/${Dockerfile} . -t $IMAGE_NAME
+docker build -f ${CURRENT_DIR}/${Dockerfile} . -t $IMAGE_NAME
 
 docker run \
     --rm \
-    --net=host \
     ${IMAGE_NAME} bash -c "mkdir build_${IMAGE_NAME};cd build_${IMAGE_NAME};cmake ..;make -j && make -j test"
 
 cd -

docker/run_tests.sh

@@ -1,5 +1,6 @@
 #pragma once
 
+#include "cosigner/platform_service.h"
 #include "cosigner_export.h"
 
 #include "crypto/ed25519_algebra/ed25519_algebra.h"
@@ -22,22 +23,18 @@ namespace cosigner
 {
 
 class cmp_key_persistency;
-class platform_service;
+class cosigner_verifier_chain;
+struct eddsa_signature_data;
+struct signing_data;
 
 static constexpr size_t SHA256_HASH_SIZE = 32;
 typedef std::array<uint8_t, SHA256_HASH_SIZE> eddsa_commitment;
 static_assert(sizeof(eddsa_commitment) == SHA256_HASH_SIZE);
 
-struct Rs_and_commitments
-{
-    std::vector<elliptic_curve_point> Rs;
-    eddsa_commitment R_commitment;
-};
-
 class COSIGNER_EXPORT asymmetric_eddsa_cosigner
 {
 public:
-    asymmetric_eddsa_cosigner(platform_service& cosigner_service, const cmp_key_persistency& key_persistency);
+    asymmetric_eddsa_cosigner(platform_service& service, const cmp_key_persistency& key_persistency);
     virtual ~asymmetric_eddsa_cosigner() {}
 
 protected:
@@ -49,7 +46,7 @@ class COSIGNER_EXPORT asymmetric_eddsa_cosigner
 
     platform_service& _service;
     const cmp_key_persistency& _key_persistency;
-    static const std::unique_ptr<elliptic_curve256_algebra_ctx_t, void (*)(elliptic_curve256_algebra_ctx_t*)> _ctx;
+    std::unique_ptr<elliptic_curve256_algebra_ctx_t, void (*)(elliptic_curve256_algebra_ctx_t*)> _ctx;
 };
 
 }