-
Notifications
You must be signed in to change notification settings - Fork 391
docs: aggregation mode architecture and setup #2264
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
Open
MarcosNicolau
wants to merge
5
commits into
testnet
Choose a base branch
from
docs-aggregation-mode-2
base: testnet
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7278073
docs: aggregation mode architecture and setup
MarcosNicolau ca1ec69
docs: add setup agg mode locally in summary
MarcosNicolau 4b0caf3
docs: simplified architecure overview
MarcosNicolau 0688d08
docs: consistent arrows
MarcosNicolau a87c021
docs: fix summary
MarcosNicolau File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| # Aligned Infrastructure Deployment Guide | ||
|
|
||
| ## Dependencies | ||
|
|
||
| Ensure you have the following installed: | ||
|
|
||
| - [Rust](https://www.rust-lang.org/tools/install) | ||
| - [Docker](https://docs.docker.com/get-docker/) | ||
| - [Kurtosis](https://docs.kurtosis.com/install/) | ||
|
|
||
| ## Supported Verifiers | ||
|
|
||
| The aggregation mode currently supports the following proving systems: | ||
|
|
||
| - **SP1** - Succinct's zkVM (compressed proofs) | ||
|
|
||
| ## Step-by-Step Setup | ||
|
|
||
| Follow these steps to start the aggregation mode locally using the Ethereum package environment. | ||
|
|
||
| ### 1. Start the Ethereum Package | ||
|
|
||
| Start the local Ethereum network using Kurtosis: | ||
|
|
||
| ```bash | ||
| make ethereum_package_start | ||
| ``` | ||
|
|
||
| This command spins up a local Ethereum network with all necessary components. To stop it run: | ||
|
|
||
| ```bash | ||
| make ethereum_package_rm | ||
| ``` | ||
|
|
||
| ### 2. Start the Gateway | ||
|
|
||
| Start the aggregation mode gateway service: | ||
|
|
||
| ```bash | ||
| make agg_mode_gateway_start_ethereum_package | ||
| ``` | ||
|
|
||
| The gateway handles proof submissions and manages the proof queue. This command also starts the required Docker containers (PostgreSQL) and runs database migrations automatically. | ||
|
|
||
| ### 3. Start the Payments Poller | ||
|
|
||
| In a separate terminal, start the payments poller: | ||
|
|
||
| ```bash | ||
| make agg_mode_payments_poller_start_ethereum_package | ||
| ``` | ||
|
|
||
| The payments poller monitors the blockchain for payment events and updates user quotas accordingly. | ||
|
|
||
| ### 4. Send a Payment (Deposit) | ||
|
|
||
| Deposit funds to get quota for submitting proofs: | ||
|
|
||
| ```bash | ||
| make agg_mode_gateway_send_payment | ||
| ``` | ||
|
|
||
| This deposits funds using a default test account. For custom deposits, you can use the CLI directly. | ||
|
|
||
| ### 5. Submit a Proof | ||
|
|
||
| Submit an SP1 proof to the gateway: | ||
|
|
||
| ```bash | ||
| make agg_mode_gateway_send_sp1_proof | ||
| ``` | ||
|
|
||
| This sends a test SP1 Fibonacci proof to the gateway. | ||
|
|
||
| ### 6. Start the Proof Aggregator | ||
|
|
||
| In a separate terminal, start the proof aggregator: | ||
|
|
||
| ```bash | ||
| AGGREGATOR=sp1 make proof_aggregator_start_ethereum_package | ||
| ``` | ||
|
|
||
| The proof aggregator fetches pending proofs from the database, aggregates them, and submits the aggregated proof on-chain. |
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.