Skip to content

Commit

Permalink
Bump to 0.2.3 (#279)
Browse files Browse the repository at this point in the history
Summary:

Fix missing `cycles` features in guest in host command.


Test Plan:

Update `test_sdk.sh` to catch missing feature bugs.

Co-authored-by: duc-nx <>
  • Loading branch information
duc-nx authored Aug 21, 2024
1 parent c703c59 commit 8bfae20
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 12 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,14 @@ jobs:
- uses: actions/checkout@v4
- run: rustup target add riscv32i-unknown-none-elf
- run: assets/scripts/smoke.sh examples/src/bin/fib3_profiling.rs
- run: assets/scripts/smoke.sh examples/src/bin/hello.rs

test-sdk:
needs: check-build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: rustup target add riscv32i-unknown-none-elf
- run: assets/scripts/test_sdk.sh examples/src/bin/hello.rs
- run: assets/scripts/test_sdk.sh examples/src/bin/fib3_profiling.rs

detect-unused-crate:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ exclude = ["nova-benches"]

[workspace.package]
edition = "2021"
version = "0.2.2"
version = "0.2.3"
authors = ["The Nexus Team <hello@nexus.xyz>"]
homepage = "https://nexus.xyz/"
repository = "https://github.com/nexus-xyz/nexus-zkvm/"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ rustup target add riscv32i-unknown-none-elf
Then, install the Nexus zkVM:

```shell
cargo install --git https://github.com/nexus-xyz/nexus-zkvm cargo-nexus --tag 'v0.2.2'
cargo install --git https://github.com/nexus-xyz/nexus-zkvm cargo-nexus --tag 'v0.2.3'
```

Verify the installation:
Expand Down
11 changes: 9 additions & 2 deletions assets/scripts/test_sdk.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ set -e

ORIGINAL_DIR=$(pwd)
PROJECT_NAME="/tmp/nexus-host-ci"
CARGO_NEXUS="$(pwd)/target/release/cargo-nexus"

function usage() {
echo "Usage: $0 <file.rs>"
Expand Down Expand Up @@ -40,9 +41,9 @@ cargo build --release --package cargo-nexus --bin cargo-nexus

function create_nexus_project() {
if [[ -z "${GITHUB_SHA}" ]]; then
./target/release/cargo-nexus nexus host "$PROJECT_NAME"
$CARGO_NEXUS nexus host "$PROJECT_NAME"
else
./target/release/cargo-nexus nexus host "$PROJECT_NAME" --rev "${GITHUB_SHA}"
$CARGO_NEXUS nexus host "$PROJECT_NAME" --rev "${GITHUB_SHA}"
fi
}

Expand All @@ -52,6 +53,12 @@ cp "$1" "$PROJECT_NAME/src/guest/src/main.rs"

function run_project() {
cargo update

# Test the cycles feature inside the guest project
pushd src/guest
$CARGO_NEXUS nexus run
popd

cargo run --release
}

Expand Down
5 changes: 3 additions & 2 deletions cli/src/command/host.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pub fn handle_command(args: HostArgs) -> anyhow::Result<()> {

if rev.is_none() && tag.is_none() {
// default to current release
tag = Some(String::from("0.2.2"));
tag = Some(String::from("0.2.3"));
}

setup_crate(path, rev, tag)
Expand Down Expand Up @@ -139,7 +139,8 @@ fn setup_crate(host_path: PathBuf, rev: Option<String>, tag: Option<String>) ->
"\n",
"# Generated by cargo-nexus, do not remove!\n",
"#\n",
"# This profile is used for generating proofs, as Nexus VM support for compiler optimizations is still under development.\n",
"[features]\n",
"cycles = [] # Enable cycle counting for run command\n",
)
)?;

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import { Callout } from 'nextra/components'

The Nexus zkVM (zero-knowledge virtual machine) is a modular, extensible, open-source, highly-parallelized, prover-optimized, contributor-friendly, [zkVM](specs/zkvm-overview.mdx) written in Rust, focused on performance and security.

[Nexus zkVM v0.2.2](https://github.com/nexus-xyz/nexus-zkvm/releases/tag/v0.2.2) is the current stable release, implementing the zkVM component of the Nexus 2.0 system.
[Nexus zkVM v0.2.3](https://github.com/nexus-xyz/nexus-zkvm/releases/tag/v0.2.3) is the current stable release, implementing the zkVM component of the Nexus 2.0 system.

## Proving Computation

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ import { Callout } from 'nextra/components'

The Nexus Network is a massively-parallelized proof network for executing and proving the Nexus zkVM.

[Nexus Network v0.2.2](https://github.com/nexus-xyz/nexus-zkvm/releases/tag/v0.2.2) is the current stable release, implementing the network component of the Nexus 2.0 system.
[Nexus Network v0.2.3](https://github.com/nexus-xyz/nexus-zkvm/releases/tag/v0.2.3) is the current stable release, implementing the network component of the Nexus 2.0 system.

<Callout type="info" emoji="ℹ️">
The Nexus Network is currently in a prototype stage.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/zkvm/cli-quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ rustup target add riscv32i-unknown-none-elf
Then, install the Nexus zkVM:

```shell
cargo install --git https://github.com/nexus-xyz/nexus-zkvm cargo-nexus --tag 'v0.2.2'
cargo install --git https://github.com/nexus-xyz/nexus-zkvm cargo-nexus --tag 'v0.2.3'
```

Verify the installation:
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/zkvm/sdk-quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ rustup target add riscv32i-unknown-none-elf
Then, install the Nexus zkVM:

```shell
cargo install --git https://github.com/nexus-xyz/nexus-zkvm cargo-nexus --tag 'v0.2.2'
cargo install --git https://github.com/nexus-xyz/nexus-zkvm cargo-nexus --tag 'v0.2.3'
```

Verify the installation:
Expand Down

0 comments on commit 8bfae20

Please sign in to comment.