chainlib-eth

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

eth-wait.1 (5024B)


      1 .TH eth-wait 1
      2 
      3 .SH NAE
      4 eth-wait \- Wait for a transaction to be confirmed on network
      5 
      6 .SH SYNOPSIS
      7 \fBeth-wait\fP [ -p \fIrpc_provider\fP ] \fItransaction_hash\fP ... 
      8 
      9 .SH DESCRIPTION
     10 .P
     11 Blocks until network confirmation for the transactions are returned from \fIrpc_provider\fP.
     12 .P
     13 By default, if execution of the transaction failed on the network, the command will cause an error. This behavior can be adjusted using the \fB--ignore\fP or \fB--ignore-all\fP option.
     14 .P
     15 A transaction hash unknown to the \fIrpc_provider\fP will also cause an error.
     16 
     17 .SS OPTIONS
     18 
     19 .TP
     20 \fB-c \fI\fIconfig_dir\fP\fP, \fB--config \fI\fIconfig_dir\fP\fP
     21 Load configuration files from given directory. All files with an .ini extension will be loaded, of which all must contain valid ini file data.
     22 
     23 .TP
     24 \fB--dumpconfig \fI\fIformat\fP\fP
     25 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.
     26 
     27 .TP
     28 \fB--env-prefix\fP
     29 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.
     30 
     31 .TP
     32 \fB--height\fP
     33 Block height at which to query state for. Does not apply to transactions.
     34 
     35 .TP
     36 \fB--ignore \fI\fItx_hash
     37 \fP\fP
     38 Ignore error from the specified transaction. May be defined more than once.
     39 
     40 .TP
     41 \fB--ignore-all \fI\fI
     42 \fP\fP
     43 Ignore errors from all transactions.
     44 
     45 .TP
     46 \fB-n \fI\fInamespace\fP\fP, \fB--namespace \fI\fInamespace\fP\fP
     47 Load given configuration namespace. Configuration will be loaded from the immediate configuration subdirectory with the same name.
     48 
     49 .TP
     50 \fB--no-logs\fP
     51 Turn of logging completely. Negates \fB-v\fP and \fB-vv\fP
     52 
     53 .TP
     54 \fB-p\fP, \fB--rpc-provider\fP
     55 Fully-qualified URL of RPC provider. Overrides the \fIRPC_PROVIDER\fP configuration setting.
     56 
     57 .TP
     58 \fB--rpc-auth\fP
     59 RPC endpoint authentication method, e.g. how to handle a HTTP WWW-Authenticate header. Overrides the \fIRPC_AUTH\fP configuration setting.
     60 
     61 .TP
     62 \fB--rpc-credentials\fP
     63 RPC endpoint authentication data. Format depends on the authentication method defined in \fB--rpc-auth\fP. Overrides the \fIRPC_CREDENTIALS\fP configuration setting.
     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_AUTH\fP
    107 Authentication method to use for the \fIRPC_PROVIDER\fP. Currently only \fIbasic\fP is supported.
    108 
    109 .TP
    110 \fIRPC_CREDENTIALS\fP
    111 Authentication credentials to use for \fIRPC_AUTH\fP. For \fIbasic\fP authentication the value must be given as \fI<user>:<pass>\fP.
    112 
    113 .TP
    114 \fIRPC_DIALECT\fP
    115 Enables translations of EVM node specific formatting and response codes.
    116 
    117 .TP
    118 \fIRPC_PROVIDER\fP
    119 Fully-qualified URL to the RPC endpoint of the blockchain node.
    120 
    121 .SH LICENSE
    122 
    123 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International license.
    124 
    125 The source code of the tool this documentation describes is licensed under the GNU General Public License 3.0.
    126 
    127 .SH COPYRIGHT
    128 
    129 Louis Holbrook <dev@holbrook.no> (https://holbrook.no)
    130 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001
    131 
    132 
    133 
    134 .SH SOURCE CODE
    135 
    136 https://git.defalsify.org
    137 
    138 
    139 .SH SEE ALSO
    140 
    141 .BP
    142 confini-dump(1), eth-keyfile(1)
    143