Skip to content
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

RELEASE ENVIRONMENT: DO NOT MERGE #1562

Closed
wants to merge 38 commits into from
Closed

RELEASE ENVIRONMENT: DO NOT MERGE #1562

wants to merge 38 commits into from

Conversation

kmurphypolygon
Copy link
Contributor

@kmurphypolygon kmurphypolygon commented Oct 1, 2024

Hosted url: docs-dev.polygon.technology/1562
This PR maintains a hosted environment for all the CDK FEP docs.

Document PR or draft doc Test env link (or prod if published)
CDK rollback feature https://www.notion.so/polygontechnology/How-to-run-Rollback-Batches-11480500116a806f918fcf6536a2b10e n/a
CDK overview #1586 https://docs-dev.polygon.technology/1562/cdk/overview/
Local deployment guide Please open a PR as changes are live https://docs.polygon.technology/cdk/getting-started/local-deployment/
CDK erigon overview Please open a PR as changes are live https://docs.polygon.technology/cdk/getting-started/cdk-erigon/
High level architecture #1563 https://docs-dev.polygon.technology/1562/cdk/architecture/high-level-views/
zkEVM vs CDK components #707 https://docs-dev.polygon.technology/1562/cdk/releases/stack-components/
DAC integration doc todo: todo:
CLI doc #1592 https://docs-dev.polygon.technology/1562/cdk/cdk-cli-tool/
CDK repos Please open a PR as changes are live https://docs.polygon.technology/cdk/resources/cdk-repo-reference/
CDK production deployment guide https://www.notion.so/polygontechnology/DRAFT-CDK-Production-deployment-guide-11580500116a800cb2f6d7edb57900b4 n/a
Migrate from 9->12 todo: todo:

@kmurphypolygon kmurphypolygon changed the title CDK: Hosted environment to showcase the CDK FEP docs CDK: Hosted environment to showcase the CDK FEP docs: NOT TO BE MERGED Oct 1, 2024
@kmurphypolygon kmurphypolygon changed the title CDK: Hosted environment to showcase the CDK FEP docs: NOT TO BE MERGED RELEASE ENVIRONMENT: CDK: Hosted environment to showcase the CDK FEP docs: NOT TO BE MERGED Oct 8, 2024
Copy link

sonarcloud bot commented Oct 8, 2024


- Modularity: CDK modular components allow developers to easily customize their L2 environment and build a chain that meets their specific needs.
The power of zero-knowledge technology is seen in enabling chains to achieve trustless finality, where chain users do not have to dependent on a few individuals to confirm finality of their transactions.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The power of zero-knowledge technology is seen in enabling chains to achieve trustless finality, where chain users do not have to dependent on a few individuals to confirm finality of their transactions.
The power of zero-knowledge technology is seen in enabling chains to achieve trustless finality, where chain users do not have to be dependent on a few individuals to confirm finality of their transactions.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I close this suggestion please @vcastellm and you could review instead the PR for the overview: #1586

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see the suggestions are in the PR now :)

@kmurphypolygon kmurphypolygon changed the title RELEASE ENVIRONMENT: CDK: Hosted environment to showcase the CDK FEP docs: NOT TO BE MERGED RELEASE ENVIRONMENT: DO NOT MERGE Oct 8, 2024
@kmurphypolygon kmurphypolygon marked this pull request as draft October 8, 2024 10:30
@Stefan-Ethernal
Copy link

WDYT about moving the img/cdk folder to the cdk folder and creating the img folder there instead?


!!! important

For specific release tags, please reference the [version matrix document](https://www.notion.so/polygontechnology/version-matrix.md).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this URL for the version matric document publicly available? I wasn't able to open it, so probably double-check is the URL correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doc shouldn't be in this environment. Apologies.

| Prover | [zkevm-prover](https://github.com/0xPolygonHermez/zkevm-prover) | [zkevm-prover](https://github.com/0xPolygonHermez/zkevm-prover) | Same code for both - wip |
| Data streamer | [zkevm-data-streamer](https://github.com/0xPolygon/zkevm-data-streamer) | [zkevm-data-streamer](https://github.com/0xPolygon/zkevm-data-streamer) | Same code for both |
| DA Layer | None | [cdk-data-availability](https://github.com/0xPolygon/cdk-data-availability) | |
| Contracts | [zkevm-contracts](https://github.com/0xPolygonHermez/zkevm-contracts) | [zkevm-contracts](https://github.com/0xPolygonHermez/zkevm-contracts) | Same code for both: 8.0.0-rc.2-fork.12 |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to specify the exact version of the contracts, since we are not doing so for the other components (for that purpose, we have the version compatibility matrix AFAIK).

Suggested change
| Contracts | [zkevm-contracts](https://github.com/0xPolygonHermez/zkevm-contracts) | [zkevm-contracts](https://github.com/0xPolygonHermez/zkevm-contracts) | Same code for both: 8.0.0-rc.2-fork.12 |
| Contracts | [zkevm-contracts](https://github.com/0xPolygonHermez/zkevm-contracts) | [zkevm-contracts](https://github.com/0xPolygonHermez/zkevm-contracts) | Same code for both |

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...this doc slipped in by accident and shouldn't be here. Apologies.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WDYT?

  • Consider adding some labels to the arrows between the Bridge service and the Agglayer components as well as the ZKEVM contracts and the Agglayer components.
  • The cli probably should be linked with the other components in the system (otherwise we can probably remove it).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding these to my notes 👍

- Engineers use a CLI tool to manage the backend components, installing and initializing various modes of operation, such as validium versus rollup for example.
- The CDK Erigon RPC sends transactions to the CDK Erigon sequencer which sequences transactions batches.
- The CDK Erigon sequencer puts the transaction batches into the data streamer.
- The data streamer streams data to the sequencer sender (validium mode) and the aggregator.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that (validium mode) can be removed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding to my notes, closing this PR now

- The CDK Erigon sequencer puts the transaction batches into the data streamer.
- The data streamer streams data to the sequencer sender (validium mode) and the aggregator.
- The sequencer sender sequences batches into the L1 smart contract domain and persists data into DAC nodes for validium mode operations.
- The aggregator sends batches to the prover and receives proofs in return. It then aggregates the proofs into batches before submitting them to the L1 domain.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to Agglayer

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @joanestebanr I'll add this to my notes, thank you :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we will say to AggLayer in the next release but will check.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joanestebanr shouldn't we say it as ?
The aggregator sends batches to the prover and receives proofs in return. It then aggregates the proofs into batches before submitting them to the Agglayer or L1 depending on the chosen settlement layer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add your comments to the respective PR. I will make a note of this suggestion.

@joanestebanr
Copy link

In Local deployment guide document:

  • Kurtosis AFAIK is working with a mockProver, so to use a real one need changes and change also the required machine to run

@kmurphypolygon
Copy link
Contributor Author

WDYT about moving the img/cdk folder to the cdk folder and creating the img folder there instead?

Hi Stefan, thanks for the question. Actually we house all images in the one folder and the reason for that is in case we ever had a lot of non-textual content, maybe videos, etc we might take the decision to host it externally, for example, and it would be easy to implement.

@kmurphypolygon
Copy link
Contributor Author

In Local deployment guide document:

  • Kurtosis AFAIK is working with a mockProver, so to use a real one need changes and change also the required machine to run

We're leaving the mock prover in for the local start up guide. The production guide will have more details on connecting a real prover.

@kmurphypolygon kmurphypolygon deleted the hosted/cdk-fep branch October 17, 2024 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants