Sync with upstream floor-licker/polyfill-rs (32 commits)

.github/workflows/ci.yml

@@ -35,8 +35,8 @@ jobs:
     - name: Run clippy
       run: cargo clippy --lib --bins --tests --benches --all-features -- -D warnings && cargo clippy --example benchmark_with_keepalive --example demo --example final_benchmark --example http2_tuning_benchmark --example performance_benchmark --example quick_demo --example snipe -- -D warnings
 
-    - name: Run tests
-      run: cargo test --all-features
+    - name: Run tests (excluding no-alloc hot paths)
+      run: cargo test --all-features -- --skip no_alloc_
 
     - name: Build examples
       run: |
@@ -64,4 +64,24 @@ jobs:
       run: cargo install cargo-audit
 
     - name: Run security audit
-      run: cargo audit
+      run: cargo audit
+
+  no_alloc:
+    name: No-alloc hot paths
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: dtolnay/rust-toolchain@stable
+
+    - name: Cache dependencies
+      uses: actions/cache@v4
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+          target
+        key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+    - name: Run no-alloc hot path tests
+      run: cargo test --all-features --test no_alloc_hot_paths

Cargo.toml

@@ -11,7 +11,6 @@ keywords = ["polymarket", "trading", "prediction-market", "kalshi", "clob", "cry
 categories = ["api-bindings", "network-programming", "finance", "prediction-markets", "polymarket", "kalshi", "clob"]
 documentation = "https://docs.rs/polyfill-rs"
 homepage = "https://github.com/floor-licker/polyfill-rs"
-license = "MIT OR Apache-2.0"
 [dependencies]
 # Pin base64ct to avoid Edition 2024 requirement
 base64ct = "=1.6.0"
@@ -71,7 +70,7 @@ tokio-test = "0.4"
 mockito = "1.0"
 proptest = "1.0"
 env_logger = "0.10"
-# polymarket-rs-client = { path = "external/polymarket-rs-client" } # Uncomment to run side-by-side benchmark
+polymarket-rs-client = "0.1.1"
 
 [features]
 default = ["stream"]
@@ -93,6 +92,10 @@ harness = false
 name = "network_benchmarks"
 harness = false
 
+[[bench]]
+name = "ws_hot_path"
+harness = false
+
 [profile.release]
 # Optimizations for HFT performance
 opt-level = 3
@@ -107,4 +110,4 @@ opt-level = 1
 [profile.test]
 # Optimizations for test performance
 opt-level = 2
-debug = true 
+debug = true 

README.md

@@ -6,6 +6,14 @@
 
 A high-performance drop-in replacement for `polymarket-rs-client` with latency-optimized data structures and zero-allocation hot paths. A 100% API-compatible drop-in replacement for `polymarket-rs-client` with identical method signatures. 
 
+At the time that this project was started, `polymarket-rs-client` was a Polymarket Rust Client with a few GitHub stars, but which seemed to be unmaintained. I took on the task of creating a Rust client which could beat the benchmarks quoted in the README.md of that project, with the added constraint of also maintaining zero alloc hot paths.
+
+I also want to take a moment to clarify what zero-alloc means because I've now recieved double digit messages about this on twitter/x and telegram. In general, zero alloc means either zero alloc in hot paths (which can be a bit more arbitrary) or atlernatively it can mean zero alloc after init/warm-up, which is the objective of this repository. Succinctly that means that **the per-message handling loop never touches the heap**. 
+
+Notably order book paths that introduce new allocations by design:
+- First time seeing a token/book (HashMap insert + key clone): `src/book.rs:~788`
+- New price levels (BTreeMap node growth): `src/book.rs:~409`
+
 
 ## Quick Start
 
@@ -56,6 +64,9 @@ End-to-end performance with Polymarket's API, including network latency, JSON pa
 | **Order Book Updates (1000 ops)** | 159.6 µs ± 32 µs | 6,260 updates/sec, zero-allocation |
 | **Spread/Mid Calculations** | 70 ns ± 77 ns | 14.3M ops/sec, optimized BTreeMap |
 | **JSON Parsing (480KB)** | ~2.3 ms | SIMD-accelerated parsing (1.77x faster than serde_json) |
+| **WS `book` hot path (decode + apply)** | ~0.28 µs / 2.01 µs / 7.70 µs | 1 / 16 / 64 levels-per-side, ~3.7–4.0x faster vs serde decode+apply (see `benches/ws_hot_path.rs`) |
+
+Run the WS hot-path benchmark locally with `cargo bench --bench ws_hot_path`.
 
 **Key Performance Optimizations:**