eth-monitor

Monitor and cache ethereum transactions with match filters
git clone git://git.defalsify.org/eth-monitor.git
Info | Log | Files | Refs | README | LICENSE

eth-monitor-list.1 (6392B)


      1 .TH eth-monitor-list 1
      2 
      3 
      4 .SH NAME
      5 eth-monitor-list \- Query transactions cache
      6 
      7 
      8 .SH SYNOPSIS
      9 .SY eth-monitor-list
     10 [ -i \fIchain_spec\fP ] [ p \fIeth_provider\fP ] [ -a \fIaddress\fP ... ] \fIcache_dir\fP
     11 .YS
     12 
     13 
     14 .SH DESCRIPTION
     15 List transactions stored in cache matching the given address.
     16 .P
     17 Any block data and/or transaction data matchin the relevant hashes returned by the query will be used to create the output. The \fB--fresh\fP option may be defined to force all block and transaction data from the RPC provider endpoint instead.
     18 .P
     19 For details on rendering and filtering, please refer to to \fBeth-monitor (1)\fP man page.
     20 
     21 
     22 .SS OPTIONS
     23 
     24 .TP
     25 \fB-0\fP
     26 Omit newline to output
     27 
     28 .TP
     29 \fB--address \fI\fIaddress
     30 \fP\fP
     31 Add an address of interest to match any role. Complements \fB--address-file\fP.
     32 
     33 .TP
     34 \fB-c \fI\fIconfig_dir\fP\fP, \fB--config \fI\fIconfig_dir\fP\fP
     35 Load configuration files from given directory. All files with an .ini extension will be loaded, of which all must contain valid ini file data.
     36 
     37 .TP
     38 \fB--dumpconfig \fI\fIformat\fP\fP
     39 Output configuration settings rendered from environment and inputs. Valid arguments are \fIini\fP for ini file output, and \fIenv\fP for environment variable output. See \fBCONFIGURATION\fP.
     40 
     41 .TP
     42 \fB--env-prefix\fP
     43 Environment prefix for variables to overwrite configuration. Example: If \fB--env-prefix\fP is set to \fBFOO\fP then configuration variable \fBBAR_BAZ\fP would be set by environment variable \fBFOO_BAZ_BAR\fP. Also see \fBENVIRONMENT\fP.
     44 
     45 .TP
     46 \fB--filter \fI\fImodule
     47 \fP\fP
     48 Add code execution filter to all matching transactions. The argument must be a python module path. Several filters may be added by supplying the option multiple times. Filters will be executed in the order the options are given. See \fBDEFINING FILTERS\fP section of \fBeth-monitor (1)\fP for more details.
     49 
     50 .TP
     51 \fB--fresh \fI\fI
     52 \fP\fP
     53 Only use hashes from cache, and retrieve all block and transaction data from RPC endpoint.
     54 
     55 .TP
     56 \fB--height\fP
     57 Block height at which to query state for. Does not apply to transactions.
     58 
     59 .TP
     60 \fB-i \fI\fIchain_spec\fP\fP, \fB--chain-spec \fI\fIchain_spec\fP\fP
     61 Chain specification string, in the format <engine>:<fork>:<chain_id>:<common_name>. Example: "evm:london:1:ethereum". Overrides the \fIRPC_CREDENTIALS\fP configuration setting.
     62 
     63 .TP
     64 \fB-n \fI\fInamespace\fP\fP, \fB--namespace \fI\fInamespace\fP\fP
     65 Load given configuration namespace. Configuration will be loaded from the immediate configuration subdirectory with the same name.
     66 
     67 .TP
     68 \fB--no-logs\fP
     69 Turn of logging completely. Negates \fB-v\fP and \fB-vv\fP
     70 
     71 .TP
     72 \fB-p\fP, \fB--rpc-provider\fP
     73 Fully-qualified URL of RPC provider. Overrides the \fIRPC_PROVIDER\fP configuration setting.
     74 
     75 .TP
     76 \fB--raw\fP
     77 Produce output most optimized for machines.
     78 
     79 .TP
     80 \fB--renderer \fI\fImodule
     81 \fP\fP
     82 Add output renderer filter to all matching transactions. The argument must be a python module path. Several renderers may be added by supplying the option multiple times. See \fBRENDERERS\fP section of \fBeth-monitor (1)\fP for more details.
     83 
     84 .TP
     85 \fB--rpc-batch-limit\fP
     86 Set number of RPC requests that can be set to the RPC provider as a batch request. This is made available through settings to any request builder implementing batch requests. A value of 1 means no batch will be used. A value of 0 indicates that the limit is not relevant. Any other positive value signals the maximum number of requests to be batched together. Overrides the \fIRPC_BATCH_LIMIT\fP configuration setting.
     87 
     88 .TP
     89 \fB--rpc-dialect\fP
     90 RPC backend dialect. If specified it \fImay\fP help with encoding and decoding issues. Overrides the \fIRPC_DIALECT\fP configuration setting.
     91 
     92 .TP
     93 \fB-u\fP, \fB--unsafe\fP
     94 Allow addresses that do not pass checksum.
     95 
     96 .TP
     97 \fB-v\fP
     98 Verbose. Show logs for important state changes.
     99 
    100 .TP
    101 \fB-vv\fP
    102 Very verbose. Show logs with debugging information.
    103 
    104 .SH CONFIGURATION
    105 
    106 All configuration settings may be overriden both by environment variables, or by overriding settings with the contents of ini-files in the directory defined by the \fB-c\fP option.
    107 
    108 The active configuration, with values assigned from environment and arguments, can be output using the \fB--dumpconfig\fP \fIformat\fP option. Note that entries having keys prefixed with underscore (e.g. _SEQ) are not actual configuration settings, and thus cannot be overridden with environment variables.
    109 
    110 To refer to a configuration setting by environment variables, the \fIsection\fP and \fIkey\fP are concatenated together with an underscore, and transformed to upper-case. For example, the configuration variable \fIFOO_BAZ_BAR\fP refers to an ini-file entry as follows:
    111 
    112 .EX
    113 [foo]
    114 bar_baz = xyzzy
    115 .EE
    116 
    117 In the \fBENVIRONMENT\fP section below, the relevant configuration settings for this tool is listed along with a short description of its meaning.
    118 
    119 Some configuration settings may also be overriden by command line options. Also note that the use of the \fB-n\fP and \fB--env-prefix\fP options affect how environment and configuration is read. The effects of options on how configuration settings are affective is described in the respective \fBOPTIONS\fP section.
    120 
    121 .SH ENVIRONMENT
    122 
    123 
    124 .TP
    125 \fICHAIN_SPEC\fP
    126 String specifying the type of chain connected to, in the format \fI<engine>:<fork>:<network_id>:<common_name>\fP. For EVM nodes the \fIengine\fP value will always be \fIevm\fP.
    127 
    128 .TP
    129 \fIRPC_BATCH_LIMIT\fP
    130 Set number of RPC requests that can be set to the RPC provider as a batch request. This is made available through settings to any request builder implementing batch requests. A value of 1 means no batch will be used. A value of 0 indicates that the limit is not relevant. Any other positive value signals the maximum number of requests to be batched together.
    131 
    132 .TP
    133 \fIRPC_DIALECT\fP
    134 Enables translations of EVM node specific formatting and response codes.
    135 
    136 .TP
    137 \fIRPC_PROVIDER\fP
    138 Fully-qualified URL to the RPC endpoint of the blockchain node.
    139 
    140 .SH LICENSE
    141 
    142 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International license.
    143 
    144 The source code of the tool this documentation describes is licensed under the GNU General Public License 3.0.
    145 
    146 .SH COPYRIGHT
    147 
    148 Louis Holbrook <dev@holbrook.no> (https://holbrook.no)
    149 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001
    150 
    151 
    152 
    153 .SH SOURCE CODE
    154 
    155 https://git.defalsify.org
    156 
    157 .SH SEE ALSO
    158 
    159 eth-monitor (1)