diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 55fdcdc8e..5a8c1780b 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -322,8 +322,8 @@ function sidebarHome() { link: "/guides/use-rollkit-cli", }, { - text: "Create genesis for your rollup", - link: "/guides/create-genesis", + text: "Use Ignite to create a Rollkit app", + link: "/guides/ignite-rollkit", }, { text: "Restart your rollup", @@ -337,17 +337,13 @@ function sidebarHome() { text: "Run a rollup full node", link: "/guides/full-node", }, - { - text: "Run a centralized sequencer", - link: "/guides/centralized-sequencer", - }, { text: "CometBFT into a Rollkit app", link: "/guides/cometbft-to-rollkit", }, { - text: "Use Ignite to create a Rollkit app", - link: "/guides/ignite-rollkit", + text: "Create genesis for your rollup", + link: "/guides/create-genesis", }, { text: "Configuration", diff --git a/guides/centralized-sequencer.md b/guides/centralized-sequencer.md deleted file mode 100644 index c2daa5ffa..000000000 --- a/guides/centralized-sequencer.md +++ /dev/null @@ -1,33 +0,0 @@ -### Centralized Sequencer Node - -The `centralized-sequencer` node implements a pluggable centralized sequencer scheme. It can be configured using the following flags: - -| Flag | Usage | Default | -|------------------------------|------------------------------------------------------------------|------------------------------| -| `batch-time` | Time in seconds to wait before generating a new batch | `2` seconds | -| `da_address` | DA address | `http://localhost:26658` | -| `da_auth_token` | Auth token for the DA | `""` | -| `da_namespace` | DA namespace where the sequencer submits transactions | `""` | -| `host` | Centralized sequencer host | `localhost` | -| `port` | Centralized sequencer port | `50051` | -| `listen-all` | Listen on all network interfaces (0.0.0.0) instead of just localhost | disabled | -| `metrics` | Enable Prometheus metrics | disabled | -| `metrics-address` | Address to expose Prometheus metrics | `":8080"` | - -See `centralized-sequencer --help` for details. - -The `centralized-sequencer` node reports Prometheus metrics when the `-metrics` flag is enabled. - -By default, metrics are exported to `http://localhost:8080/metrics`. - -The listening address and port can be configured with the `-metrics-address` flag. - -The following metrics are available: - -| **Name** | **Type** | **Tags** | **Description** | -|-------------------------------------------|-----------|-----------|------------------------------------------------------------------------| -| sequencer_gas_price | Gauge | | Gas price of the DA transaction | -| sequencer_last_blob_size | Gauge | | Last blob size submitted to the DA | -| sequencer_transaction_status | Gauge | | Transaction status of the DA transaction | -| sequencer_num_pending_blocks | Gauge | | Number of blocks pending DA submission | -| sequencer_included_block_height | Gauge | | Block height of the last DA transaction | diff --git a/tutorials/sequencing/centralized.md b/tutorials/sequencing/centralized.md index 15430f8da..426b3b53b 100644 --- a/tutorials/sequencing/centralized.md +++ b/tutorials/sequencing/centralized.md @@ -30,6 +30,8 @@ make build ./build/centralized-sequencer -h ``` +You should see the following output: + ```sh Usage: -host string @@ -50,6 +52,7 @@ Usage: DA namespace where the sequencer submits transactions -db_path string path to the database +... ``` As shown by the help command, a centralized sequencer is configured to serve a rollup (via `rollup_id`). The DA network to persist the sequenced batches are specified using `da_address`, `da_auth_token` and `da_namespace`. @@ -113,6 +116,24 @@ Then after a few blocks you should see this message confirming that your sequenc I[2024-11-15|16:04:07.698] successfully submitted Rollkit headers to DA layer module=BlockManager gasPrice=-1 daHeight=1 headerCount=14 ``` +## Metrics {#metrics} + +The `centralized-sequencer` node reports Prometheus metrics when the `-metrics` flag is enabled. + +By default, metrics are exported to `http://localhost:8080/metrics`. + +The listening address and port can be configured with the `-metrics-address` flag. + +The following metrics are available: + +| **Name** | **Type** | **Tags** | **Description** | +|-------------------------------------------|-----------|-----------|------------------------------------------------------------------------| +| sequencer_gas_price | Gauge | | Gas price of the DA transaction | +| sequencer_last_blob_size | Gauge | | Last blob size submitted to the DA | +| sequencer_transaction_status | Gauge | | Transaction status of the DA transaction | +| sequencer_num_pending_blocks | Gauge | | Number of blocks pending DA submission | +| sequencer_included_block_height | Gauge | | Block height of the last DA transaction | + ## Summary {#summary} By following these steps, you will have successfully set up and connected your chain to the centralized sequencer. You can now start submitting transactions to your chain.