Add benchmarks (#182)

Author: ofek

.github/workflows/build.yml

@@ -15,6 +15,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
+  PYTHON_VERSION: '3.13'
   COINCURVE_IGNORE_SYSTEM_LIB: 'ON'
   COINCURVE_SECP256K1_STATIC: 'ON'
   COINCURVE_CROSS_HOST: ''
@@ -23,7 +24,7 @@ env:
     COINCURVE_SECP256K1_STATIC
     COINCURVE_CROSS_HOST
   CIBW_BEFORE_ALL_MACOS: ./.github/scripts/install-macos-build-deps.sh
-  CIBW_TEST_REQUIRES: pytest pytest-benchmark
+  CIBW_TEST_REQUIRES: pytest
   CIBW_TEST_COMMAND: >
     python -c
     "from coincurve import PrivateKey;
@@ -79,8 +80,11 @@ jobs:
         name: coverage-${{ matrix.os }}-${{ matrix.python-version }}
         path: coverage.xml
 
-    - name: Run benchmarks
-      run: hatch run hatch-test.py${{ matrix.python-version }}:bench
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Benchmark
+      run: uv run --python-preference system scripts/bench.py
 
   coverage:
     name: Upload coverage
@@ -172,7 +176,7 @@ jobs:
 
     - uses: actions/setup-python@v5
       with:
-        python-version: '3.12'
+        python-version: ${{ env.PYTHON_VERSION }}
 
     - name: Build wheels
       uses: pypa/[email protected]

.github/workflows/verify_conda_build.yml

@@ -15,6 +15,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
+  PYTHON_VERSION: '3.12'
   COINCURVE_UPSTREAM_REF: __no_upstream__
   COINCURVE_IGNORE_SYSTEM_LIB: 'OFF'
   COINCURVE_SECP256K1_STATIC: 'OFF'
@@ -25,7 +26,7 @@ env:
     COINCURVE_SECP256K1_STATIC
     COINCURVE_CROSS_HOST
   CIBW_BEFORE_ALL_MACOS: ./.github/scripts/install-macos-build-deps.sh
-  CIBW_TEST_REQUIRES: pytest pytest-benchmark
+  CIBW_TEST_REQUIRES: pytest
   CIBW_TEST_COMMAND: >
     python -c
     "from coincurve import PrivateKey;
@@ -44,8 +45,6 @@ jobs:
     defaults:
       run:
         shell: bash -el {0}
-    env:
-      PYTHON_VERSION: '3.12'
 
     steps:
     - uses: actions/checkout@v4
@@ -70,8 +69,11 @@ jobs:
     - name: Run tests
       run: LD_LIBRARY_PATH=$CONDA_PREFIX/lib hatch test
 
-    - name: Run benchmarks
-      run: hatch run hatch-test.py${{ env.PYTHON_VERSION }}:bench
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Benchmark
+      run: LD_LIBRARY_PATH=$CONDA_PREFIX/lib uv run --python-preference system scripts/bench.py
 
   linux-wheels-standard:
     name: Build Linux wheels
@@ -81,8 +83,6 @@ jobs:
     defaults:
       run:
         shell: bash -el {0}
-    env:
-      PYTHON_VERSION: '3.12'
 
     steps:
     - uses: actions/checkout@v4

.github/workflows/verify_shared_build.yml

@@ -15,14 +15,15 @@ concurrency:
   cancel-in-progress: true
 
 env:
+  PYTHON_VERSION: '3.12'
   COINCURVE_IGNORE_SYSTEM_LIB: '1'
   # Only 'SHARED' is recognized, any other string means 'not SHARED'
   COINCURVE_SECP256K1_BUILD: 'SHARED'
   CIBW_ENVIRONMENT_PASS_LINUX: >
     COINCURVE_IGNORE_SYSTEM_LIB
     COINCURVE_SECP256K1_BUILD
   CIBW_BEFORE_ALL_MACOS: ./.github/scripts/install-macos-build-deps.sh
-  CIBW_TEST_REQUIRES: pytest pytest-benchmark
+  CIBW_TEST_REQUIRES: pytest
   CIBW_TEST_COMMAND: >
     python -c
     "from coincurve import PrivateKey;
@@ -40,9 +41,6 @@ jobs:
     name: Test latest Python
     runs-on: ubuntu-latest
 
-    env:
-      PYTHON_VERSION: '3.12'
-
     steps:
     - uses: actions/checkout@v4
 
@@ -67,8 +65,11 @@ jobs:
     - name: Run tests
       run: hatch test
 
-    - name: Run benchmarks
-      run: hatch run hatch-test.py${{ env.PYTHON_VERSION }}:bench
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Benchmark
+      run: uv run --python-preference system scripts/bench.py
 
   linux-wheels-standard:
     name: Build Linux wheels
@@ -119,7 +120,7 @@ jobs:
 
     - uses: actions/setup-python@v5
       with:
-        python-version: '3.12'
+        python-version: ${{ env.PYTHON_VERSION }}
 
     - name: Build wheels
       uses: pypa/[email protected]

docs/benchmarks.md

@@ -0,0 +1,23 @@
+# Benchmarks
+
+-----
+
+## Setup
+
+Download [Hatch](https://hatch.pypa.io/latest/install/) or [UV](https://docs.astral.sh/uv/getting-started/installation/) in order to run the benchmarks as follows:
+
+```
+[hatch|uv] run scripts/bench.py
+```
+
+## Results
+
+| Library | Key generation | Signing | Verification | Key export | Key import |
+| --- | --- | --- | --- | --- | --- |
+| coincurve v20.0.0 | 33.4 | 52.8 | 58.4 | 12.6 | 39.4 |
+| [fastecdsa](https://github.com/AntonKueltz/fastecdsa) v3.0.1 | 1319.6 | 1449.5 | 1160.4 | 1402.9 | 15.5 |
+
+!!! note
+    - the timings are in microseconds
+    - signing and verification use a 16 KiB message
+    - the Python version used for the benchmarks is 3.13.x

hatch.toml

@@ -8,15 +8,6 @@ dependencies = ["ruff==0.9.9"]
 
 [envs.hatch-test]
 dev-mode = false
-extra-dependencies = [
-  "pytest-benchmark",
-]
-[envs.hatch-test.scripts]
-run = "pytest{env:HATCH_TEST_ARGS:} --benchmark-skip {args}"
-run-cov = "coverage run -m pytest{env:HATCH_TEST_ARGS:} --benchmark-skip {args}"
-cov-combine = "coverage combine"
-cov-report = "coverage report"
-bench = "pytest{env:HATCH_TEST_ARGS:} --benchmark-only --benchmark-sort=name --benchmark-cprofile=tottime {args}"
 
 [envs.types]
 dependencies = [

mkdocs.yml

@@ -48,6 +48,7 @@ nav:
   - About: index.md
   - Install: install.md
   - API Reference: api.md
+  - Benchmarks: benchmarks.md
   - Meta:
     - Users: users.md
     - History: history.md

pyproject.toml

@@ -13,14 +13,16 @@ name = "coincurve"
 authors = [
     { name = "Ofek Lev", email = "[email protected]" },
 ]
-description = "Cross-platform Python bindings for libsecp256k1"
+description = "Safest and fastest Python library for secp256k1 elliptic curve operations"
 keywords = [
     "bitcoin",
     "crypto",
     "cryptocurrency",
+    "ecdh",
     "ecdsa",
     "elliptic curves",
     "ethereum",
+    "libsecp256k1",
     "secp256k1",
     "schnorr",
 ]

scripts/README.md

@@ -0,0 +1,5 @@
+# Scripts
+
+-----
+
+This directory contains scripts that are used to develop the project.