4
0
mirror of git://holbrook.no/eth-monitor.git synced 2024-11-30 06:46:46 +01:00
eth-monitor/man/eth-monitor.head.groff

34 lines
1.2 KiB
Plaintext
Raw Normal View History

2022-02-25 15:23:38 +01:00
.TH eth-monitor 1
.SH NAME
eth-monitor \- Cache, index and monitor transactions with an EVM node rpc
.SH SYNOPSIS
2022-02-25 16:30:01 +01:00
.SY eth-monitor
2022-03-03 18:27:19 +01:00
[ --skip-history ] [ --single ] [ p \fIeth_provider\fP ] [ --includes-file \fIfile\fP ] [ -i chain_spec ]
2022-02-25 16:30:01 +01:00
.YS
.SY eth-monitor
2022-03-03 18:27:19 +01:00
[ --skip-history ] [ --single ] [ p \fIeth_provider\fP ] [ --excludes-file \fIfile\fP ] [ --include-default ] [ -i chain_spec ] 
2022-02-25 16:30:01 +01:00
.YS
2022-02-25 15:23:38 +01:00
.SH DESCRIPTION
2022-02-25 16:30:01 +01:00
The \fBeth-monitor\fP has fulfills three distinct but related functions:
.IP
1. A customizable view of on transactions of interest.
.IP
2. A block and transaction cache.
.IP
3. Arbitrary code executions using a transaction (and its block) as input.
2022-02-25 15:23:38 +01:00
.P
Using an EVM RPC endpoint, the \fBeth-monitor\fP tool will retrieve blocks within a given range and provides arbitrary processing of each transaction.
2022-02-25 15:23:38 +01:00
.P
A collection of options is provided to control the behavior of which block ranges to sync, which criteria to use for display and cache, and what code to execute for matching transactions. Details on each topic can be found in the \fBSYNCING\fP, \fBMATCHING ADDRESSES\fP and \fBDEFINING FILTERS\fP sections below, respectively.
2022-02-25 15:23:38 +01:00
.P
Example executions of the tool can be found in the \fBEXAMPLES\fP section.
2022-02-25 15:23:38 +01:00
.P
.SS OPTIONS