rust repo template

Author: maksimryndin

.githooks/pre-push

@@ -0,0 +1,34 @@
+#!/bin/sh
+set -e pipefail 
+
+# Dependency audit
+cargo deny check || {
+    echo "❌ Critical: Vulnerable dependencies detected (run 'cargo deny check')"
+    exit 1
+}
+
+# Formatting check
+cargo fmt --all -- --check || {
+    echo "❌ Formatting issues (run 'cargo fmt --all')"
+    exit 2
+}
+
+# Typo check
+typos || {
+    echo "❌ Spelling mistakes found (run 'typos --write-changes')"
+    exit 3
+}
+
+# Linting
+cargo clippy --all-targets --all-features -- -D warnings || {
+    echo "❌ Clippy violations (check warnings above)"
+    exit 4
+}
+
+# Tests
+cargo test --workspace --verbose || {
+    echo "❌ Test failures detected"
+    exit 5
+}
+
+echo "✅ All checks passed!"

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

@@ -0,0 +1,21 @@
+name: Build and test code
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_INCREMENTAL: 0
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build
+      run: cargo test --workspace --verbose --no-run
+    - name: Run tests
+      run: cargo test --workspace --verbose

.github/workflows/dependency-audit.yml

@@ -0,0 +1,41 @@
+name: Dependency security audit
+
+on:
+  push:
+    paths:
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_INCREMENTAL: 0
+
+jobs:
+  security_audit:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      checks: write
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Cache audit-check build
+        id: cache-audit-check
+        uses: actions/cache@v4
+        continue-on-error: false
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-
+
+      - name: Run audit-check action
+        run: |
+          which cargo-deny || cargo install cargo-deny
+          cargo deny check

.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: Docs
+
+# TODO(template)
+# GH pages seems to work properly for public repos
+on:
+  workflow_dispatch:
+
+jobs:
+  # TODO(template) remove docs publishing, when the crate is published to crates.io
+  docs:
+    permissions:
+        contents: write
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          persist-credentials: false
+
+      - name: Setup pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Clean docs folder
+        run: cargo clean --doc
+
+      # Documentation with Latex support
+      # TODO(template) if Latex is not needed
+      # just remove katex-header.html at the root and RUSTDOCFLAGS here
+      # TODO(template) update the crate name
+      - name: Build documentation
+        run: RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --no-deps -p mycrate
+
+      - name: Remove lock file
+        run: rm target/doc/.lock
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: target/doc
+
+  publish-docs:
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: docs
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/linter.yml

@@ -0,0 +1,24 @@
+name: Linter check
+
+on: push
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_INCREMENTAL: 0
+  # Make sure CI fails on all warnings, including Clippy lints
+  RUSTFLAGS: "-Dwarnings"
+
+jobs:
+  linter_check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run Fmt
+        run: cargo fmt --all -- --check
+
+      - name: Run Clippy
+        run: cargo clippy --all-targets --all-features
+
+      - name: Check typos
+        uses: crate-ci/typos@master
+      

.github/workflows/ub-detection.yml

@@ -0,0 +1,22 @@
+name: UB (undefined behavior) detection
+
+on: push
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_INCREMENTAL: 0
+  # Make sure CI fails on all warnings, including Clippy lints
+  RUSTFLAGS: "-Dwarnings"
+
+jobs:
+  ub-detection:
+    if: github.event.pull_request.draft == false
+    name: Check for undefined behaviour (UB)
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          rustup +nightly component add miri
+          cargo +nightly miri setup
+          MIRIFLAGS="-Zmiri-strict-provenance" cargo +nightly miri test --lib

.gitignore

@@ -0,0 +1,14 @@
+# IDEs
+.vscode
+.idea
+
+# Rust/Cargo
+debug/
+target/
+Cargo.lock
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# These are backup files generated by rustfmt
+**/*.rs.bk

CODEOWNER

@@ -0,0 +1,3 @@
+# TODO(template) put codeowners here (usually the project contribitors and the group manager)
+
+Michal Zajac @mpzajac

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributor's guide
+
+## Commit signing
+
+Enable [commit signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
+
+```sh
+git config commit.gpgsign true
+```
+
+## Prerequisites
+
+* [Rust](https://www.rust-lang.org/tools/install)
+* [cargo deny](https://github.com/EmbarkStudios/cargo-deny)
+* [typos](https://github.com/crate-ci/typos?tab=readme-ov-file#install)
+
+## Code quality assurance
+
+Install a pre-push git hook:
+
+```sh
+git config core.hooksPath .githooks
+```
+
+## Running the Rust Documentation Locally
+After cloning the repository, follow the instructions below to run the documentation locally:
+
+```sh
+cargo doc
+```
+
+Docs for `TODO(template) template-crate`:
+
+```sh
+RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --no-deps -p template-crate --open
+```

Cargo.toml

@@ -0,0 +1,36 @@
+[workspace.package]
+version = "0.1.0"
+edition = "2021"
+# TODO(template) update for your repository
+repository = "https://github.com/NethermindEth/rust-template"
+license = "Apache-2.0" # TODO(template) update license if needed
+
+# TODO(template) update for the crate name
+[workspace]
+members = [
+    "examples",
+    "mycrate",
+]
+resolver = "2"
+default-members = ["mycrate"]
+
+[workspace.dependencies]
+
+[workspace.lints.rust]
+missing_docs = "deny"
+# TODO(template) if you use any unsafe code, then running miri in CI is a must
+# if for a crate in the workspace you need an unsafe code
+# prefer to preserve forbid for the workspace
+# and allowing only at a specific crate level 
+unsafe_code = "forbid"
+
+[workspace.lints.clippy]
+arithmetic_side_effects = "deny"
+cast_lossless = "deny"
+cast_possible_truncation = "deny"
+cast_possible_wrap = "deny"
+cast_precision_loss = "deny"
+cast_sign_loss = "deny"
+needless_return = "deny"
+panicking_overflow_checks = "deny"
+unwrap_used = "deny"