https://github.com/0xpolygon/cdk
CDK Node core repo
https://github.com/0xpolygon/cdk
Last synced: about 1 year ago
JSON representation
CDK Node core repo
- Host: GitHub
- URL: https://github.com/0xpolygon/cdk
- Owner: 0xPolygon
- License: agpl-3.0
- Created: 2024-01-19T09:52:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-08T12:10:25.000Z (over 1 year ago)
- Last Synced: 2024-11-08T12:17:59.378Z (over 1 year ago)
- Language: Go
- Homepage: https://polygon.technology/polygon-cdk
- Size: 59.8 MB
- Stars: 4
- Watchers: 6
- Forks: 5
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
## Polygon CDK
**Polygon CDK** (Chain Development Kit) is a modular framework that developers can use to build and deploy Zero Knowledge Proofs enabled Rollups and Validiums.
The CDK allow to build Rollups that are ZK powered, verifying the execution using the zkEVM prover from Polygon, they can be completelly personalizable because its modullar architecture.
[](https://sonarcloud.io/summary/new_code?id=0xPolygon_cdk)
## Getting Started
## Pre-requisites
Setup Kurtosis following this instructions https://github.com/0xPolygon/kurtosis-cdk?tab=readme-ov-file#getting-started
### Local Testing
- You can run locally against kurtosis-cdk environment using: [docs/local_debug.md](docs/local_debug.md)
### Build locally
You can locally build a production release of CDK CLI + cdk-node 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/cdk/local_config/test.kurtosis.toml --chain ./tmp/cdk/local_config/genesis.json erigon
## Contributing
Contributions are very welcomed, the guidelines are currently not available (WIP)
## Support
Feel free to [open an issue](https://github.com/0xPolygon/cdk/issues/new) if you have any feature request or bug report.
## License
Polygon Chain Development Kit
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 .