Merge branch 'feature/performance' into develop

Author: axllent

.github/workflows/release-build.yml

@@ -4,8 +4,22 @@ on:
 
 name: Build & release
 jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Run tests
+        run: go test ./... -v
+
   releases-matrix:
     name: Build
+    needs: test
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -19,19 +33,19 @@ jobs:
           - goarch: arm
             goos: windows
     steps:
-    - uses: actions/checkout@v6
+      - uses: actions/checkout@v6
 
-    # build the binaries
-    - uses: wangyoucao577/go-release-action@v1.55
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        goos: ${{ matrix.goos }}
-        goarch: ${{ matrix.goarch }}
-        binary_name: "wireguard-vanity-keygen"
-        pre_command: export CGO_ENABLED=0
-        asset_name: wireguard-vanity-keygen-${{ matrix.goos }}-${{ matrix.goarch }}
-        extra_files: LICENSE README.md
-        md5sum: false
-        overwrite: true
-        retry: 5
-        ldflags: -w -X "main.appVersion=${{ github.ref_name }}"
+      # build the binaries
+      - uses: wangyoucao577/go-release-action@v1.55
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          goos: ${{ matrix.goos }}
+          goarch: ${{ matrix.goarch }}
+          binary_name: "wireguard-vanity-keygen"
+          pre_command: export CGO_ENABLED=0
+          asset_name: wireguard-vanity-keygen-${{ matrix.goos }}-${{ matrix.goarch }}
+          extra_files: LICENSE README.md
+          md5sum: false
+          overwrite: true
+          retry: 5
+          ldflags: -w -X "main.appVersion=${{ github.ref_name }}"

.github/workflows/tests.yml

@@ -0,0 +1,21 @@
+name: Tests
+
+on:
+  push:
+    branches: [develop, "feature/**"]
+  pull_request:
+    branches: [develop, "feature/**"]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Run tests
+        run: go test ./... -v

go.mod

@@ -1,10 +1,14 @@
 module github.com/axllent/wireguard-vanity-keygen
 
-go 1.24.0
+go 1.25.0
 
 require (
+	github.com/axllent/ghru/v2 v2.2.0
 	github.com/oasisprotocol/curve25519-voi v0.0.0-20251114093237-2ab5a27a1729
 	github.com/spf13/pflag v1.0.10
 )
 
-require golang.org/x/sys v0.40.0 // indirect
+require (
+	golang.org/x/mod v0.34.0 // indirect
+	golang.org/x/sys v0.42.0 // indirect
+)

go.sum

@@ -1,6 +1,10 @@
+github.com/axllent/ghru/v2 v2.2.0 h1:DzWyWPJL+3qSwvR2S4tTetOhVgP9XjJixng1Aax8GGo=
+github.com/axllent/ghru/v2 v2.2.0/go.mod h1:tyH60pqmLCDHd3UMOZyiedrYMFVLwBQqPQ5y8WLvDzA=
 github.com/oasisprotocol/curve25519-voi v0.0.0-20251114093237-2ab5a27a1729 h1:yfQ2sO9WJXUAIUR+g7NUkxJSKCAFJcR5sUDu+ZmjTZI=
 github.com/oasisprotocol/curve25519-voi v0.0.0-20251114093237-2ab5a27a1729/go.mod h1:hVoHR2EVESiICEMbg137etN/Lx+lSrHPTD39Z/uE+2s=
 github.com/spf13/pflag v1.0.10 h1:4EBh2KAYBwaONj6b2Ye1GiHfwjqyROoF4RwYO+vPwFk=
 github.com/spf13/pflag v1.0.10/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
-golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ=
-golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
+golang.org/x/mod v0.34.0 h1:xIHgNUUnW6sYkcM5Jleh05DvLOtwc6RitGHbDk4akRI=
+golang.org/x/mod v0.34.0/go.mod h1:ykgH52iCZe79kzLLMhyCUzhMci+nQj+0XkbXpNYtVjY=
+golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
+golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=

keygen/crypto.go

@@ -38,9 +38,12 @@ func (k *PrivateKey) Public() Key {
 	var pub curve25519voi.MontgomeryPoint
 	base := *curve25519voi.X25519_BASEPOINT
 	s, err := scalar.NewFromBytesModOrder(k[:])
-	if err != nil || s == nil {
+	if err != nil {
 		panic("invalid private key for scalar.NewFromBytesModOrder: " + err.Error())
 	}
+	if s == nil {
+		panic("invalid private key for scalar.NewFromBytesModOrder: nil scalar")
+	}
 	pub.Mul(&base, s)
 	return Key(pub)
 }

keygen/crypto_benchmark_test.go

@@ -1,6 +1,10 @@
 package keygen
 
 import (
+	"encoding/base64"
+	"math"
+	"runtime"
+	"sync"
 	"testing"
 )
 
@@ -13,3 +17,44 @@ func BenchmarkKeygenGenerationSpeed(b *testing.B) {
 		}
 	}
 }
+
+// BenchmarkCrunchThroughput benchmarks concurrent crunch() throughput including
+// key generation, base64 encoding, case conversion, and prefix matching.
+// This reflects the worker pool design: fixed goroutines loop internally.
+func BenchmarkCrunchThroughput(b *testing.B) {
+	opts := Options{Cores: runtime.NumCPU(), CaseSensitive: false}
+	c := New(opts, 0)
+	// Use a prefix that will never match so the counter never saturates
+	c.WordMap["zzzz"] = &AtomicCounter{Value: math.MaxInt64}
+	b.ResetTimer()
+	b.RunParallel(func(pb *testing.PB) {
+		buf := make([]byte, base64.StdEncoding.EncodedLen(KeySize)) // one per goroutine
+		for pb.Next() {
+			c.crunch(func(Pair) {}, buf)
+		}
+	})
+}
+
+// BenchmarkGoroutinePerAttempt simulates the previous design where a new goroutine
+// was spawned for every single key attempt. Compare against BenchmarkCrunchThroughput
+// to quantify the goroutine lifecycle overhead that the worker pool eliminates.
+func BenchmarkGoroutinePerAttempt(b *testing.B) {
+	cores := runtime.NumCPU()
+	thread := make(chan int, cores)
+	var wg sync.WaitGroup
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		thread <- 1
+		wg.Add(1)
+		go func() {
+			defer wg.Done()
+			k, err := newPrivateKey()
+			if err != nil {
+				panic(err)
+			}
+			_ = k.Public().String()
+			<-thread
+		}()
+	}
+	wg.Wait()
+}