chainlib-eth

Ethereum implementation of the chainlib interface
Info | Log | Files | Refs | README | LICENSE

eth-info.1 (4230B)

      1 .TH eth-info 1
      2 
      3 .SH NAME
      4 eth-info - Return key metrics from the current state of the EVM network.
      5 
      6 .SH SYNOPSIS
      7 \fBeth-info\fP [ -p \fIrpc_provider\fP ] [ \fIkey\fP ]
      8 
      9 .SH DESCRIPTION
     10 \fBeth-info\fP reports statistics from the current state of the EVM network:
     11 
     12 .EX
     13 $ eth-info
     14 Block: 1024478
     15 Gas price: 1000000000
     16 .EE
     17 
     18 An individual data item may be specified using the \fIkey\fP positional argument:
     19 
     20 .EX
     21 $ eth-info block
     22 Block: 1024478
     23 $ eth-info --raw gas_price
     24 1000000000
     25 .EE
     26 
     27 .SS OPTIONS
     28 
     29 .TP
     30 \fB-0\fP
     31 Omit newline to output
     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--height\fP
     47 Block height at which to query state for. Does not apply to transactions.
     48 
     49 .TP
     50 \fB-n \fI\fInamespace\fP\fP, \fB--namespace \fI\fInamespace\fP\fP
     51 Load given configuration namespace. Configuration will be loaded from the immediate configuration subdirectory with the same name.
     52 
     53 .TP
     54 \fB--no-logs\fP
     55 Turn of logging completely. Negates \fB-v\fP and \fB-vv\fP
     56 
     57 .TP
     58 \fB-p\fP, \fB--rpc-provider\fP
     59 Fully-qualified URL of RPC provider. Overrides the \fIRPC_PROVIDER\fP configuration setting.
     60 
     61 .TP
     62 \fB--raw\fP
     63 Produce output most optimized for machines.
     64 
     65 .TP
     66 \fB--rpc-dialect\fP
     67 RPC backend dialect. If specified it \fImay\fP help with encoding and decoding issues. Overrides the \fIRPC_DIALECT\fP configuration setting.
     68 
     69 .TP
     70 \fB--seq\fP
     71 Use numeric sequencial jsonrpc query ids. Useful for buggy server implementations who expects such.
     72 
     73 .TP
     74 \fB-u\fP, \fB--unsafe\fP
     75 Allow addresses that do not pass checksum.
     76 
     77 .TP
     78 \fB-v\fP
     79 Verbose. Show logs for important state changes.
     80 
     81 .TP
     82 \fB-vv\fP
     83 Very verbose. Show logs with debugging information.
     84 
     85 .SH CONFIGURATION
     86 
     87 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.
     88 
     89 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.
     90 
     91 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:
     92 
     93 .EX
     94 [foo]
     95 bar_baz = xyzzy
     96 .EE
     97 
     98 In the \fBENVIRONMENT\fP section below, the relevant configuration settings for this tool is listed along with a short description of its meaning.
     99 
    100 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.
    101 
    102 .SH ENVIRONMENT
    103 
    104 
    105 .TP
    106 \fIRPC_DIALECT\fP
    107 Enables translations of EVM node specific formatting and response codes.
    108 
    109 .TP
    110 \fIRPC_PROVIDER\fP
    111 Fully-qualified URL to the RPC endpoint of the blockchain node.
    112 
    113 .SH LICENSE
    114 
    115 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International license.
    116 
    117 The source code of the tool this documentation describes is licensed under the GNU General Public License 3.0.
    118 
    119 .SH COPYRIGHT
    120 
    121 Louis Holbrook <dev@holbrook.no> (https://holbrook.no)
    122 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001
    123 
    124 
    125 
    126 .SH SOURCE CODE
    127 
    128 https://git.defalsify.org
    129 
    130 
    131 .SH SEE ALSO
    132 
    133 .BP
    134 confini-dump(1), eth-keyfile(1)
    135