Browse Source

add mdbook-katex, add typos GHA, add docs intro page

main
arnaucube 1 year ago
parent
commit
c3e598b184
6 changed files with 55 additions and 0 deletions
  1. +2
    -0
      .github/workflows/mdbook.yml
  2. +2
    -0
      .github/workflows/typos.toml
  3. +18
    -0
      .github/workflows/typos.yml
  4. +30
    -0
      src/README.md
  5. +3
    -0
      src/SUMMARY.md
  6. BIN
      src/imgs/sonobe.png

+ 2
- 0
.github/workflows/mdbook.yml

@ -23,6 +23,7 @@ jobs:
runs-on: ubuntu-latest
env:
MDBOOK_VERSION: 0.4.36
MDBOOKKATEX_VERSION: 0.7.0
steps:
- uses: actions/checkout@v4
- name: Install mdBook
@ -30,6 +31,7 @@ jobs:
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
rustup update
cargo install --version ${MDBOOK_VERSION} mdbook
cargo install --version ${MDBOOKKATEX_VERSION} mdbook-katex
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4

+ 2
- 0
.github/workflows/typos.toml

@ -0,0 +1,2 @@
[default.extend-words]
groth = "groth"

+ 18
- 0
.github/workflows/typos.yml

@ -0,0 +1,18 @@
name: typos
on:
push:
branches:
- main
jobs:
typos:
if: github.event.pull_request.draft == false
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Use typos with config file
uses: crate-ci/typos@master
with:
config: .github/workflows/typos.toml

+ 30
- 0
src/README.md

@ -0,0 +1,30 @@
# sonobe docs
Experimental folding schemes library implemented in a joint effort by [0xPARC](https://0xparc.org/) and [PSE](https://pse.dev).
<img align="left" style="width:30%;min-width:250px;margin:20px;" src="imgs/sonobe.png">
<br>
<b>Sonobe</b> is a modular library to fold circuit instances in an Incremental Verifiable computation (IVC) style, which allows to generate a zkSNARK proof of the circuit foldings that can be verified in Ethereum's EVM.
<br><br>
<i>"The <a href="https://en.wikipedia.org/wiki/Sonobe">Sonobe module</a> is one of the many units used to build modular origami. The popularity of Sonobe modular origami models derives from the simplicity of folding the modules, the sturdy and easy assembly, and the flexibility of the system."</i>
<br><br>
## Schemes implemented
The library uses [arkworks](https://github.com/arkworks-rs), and implements the following folding schemes:
- [Nova: Recursive Zero-Knowledge Arguments from Folding Schemes](https://eprint.iacr.org/2021/370.pdf), Abhiram Kothapalli, Srinath Setty, Ioanna Tzialla. 2021
- [CycleFold: Folding-scheme-based recursive arguments over a cycle of elliptic curves](https://eprint.iacr.org/2023/1192.pdf), Abhiram Kothapalli, Srinath Setty. 2023
Work in progress:
- [HyperNova: Recursive arguments for customizable constraint systems](https://eprint.iacr.org/2023/573.pdf), Abhiram Kothapalli, Srinath Setty. 2023
- [ProtoGalaxy: Efficient ProtoStar-style folding of multiple instances](https://eprint.iacr.org/2023/1106.pdf), Liam Eagen, Ariel Gabizon. 2023
### Available frontends
Available frontends to define the folded circuit:
- [arkworks](https://github.com/arkworks-rs), arkworks contributors
- [Circom](https://github.com/iden3/circom), iden3, 0Kims Association

+ 3
- 0
src/SUMMARY.md

@ -0,0 +1,3 @@
# sonobe docs
[Introduction](README.md)

BIN
src/imgs/sonobe.png

Before After
Width: 1024  |  Height: 1024  |  Size: 3.0 MiB

Loading…
Cancel
Save