Add CI (#11)

* add check CI

* fix spacing from tabs

* add licenses

* rewrite CI to only use allowed action domains

* remove redundant clippy

* sort deps

* forge fmt and build before testing

* remove cache and timings

* simplify test schema

* remove duplicate ABI gen and rebuild

* remove unused action

* automatically build and copy

* add note to rebuild statement

Author: austinabell

.github/workflows/main.yml

@@ -0,0 +1,87 @@
+permissions:
+  contents: read
+  # This configuration allows maintainers of this repo to create a branch and pull request based on
+  # the new branch. Restricting the push trigger to the main branch ensures that the PR only gets
+  # built once.
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+env:
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  RISC0_TOOLCHAIN_VERSION: v2024-04-22.0
+  RISC0_MONOREPO_REF: "release-1.0"
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Full history is required by license-check.py
+          fetch-depth: 0
+          submodules: recursive
+      - uses: risc0/risc0/.github/actions/rustup@main
+      - name: Install cargo-sort
+        uses: risc0/cargo-install@b9307573043522ab0d3e3be64a51763b765b52a4
+        with:
+          crate: cargo-sort
+          version: "1.0"
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - uses: risc0/foundry-toolchain@2fe7e70b520f62368a0e3c464f997df07ede420f
+      - run: cargo fmt --all --check
+      - run: cargo sort --workspace --check
+      - run: cargo clippy -p risc0-tm-core
+      - run: forge fmt --check
+        working-directory: contracts
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - run: python license-check.py
+      - name: check for "D0 NOT MERGE" comments
+        run: |
+          [ "$(grep -re 'DO[_ ]\?NOT[_ ]\?MERGE' $(git ls-tree --full-tree --name-only -r HEAD) | tee /dev/fd/2 | wc -l)" -eq "0" ]
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      # This is a workaround from: https://github.com/actions/checkout/issues/590#issuecomment-970586842
+      - name: checkout dummy commit (submodule bug workaround)
+        run: "git checkout -f $(git -c user.name=x -c user.email=x@x commit-tree $(git hash-object -t tree /dev/null) < /dev/null) || :"
+
+      - name: clone repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install rust
+        uses: risc0/risc0/.github/actions/rustup@main
+
+      - name: Install Foundry
+        uses: risc0/foundry-toolchain@2fe7e70b520f62368a0e3c464f997df07ede420f
+
+      - name: risczero toolchain install
+        uses: risc0/risc0-ethereum/.github/actions/[email protected]
+        with:
+          ref: ${{ env.RISC0_MONOREPO_REF }}
+
+      - name: cargo check to build autogenerated files
+        run: cargo check
+
+      # Note: check above should rebuild contracts
+      # - name: build solidity contracts
+      #   run: forge build
+      #   working-directory: contracts
+
+      - name: run tests
+        run: cargo test
+
+      - name: run foundry tests in dev mode
+        env:
+            RISC0_DEV_MODE: true
+        run: forge test -vvv
+        working-directory: contracts

Cargo.lock

@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["host", "core"]
+members = ["core", "host"]
 default-members = ["host"]
 
 [workspace.dependencies]

Cargo.toml

@@ -7,5 +7,8 @@ edition = "2021"
 risc0-build = { version = "1.0.1" }
 risc0-build-ethereum = { git = "https://github.com/risc0/risc0-ethereum", tag = "v1.0.0" }
 
+# Currently just used to format built artifact
+serde_json = "1.0"
+
 [package.metadata.risc0]
 methods = ["guest"]

batch-guest/Cargo.toml

@@ -1,4 +1,4 @@
-// Copyright 2023 RISC Zero, Inc.
+// Copyright 2024 RISC Zero, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,10 +12,17 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use std::{collections::HashMap, env};
+use std::{
+    collections::HashMap,
+    env,
+    fs::{self, File},
+    io::BufReader,
+    process::Command,
+};
 
 use risc0_build::{embed_methods_with_options, DockerOptions, GuestOptions};
 use risc0_build_ethereum::generate_solidity_files;
+use serde_json::Value;
 
 // Paths where the generated Solidity files will be written.
 const SOLIDITY_IMAGE_ID_PATH: &str = "../contracts/src/ImageID.sol";
@@ -43,4 +50,43 @@ fn main() {
         .with_elf_sol_path(SOLIDITY_ELF_PATH);
 
     generate_solidity_files(guests.as_slice(), &solidity_opts).unwrap();
+
+    let contracts_dir = fs::canonicalize(env!("CARGO_MANIFEST_DIR"))
+        .unwrap()
+        // Go back a directory from `./batch-guest`
+        .parent()
+        .unwrap()
+        // Use guest directory.
+        .join("contracts");
+
+    // Rebuild contracts after generating image ID to avoid inconsistencies.
+    Command::new("forge")
+        .args(["build", "--silent"])
+        .current_dir(&contracts_dir)
+        .status()
+        .unwrap();
+
+    // Read and deserialize JSON artifact
+    let file = File::open(
+        contracts_dir
+            .clone()
+            .join("out")
+            .join("Blobstream0.sol")
+            .join("Blobstream0.json"),
+    )
+    .expect("Failed to open JSON file");
+    let reader = BufReader::new(file);
+    let artifact: Value = serde_json::from_reader(reader).expect("Failed to parse JSON");
+
+    // Write the artifact to artifacts dir
+    // Open the file for writing
+    let output_file = File::create(contracts_dir.join("artifacts").join("Blobstream0.json"))
+        .expect("Failed to create output file");
+
+    // Write the formatted JSON
+    serde_json::to_writer_pretty(output_file, &artifact).expect("Failed to write formatted JSON");
+
+    // NOTE: This should not be a circular update, as the code files are not updated with this, just
+    //       the built artifact that is pointed to.
+    println!("cargo:rerun-if-changed={}", contracts_dir.display());
 }

batch-guest/build.rs

@@ -1,7 +1,24 @@
+// Copyright 2024 RISC Zero, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 use alloy_primitives::U256;
 use alloy_sol_types::SolValue;
 use light_client_guest::TM_LIGHT_CLIENT_ID;
-use risc0_tm_core::{DataRootTuple, LightClientCommit, MerkleTree, RangeCommitment};
+use risc0_tm_core::{
+    IBlobstream::{DataRootTuple, RangeCommitment},
+    LightClientCommit, MerkleTree,
+};
 use risc0_zkvm::{guest::env, serde::from_slice};
 
 // TODO by default this will serialize poorly, optimize

batch-guest/guest/src/main.rs

@@ -1 +1,15 @@
+// Copyright 2024 RISC Zero, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 include!(concat!(env!("OUT_DIR"), "/methods.rs"));