CDK PP Docs Review Env: DO NOT MERGE!!! #2459
Conversation
EmpieichO
changed the title
Adding new doc: `pp-intro.components.md`
Adding "Pessimistic proofs" to nav
|
Hi @sshrihar I have created a Dev Env here https://docs-dev.polygon.technology/2459 Can you tell me why clicking on the /cdk/Pessismistic proofs/ throws a 404 ? |
Fixing filename ref in nav pp-intro-components.md --> pp-intro.components.md
Remove DAC component
fixing indentation
Update resources.md in the cdk-erigon docs
Add CDK PP high level architecture doc
Update CLI Tool doc
I tried accessing the url and it redirected me to https://docs-dev.polygon.technology/2459/cdk/releases/pp-intro.components/ |
| | Node = RPC and sequencer | [cdk-erigon](https://github.com/0xPolygonHermez/cdk-erigon) | Customizable, commonly:<br/>\- Sequencer = 1 node<br/>\- RPC = multiple nodes | | ||
| | Contracts | <a href=https://github.com/0xPolygonHermez/zkevm-contracts>zkevm-contracts</a> | | | ||
| | CLI | [cdk](https://github.com/0xPolygon/cdk) | Included in [CDK](https://github.com/0xPolygon/cdk) repo | | ||
| | AggSender | <a href=https://github.com/0xPolygon/cdk>cdk</a> | Included in [CDK](https://github.com/0xPolygon/cdk) repo | |
There was a problem hiding this comment.
The AggSender is just a sub-component of the cdk client. I think that we should be talking about cdk client or cdk node more in the doc... Although it's ok to specify that the AggSender is the specific sub-component that sends the certs to the AL. But note that the AggSender works in conjunction with other sub-components of the cdk such as the bridge syncer and others...
| - AggSender is the CDK PP component that accumulates all necessary info in order to generate certificates, which are sent to the SP1 prover via the JSON-RPC API for the generation of pessimistic proofs. | ||
| - Transaction pool manager: For storing transactions submitted by users. | ||
|
|
||
| ### AggLayer-side components |
There was a problem hiding this comment.
It feels a bit odd to have a sub section for AL, and not for CDK
| - `PolygonZkEVMDeployer` | ||
| - `PolygonZkEVMTimelock` | ||
| - CLI tool: A single command line interface tool for abstracting away the complexity of deploying or configuring CDK components. | ||
| - AggSender is the CDK PP component that accumulates all necessary info in order to generate certificates, which are sent to the SP1 prover via the JSON-RPC API for the generation of pessimistic proofs. |
There was a problem hiding this comment.
I don't like the idea of CDK PP. No, there is the cdk. And the cdk happens to be used to give PP functionality, but there is no CDK PP... Again, once we've FEP+PP the same cdk will be used, and in this case we will have the aggsender as well as other components
|
|
||
| We henceforth refer to CDK sovereign chains as CDK PP chains. | ||
|
|
||
| ## CDK PP stack |
There was a problem hiding this comment.
Overall, there is a weird level of detail... We list the CLI, but not the syncers? Most importantly, the aggSender looks like a standalone piece of software, when it's clearly just a functionality of the cdk client. I've been talking with some non Polygon folks and they're super confused with what's the CDK / AggLayer. We need to be very careful on how we articulate this things...
|
|
||
| Unlike in the CDK FEP chain, the prover in a CDK PP chain is not directly connected to the chain. It in fact resides in the AggLayer. | ||
|
|
||
| - JSON-RPC API: A component provided by the AggLayer to interface between the CDK PP chain and the SP1 prover. |
There was a problem hiding this comment.
Wouldnt it be better to talk about AggLayer node similar to the aggsender, the RPC is just a part of the AL node... but for sure avoid JSON-RPC it's extremely confusing, people will think about the API of the Ethereum execution clients when they see this, and it has nothing to do with it
Co-authored-by: Arnau Bennassar <[email protected]>
Co-authored-by: Arnau Bennassar <[email protected]>
Co-authored-by: Arnau Bennassar <[email protected]>
Co-authored-by: Arnau Bennassar <[email protected]>
Co-authored-by: Arnau Bennassar <[email protected]>
|
mitchpolygon
dismissed
arnaubennassar’s stale review
Made almost all of the changes, we can discuss further changes in a new PR -> goal is to get this one live and assess from the staging env.
|
In having password issues. Had someone resolve most of it but seems it still isn't. I'm trying to work on it now but I'm by myself and need time. I don't want to run out of time again before I can get this resolved. Send me discord invite please |
Hosted url: docs-dev.polygon.technology/2459
CDK PP docs review env: DO NOT MERGE!!!
docs/cdk/releases/pp-intro-components.mddocs/cdk/getting-started/cdk-erigon/resources.mddocs/cdk/architecture/cdk-pp-highlevel-arch.mddocs/cdk/getting-started/cli-tool.md