Skip to content

Commit

Permalink
Clatifications to the Global Event README.md (#74)
Browse files Browse the repository at this point in the history
Fixed some typos and clarified that an option requires a directory and not a file.
  • Loading branch information
yfalcone authored Sep 24, 2024
1 parent f7de161 commit 1cba63b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions op-monitorism/global_events/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ DESCRIPTION:

OPTIONS:
--l1.node.url value Node URL of L1 peer (default: "http://127.0.0.1:8545") [$GLOBAL_EVENT_MON_L1_NODE_URL]
--nickname value Nickname of chain being monitored [$GLOBAL_EVENT_MON_NICKNAME]
--PathYamlRules value Path to the yaml file containing the events to monitor [$GLOBAL_EVENT_MON_PATH_YAML]
--nickname value Nickname of the chain being monitored [$GLOBAL_EVENT_MON_NICKNAME]
--PathYamlRules value Path to the directory containing the yaml files with the events to monitor [$GLOBAL_EVENT_MON_PATH_YAML]
--log.level value The lowest log level that will be output (default: INFO) [$MONITORISM_LOG_LEVEL]
--log.format value Format the log output. Supported formats: 'text', 'terminal', 'logfmt', 'json', 'json-pretty', (default: text) [$MONITORISM_LOG_FORMAT]
--log.color Color the log output if in terminal mode (default: false) [$MONITORISM_LOG_COLOR]
Expand All @@ -36,15 +36,15 @@ OPTIONS:
### Yaml rules
The rules are located here: `op-monitorism/global_events/rules/` then we have multiples folders depending the networks you want to monitore (`mainnet` or `sepolia`) for now.
The rules are located here: `op-monitorism/global_events/rules/`. Then we have multiple folders depending on the networks you want to monitor (`mainnet` or `sepolia`) for now.
```yaml
# This is a TEMPLATE file please copy this one
# This watches all contacts for OP, Mode, and Base mainnets for two logs.
version: 1.0
name: Template SafeExecution Events (Success/Failure) L1 # Please put the L1 or L2 at the end of the name.
priority: P5 # This is a test, so it is a P5
#If addresses is empty like below it will watch all addresses otherwise you can address specific addresses.
#If addresses are empty like below, it will watch all addresses; otherwise, you can address specific addresses.
addresses:
# - 0xbEb5Fc579115071764c7423A4f12eDde41f106Ed # Specific Addresses /!\ We are not supporting EIP 3770 yet, if the address is not starting by 0x, this will panic by safety measure.
events:
Expand Down

0 comments on commit 1cba63b

Please sign in to comment.