Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #72

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 53 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,54 @@
# op-succinct

Standalone repo to use Kona & SP1 to verify OP Stack blocks.
This repo provides a way to take an OP stack chain & turn it in a full ZK-validity proven chain in < 1 hour by deploying 1 smart contract and spinning up a lightweight "proposer" service that ...

## Overview
Benefits include:...

Read more: [blog post]

Reach out if you're interested in using this in production: ...

## Getting Started

### Use an existing OP stack rollup

* Get an existing OP stack rollup deployed using [...] or with [...].
* Today, we require that the rollup uses Ethereum for DA (blobs or calldata).
* We require that the rollups use `OptimismPortalGatewayV1.sol` (not the V2 of the Gateway, which is for optimistic fault proofs).

### Deploy ZK L2 Output Oracle

Our ZK L2 Output Oracle is a "ZK" version of the L2 Output Oracle used by the V1 version of the OP stack (the non-fault proof version). In particular,...

To deploy it, you can use the following commands in the `contracts` folder of this repo:

```
```

Make sure to set your `.env` with a `PRIVATE_KEY` and ... and following the .env.example.


### Spin up the ZK op-proposer

The next step of the integration

**Get prover network API key**: follow instructions here

### Transfer L2 Output Oracle to ZK L2 Output Oracle

The final step is to ...

### Check it's working

Now you can check that it's working by examining: ...

To troubleshooot you can: ...

## Profiling Cycle Counts

To learn how to estimate cycle counts for a given block range, check out our [Cycle Count Guide](./zkvm-host/CYCLE_COUNT.md).

## Repository Overview

**`crates`**
- `client-utils`: A suite of utilities for the client program.
Expand All @@ -19,13 +65,12 @@ Standalone repo to use Kona & SP1 to verify OP Stack blocks.
first generate proofs for `range` programs for each batch, then use `aggregation` to
generate an aggregate proof.

## Running `op-succinct`
## Acknowlements

For instructions on how to upgrade an OP Stack chain to use ZK validity proofs, refer to the [`op-succinct` Guide](./op-succinct-proposer/TUTORIAL.md).

## Estimating Cycle Counts

To learn how to estimate cycle counts for a given block range, check out our [Cycle Count Guide](./zkvm-host/CYCLE_COUNT.md).
This repo could not exist without:
* Kona
* OP Stack
* SP1

## Open Source

Expand Down
Loading