The Agglayer (Aggregation layer) provides a common language for secure, atomic, interoperability among heterogeneous chains. (WIP)
- Overview
- Repository Structure
- Prerequisites
- Installation
- Modifying and building the Aggchain Proof
- Development
- Support
- Resources
- License
Agglayer is the Rust-based service designed to:
- Receive updates from Agglayer-connected chains
- Verify their validity
- Send them to the L1 for final settlement.
To find out more about Agglayer, please visit the more detailed documentation.
Warning
- Some of the content in this section discusses technology in development and not ready for release. As such, all APIs and configuration are subject to change. The code is still being audited, so please contact the Polygon team if you would like to use it in production.
The crates and their functions within the Agglayer repo are as follows:
TODO
Before working with the repository, you’ll need the following:
You’ll need to submit a unique Ethereum address to Succinct for access to their proving network. To get access:
- Follow the instructions here to use Foundry to generate a new private key or retrieve an existing one.
- Apply for access for the public address associated with your private key to Succinct Network here.
- Rustup (stable)
- protoc
- nextest
- cargo-make
- cargo-insta
- Go
With SP1, you do not need to generate proofs locally on your machine.
However, if you’d like to run a prover locally (not recommended), you’ll need roughly 40-50GB of available RAM.
To install the Agglayer provers repository, please run the following:
git clone https://github.com/agglayer/provers
cd proversTo build Agglayer provers locally, please run:
cargo buildTo execute the test suite, please run the following:
cargo nextest run --workspaceBy default, the committed pre-compiled ELF binary is used.
Modifications in proof code will not be automatically reflected in the binary.
We use docker-based deterministic build to compile the proof.
Therefore, docker has to be present on the system for the build to work if rebuild is enabled.
The following command rebuilds the Aggchain proof and.
It requires cargo-make to be installed:
cargo make ap-elfThis option makes the standard commands like cargo build, cargo run etc. rebuild the proof automatically any time it changes as if it were a normal part of the build.
It is enabled by setting the AGGLAYER_ELF_BUILD environment variable to update.
export AGGLAYER_ELF_BUILD=updateNote: Rust suppresses the output of build scripts by default.
As a result, the build may appear stuck on the aggchain-proof-builder crate while the proof is being rebuilt.
In the update mode, the proof will be rebuilt and the cached ELF will be updated.
There is also the build mode which leaves the cached ELF intact.
It is mostly useful for debugging, the update is more suitable for regular development.
To get automatic rebuilds by default, set the variable in the shell init script.
The proof binary to use is uniquely identified by a vkey selector on the L1.
The selector is derived from the major version of the aggchain-proof-program package.
This version must be bumped between releases / deployments.
Contributions are very welcomed, the guidelines are currently not available (WIP)
Feel free to open an issue if you have any feature request or bug report.
Copyright (c) 2024 PT Services DMCC
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
The SPDX license identifier for this project is MIT OR Apache-2.0.