Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

feat(docs): Updated documentation with node/service requirements #204

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/architecture/requirements.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: page
title: Requirements
permalink: /requirements
---

{% raw %}
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.3.0/dist/mermaid.min.js"></script>
{% 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`).
1 change: 1 addition & 0 deletions docs/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down