Merge branch 'main' of https://github.com/0xPolygon/polygon-docs into cdk/native-gas-token

kmurphypolygon · kmurphypolygon · commit a5b9dccfe6e4 · 2024-03-08T09:57:48.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ node_modules/
 .DS_Store
 **/.DS_Store
 *.iml
+temp_dir/
diff --git a/docs/cdk/architecture/cdk-validium.md b/docs/cdk/architecture/cdk-validium.md
diff --git a/docs/cdk/architecture/cdk-zkevm.md b/docs/cdk/architecture/cdk-zkevm.md
diff --git a/docs/cdk/get-started/deploy-rollup/intro.md b/docs/cdk/get-started/deploy-rollup/intro.md
@@ -1,7 +1,9 @@
-This quick start takes you through the process of deploying a full CDK zkRollup, EVM-compatible network on Goerli.
+This tutorial takes you through the process of deploying a full CDK zkRollup, EVM-compatible network on Goerli.
+
+It relies on specific component versions so we have hidden most of the configuration complexity in scripts to make the process straightforward.
 
 !!! warning
-    - These instructions are subject to frequent updates as the software remains at an early development stage.
+    - The tutorial is for learning purposes only and is not intended to describe a latest stable version build.
     - Report any content issues on our docs repo: https://github.com/0xPolygon/polygon-docs
 
 The process is split into the following sections:
diff --git a/docs/cdk/get-started/deploy-validium/intro.md b/docs/cdk/get-started/deploy-validium/intro.md
@@ -2,9 +2,11 @@
 comments: true
 ---
 
-This guide takes you through the process of deploying a fully EVM-compatible, CDK validium on the Sepolia network.
+This tutorial takes you through the process of deploying a fully EVM-compatible, CDK validium on the Sepolia network.
 
-We have hidden most of the configuration complexity in scripts to make the process straightforward and easy to follow.
+It relies on specific component versions so we have hidden most of the configuration complexity in scripts to make the process straightforward and easy to follow.
+
+The tutorial is for learning only and is not intended to describe a latest stable version build.
 
 ## Process steps
 
diff --git a/docs/cdk/how-to/integrate-agglayer.md b/docs/cdk/how-to/integrate-agglayer.md
@@ -0,0 +1,78 @@
+Polygon AggLayer is a web service that receives zero-knowledge proofs from different CDK chains and checks their soundness before sending the proof to L1 for verification.
+
+!!! warning
+    - The AggLayer is in development and subject to architectural changes.
+    - The code is still being audited.
+
+## Prerequisites
+
+Make sure you have the following software installations.
+
+- [Docker](https://docs.docker.com/engine/install/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+- [Golang](https://go.dev/doc/install)
+- [GCloud cli](https://cloud.google.com/sdk/docs/install) - production only.
+
+### Clone the repo.
+
+```sh
+git clone https://github.com/0xPolygon/agglayer.git
+cd agglayer/
+```
+
+## Set up and installation
+
+### Local
+
+Run the following command to bring up a zkEVM node, a prover, and a mock L1 network.
+
+```sh
+make run-docker
+```
+
+### Production
+
+!!! warning
+    - Currently only one instance of the AggLayer can run at one time.
+    - The AggLayer should, therefore, automatically start in the case of failure using a containerized setup or an OS level service manager/monitoring system.
+
+Install the Golang dependencies.
+
+```sh
+go install .
+```
+
+#### Key-signing configurations
+
+Install polygon-cli:
+
+```sh
+go install github.com/maticnetwork/polygon-cli@latest
+```
+
+Create a new signature:
+
+```sh
+polygon-cli signer create --kms GCP --gcp-project-id gcp-project --key-id mykey-tmp
+```
+
+Set up ADC in GCloud:
+
+```sh
+gcloud auth application-default login
+```
+
+In the `../agglayer/docker/data/agglayer.toml` file, add the `KMSKeyName` from GCloud.
+
+## Setting up the AggLayer
+
+Each CDK chain requires a corresponding RPC node configuration that is synced with the target CDK. This node checks the state root after executions of L2 batches.
+
+!!! info "Storage recommendations"
+    - Use a durable HA PostgresDB for storage; ideally AWS Aurora PostgreSQL or Cloud SQL for PostgreSQL in GCP.
+
+Add the chain configurations to the `../agglayer/docker/data/agglayer.toml` file by amending the following details to add the required chain(s).
+
+* Configure `[FullNodeRPCs]` to point to the corresponding L2 full node.
+* Configure `[L1]` to point to the corresponding L1 chain.
+* Configure the `[DB]` section with the managed database details.
diff --git a/docs/cdk/resources/third-party-guides.md b/docs/cdk/resources/third-party-guides.md
@@ -3,7 +3,7 @@ hide:
 - toc
 ---
 
-This page is a catalogue of third-party and partner quick starts and guides that explain how to spin up and deploy validium and rollup CDK stacks, and more.
+This page links to full guides that some of [our solution providers](https://ecosystem.polygon.technology/spn/explore/?search=&competency=All&chain=All) have developed, including quick starts and guides that explain how to spin up and deploy validium and rollup CDK stacks.
 
 <div class="grid-container">
    <div class="grid-item">
@@ -26,3 +26,4 @@ This page is a catalogue of third-party and partner quick starts and guides that
    </div>
 </div>
 
+Check out the [solution provider page]((https://ecosystem.polygon.technology/spn/explore/?search=&competency=All&chain=All)) to see more info on our partners.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -58,7 +58,7 @@ nav:
         - Quickstart: 
           - Validium: cdk/get-started/quickstart-validium.md
           - Rollup: cdk/get-started/quickstart-rollup.md
-        - Deploy:
+        - Deployment tutorials:
           - Validium: 
               - Introduction: cdk/get-started/deploy-validium/intro.md
               - Deploy contracts:
@@ -83,12 +83,13 @@ nav:
               - Start services: cdk/get-started/deploy-rollup/start-services.md
         - Connect to CDK testnet: cdk/get-started/connect-testnet.md
       - How to:
+        - Integrate the AggLayer: cdk/how-to/integrate-agglayer.md
         - Quickly test a running stack: cdk/how-to/quick-test-stack.md
         - Manage allowlists with policies: cdk/how-to/manage-policies.md
         - Use a native token: cdk/how-to/use-native-token.md
       - Architecture:
-        - CDK rollup option: cdk/architecture/cdk-zkevm-option.md
-        - CDK validium option: cdk/architecture/cdk-validium-option.md
+        - CDK rollup: cdk/architecture/cdk-zkevm.md
+        - CDK validium: cdk/architecture/cdk-validium.md
       - Specification:
         - Validium vs rollup: cdk/spec/validium-vs-rollup.md
       - Concepts:
