sigma-proofs 0.3.1

A toolkit for auto-generated implementations of Σ-protocols
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

name: PR

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always

jobs:
  typos:
    name: Spell check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: crate-ci/typos@v1

  format:
    name: Format
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt
      - run: cargo fmt --all -- --check
      - run: cargo install cargo-sort
      - run: cargo sort --check

  clippy:
    name: Clippy (${{ matrix.toolchain }}, ${{ matrix.features }})
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        toolchain: [stable, nightly]
        features: [default, no-default, all]
    steps:
      - uses: actions/checkout@v6
      - uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ matrix.toolchain }}
          components: clippy
      - name: Run clippy
        run: |
          case "${{ matrix.features }}" in
            default)    cargo clippy --all-targets -- -D warnings ;;
            no-default) cargo clippy --all-targets --no-default-features -- -D warnings ;;
            all)        cargo clippy --all-targets --all-features -- -D warnings ;;
          esac

  test:
    name: Test (${{ matrix.toolchain }}, ${{ matrix.features }})
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        toolchain: [stable, nightly]
        features: [default, no-default, all]
    steps:
      - uses: actions/checkout@v6
      - uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ matrix.toolchain }}
      - name: Build
        run: |
          case "${{ matrix.features }}" in
            default)    cargo build --verbose ;;
            no-default) cargo build --no-default-features --verbose ;;
            all)        cargo build --all-features --verbose ;;
          esac
      - name: Test
        run: |
          case "${{ matrix.features }}" in
            default)    cargo test --verbose --no-fail-fast ;;
            no-default) cargo test --no-default-features --verbose --no-fail-fast ;;
            all)        cargo test --all-features --verbose --no-fail-fast ;;
          esac

  wasm:
    name: WASM
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: bytecodealliance/actions/wasmtime/setup@v1
      - name: Build
        run: cargo build --target wasm32-wasip1 --verbose
      - name: Test
        run: cargo test --target wasm32-wasip1 --verbose --no-fail-fast

  bench:
    name: Benchmark smoke test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Run benchmark
        run: cargo bench --bench msm -- --sample-count 1 --sample-size 1

  # Build docs with the same flags docs.rs uses. Reduces risk of broken public docs.
  docs-rs:
    name: docs.rs
    runs-on: ubuntu-latest
    env:
      RUSTDOCFLAGS: "--cfg docsrs -D warnings"
    steps:
      - uses: actions/checkout@v6
      - uses: dtolnay/rust-toolchain@nightly
      - run: cargo doc --all-features --no-deps

  # Anchor job for branch protection. Point required status checks at this.
  # see: https://github.com/orgs/community/discussions/26822
  status-check:
    if: always()
    needs:
      - typos
      - format
      - clippy
      - test
      - wasm
      - bench
      - docs-rs
    runs-on: ubuntu-latest
    steps:
      - name: Check all job results
        if: ${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}
        run: exit 1