mirror of
https://github.com/Sunscreen-tech/Sunscreen.git
synced 2026-01-14 16:17:56 -05:00
badb8f9c8f
* Export type alias for bulletproof backend fields Also, keep bulletproof stuff namespaced to a `bulletproofs` module. * Change sudoku to use pub over const * Docs updates * Rename / clean up sudoku * Export `Proof` type Basically required for being able to deserialize a proof * Add zkp/serde workspace example * Drive by cleaning * Exports necessary for gadget impls * Rename compute_inputs to compute_hidden_inputs * Add prove/verify builders * Export the builder types This isnt strictly necessary but it would be weird for these to not show up in the cargo docs * Clippy fix * Add helper .compile() & .runtime() methods to fhe prog fns I do wonder if these should be defined in a separate trait, just so that they don't live next to the more internal functions in documentation. * Use new swag to simplify the front-facing api docs example * Add some whitespace * Switch to an extension trait * Add an extension to ZkpProgramFn * Take an owned ZkpBackend, rather than reference Its typical to have the caller handle cloning, rather than taking a reference, requiring Clone impl, and forcing clone. Plus, as of now the only backend is a zero size null struct, so nothing to be gained by using a reference. It also just looks weird to always pass `&BulletproofsBackend::new()` * Update sudoku to use new swag * Target second attribute in multi attribute error * Enforce ordering zkp inputs: constants,public,private Honestly this feels a little unnatural to me. Might want to reverse: private, public, constant and then change all the prove/verify methods to that ordering * Build whitelist example in CI * Reorder constant->public->private to private->public->constant * Fix trailing ws * Fix example * Make .runtime() more consistent with .compile() * Get rid of some boilerplate impls * Add custom zkp type example * Move example run checks into example tests Should speed up CI a bit * Change whitelist -> allowlist
100 lines
3.0 KiB
YAML
100 lines
3.0 KiB
YAML
name: CI
|
|
|
|
on:
|
|
push:
|
|
branches: [ main ]
|
|
pull_request:
|
|
branches: [ main, debugger ]
|
|
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
submodules: 'recursive'
|
|
- uses: actions/cache@v3
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ${{ runner.os }}-cargo-build-${{ hashFiles('Cargo.lock') }}
|
|
- uses: actions/cache@v3
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
mdBook/target
|
|
key: ${{ runner.os }}-cargo-mdBook-${{ hashFiles('mdBook/Cargo.lock') }}
|
|
# Checks are ordered from fastest to slowest so your build fails quickly on invalid PRs
|
|
# We do everything in release mode so tests run quickly and steps cache each other.
|
|
# Check the submitted change meets style guidelines
|
|
- name: Cargo Format
|
|
run: cargo fmt --check
|
|
# Build and run the tests
|
|
- name: Build and run tests
|
|
run: cargo test --workspace --verbose --release
|
|
- name: Verify examples outside of workspace (allowlist_zkp)
|
|
run: cargo test --workspace --verbose
|
|
working-directory: ./examples/allowlist_zkp
|
|
- name: Build sunscreen and bincode
|
|
run: cargo build --release --package sunscreen --package bincode
|
|
- name: Build mdBook
|
|
run: cargo build --release
|
|
working-directory: ./mdBook
|
|
- name: Test docs
|
|
run: ../mdBook/target/release/mdbook test -L dependency=../target/release/deps --extern sunscreen=../target/release/libsunscreen.rlib --extern bincode=../target/release/libbincode.rlib
|
|
working-directory: ./sunscreen_docs
|
|
|
|
lint:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
submodules: 'recursive'
|
|
- uses: actions/cache@v3
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ${{ runner.os }}-cargo-clippy-${{ hashFiles('Cargo.lock') }}
|
|
# Check the submitted change passes the clippy linter
|
|
- name: Cargo clippy
|
|
run: cargo clippy --release --all-targets -- --deny warnings
|
|
|
|
api_docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
submodules: 'recursive'
|
|
- uses: actions/cache@v3
|
|
with:
|
|
path: |
|
|
~/.cargo/bin/
|
|
~/.cargo/registry/index/
|
|
~/.cargo/registry/cache/
|
|
~/.cargo/git/db/
|
|
target/
|
|
key: ${{ runner.os }}-cargo-doc-${{ hashFiles('**/Cargo.lock') }}
|
|
# Cursory check to ensure your CL contains valid Rust code
|
|
- name: Cargo check
|
|
run: cargo check --release
|
|
# Check the documentation builds, links work, etc.
|
|
- name: Cargo doc
|
|
env:
|
|
RUSTDOCFLAGS: -D warnings
|
|
run: cargo doc --release --no-deps
|