Skip to content

Commit 1493af5

Browse files
tac0turtledamiannolantac0turtlegithub-advanced-security[bot]
authored
feat: add rollkit rust types lib crate (#2437)
<!-- Please read and fill out this form before submitting your PR. Please make sure you have reviewed our contributors guide before submitting your first PR. NOTE: PR titles should follow semantic commits: https://www.conventionalcommits.org/en/v1.0.0/ --> ## Overview closes #2413 <!-- Please provide an explanation of the PR, including the appropriate context, background, goal, and rationale. If there is an issue with this information, please provide a tl;dr and link the issue. Ex: Closes #<issue number> --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Introduced Rust client libraries for interacting with Rollkit nodes, including gRPC-based clients for health, P2P, signing, and store services. * Added comprehensive documentation and usage examples for the Rust client libraries. * Provided automated scripts and Makefile targets for generating and checking Rust protobuf files. * Implemented integration tests for the Rust client. * Added a new GitHub Action to automate Rust environment setup with caching and protoc installation. * Introduced new CI workflows for Rust linting, testing, publishing, and CI status reporting. * **Chores** * Set up continuous integration workflows for Rust code formatting, linting, testing, publishing, and status reporting. * Added caching and dependency management to CI workflows. * Updated `.gitignore` to exclude build artifacts. * Configured code coverage to exclude the client directory. * **Documentation** * Added detailed README files for client libraries and protobuf types, including installation, usage, and regeneration instructions. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Damian Nolan <damiannolan@gmail.com> Co-authored-by: tac0turtle <you@example.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
1 parent e8bfe24 commit 1493af5

30 files changed

Lines changed: 4669 additions & 0 deletions

‎.github/actions/rust-setup/action.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: "Setup Rust"
2+
description: "Setup Rust toolchain with caching and protoc"
3+
inputs:
4+
toolchain:
5+
description: "Rust toolchain to install"
6+
required: false
7+
default: "stable"
8+
components:
9+
description: "Rust components to install"
10+
required: false
11+
default: ""
12+
cache-key:
13+
description: "Additional cache key for dependencies"
14+
required: false
15+
default: "default"
16+
17+
runs:
18+
using: "composite"
19+
steps:
20+
- name: Install Rust toolchain
21+
uses: dtolnay/rust-toolchain@master
22+
with:
23+
toolchain: ${{ inputs.toolchain }}
24+
components: ${{ inputs.components }}
25+
26+
- name: Install protoc
27+
uses: arduino/setup-protoc@v3
28+
with:
29+
version: "25.1"
30+
repo-token: ${{ github.token }}
31+
32+
- name: Cache Rust dependencies
33+
uses: actions/cache@v4
34+
with:
35+
path: |
36+
~/.cargo/bin/
37+
~/.cargo/registry/index/
38+
~/.cargo/registry/cache/
39+
~/.cargo/git/db/
40+
target/
41+
key: ${{ runner.os }}-cargo-${{ inputs.toolchain }}-${{ inputs.cache-key }}-${{ hashFiles('**/Cargo.lock') }}
42+
restore-keys: |
43+
${{ runner.os }}-cargo-${{ inputs.toolchain }}-${{ inputs.cache-key }}-
44+
${{ runner.os }}-cargo-${{ inputs.toolchain }}-
45+
46+
- name: Display Rust version
47+
shell: bash
48+
run: |
49+
rustc --version
50+
cargo --version
51+
protoc --version

‎.github/workflows/rust-ci-status.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Rust CI Status
2+
3+
on:
4+
workflow_run:
5+
workflows: ["Rust Tests", "Rust Lint", "Rust Proto Generation Check"]
6+
types:
7+
- completed
8+
9+
jobs:
10+
status:
11+
name: Update CI Status
12+
runs-on: ubuntu-latest
13+
permissions:
14+
contents: read
15+
if: github.event.workflow_run.conclusion != 'skipped'
16+
steps:
17+
- name: Report status
18+
run: |
19+
echo "Workflow: ${{ github.event.workflow_run.name }}"
20+
echo "Status: ${{ github.event.workflow_run.conclusion }}"
21+
echo "Branch: ${{ github.event.workflow_run.head_branch }}"
22+
23+
if [ "${{ github.event.workflow_run.conclusion }}" != "success" ]; then
24+
echo "::error::Rust CI workflow failed"
25+
exit 1
26+
fi

‎.github/workflows/rust-lint.yml‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: Rust Lint
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "client/**"
7+
- "proto/**"
8+
- "Cargo.toml"
9+
- "Cargo.lock"
10+
- ".github/workflows/rust-*.yml"
11+
push:
12+
branches:
13+
- main
14+
- release/*
15+
16+
jobs:
17+
fmt:
18+
name: Rustfmt
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout code
22+
uses: actions/checkout@v4
23+
24+
- name: Install Rust toolchain
25+
uses: dtolnay/rust-toolchain@stable
26+
with:
27+
components: rustfmt
28+
29+
- name: Check formatting
30+
run: cargo fmt --all -- --check
31+
32+
clippy:
33+
name: Clippy
34+
runs-on: ubuntu-latest
35+
permissions:
36+
contents: read
37+
steps:
38+
- name: Checkout code
39+
uses: actions/checkout@v4
40+
41+
- name: Install Rust toolchain
42+
uses: dtolnay/rust-toolchain@stable
43+
with:
44+
components: clippy
45+
46+
- name: Install protoc
47+
uses: arduino/setup-protoc@v3
48+
with:
49+
version: "25.1"
50+
repo-token: ${{ secrets.GITHUB_TOKEN }}
51+
52+
- name: Cache Rust dependencies
53+
uses: actions/cache@v4
54+
with:
55+
path: |
56+
~/.cargo/bin/
57+
~/.cargo/registry/index/
58+
~/.cargo/registry/cache/
59+
~/.cargo/git/db/
60+
target/
61+
key: ${{ runner.os }}-cargo-clippy-${{ hashFiles('**/Cargo.lock') }}
62+
restore-keys: |
63+
${{ runner.os }}-cargo-clippy-
64+
65+
- name: Run clippy
66+
run: cargo clippy --workspace --all-features -- -D warnings
67+
68+
audit:
69+
name: Security Audit
70+
runs-on: ubuntu-latest
71+
steps:
72+
- name: Checkout code
73+
uses: actions/checkout@v4
74+
75+
- name: Run cargo audit
76+
uses: actions-rust-lang/audit@v1
77+
with:
78+
ignore: "" # Add RUSTSEC IDs to ignore if needed
79+
80+
docs:
81+
name: Documentation
82+
runs-on: ubuntu-latest
83+
steps:
84+
- name: Checkout code
85+
uses: actions/checkout@v4
86+
87+
- name: Install Rust toolchain
88+
uses: dtolnay/rust-toolchain@stable
89+
90+
- name: Install protoc
91+
uses: arduino/setup-protoc@v3
92+
with:
93+
version: "25.1"
94+
repo-token: ${{ secrets.GITHUB_TOKEN }}
95+
96+
- name: Cache Rust dependencies
97+
uses: actions/cache@v4
98+
with:
99+
path: |
100+
~/.cargo/bin/
101+
~/.cargo/registry/index/
102+
~/.cargo/registry/cache/
103+
~/.cargo/git/db/
104+
target/
105+
key: ${{ runner.os }}-cargo-doc-${{ hashFiles('**/Cargo.lock') }}
106+
restore-keys: |
107+
${{ runner.os }}-cargo-doc-
108+
109+
- name: Check documentation
110+
run: cargo doc --workspace --no-deps --all-features
111+
env:
112+
RUSTDOCFLAGS: -D warnings

‎.github/workflows/rust-publish.yml‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: Publish Rust Crates
2+
3+
on:
4+
push:
5+
tags:
6+
- 'rust-v*'
7+
workflow_dispatch:
8+
inputs:
9+
dry_run:
10+
description: 'Perform a dry run without publishing'
11+
required: false
12+
type: boolean
13+
default: true
14+
15+
jobs:
16+
publish:
17+
name: Publish to crates.io
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Checkout code
21+
uses: actions/checkout@v4
22+
23+
- name: Setup Rust
24+
uses: ./.github/actions/rust-setup
25+
with:
26+
cache-key: publish
27+
28+
- name: Check crate versions
29+
run: |
30+
echo "=== Checking crate versions ==="
31+
echo "rollkit-types version: $(cargo pkgid -p rollkit-types | cut -d# -f2)"
32+
echo "rollkit-client version: $(cargo pkgid -p rollkit-client | cut -d# -f2)"
33+
34+
- name: Run tests
35+
run: cargo test --workspace --all-features
36+
37+
- name: Package crates
38+
run: |
39+
cargo package -p rollkit-types --allow-dirty
40+
cargo package -p rollkit-client --allow-dirty
41+
42+
- name: Publish rollkit-types (dry run)
43+
if: github.event_name == 'workflow_dispatch' && inputs.dry_run
44+
run: |
45+
cd client/crates/rollkit-types
46+
cargo publish --dry-run
47+
48+
- name: Publish rollkit-client (dry run)
49+
if: github.event_name == 'workflow_dispatch' && inputs.dry_run
50+
run: |
51+
cd client/crates/rollkit-client
52+
cargo publish --dry-run
53+
54+
- name: Publish rollkit-types
55+
if: (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')) || (github.event_name == 'workflow_dispatch' && !inputs.dry_run)
56+
env:
57+
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
58+
run: |
59+
cd client/crates/rollkit-types
60+
cargo publish
61+
62+
- name: Wait for rollkit-types to be available
63+
if: (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')) || (github.event_name == 'workflow_dispatch' && !inputs.dry_run)
64+
run: |
65+
echo "Waiting for rollkit-types to be available on crates.io..."
66+
sleep 30
67+
68+
- name: Publish rollkit-client
69+
if: (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')) || (github.event_name == 'workflow_dispatch' && !inputs.dry_run)
70+
env:
71+
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
72+
run: |
73+
cd client/crates/rollkit-client
74+
cargo publish
75+
76+
- name: Create GitHub Release
77+
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
78+
uses: softprops/action-gh-release@v2
79+
with:
80+
name: Rust Client ${{ github.ref_name }}
81+
body: |
82+
# Rust Client Release
83+
84+
This release includes:
85+
- `rollkit-types`: Proto-generated types for Rollkit
86+
- `rollkit-client`: High-level Rust client for Rollkit gRPC services
87+
88+
## Installation
89+
90+
Add to your `Cargo.toml`:
91+
```toml
92+
[dependencies]
93+
rollkit-client = "<version>"
94+
```
95+
96+
See the [README](https://github.com/rollkit/rollkit/tree/main/client/crates/rollkit-client) for usage examples.
97+
draft: false
98+
prerelease: false

‎.github/workflows/rust-test.yml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: Rust Tests
2+
permissions:
3+
contents: read
4+
5+
on:
6+
pull_request:
7+
paths:
8+
- 'client/**'
9+
- 'proto/**'
10+
- 'Cargo.toml'
11+
- 'Cargo.lock'
12+
- '.github/workflows/rust-*.yml'
13+
push:
14+
branches:
15+
- main
16+
- release/*
17+
paths:
18+
- 'client/**'
19+
- 'proto/**'
20+
- 'Cargo.toml'
21+
- 'Cargo.lock'
22+
- '.github/workflows/rust-*.yml'
23+
24+
jobs:
25+
test:
26+
name: Test Rust Client
27+
runs-on: ubuntu-latest
28+
strategy:
29+
matrix:
30+
rust:
31+
- stable
32+
- beta
33+
- nightly
34+
steps:
35+
- name: Checkout code
36+
uses: actions/checkout@v4
37+
38+
- name: Setup Rust
39+
uses: ./.github/actions/rust-setup
40+
with:
41+
toolchain: ${{ matrix.rust }}
42+
components: rustfmt, clippy
43+
cache-key: test
44+
45+
- name: Build
46+
run: cargo build --workspace --all-features --verbose
47+
48+
- name: Run tests
49+
run: cargo test --workspace --all-features --verbose
50+
51+
- name: Run doc tests
52+
run: cargo test --workspace --doc --verbose
53+
54+
- name: Check examples
55+
run: |
56+
cd client/crates/rollkit-client
57+
cargo check --examples --verbose
58+
59+
coverage:
60+
name: Code Coverage
61+
runs-on: ubuntu-latest
62+
if: github.event_name == 'pull_request'
63+
steps:
64+
- name: Checkout code
65+
uses: actions/checkout@v4
66+
67+
- name: Install Rust toolchain
68+
uses: dtolnay/rust-toolchain@stable
69+
with:
70+
components: llvm-tools-preview
71+
72+
- name: Install cargo-llvm-cov
73+
uses: taiki-e/install-action@cargo-llvm-cov
74+
75+
- name: Install protoc
76+
uses: arduino/setup-protoc@v3
77+
with:
78+
version: "25.1"
79+
repo-token: ${{ secrets.GITHUB_TOKEN }}
80+
81+
- name: Generate code coverage
82+
run: cargo llvm-cov --workspace --lcov --output-path lcov.info
83+
84+
- name: Upload coverage to Codecov
85+
uses: codecov/codecov-action@v4
86+
with:
87+
files: lcov.info
88+
flags: rust
89+
fail_ci_if_error: false
90+
token: ${{ secrets.CODECOV_TOKEN }}

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ build
1414
.DS_Store
1515
coverage.out
1616
execution/evm/jwttoken
17+
target

0 commit comments

Comments
 (0)