From 148ab9053fa5fbe8531936e4987b8a1747c9eb2c Mon Sep 17 00:00:00 2001 From: Dr K Murphy Date: Thu, 17 Oct 2024 18:15:43 +0200 Subject: [PATCH 1/3] add migrate tip --- docs/cdk/how-to/migrate/forkid-9-12.md | 3 +++ mkdocs.yml | 1 + 2 files changed, 4 insertions(+) create mode 100644 docs/cdk/how-to/migrate/forkid-9-12.md diff --git a/docs/cdk/how-to/migrate/forkid-9-12.md b/docs/cdk/how-to/migrate/forkid-9-12.md new file mode 100644 index 000000000..a3e6c3f11 --- /dev/null +++ b/docs/cdk/how-to/migrate/forkid-9-12.md @@ -0,0 +1,3 @@ +!!! tip + The migration instructions for moving from fork 9 to fork 12 will be published in the next few weeks. + diff --git a/mkdocs.yml b/mkdocs.yml index 808f64041..ed7332603 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -71,6 +71,7 @@ nav: - Admin upgradeability: cdk/concepts/admin-upgradeability.md - How to: - Migrate: + - Fork id 9 to 12: cdk/how-to/migrate/forkid-9-12.md - Fork id 7 to 9: cdk/how-to/migrate/forkid-7-to-9.md - General guide for partners: cdk/how-to/migrate/fork.md - Create custom native token: cdk/how-to/use-native-token.md From e8c506adc79f79aac83b4bbb92be7826f4777110 Mon Sep 17 00:00:00 2001 From: Dr K Murphy Date: Thu, 17 Oct 2024 18:21:25 +0200 Subject: [PATCH 2/3] remove other pr stuff --- docs/cdk/getting-started/cdk-cli-tool.md | 79 ------------------------ mkdocs.yml | 1 - 2 files changed, 80 deletions(-) delete mode 100644 docs/cdk/getting-started/cdk-cli-tool.md diff --git a/docs/cdk/getting-started/cdk-cli-tool.md b/docs/cdk/getting-started/cdk-cli-tool.md deleted file mode 100644 index 325d42ae2..000000000 --- a/docs/cdk/getting-started/cdk-cli-tool.md +++ /dev/null @@ -1,79 +0,0 @@ -To simplify the process of running and configuring CDK components, Polygon provides a Rust-based CLI tool which is an interface that chain administrators can use to interact with the components. - -This CLI tool is an entry point for chain administrators to access the CDK system. - -## Installation - -As the chain admin, you simply need to download the precompiled [CDK package binaries](https://github.com/0xPolygon/cdk/releases/). - -## Running the CLI tool - -!!! info - - Requirements: - - Get the binaries, packages and docker images published with each release, [here](https://github.com/0xPolygon/cdk/releases/). - -## Commands - -### CDK - -Here, you need to provide the CDK node configuration file and the genesis file for your desired chain. - -Usage: `cdk ` - -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) - -Options: -* `-h, --help` - Print help - -### `cdk node` - -To run cdk-node use the `node` subcommand with one of the options mentioned below. - -Usage: `cdk node [OPTIONS]` - -Options: -* `-C, --config ` - The path to the configuration file [env: `CDK_CONFIG_PATH=`] -* `-c, --components ` - Components to run [env: `CDK_COMPONENTS=`] -* `-h, --help` - Print help - -Example: - -``` -cdk node --config /etc/cdk/cdk-node-config.toml --components sequence-sender,aggregator -``` - -### `cdk erigon` - -You can run a cdk-erigon RPC node that syncs to an existing chain using the default parameters. - -This subcommand is intended for quickly spinning up an RPC node or testing existing chains with default configuration values. In order to fine-tune settings and access all available configuration options, refer to the [full cdk-erigon documentation](../../cdk/getting-started/cdk-erigon/index.md) on Erigon configuration. - -Usage: `cdk erigon [OPTIONS]` - -Options: -* `-C, --config ` - The path to the configuration file [env: `CDK_CONFIG_PATH=`] -* `-g, --chain ` - The path to a chain specification file [env: `CDK_GENESIS_PATH=`] -* `-h, --help` - Print help - -### `cdk versions` - -The above command generates all the required configuration files for cdk-erigon on the fly and runs the node. - -To print the corresponding versions of the components, run the following command: - -Usage: `cdk versions` - -Options: -* `-h, --help` - Print help - -Example: - -``` -cdk erigon --config /etc/cdk/cdk-node-config.toml --chain genesis.json -``` diff --git a/mkdocs.yml b/mkdocs.yml index ed7332603..0715b0db6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,7 +57,6 @@ nav: - Version compatibility matrix: cdk/version-matrix.md - Get started: - Local deployment guide: cdk/getting-started/local-deployment.md - - CLI tool: cdk/getting-started/cdk-cli-tool.md - Concepts: - Layer 2s: cdk/concepts/layer2s.md - L2 architecture overview: cdk/concepts/architecture.md From ad28057a19f4ce94fef6ad63ce865503d7f56da3 Mon Sep 17 00:00:00 2001 From: Dr K Murphy Date: Thu, 17 Oct 2024 18:23:08 +0200 Subject: [PATCH 3/3] add extra --- docs/cdk/how-to/migrate/forkid-9-12.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cdk/how-to/migrate/forkid-9-12.md b/docs/cdk/how-to/migrate/forkid-9-12.md index a3e6c3f11..8d0cd929d 100644 --- a/docs/cdk/how-to/migrate/forkid-9-12.md +++ b/docs/cdk/how-to/migrate/forkid-9-12.md @@ -1,3 +1,3 @@ !!! tip - The migration instructions for moving from fork 9 to fork 12 will be published in the next few weeks. + The migration instructions for moving from fork 9 to fork 12 are coming soon.