chainlib-eth

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

eth-balance.1 (3349B)


      1 .TH eth-balance 1
      2 
      3 .SH NAME
      4 eth-balance \- Get network gas token balance for an address
      5 
      6 .SH SYNOPSIS
      7 \fBeth-balance\fP [ -p \fIrpc_provider\fP ] \fIaddress\fP
      8 
      9 .SH DESCRIPTION
     10 .P
     11 Query the network for the gas token balance of an account.
     12 .P
     13 The balance will be returned as an integer value denominated in the gas unit.
     14 
     15 
     16 .SS OPTION
     17 
     18 .TP
     19 \fB-0\fP
     20 Omit newline to output
     21 
     22 .TP
     23 \fB-a\fP, \fB --address\fP
     24 Address to get balance for.
     25 
     26 .TP
     27 \fB-c \fI\fIconfig_dir\fP\fP, \fB--config \fI\fIconfig_dir\fP\fP
     28 Load configuration files from given directory. All files with an .ini extension will be loaded, of which all must contain valid ini file data.
     29 
     30 .TP
     31 \fB--dumpconfig \fI\fIformat\fP\fP
     32 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.
     33 
     34 .TP
     35 \fB--env-prefix\fP
     36 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.
     37 
     38 .TP
     39 \fB-n \fI\fInamespace\fP\fP, \fB--namespace \fI\fInamespace\fP\fP
     40 Load given configuration namespace. Configuration will be loaded from the immediate configuration subdirectory with the same name.
     41 
     42 .TP
     43 \fB--no-logs\fP
     44 Turn of logging completely. Negates \fB-v\fP and \fB-vv\fP
     45 
     46 .TP
     47 \fB--raw\fP
     48 Produce output most optimized for machines.
     49 
     50 .TP
     51 \fB-v\fP
     52 Verbose. Show logs for important state changes.
     53 
     54 .TP
     55 \fB-vv\fP
     56 Very verbose. Show logs with debugging information.
     57 
     58 .SH CONFIGURATION
     59 
     60 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.
     61 
     62 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.
     63 
     64 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:
     65 
     66 .EX
     67 [foo]
     68 bar_baz = xyzzy
     69 .EE
     70 
     71 In the \fBENVIRONMENT\fP section below, the relevant configuration settings for this tool is listed along with a short description of its meaning.
     72 
     73 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.
     74 
     75 
     76 .SH LICENSE
     77 
     78 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International license.
     79 
     80 The source code of the tool this documentation describes is licensed under the GNU General Public License 3.0.
     81 
     82 .SH COPYRIGHT
     83 
     84 Louis Holbrook <dev@holbrook.no> (https://holbrook.no)
     85 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001
     86 
     87 
     88 
     89 .SH SOURCE CODE
     90 
     91 https://git.defalsify.org
     92 
     93 
     94 .SH SEE ALSO
     95 
     96 .BP
     97 confini-dump(1), eth-keyfile(1)
     98