Remove Capnp as a Required Dependency

.github/workflows/ci.yaml

@@ -19,41 +19,43 @@ jobs:
   test_dev:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: Swatinem/rust-cache@v2
-    - name: Install Dependencies
-      run: |
+      - uses: actions/checkout@v3
+      - uses: Swatinem/rust-cache@v2
+      - name: Build
+        run: cargo build
+      - name: Test
+        run: cargo test
+      - name: Check capnp schema should match the generated code
+        run: |
           export DEBIAN_FRONTEND=noninteractive
           sudo apt-get install -y capnproto libcapnp-dev
-    - name: Build
-      run: cargo build
-    - name: Test
-      run: cargo test
+          make capnp-build
+          git diff --exit-code
 
   test_release:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: Swatinem/rust-cache@v2
-    - name: Install Dependencies
-      run: |
+      - uses: actions/checkout@v3
+      - uses: Swatinem/rust-cache@v2
+      - name: Install Dependencies
+        run: |
           export DEBIAN_FRONTEND=noninteractive
           sudo apt-get install -y capnproto libcapnp-dev
-    - name: Build
-      run: cargo build --release
-    - name: Test
-      run: cargo test --release
+      - name: Build
+        run: cargo build --release
+      - name: Test
+        run: cargo test --release
 
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: Swatinem/rust-cache@v2
-    - name: Install Dependencies
-      run: |
+      - uses: actions/checkout@v3
+      - uses: Swatinem/rust-cache@v2
+      - name: Install Dependencies
+        run: |
           export DEBIAN_FRONTEND=noninteractive
           sudo apt-get install -y capnproto libcapnp-dev
-    - name: Rustfmt
-      run: cargo fmt --check
-    - name: Clippy
-      run: cargo clippy -- -Dwarnings
+      - name: Rustfmt
+        run: cargo fmt --check
+      - name: Clippy
+        run: cargo clippy -- -Dwarnings

README.md

@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/enviodev/hypersync-client-rust/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/enviodev/hypersync-client-rust/actions/workflows/ci.yaml)
 <a href="https://crates.io/crates/hypersync-client">
-    <img src="https://img.shields.io/crates/v/hypersync-client.svg?style=flat-square"
+<img src="https://img.shields.io/crates/v/hypersync-client.svg?style=flat-square"
     alt="Crates.io version" />
 </a>
 
@@ -12,7 +12,7 @@ Rust crate for [Envio's](https://envio.dev/) HyperSync client.
 
 ### Dependencies
 
-Need to install capnproto tool in order to build the library.
+In order to update the capnp schema on hypersync-net-types, you will need to install the `capnproto` tool.
 
 #### Linux
 
@@ -31,3 +31,14 @@ choco install capnproto
 ```bash
 brew install capnp
 ```
+
+## Building
+
+To build the schema, run the following command:
+
+```bash
+cd hypersync-net-types
+make capnp-build
+```
+
+This triggers the build script in hypersync-net-types, which will generate the `hypersync_net_types_capnp.rs` file in the `src` directory.

hypersync-format/src/types/fixed_size_data.rs

@@ -191,6 +191,8 @@ impl<const N: usize> fmt::Debug for FixedSizeData<N> {
 #[cfg(test)]
 mod tests {
     type FixedSizeData = super::FixedSizeData<4>;
+    type FSD4 = FixedSizeData;
+    use derive_more::FromStr;
     use hex_literal::hex;
     use serde_test::{assert_tokens, Token};
 

hypersync-net-types/Cargo.toml

@@ -11,6 +11,3 @@ serde = { version = "1", features = ["derive"] }
 arrayvec = { version = "0.7", features = ["serde"] }
 
 hypersync-format = { path = "../hypersync-format", version = "0.4" }
-
-[build-dependencies]
-capnpc = "0.19"

hypersync-net-types/README.md

@@ -0,0 +1,19 @@
+# hypersync-net-types
+
+This crate contains the capnp schema for the hypersync network protocol.
+
+## Building
+
+To build the schema, run the following command:
+
+```bash
+make capnp-build
+```
+
+This will generate the `hypersync_net_types_capnp.rs` file in the `src` directory.
+
+The build script will not run on every build, so you will need to run it manually if you make changes to the schema.
+
+The ci tests will fail if the schema is not up to date.
+
+This is to avoid the need to have a capnp compiler installed on the consumers of this crate.

hypersync-net-types/makefile

@@ -0,0 +1,6 @@
+.PHONY: capnp-build
+
+capnp-build:
+	cargo install capnpc
+	capnp compile -orust:src hypersync_net_types.capnp
+	rustfmt -- src/hypersync_net_types_capnp.rs