Skip to content

Commit

Permalink
chore: rename succinct to curta (#192)
Browse files Browse the repository at this point in the history
Co-authored-by: John Guibas <[email protected]>
  • Loading branch information
jtguibas and John Guibas authored Feb 11, 2024
1 parent 1521fa7 commit f2fbf89
Show file tree
Hide file tree
Showing 93 changed files with 682 additions and 732 deletions.
34 changes: 17 additions & 17 deletions .github/workflows/book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,24 +120,24 @@ jobs:
retention-days: 1
if-no-files-found: error

# deploy:
# # Only deploy if a push to main
# if: github.ref_name == 'main' && github.event_name == 'push'
# runs-on: ubuntu-latest
# needs: [lint, build]
deploy:
# Only deploy if a push to main
if: github.ref_name == 'main' && github.event_name == 'push'
runs-on: ubuntu-latest
needs: [lint, build]

# # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
# permissions:
# pages: write
# id-token: write
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write
id-token: write

# environment:
# name: github-pages
# url: ${{ steps.deployment.outputs.page_url }}
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

# timeout-minutes: 60
timeout-minutes: 60

# steps:
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v2
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
uses: actions-rs/cargo@v1
with:
command: test
args: -p succinct-core --release
args: -p curta-core --release
env:
RUSTFLAGS: -Copt-level=3 -Cdebug-assertions -Coverflow-checks=y -Cdebuginfo=0
RUST_LOG: 1
Expand Down
202 changes: 101 additions & 101 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The first performant, 100% open-source, contributor-friendly zero-knowledge virt

![](assets/curta.svg)

Curta is inspired by the open-source software movement and takes a collaborative approach towards building the best zkVM for rollups, coprocessors and other ZKP applications. We envision a diversity of contributors integrating the latest ZK innovations, creating a zkVM that is *performant*, *customizable* and will stand the *test of time*. **We invite the community to join us in this ambitious journey to build an open-source public good to democratize access to programmable truth.**
Curta is inspired by the open-source software movement and takes a collaborative approach towards building the best zkVM for rollups, coprocessors and other ZKP applications. We envision a diversity of contributors integrating the latest ZK innovations, creating a zkVM that is *performant*, *customizable* and will stand the *test of time*.

**[Install](https://getcurta.succinct.xyz)**
| [Docs]()
Expand Down Expand Up @@ -37,7 +37,7 @@ cd program && cargo prove build

Generate and verify the execution of the binary:
```
cd script && cargo run --release
cd script && RUSTFLAGS="-C target-cpu=native" cargo run --release
```

Note that the `RUST_LOG` and `RUST_TRACER` enviroment variables can be set to different status levels to get more fine-grained logging and debugging information.
Expand All @@ -46,7 +46,7 @@ Note that the `RUST_LOG` and `RUST_TRACER` enviroment variables can be set to di

If you want to build the `cargo-prove` CLI from source, run the following commands:
```
git clone ssh://[email protected]/succinctlabs/vm
git clone ssh://[email protected]/succinctlabs/curta
cd vm
cd cli
cargo install --locked --path .
Expand All @@ -72,6 +72,6 @@ Note that if you use `cargo prove new` inside a monorepo, you will need to add t

We would like to acknowledge the projects below whose previous work has been instrumental in making this project a reality.

- [Plonky3](https://github.com/Plonky3/Plonky3): The Succinct zkVM's prover is powered by the Plonky3 toolkit.
- [Valida](https://github.com/valida-xyz/valida): The Succinct zkVM cross-table lookups, prover, and chip design, including constraints, are inspired by Valida.
- [RISC0](https://github.com/risc0/risc0): The Succinct zkVM rust toolchain, install/build scripts, and our RISCV runtime borrow code from RISC0.
- [Plonky3](https://github.com/Plonky3/Plonky3): The Curta zkVM's prover is powered by the Plonky3 toolkit.
- [Valida](https://github.com/valida-xyz/valida): The Curta zkVM cross-table lookups, prover, and chip design, including constraints, are inspired by Valida.
- [RISC0](https://github.com/risc0/risc0): The Curta zkVM rust toolchain, install/build scripts, and our RISCV runtime borrow code from RISC0.
299 changes: 137 additions & 162 deletions assets/curta.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description = "A book on all things Reth"

[output.html]
theme = "book/theme"
git-repository-url = "https://github.com/succinctlabs/vm"
git-repository-url = "https://github.com/succinctlabs/curta"
default-theme = "ayu"
no-section-label = true

Expand Down
12 changes: 6 additions & 6 deletions book/generating-proofs/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ We recommend that during development of large programs (> 1 million cycles) that
Instead, you should have your script only execute the program with the RISC-V runtime and read `stdout`. Here is an example:

```rust,noplayground
use succinct_core::{SuccinctProver, SuccinctStdin, SuccinctVerifier};
use curta_core::{CurtaProver, CurtaStdin, CurtaVerifier};
// The ELF file with the RISC-V bytecode of the program from above.
const ELF: &[u8] = include_bytes!("../../program/elf/riscv32im-succinct-zkvm-elf");
fn main() {
let mut stdin = SuccinctStdin::new();
let mut stdin = CurtaStdin::new();
let n = 5000u32;
stdin.write(&n);
let mut stdout = SuccinctProver::execute(ELF, stdin).expect("execution failed");
let mut stdout = CurtaProver::execute(ELF, stdin).expect("execution failed");
let a = stdout.read::<u32>();
let b = stdout.read::<u32>();
Expand Down Expand Up @@ -46,16 +46,16 @@ SAVE_DISK_THRESHOLD=64 SHARD_SIZE=2097152 RUST_LOG=info RUSTFLAGS='-C target-cpu

#### Blake3 on ARM machines

Blake3 on ARM machines requires using the `neon` feature of `succinct-core`. For examples in the the succinct-core repo, you can use:
Blake3 on ARM machines requires using the `neon` feature of `curta-core`. For examples in the the curta-core repo, you can use:

```rust,noplayground
SHARD_SIZE=2097152 RUST_LOG=info RUSTFLAGS='-C target-cpu=native' cargo run --release --features neon
```

Otherwise, make sure to include the "neon" feature when importing `succinct-zkvm` in your `Cargo.toml`:
Otherwise, make sure to include the "neon" feature when importing `curta-zkvm` in your `Cargo.toml`:

```toml,noplayground
succinct-core = { git = "ssh://[email protected]/succinctlabs/vm.git", features = [ "neon" ] }
curta-core = { git = "ssh://[email protected]/succinctlabs/curta.git", features = [ "neon" ] }
```

## Logging and Tracing Information
Expand Down
Loading

0 comments on commit f2fbf89

Please sign in to comment.