Polygon AggKit

Polygon AggKit is a modular framework that developers can use to build and deploy Pessimistic Proofs enabled chains (TBD).

Getting Started

Pre-requisites

Setup Kurtosis following these instructions: Kurtosis CDK Getting Started

Local Testing

• You can run locally against kurtosis-cdk environment using: docs/local_debug.md

Build locally

You can locally build a production release of AggKit CLI + AggKit with:

make build

Run locally

You can build and run a debug release locally using:

cargo run

It will build and run both binaries.

Running with Kurtosis

1. Run your kurtosis environment
2. build cdk-erigon and make it available in your system's PATH
3. Run scripts/local_config
4. cargo run -- --config ./tmp/aggkit/local_config/test.kurtosis.toml --chain ./tmp/aggkit/local_config/genesis.json erigon

Contributing

Contributions are very welcomed, the guidelines are currently not available (WIP)

Support

Feel free to open an issue if you have any feature request or bug report.

License

Polygon AggKit Copyright (c) 2024 PT Services DMCC

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.