-
Notifications
You must be signed in to change notification settings - Fork 623
feat: openvm v0.3.0 #1648
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: openvm v0.3.0 #1648
Conversation
WalkthroughThis change updates dependency versions in several Rust project configuration files, specifically upgrading Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub Actions
participant SSH Agent
participant Docker Build
participant Shell Script
participant GitHub Repo
GitHub Actions->>SSH Agent: Set up SSH key (webfactory/ssh-agent)
GitHub Actions->>Docker Build: Start Docker build for coordinator-api
Docker Build->>Shell Script: Run init-openvm.sh
Shell Script->>GitHub Repo: Clone openvm-gpu at specific commit via SSH
Shell Script-->>Docker Build: openvm-gpu ready at fixed commit
Docker Build-->>GitHub Actions: Build completes with patched dependencies
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (17)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1648 +/- ##
========================================
Coverage 40.75% 40.75%
========================================
Files 225 225
Lines 18416 18417 +1
========================================
+ Hits 7505 7506 +1
Misses 10176 10176
Partials 735 735
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
common/libzkp/impl/Cargo.lock
is excluded by!**/*.lock
zkvm-prover/Cargo.lock
is excluded by!**/*.lock
📒 Files selected for processing (3)
common/libzkp/impl/Cargo.toml
(1 hunks)common/version/version.go
(1 hunks)zkvm-prover/Cargo.toml
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: check
- GitHub Check: tests
- GitHub Check: check
- GitHub Check: check
🔇 Additional comments (2)
common/version/version.go (1)
8-8
: Version bump is correct and consistent.The
tag
variable has been updated from"v4.5.5"
to"v4.5.6"
to align with the coordinated release of dependencies. No logic changes were introduced.zkvm-prover/Cargo.toml (1)
21-21
:✅ Verification successful
Ensure the bumped tag is available upstream.
The
scroll-zkvm-prover-euclid
dependency tag is updated tov0.3.0
. Please verify that this tag exists in thezkvm-prover
repository. Additionally, if this crate is published separately, consider bumping its ownversion = "0.1.0"
field to reflect the dependency changes.
🏁 Script executed:
#!/bin/bash # Verify that v0.3.0 tag exists in zkvm-prover repo git ls-remote --tags https://github.com/scroll-tech/zkvm-prover.git | grep -q 'refs/tags/v0.3.0$' \ && echo "Tag v0.3.0 found" \ || { echo "ERROR: Tag v0.3.0 not found"; exit 1; }Length of output: 142
Verified upstream tag exists
Tagv0.3.0
was found in thescroll-tech/zkvm-prover
repository. No further changes are required here.
Note: thescroll-zkvm-prover-euclid
entry is just a git‑sourced dependency alias, so there’s no local crate version to bump.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (4)
build/dockerfiles/coordinator-api.Dockerfile (4)
14-15
: Automate and verify openvm‑gpu initialization
Relying on an externalinit-openvm.sh
script increases fragility and manual steps. Consider embedding aRUN
step to clone or checkout theopenvm-gpu
repo at the pinned commit directly in this Dockerfile so builds are self‑contained. Also ensurecoordinator-api/init-openvm.sh
is versioned and reachable in the build context, or remove the reference if fully automated.
16-16
: Minimize Docker context and improve caching
Copying the entireopenvm-gpu
directory can bloat the build context and invalidate cache on any file change. Use a tailored.dockerignore
to exclude unneeded files (tests, docs, large assets) or fetch only the required subset via agit clone --depth=1
in aRUN
step to keep layers lean.
17-17
: Scope Git URL rewrite to avoid global side effects
Overwriting/root/.gitconfig
applies URL rewrites globally across all future Git commands in this container. Instead, limit the rewrite to this build stage by injecting the config viaRUN git config --global ...
or by mounting it only when needed, reducing the risk of unintended behavior in downstream stages.
18-18
: Ensure Cargo config directory exists and leverage CARGO_HOME
Before copyingconfig.toml
, addRUN mkdir -p /root/.cargo
or setENV CARGO_HOME=/root/.cargo
at the top of this stage. Then useCOPY coordinator-api/config.toml $CARGO_HOME/config.toml
for consistency and clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
build/dockerfiles/coordinator-api.Dockerfile
(1 hunks)build/dockerfiles/coordinator-api/config.toml
(1 hunks)build/dockerfiles/coordinator-api/gitconfig
(1 hunks)build/dockerfiles/coordinator-api/init-openvm.sh
(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- build/dockerfiles/coordinator-api/gitconfig
- build/dockerfiles/coordinator-api/config.toml
- build/dockerfiles/coordinator-api/init-openvm.sh
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: check
- GitHub Check: check
- GitHub Check: check
- GitHub Check: check
- GitHub Check: tests
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/docker.yml
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: check
- GitHub Check: check
- GitHub Check: check
- GitHub Check: check
- GitHub Check: tests
- GitHub Check: tests
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
build/dockerfiles/coordinator-api.Dockerfile (1)
12-15
: Clarify initialization of openvm‑gpu patch files
The inline comment on lines 12 and 19 reminds users to runinit-openvm.sh
, but it can be overlooked or become outdated if the script location moves. Consider relocating this guidance to your top‑level README or adding a fail‑fast check in the Dockerfile that explicitly errors if/openvm-gpu
is missing.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/workflows/docker.yml
(1 hunks)build/dockerfiles/coordinator-api.Dockerfile
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- .github/workflows/docker.yml
⏰ Context from checks skipped due to timeout of 90000ms (17)
- GitHub Check: coordinator-cron
- GitHub Check: coordinator-api
- GitHub Check: bridgehistoryapi-db-cli
- GitHub Check: gas_oracle
- GitHub Check: rollup-db-cli
- GitHub Check: bridgehistoryapi-api
- GitHub Check: rollup_relayer
- GitHub Check: bridgehistoryapi-fetcher
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: check
- GitHub Check: check
- GitHub Check: check
- GitHub Check: check
- GitHub Check: tests
the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.github/workflows/common.yml (1)
45-48
: Verify necessity and improve SSH configurationThe
Setup SSH for private repos
step correctly loads the SSH key for accessingopenvm-gpu
, but please ensure the following:
- The
OPENVM_GPU_SSH_PRIVATE_KEY
secret exists in repo settings and is scoped read-only.- Add GitHub’s host key to
known_hosts
to prevent host verification prompts:- name: Add GitHub to known hosts run: ssh-keyscan github.com >> ~/.ssh/known_hosts- Confirm that the subsequent
make lint
incommon
truly requires SSH access—if not, consider moving this step to only those jobs that clone private repos.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/common.yml
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: tests
- GitHub Check: check
- GitHub Check: check
- GitHub Check: check
- GitHub Check: tests
- GitHub Check: check
- GitHub Check: tests
Purpose or design rationale of this PR
PR title
Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:
Deployment tag versioning
Has
tag
incommon/version.go
been updated or have you addedbump-version
label to this PR?Breaking change label
Does this PR have the
breaking-change
label?Summary by CodeRabbit
Chores
Bug Fixes