|
1 | | -## Deploy CDK locally |
| 1 | +--- |
| 2 | +comments: true |
| 3 | +--- |
2 | 4 |
|
3 | | -This guide walks you through the process of setting up and deploying a layer 2 blockchain on your local machine using the Polygon CDK with [Kurtosis](https://docs.kurtosis.com/). |
| 5 | +This guide walks you through the process of setting up and deploying a layer 2 CDK blockchain on your local machine. |
4 | 6 |
|
5 | | -The components run in Docker containers. |
| 7 | +The [Polygon CDK Kurtosis package](https://github.com/0xPolygon/kurtosis-cdk/) allows you to easily customize and instantiate all the components of a CDK chain. It uses the [Kurtosis](https://docs.kurtosis.com/) tool to orchestrate the setup of the chain components in Docker containers, with logic defined in [Starlark](https://github.com/bazelbuild/starlark) scripts (a Python dialect) which define the step-by-step process of setting up the chain. |
| 8 | + |
| 9 | +!!! tip |
| 10 | + Check out the [Polygon Kurtosis docs](https://github.com/0xPolygon/kurtosis-cdk) for more documentation on this stack and how to use it, and if you need to raise an issue or have a question for the team. |
6 | 11 |
|
7 | 12 | ## Prerequisites |
8 | 13 |
|
9 | 14 | ### Hardware |
10 | 15 |
|
11 | | -- A Linux-based operating system (or [WSL](https://learn.microsoft.com/en-us/windows/wsl/about)). |
12 | | -- Minimum 8GB RAM and 2-core CPU. |
13 | | -- An AMD64 architecture system. |
| 16 | +- Linux-based OS (or [WSL](https://learn.microsoft.com/en-us/windows/wsl/about)). |
| 17 | +- Minimum 8GB RAM/2-core CPU. |
| 18 | +- AMD64 architecture. |
14 | 19 |
|
15 | 20 | ### Software |
16 | 21 |
|
17 | 22 | - [Docker Engine](https://docs.docker.com/engine/) version 4.27 or higher. |
18 | 23 | - [Kurtosis CLI](https://docs.kurtosis.com/install/) |
19 | 24 | - [Foundry](https://book.getfoundry.sh/getting-started/installation) |
| 25 | + |
| 26 | +And for submitting transactions and interacting with the environment once set up: |
| 27 | + |
20 | 28 | - [yq](https://github.com/mikefarah/yq) |
21 | 29 | - [jq](https://stedolan.github.io/jq/) |
22 | | -- [polycli](https://github.com/maticnetwork/polygon-cli) to help submit transactions and interact with the environment. |
| 30 | +- [polyon-cli](https://github.com/maticnetwork/polygon-cli) |
23 | 31 |
|
24 | 32 | ## Set up the Kurtosis environment |
25 | 33 |
|
26 | | -The [Polygon CDK Kurtosis package](https://github.com/0xPolygon/kurtosis-cdk/) allows you to easily customize and instantiate all the components of a CDK chain. It uses the [Kurtosis](https://docs.kurtosis.com/) tool to orchestrate the setup of the chain components in Docker containers, with logic defined in [Starlark](https://github.com/bazelbuild/starlark) scripts (a Python dialect) that define the step-by-step process of setting up the chain. |
27 | | - |
28 | 34 | ### Clone the repository |
29 | 35 |
|
30 | | -To get started, clone the repository and navigate to the `kurtosis-cdk` directory: |
31 | | - |
32 | 36 | ```bash |
33 | 37 | git clone https://github.com/0xPolygon/kurtosis-cdk.git |
34 | 38 | cd kurtosis-cdk |
35 | 39 | ``` |
36 | 40 |
|
37 | 41 | ### Check your environment |
38 | 42 |
|
39 | | -Ensure Docker is running on your machine, then run the following command to confirm that all prerequisites are installed: |
| 43 | +Run the `tool_check.sh` script to confirm you have all the prerequisite software. |
40 | 44 |
|
41 | | -```bash |
42 | | -sh scripts/tool_check.sh |
| 45 | +You may need to make the script executable: `chmod +x scripts/tool_check.sh` |
| 46 | + |
| 47 | +```sh |
| 48 | +./scripts/tool_check.sh |
43 | 49 | ``` |
44 | 50 |
|
45 | 51 | If everything is installed correctly, you should see the following output: |
|
0 commit comments