From 90d4c4eb95e3bfd196a866746ca0439151008ae8 Mon Sep 17 00:00:00 2001 From: lash Date: Thu, 24 Feb 2022 12:07:56 +0000 Subject: [PATCH] Add man page for eth-encode --- man/eth-encode.custom.groff | 18 ++++++++++++++++++ man/eth-encode.examples.groff | 5 +++++ man/eth-encode.head.groff | 17 +++++++++++++++++ 3 files changed, 40 insertions(+) create mode 100644 man/eth-encode.custom.groff create mode 100644 man/eth-encode.examples.groff create mode 100644 man/eth-encode.head.groff diff --git a/man/eth-encode.custom.groff b/man/eth-encode.custom.groff new file mode 100644 index 0000000..ca6e569 --- /dev/null +++ b/man/eth-encode.custom.groff @@ -0,0 +1,18 @@ +.SH SPECIFYING VALUES +Dynamic value types are not yet supported. + +.SS Specifying an unsigned integer: +.IP u:1024 + +.SS Specifying an address: +.IP a:19062190B1925b5b6689D7073fDfC8c2976EF8Cb + +.SS Specifying bytes values: + +.IP b:deadbeef +.IP b4:deadbeef +.IP b32:deadbeef + +.SS Specifying a string value: + +.IP s:foobar diff --git a/man/eth-encode.examples.groff b/man/eth-encode.examples.groff new file mode 100644 index 0000000..5e86f43 --- /dev/null +++ b/man/eth-encode.examples.groff @@ -0,0 +1,5 @@ +.SS Build a signed ERC20 transfer + +.EX +$ eth-encode -y <\fIkey_file_path\fP> -e <\fItoken_address\fP> --signature transfer a:00000000000000000000000000000000DeaDBeef u:1024 +.EE diff --git a/man/eth-encode.head.groff b/man/eth-encode.head.groff new file mode 100644 index 0000000..0f00480 --- /dev/null +++ b/man/eth-encode.head.groff @@ -0,0 +1,17 @@ +.TH eth-encode 1 + +.SH NAME +eth-encode \- Encode arbitrary contract calls and transactions + +.SH SYNOPSIS +\fBeth-encode\fP [ -p \fIrpc_provider\fP ] [ -i \fIchain_Spec\fP] [ -s ] [ -w ] [ -e \fIsmart_contract_address\fP ] --signature \fIcontract_method_name\fP [ \fIvalue_specifiers\fP ... ] + +.SH DESCRIPTION + +Generate wire-format or rpc query any EVM smart contract call or transaction by specifying method and arguments. + +The resulting call or transaction can either be stored offline for future use, or directly sent to the network using the \fB-s\fP flag. + +A description of value formatting is given in the \fBSPECIFYING VALUES\fP section below. Usage is demonstrated in the \fBEXAMPLES\fP section. + +.SS OPTIONS