eth-monitor-import.1 (6781B)
1 .TH eth-monitor-import 1 2 3 4 .SH NAME 5 eth-monitor-import \- Import transaction data from an indexing service 6 7 8 .SH SYNOPSIS 9 .SY eth-monitor-import 10 [ -i \fIchain_spec\fP] [ --api-key-file \fIfile\fp ] [ --address-file \fIfile\fP ] [ -a \fIaddress\fP ... ] [ --cache-dir \fIdirectory\fP ] \fIservice\fP 11 12 13 .SH DESCRIPTION 14 Use an indexing service to retrieve transaction hashes for one or more addresses. Supported services may be listed using the \fB--list-services\fP option. 15 .P 16 Which addresses to retrieve data for may be defined by the \fB-a\fP \fIaddress\fP option. Alternatively, the \fB--address-file\fP \fIfile\fP option may be used, where addresses are supplied from the given file as a comma-separated list. The address matching mechanism used in transaction processing is the same as for \fBeth-monitor(1)\fP. 17 .P 18 Only block and transaction hashes are used from the indexing service. The RPC endpoint will be used to retrieve the block and transaction data. 19 .P 20 If \fB--cache-dir\fP \fIdirectory\fP is defined, data will be cached to the given path using the same caching filter as \fBeth-monitor(1)\fP. \fB--store-tx-data\fP and \fB--store-block-data-\fP define whether also transaction and block data is stored to cache, respectively. 21 22 23 .SS OPTIONS 24 25 .TP 26 \fB-0\fP 27 Omit newline to output 28 29 .TP 30 \fB--address-file \fI\fIfile 31 \fP\fP 32 Load address include matching rules from file. Addresses must be given as a comma-separated list. 33 34 .TP 35 \fB-c \fI\fIconfig_dir\fP\fP, \fB--config \fI\fIconfig_dir\fP\fP 36 Load configuration files from given directory. All files with an .ini extension will be loaded, of which all must contain valid ini file data. 37 38 .TP 39 \fB--dumpconfig \fI\fIformat\fP\fP 40 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. 41 42 .TP 43 \fB--env-prefix\fP 44 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. 45 46 .TP 47 \fB--height\fP 48 Block height at which to query state for. Does not apply to transactions. 49 50 .TP 51 \fB-i \fI\fIchain_spec\fP\fP, \fB--chain-spec \fI\fIchain_spec\fP\fP 52 Chain specification string, in the format <engine>:<fork>:<chain_id>:<common_name>. Example: "evm:london:1:ethereum". Overrides the \fIRPC_CREDENTIALS\fP configuration setting. 53 54 .TP 55 \fB--list-services \fI\fI 56 \fP\fP 57 List all supported services. 58 59 .TP 60 \fB-n \fI\fInamespace\fP\fP, \fB--namespace \fI\fInamespace\fP\fP 61 Load given configuration namespace. Configuration will be loaded from the immediate configuration subdirectory with the same name. 62 63 .TP 64 \fB--no-logs\fP 65 Turn of logging completely. Negates \fB-v\fP and \fB-vv\fP 66 67 .TP 68 \fB-p\fP, \fB--rpc-provider\fP 69 Fully-qualified URL of RPC provider. Overrides the \fIRPC_PROVIDER\fP configuration setting. 70 71 .TP 72 \fB--raw\fP 73 Produce output most optimized for machines. 74 75 .TP 76 \fB--rpc-batch-limit\fP 77 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. 78 79 .TP 80 \fB--rpc-dialect\fP 81 RPC backend dialect. If specified it \fImay\fP help with encoding and decoding issues. Overrides the \fIRPC_DIALECT\fP configuration setting. 82 83 .TP 84 \fB--socks-host \fI\fIhost 85 \fP\fP 86 Connect through the specified socks4a host (e.g. tor) 87 88 .TP 89 \fB--socks-port \fI\fIport 90 \fP\fP 91 Connect through the specified socks4a host port (e.g. tor) 92 93 .TP 94 \fB--store-block-data \fI\fI 95 \fP\fP 96 Store block data in cache for matching transactions. Requires \fB--cache-dir\fP. 97 98 .TP 99 \fB--store-tx-data \fI\fI 100 \fP\fP 101 Store transaction data in cache for matching transactions. Requires \fB--cache-dir\fP. 102 103 .TP 104 \fB-u\fP, \fB--unsafe\fP 105 Allow addresses that do not pass checksum. 106 107 .TP 108 \fB-v\fP 109 Verbose. Show logs for important state changes. 110 111 .TP 112 \fB-vv\fP 113 Very verbose. Show logs with debugging information. 114 115 .SH CONFIGURATION 116 117 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. 118 119 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. 120 121 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: 122 123 .EX 124 [foo] 125 bar_baz = xyzzy 126 .EE 127 128 In the \fBENVIRONMENT\fP section below, the relevant configuration settings for this tool is listed along with a short description of its meaning. 129 130 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. 131 132 .SH ENVIRONMENT 133 134 135 .TP 136 \fICHAIN_SPEC\fP 137 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. 138 139 .TP 140 \fIRPC_BATCH_LIMIT\fP 141 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. 142 143 .TP 144 \fIRPC_DIALECT\fP 145 Enables translations of EVM node specific formatting and response codes. 146 147 .TP 148 \fIRPC_PROVIDER\fP 149 Fully-qualified URL to the RPC endpoint of the blockchain node. 150 151 .SH LICENSE 152 153 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International license. 154 155 The source code of the tool this documentation describes is licensed under the GNU General Public License 3.0. 156 157 .SH COPYRIGHT 158 159 Louis Holbrook <dev@holbrook.no> (https://holbrook.no) 160 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001 161 162 163 164 .SH SOURCE CODE 165 166 https://git.defalsify.org 167 168 .SH SEE ALSO 169 170 eth-monitor (1)