generated from ethereum-optimism/.github
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fixing function documentation and README
- Loading branch information
1 parent
88bb56c
commit fc7037f
Showing
4 changed files
with
26 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Purpose of the Service | ||
faultproof_withdrawals has the following purpose: | ||
- Monitor Withdrawals: The service listens for WithdrawalProven events on the OptimismPortal contract on L1. | ||
- Validate Withdrawals: It verifies the validity of these withdrawals by checking the corresponding state on L2. | ||
- Detect Forgeries: The service identifies and reports any invalid withdrawals or potential forgeries. | ||
|
||
NOTE: Withdrawal monitor is only working against chains Pre-Faultproof. For chains using Faultproof system please check [faultproof_withdrwals service](https://github.com/ethereum-optimism/monitorism/blob/main/op-monitorism/faultproof_withdrawals/README.md) | ||
|
||
```bash | ||
OPTIONS: | ||
--l1.node.url value Node URL of L1 peer Geth node [$WITHDRAWAL_MON_L1_NODE_URL] | ||
--l2.node.url value Node URL of L2 peer Op-Geth node [$WITHDRAWAL_MON_L2_NODE_URL] | ||
--event.block.range value Max block range when scanning for events (default: 1000) [$WITHDRAWAL_MON_EVENT_BLOCK_RANGE] | ||
--start.block.height value Starting height to scan for events (default: 0) [$WITHDRAWAL_MON_START_BLOCK_HEIGHT] | ||
--optimismportal.address value Address of the OptimismPortal contract [$WITHDRAWAL_MON_OPTIMISM_PORTAL] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters