From 942a07cdadf354215bb9b2db20a6dc1c165d4c81 Mon Sep 17 00:00:00 2001 From: epociask Date: Sat, 10 Feb 2024 01:18:05 -0500 Subject: [PATCH] feat(docs): Updated documentation with node/service requirements --- docs/architecture/requirements.markdown | 21 +++++++++++++++++++++ docs/index.markdown | 1 + 2 files changed, 22 insertions(+) create mode 100644 docs/architecture/requirements.markdown diff --git a/docs/architecture/requirements.markdown b/docs/architecture/requirements.markdown new file mode 100644 index 00000000..4bedd2b3 --- /dev/null +++ b/docs/architecture/requirements.markdown @@ -0,0 +1,21 @@ +--- +layout: page +title: Requirements +permalink: /requirements +--- + +{% raw %} + +{% endraw %} + +## Overview +The following service dependencies are required for running a pessimism instance: + +### L1 Node +An ethereum json rpc node (e.g, go-ethereum, reth) is required for reading and syncing from recent chain state. It is best recommended to use an archival node if you're running any heuristic sessions that requires more than the last 128 blocks. Otherwise full node syncing should be sufficient assuming you're starting the application at most recent block state. + +### L2 Node +An OP Stack execution node (i.e, op-reth, op-geth) is required for reading and syncing from recent chain state. It is best recommended to use an archival node if you're running any heuristic sessions that requires more than the last 128 blocks. Otherwise full node syncing should be sufficient assuming you're starting the application at most recent block state. + +### OP Indexer +The [OP Indexer](https://github.com/ethereum-optimism/optimism/tree/develop/indexer) is used as a stateful dependency for ingesting key native bridge metadata (i.e, L2 -> L1 withdrawals, supply counts). This is only required if you'd like native bridge heuristic support (`withdrawal_enforcement`, `supply_enforcement`). diff --git a/docs/index.markdown b/docs/index.markdown index 285e3121..b8109d4e 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -11,6 +11,7 @@ Detect real-time threats on Op-stack compatible chains - [ETL Subsystem](../pessimism/architecture/etl) - [Engine Subsystem](../pessimism/architecture/risk-engine) - [Alerting Subsystem](../pessimism/architecture/alerting) +- [Requirements][../pessimism/requirements] - [API Swaggerdoc](swaggerdoc.html) - [Heuristic Documentation](../pessimism/heuristics) - [Telemetry Documentation](../pessimism/telemetry)