Merge branch 'main' into hosted/cdk-pp-docs-review-env

Author: mitchpolygon

docs/agglayer/overview.md

@@ -12,23 +12,22 @@ The AggLayer currently connects chains built with Polygon CDK, a developer toolk
 Here's a list of chains connected to the alpha version of the AggLayer:
 
 
-| Polygon IP Partner | Chain Partner | L2 Chain ID | Network Name            |
+| Implementation Provider | Chain Name | L2 Chain ID |Network Name           |
 | ------------------ | ------------- | ----------- | ----------------------- |
 | Startale Labs      | Astar         | 6038361     | zKyoto                  |
 | Startale Labs      | Astar         | 3776        | Astar zkEVM             |
 | Gateway FM         | GPT Protocol  | 1511670449  | gpt-mainnet             |
 | Gateway FM         | Haust         | 1570754601  | haust-testnet           |
-| Gateway FM         | Haust         | 999         | haust-network           |
+| Gateway FM         | Haust         | 938        | haust-network           |
 | Gateway FM         | Lumia         | 1952959480  | Lumia Testnet           |
 | Gateway FM         | Lumia         | 994873017   | prism                   |
 | Gateway FM         | Moonveil      | 1297206718  | moonveil-testnet        |
-| OKX                | OKX           | 195         | X Layer Devnet          |
 | OKX                | OKX           | 196         | X Layer                 |
 | Gateway FM         | Silicon       | 1722641160  | silicon-sepolia-testnet |
 | Gateway FM         | Silicon       | 2355        | silicon-zk              |
-| Gateway FM         | WilderWorld   | 1668201165  | zchain-testnet          |
-| Gateway FM         | Wirex         | 407985408   | wirex-pay-devnet        |
+| Gateway FM         | WilderWorld   | 1668201165  | zchain-testnet          |  
 | Gateway FM         | Wirex         | 31415       | pay-chain               |
+| Gateway FM         | Witness       | 1702448187  | witnesschain            |
 
 ## AggLayer components
 

docs/cdk/architecture/cdk-pp-highlevel-arch.md

@@ -1,19 +1,17 @@
-# CDK Chain (PP) High-Level Architecture
+The figure below depicts a simplified, high level view of the CDK PP chain architecture, as well as the flow of transactions through the system.
 
-The figure below depicts a simplified, high-level view of the CDK chain architecture using pessimistic proofs and the flow of transactions through the system.
+![Figure: CDK PP Architecture](../../img/cdk/CDK-pessimistic-proof-chain.jpg)
 
-![Figure: CDK Architecture](../../img/cdk/CDK-pessimistic-proof-chain.jpg)
+## Transaction flow
 
-## Transaction Flow
-
-Here is a step-by-step flow of transactions starting from when users submit transactions up to when the transactions are settled in L1:
+Here is a step by step flow of transactions starting from when users submit transactions up to when the transactions are settled in L1.
 
 1. A user connects to the chain via a CDK Erigon RPC node and submits a transaction.
 2. CDK Erigon RPC node sends the transaction data to the transaction-pool manager.
 3. The transaction-pool manager proxies all transaction data to the CDK Erigon sequencer.
-4. CDK Erigon sequencer executes transactions, puts the transactions in blocks, and the blocks fill up batches.
-5. Any CDK Erigon RPC node syncs transaction data from the CDK Erigon sequencer.
-6. AggSender gets batch data from the CDK Erigon sequencer, uses the data to generate certificates, and submits the certificates to the AggLayer RPC.
-7. The AggLayer RPC checks the validity of the certificates against the transaction data in the CDK Erigon RPC node.
-8. After validating the certificates, the AggLayer RPC sends a request to generate a proof, together with the necessary data (including the certificates), to the SP1 prover.
-9. Once the proof is received from the SP1 prover, the AggLayer RPC sends it to L1.
+4. CDK Erigon sequencer executes transactions, puts the transactions in blocks, and the blocks fill up batches. 
+5. CDK Erigon sequencer syncs all transaction data with any CDK Erigon RPC node.
+6. AggSender gets batch data from the CDK Erigon sequencer, uses the data to generate certificates, and submits the certificates to the JSON-RPC API.
+7. The JSON-RPC API checks validity of the certificates against the transaction data in the CDK Erigon RPC node.
+8. After validating the certificates, the JSON-RPC API sends a request to generate a proof, together with the necessary data (including the certificates), to the SP1 prover. 
+9. Once the proof is received from the SP1 prover, the JSON-RPC API sends it to L1.

docs/cdk/concepts/bridging.md

@@ -26,7 +26,7 @@ Chains that integrate with the unified bridge can benefit from the network effec
 
 This option is suited to chains that want a standard bridging experience and do not require customization of the bridge's operation. The shared bridge is also not directly managed by the chain operator, instead, it shares the governance outlined in the [admin upgradeability](./admin-upgradeability.md) section.
 
-![Unified bridge](../../img/cdk/unified-bridge.png)
+![unified bridge](https://github.com/0xPolygon/polygon-docs/blob/254d7d70a0596a1244122e006e62c4c34c9fbec4/docs/img/cdk/high-level-architecture/unified-bridge-rev.png)
 
 ## Further reading
 

docs/cdk/getting-started/cli-tool.md

@@ -23,13 +23,13 @@ Here, you need to provide the CDK node configuration file and the genesis file f
 Usage: `cdk <COMMAND>`
 
 Commands:
-* `node` - Run the cdk-node with the provided configuration
-* `erigon` - Run cdk-erigon node with the provided default configuration
-* `versions` - Output the corresponding versions of the components
-* `help`    Print this message or the help of the given subcommand(s)
+- `node` - Run the cdk-node with the provided configuration
+- `erigon` - Run cdk-erigon node with the provided default configuration
+- `versions` - Output the corresponding versions of the components
+- `help`    Print this message or the help of the given subcommand(s)
 
 Options:
-* `-h, --help` - Print help
+- `-h, --help` - Print help
 
 ### `cdk node`
 
@@ -38,16 +38,23 @@ To run cdk-node use the `node` subcommand with one of the options mentioned belo
 Usage: `cdk node [OPTIONS]`
 
 Options:
-* `-C, --config <CONFIG>` - The path to the configuration file [env: `CDK_CONFIG_PATH=`]
-* `-c, --components <COMPONENTS>` - Components to run [env: `CDK_COMPONENTS=`]
-* `-h, --help` - Print help
+- `-C, --config <CONFIG>` - The path to the configuration file [env: `CDK_CONFIG_PATH=`]
+- `-c, --components <COMPONENTS>` - Components to run [env: `CDK_COMPONENTS=`]
+- `-h, --help` - Print help
 
-Example:
+Example to run in FEP mode:
 
 ```
 cdk node --config /etc/cdk/cdk-node-config.toml --components sequence-sender,aggregator
 ```
 
+Example to run in PP mode:
+
+```
+cdk node --config /etc/cdk/cdk-node-config.toml --components rpc,aggsender
+```
+
+
 ### `cdk erigon`
 
 You can run a cdk-erigon RPC node that syncs to an existing chain using the default parameters.
@@ -57,9 +64,13 @@ This subcommand is intended for quickly spinning up an RPC node or testing exist
 Usage: `cdk erigon [OPTIONS]`
 
 Options:
-* `-C, --config <CONFIG>` - The path to the configuration file [env: `CDK_CONFIG_PATH=`]
-* `-g, --chain <CHAIN>` - The path to a chain specification file [env: `CDK_GENESIS_PATH=`]
-* `-h, --help` - Print help
+- `-C, --config <CONFIG>` - The path to the cdk-node configuration file [env: `CDK_CONFIG_PATH=`]
+- `-g, --chain <CHAIN>` - The path to the genesis.json file [env: `CDK_GENESIS_PATH=`]
+- `-h, --help` - Print help
+
+```
+cdk erigon --config /etc/cdk/cdk-node-config.toml --chain genesis.json
+```
 
 ```
 cdk erigon --config /etc/cdk/cdk-node-config.toml --chain genesis.json
@@ -74,7 +85,7 @@ To print the corresponding versions of the components, run the following command
 Usage: `cdk versions`
 
 Options:
-* `-h, --help` - Print help
+- `-h, --help` - Print help
 
 Example:
 

docs/cdk/getting-started/local-deployment.md

@@ -31,7 +31,23 @@ And, optionally, for submitting transactions and interacting with the environmen
 - [jq](https://stedolan.github.io/jq/)
 - [polyon-cli](https://github.com/0xPolygon/polygon-cli)
 
-## Set up the Kurtosis environment
+## Quick setup
+
+After installing the requirements you can launch a CDK chains with a oneliner:
+
+### Pesimistic Proof
+
+```
+kurtosis run --enclave cdk --args-file "https://raw.githubusercontent.com/0xPolygon/kurtosis-cdk/refs/heads/main/.github/tests/fork12-pessimistic.yml" github.com/0xPolygon/kurtosis-cdk
+```
+
+### FEP
+
+```
+kurtosis run --enclave cdk github.com/0xPolygon/kurtosis-cdk
+```
+
+## Extended Kurtosis environment setup
 
 ### Understanding the deployment steps
 
@@ -64,13 +80,13 @@ It defines the following steps for the deployment process:
 
 You can customize (or skip) any of the numbered steps by modifying the logic in the respective files.
 
-#### 2. [`params.yml`](https://github.com/0xPolygon/kurtosis-cdk/blob/main/params.yml) 
+#### 2. [`input_parser.star`](https://github.com/0xPolygon/kurtosis-cdk/blob/main/input_parser.star)
 
-The `params.yml` file defines the parameters of the chain and the deployment process. 
+The `input_parser.star` file defines the default parameters of the chain and the deployment process. 
 
 It includes configurations for simple parameters such as the chain ID and more complex configurations such as the gas token smart contract address.
 
-You can modify each of these parameters to customize the chain to your specific needs.
+To customize the chain to your specific needs you need to create a new configuration file in your desired path, for example: `./params.yml`
 
 ## Run the chain locally
 
@@ -102,20 +118,35 @@ You can modify each of these parameters to customize the chain to your specific
 
       ```
 
-The default deployment includes `cdk-erigon` as the sequencer, and `cdk-node` functioning as the sequence sender and aggregator. 
+The default deployment it's a **Full Execution Proofs** setup that includes `cdk-erigon` as the sequencer, and `cdk-node` functioning as the sequence sender and aggregator.
 
 You can verify the default versions of these components and the default fork ID by reviewing `input_parser.star`. You can check the default versions of the deployed components and the default fork ID by looking at `input_parser.star`.
 
 3. Customize the chain
 
-To make customizations to the CDK environment, clone this repo, make any desired configuration changes, and then run:
+To make customizations to the CDK environment create a kurtosis configuration file with your desired environment, for example:
+
+### Configure a CDK Sovereign chain
+
+```yaml
+args:
+  consensus_contract_type: pessimistic
+  sequencer_type: erigon
+  erigon_strict_mode: false
+  agglayer_prover_sp1_key: REDACTED
+  enable_normalcy: true
+```
+
+Save this config to `params.yml` file, and then run:
 
 ```sh
 # Delete all stop and clean all currently running enclaves
 kurtosis clean --all
 
+
+
 # Run this command from the root of the repository to start the network
-kurtosis run --enclave cdk .
+kurtosis run --enclave cdk --args-file ./params.yml github.com/0xPolygon/kurtosis-cdk
 ```
 
 4. Inspect the chain