feat: add eth2api (#113)

* Initial `version` module

- Pending `GitCommit` implementation

* Port version tests

* Add `FromStr`

- Move parse method to `impl` block

* Port internal version tests

* Add support for build-time data

- Include Git commit
- Include timestamp
- Include env version if any

* Apply Clippy suggestions

* Apply Copilot suggestion

* Initial `eth2wrap` module

- Includes `version`

* Fix Grandine version

* Add tests

* Add OpenAPI spec

- v4.0

* Generate relevant code from spec

- Add `eth2api` crate

* Ignore generated files

- Not relevant to track

* Add integration tests

- Use `testcontainers`

* Update lockfile

* Avoid unnecessary recompilation

* Remove `eth2wrap`

- Should be part of a different branch

* Ignore clippy/rustfmt in generated code

* Update prerequisites

- Add `oas3-gen`

* Delete `core/version`

- I can't rebase

* Update CI dependencies

* Apply copilot suggestions

* Add `oas3-gen` to Nix flake

* Added custom error message

- Same style as missing `protoc`

* Check for success on command

* Use `Error::other`

Author: emlautarom1

.github/workflows/build-and-test.yml

@@ -19,6 +19,8 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get install -y protobuf-compiler
+    - name: Install `oas3-gen`
+      run: cargo install oas3-gen
     - name: Build
       run: cargo test --workspace --verbose --no-run
     - name: Run tests

.github/workflows/coverage-pr.yml

@@ -24,6 +24,9 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y protobuf-compiler
 
+      - name: Install `oas3-gen`
+        run: cargo install oas3-gen
+
       - run: cargo install cargo-llvm-cov
       - run: rustup component add llvm-tools-preview
       - run: cargo llvm-cov --workspace --lcov --output-path lcov.info --ignore-filename-regex '^examples/'
@@ -82,6 +85,10 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y protobuf-compiler
 
+      - name: Install `oas3-gen`
+        if: ${{ steps.base_art.outputs.found == 'false' }}
+        run: cargo install oas3-gen
+
       - name: Install cargo-llvm-cov (fallback path)
         if: ${{ steps.base_art.outputs.found == 'false' }}
         run: cargo install cargo-llvm-cov

.github/workflows/coverage.yml

@@ -19,6 +19,9 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y protobuf-compiler
 
+      - name: Install `oas3-gen`
+        run: cargo install oas3-gen
+
       - run: cargo install cargo-llvm-cov
       - run: rustup component add llvm-tools-preview
       - run: cargo llvm-cov --workspace --lcov --output-path lcov.info --ignore-filename-regex '^examples/'

.github/workflows/docs.yml

@@ -9,7 +9,7 @@ jobs:
   # TODO(template) remove docs publishing, when the crate is published to crates.io
   docs:
     permissions:
-        contents: write
+      contents: write
     name: Documentation
     runs-on: ubuntu-latest
     steps:
@@ -24,6 +24,9 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y protobuf-compiler
 
+      - name: Install `oas3-gen`
+        run: cargo install oas3-gen
+
       - name: Setup pages
         id: pages
         uses: actions/configure-pages@v5
@@ -58,4 +61,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@v4

.github/workflows/linter.yml

@@ -19,6 +19,9 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y protobuf-compiler
 
+      - name: Install `oas3-gen`
+        run: cargo install oas3-gen
+
       - run: rustup +nightly component add rustfmt
       - name: Run Fmt
         run: cargo +nightly fmt --all -- --check

.github/workflows/semver-checks.yml

@@ -25,12 +25,15 @@ jobs:
       with:
         # cargo-semver-checks needs the full git history to compare versions
         fetch-depth: 0
-    
+
     - name: Install protobuf compiler
       run: |
         sudo apt-get update
         sudo apt-get install -y protobuf-compiler
-    
+
+    - name: Install `oas3-gen`
+      run: cargo install oas3-gen
+
     - name: Cache cargo registry
       uses: actions/cache@v4
       with:
@@ -41,7 +44,7 @@ jobs:
         key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
         restore-keys: |
           ${{ runner.os }}-cargo-
-    
+
     - name: Get latest version tag
       id: get-baseline
       run: |
@@ -54,7 +57,7 @@ jobs:
         else
           # Extract version without 'v' prefix for comparison
           version=${latest_tag#v}
-          
+
           # Check if version is >= 0.1.0 (using semver comparison)
           if printf '%s\n%s\n' "0.1.0" "$version" | sort -V | head -n1 | grep -q "^0\.1\.0$"; then
             echo "Found suitable baseline tag: $latest_tag (>= v0.1.0)"
@@ -66,14 +69,14 @@ jobs:
             echo "skip=true" >> $GITHUB_OUTPUT
           fi
         fi
-    
+
     - name: Check semver compatibility
       if: steps.get-baseline.outputs.skip == 'false'
       uses: obi1kenobi/cargo-semver-checks-action@v2
       with:
         baseline-rev: ${{ steps.get-baseline.outputs.baseline_rev }}
         verbose: true
-    
+
     - name: Semver check skipped
       if: steps.get-baseline.outputs.skip == 'true'
       run: |
@@ -84,4 +87,4 @@ jobs:
         echo "3. Future changes will be checked against tagged versions"
         echo ""
         echo "Note: Semver checking starts from v0.1.0 as this indicates"
-        echo "the beginning of API stability commitments in Rust projects"
+        echo "the beginning of API stability commitments in Rust projects"

CONTRIBUTING.md

@@ -13,6 +13,7 @@ git config commit.gpgsign true
 * [Rust](https://www.rust-lang.org/tools/install)
 * [Protobuf](https://protobuf.dev/installation/)
 * [cargo deny](https://github.com/EmbarkStudios/cargo-deny)
+* [oas3-gen](https://github.com/eklipse2k8/oas3-gen)
 
 ## Code quality assurance