Skip to content

Commit

Permalink
chore(README.md): <- updates that with info re new CLI abilities
Browse files Browse the repository at this point in the history
  • Loading branch information
gskapka committed May 15, 2021
1 parent 18bc983 commit 541f5bd
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :heart_eyes_cat: Etheroff

A simple CLI for offline signing of ethereum transactions.
A simple CLI for offline signing of ethereum transactions. It can also generate random ethereum private-keys.

&nbsp;

Expand All @@ -12,7 +12,7 @@ __`❍ git clone https://github.com/gskapka/etheroff.git`__

**2)** Enter app dir and build it:

__`❍ cd etheroff && cargo +nightly b --release`__
__`❍ cd etheroff && cargo b --release`__

**3)** You'll find the __`etheroff`__ binary in:

Expand Down Expand Up @@ -40,17 +40,19 @@ A simple CLI for offline signing of ethereum transactions.
Usage: etheroff [--help]
etheroff version
etheroff generateRandom
etheroff [--keyfile=<path>]
etheroff signTransaction <to> <value> <nonce> [--gasLimit=<uint>] [--gasPrice=<uint>] [--data=<bytes>] [--chainId=<uint>] [--keyfile=<path>] [--logLevel=<string>]
Commands:
<no-command> ❍ Run the interactive Q&A version of this tool.
version ❍ Show version info.
generateRandom ❍ Generate random ETH private key & address.
signTransaction ❍ Sign an ethereum transaction.
<to> ❍ Ethereum address to send the transaction to.
<nonce> ❍ The nonce to be used for the ethereum transaction.
<value> ❍ How much ether to send (in Wei!)
<no-command> ❍ Run the interactive Q&A version of this tool.
Options:
Expand All @@ -62,6 +64,7 @@ Options:
--gasPrice=<uint> ❍ The gas price for the ETH transaction. [default: 20000000000]
--logLevel=<level> ❍ Define the level of logging in the tool's output as one of: `none`, `info`, `debug`,
`trace` or `error`. [default: none]
```

&nbsp;
Expand Down Expand Up @@ -143,4 +146,19 @@ You'll find a sample script in the __`./example/`__ directory. Run it to see the
f869820539850df847580082753094fedfe2616eb3661cb8fed2782f5f0cc91d59dcac01830decaf2aa0c8a9434fa0775488d27f5395bcd4e1180b0b67800d58bc3a69f1e9071e45d3eba06084d3d8e723188c441403e0ecd6d7cd894346730a28d557eda393fc2eb0fda3
```

&nbsp;

## :shipit: Generating a random ETH address:

After building the tool, simply call it like so:

```
./etheroff generateRandom
{
"eth_address": "0xc1eef08242d7da6bd4f5887ef38e37dc2c0d9110",
"private_key": "0xd3df92df1f2445f9dd6e90464ebd51aa1e10c78a81998258bbfd297614e3c011"
}
```

:exclamation: __NOTE:__ The above example has logging turned on. The tool will _default_ to no logging and so _only_ the final signed transaction will be outputted to stdout. Perfect for programmatic use-cases.

0 comments on commit 541f5bd

Please sign in to comment.