chainlib-eth

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

eth-raw.1 (7965B)


      1 .TH eth-raw 1
      2 
      3 .SH NAME
      4 eth-raw \- Create and send a jsonrpc transaction from signed rlp transaction
      5 
      6 .SH SYNOPSIS
      7 .P
      8 \fBeth-raw\fP [ --deploy ] \fItransaction_data\fP
      9 .P
     10 \fBeth-raw\fP [ -p \fIrpc_provider\fP ] [ --deploy ] -s \fItransaction_data\fP
     11 
     12 
     13 .SH DESCRIPTION
     14 .P
     15 Creates a jsonrpc object from serialized data.
     16 .P
     17 If \fB-y\fP is defined, and \fB--mode\fP is not set, or set to "tx", a \fIeth_sendRawTransaction\fP object will be created.
     18 .P
     19 Otherwise, an \fIeth_call\fP object will be created. The recipient of the call will be the contract specified with \fB-e\fP. If \fB-y\fP has been set, the sender of the query will be the address corresponding to the key file.
     20 .P
     21 If the \fB-s\fP option is added, the jsonrpc object will be sent to the rpc provider. \fBNote\fP If the jsonrpc object is a transaction, this may incur real costs.
     22 .P
     23 See the \fBEXAMPLES\fP section for details on how to use \fBeth-raw\fP with the outputs from \fBeth-gas\fP and \fBeth-encode\fP
     24 
     25 
     26 .SS OPTIONS
     27 
     28 .TP
     29 \fB-0\fP
     30 Omit newline to output
     31 
     32 .TP
     33 \fB-c \fI\fIconfig_dir\fP\fP, \fB--config \fI\fIconfig_dir\fP\fP
     34 Load configuration files from given directory. All files with an .ini extension will be loaded, of which all must contain valid ini file data.
     35 
     36 .TP
     37 \fB--dumpconfig \fI\fIformat\fP\fP
     38 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.
     39 
     40 .TP
     41 \fB-e\fP, \fB--executable-address\fP
     42 Address of an executable code point on the network.
     43 
     44 .TP
     45 \fB--env-prefix\fP
     46 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.
     47 
     48 .TP
     49 \fB--fee-limit\fP
     50 Set the limit of execution units for the transaction. If used with \fB-s\fP this may incur actual network token cost. If \fB--fee-price\fP is not explicitly set, the price \fImay\fP be retrieved from the network, and multiplied with this value to define the cost.
     51 
     52 .TP
     53 \fB--fee-price\fP
     54 Set fee unit price to offer for the transaction. If used with \fB-s\fP this may incur actual network token cost.
     55 
     56 .TP
     57 \fB--height\fP
     58 Block height at which to query state for. Does not apply to transactions.
     59 
     60 .TP
     61 \fB-i \fI\fIchain_spec\fP\fP, \fB--chain-spec \fI\fIchain_spec\fP\fP
     62 Chain specification string, in the format <engine>:<fork>:<chain_id>:<common_name>. Example: "evm:london:1:ethereum". Overrides the \fIRPC_CREDENTIALS\fP configuration setting.
     63 
     64 .TP
     65 \fB-n \fI\fInamespace\fP\fP, \fB--namespace \fI\fInamespace\fP\fP
     66 Load given configuration namespace. Configuration will be loaded from the immediate configuration subdirectory with the same name.
     67 
     68 .TP
     69 \fB--no-logs\fP
     70 Turn of logging completely. Negates \fB-v\fP and \fB-vv\fP
     71 
     72 .TP
     73 \fB--nonce\fP
     74 Explicitly set nonce to use for transaction.
     75 
     76 .TP
     77 \fB-p\fP, \fB--rpc-provider\fP
     78 Fully-qualified URL of RPC provider. Overrides the \fIRPC_PROVIDER\fP configuration setting.
     79 
     80 .TP
     81 \fB--passphrase-file \fI\fIpath\fP\fP
     82 Path to file containing password to unlock key file
     83 
     84 .TP
     85 \fB--raw\fP
     86 Produce output most optimized for machines.
     87 
     88 .TP
     89 \fB--rpc-auth\fP
     90 RPC endpoint authentication method, e.g. how to handle a HTTP WWW-Authenticate header. Overrides the \fIRPC_AUTH\fP configuration setting.
     91 
     92 .TP
     93 \fB--rpc-credentials\fP
     94 RPC endpoint authentication data. Format depends on the authentication method defined in \fB--rpc-auth\fP. Overrides the \fIRPC_CREDENTIALS\fP configuration setting.
     95 
     96 .TP
     97 \fB--rpc-dialect\fP
     98 RPC backend dialect. If specified it \fImay\fP help with encoding and decoding issues. Overrides the \fIRPC_DIALECT\fP configuration setting.
     99 
    100 .TP
    101 \fB-s\fP
    102 Send to network. If set, network state may change. This means tokens may be spent and so on. Use with care. Only applies to transactions.
    103 
    104 .TP
    105 \fB--seq\fP
    106 Use numeric sequencial jsonrpc query ids. Useful for buggy server implementations who expects such.
    107 
    108 .TP
    109 \fB-u\fP, \fB--unsafe\fP
    110 Allow addresses that do not pass checksum.
    111 
    112 .TP
    113 \fB-v\fP
    114 Verbose. Show logs for important state changes.
    115 
    116 .TP
    117 \fB-vv\fP
    118 Very verbose. Show logs with debugging information.
    119 
    120 .TP
    121 \fB-w\fP
    122 Wait for the last transaction to be confirmed on the network. Will generate an error if the EVM execution fails.
    123 
    124 .TP
    125 \fB-ww\fP
    126 Wait for \fIall\fP transactions sequentially to be confirmed on the network. Will generate an error if EVM execution fails for any of the transactions.
    127 
    128 .TP
    129 \fB-y \fI\fIpath\fP\fP, \fB--key-path \fI\fIpath\fP\fP
    130 Path to signing key. Overrides the \fIWALLET_KEY_FILE\fP configuration setting.
    131 
    132 .SH CONFIGURATION
    133 
    134 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.
    135 
    136 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.
    137 
    138 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:
    139 
    140 .EX
    141 [foo]
    142 bar_baz = xyzzy
    143 .EE
    144 
    145 In the \fBENVIRONMENT\fP section below, the relevant configuration settings for this tool is listed along with a short description of its meaning.
    146 
    147 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.
    148 
    149 .SH EXAMPLES
    150 
    151 .SH EXAMPLES
    152 
    153 Outputs of \fBeth-gas\fP and \fBeth-encode\fP map directly to inputs for \fBeth-raw\fP.
    154 
    155 .SS Encapsulate a gas transaction
    156 
    157 .EX
    158 $ eth-gas -y <\fIkey_file_path\fP> -a 00000000000000000000000000000000DeaDBeef --fee-price 100000000000 --fee-limit 21000 --nonce 42 --raw 1024 | eth-raw 
    159 .SH ENVIRONMENT
    160 
    161 
    162 .TP
    163 \fICHAIN_SPEC\fP
    164 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.
    165 
    166 .TP
    167 \fIRPC_AUTH\fP
    168 Authentication method to use for the \fIRPC_PROVIDER\fP. Currently only \fIbasic\fP is supported.
    169 
    170 .TP
    171 \fIRPC_CREDENTIALS\fP
    172 Authentication credentials to use for \fIRPC_AUTH\fP. For \fIbasic\fP authentication the value must be given as \fI<user>:<pass>\fP.
    173 
    174 .TP
    175 \fIRPC_DIALECT\fP
    176 Enables translations of EVM node specific formatting and response codes.
    177 
    178 .TP
    179 \fIRPC_PROVIDER\fP
    180 Fully-qualified URL to the RPC endpoint of the blockchain node.
    181 
    182 .TP
    183 \fIWALLET_KEY_FILE\fP
    184 The wallet key file containing private key to use for transaction signing. Overridden by \fB-y\fP.
    185 
    186 .TP
    187 \fIWALLET_PASSPHRASE\fP
    188 Passphrase to unlock wallet. \fBWARNING:\fP it is \fBunsafe\fP to pass the passphrase as an environment variable. If the key unlocks something of value, the passphrase should rather be in a configuration file, preferably as an encrypted entry. Alternatively, a passphrase can be read from file using the \fB--passphrase-file\fP option. Files containing passphrases should only be accessible by the owner.
    189 
    190 .SH LICENSE
    191 
    192 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International license.
    193 
    194 The source code of the tool this documentation describes is licensed under the GNU General Public License 3.0.
    195 
    196 .SH COPYRIGHT
    197 
    198 Louis Holbrook <dev@holbrook.no> (https://holbrook.no)
    199 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001
    200 
    201 
    202 
    203 .SH SOURCE CODE
    204 
    205 https://git.defalsify.org
    206 
    207 .SH SEE ALSO
    208 
    209 .BP
    210 confini-dump(1), eth-keyfile(1), eth-encode(1), eth-gas(1)