mirror of git://holbrook.no/eth-monitor.git
39 lines
2.3 KiB
Plaintext
39 lines
2.3 KiB
Plaintext
.TH eth-monitor 1
|
||
|
||
.SH NAME
|
||
eth-monitor \- Cache, index and monitor transactions with an EVM node rpc
|
||
|
||
.SH SYNOPSIS
|
||
.SY eth-monitor
|
||
[ --skip-history ] [ --single ] [ p \fIeth_provider\fP ] [ --includes-file \fIfile\fP ]
|
||
.YS
|
||
.SY eth-monitor
|
||
[ --skip-history ] [ --single ] [ p \fIeth_provider\fP ] [ --excludes-file \fIfile\fP ] [ --include-default ]
|
||
.YS
|
||
|
||
|
||
.SH DESCRIPTION
|
||
.P
|
||
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.
|
||
|
||
.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. Sync behavior is controlled using the \fB--offset\fP, \fB--until\fP and \fB--head\fP options. \fBSee EXAMPLES\fP on sync example usage.
|
||
.P
|
||
Processing is done by python modules implementing a filter interface. Filter modules are specified by the \fB--filter\fP option, which can be defined multiple times. See \fBDEFINING FILTERS\fP for details.
|
||
.P
|
||
Each chain spec persists its own sync state. E.g. if a historical sync between blocks 100 and 200 was executed against chain \fIevm:foo:42:bar\fP and halted at block 150, then next execution will resume at this block height. The state of which filters were executed for the last transaction processed is also kept. The \fB--single\fP option can be used to override this behavior. See \fBSYNCING\fP below for more details.
|
||
.P
|
||
.P
|
||
By default, no transactions are matched, and input and output addresses to match against transactions need to be explicitly specified. This behavior can be reversed with the \fB--include-default\fP option. Addresses to match are defined using the \fB--input\fP and \fB--output\fP options, and/or by file using the \fB--includes-file\fP and \fB--excludes-file\fP options. Addresses specified multiple times will be deduplicated.
|
||
.P
|
||
Every transaction matched will cause the a copy of that transaction and its block to be stored to the cache. In some cases, it may be desirable to store all blocks and/or transactions, and only use address matches for display and/or filters. \fB--store-tx-data\fP and \fB--store-block-data\fP provides this function.
|
||
|
||
|
||
.SS OPTIONS
|