diff --git a/README.md b/README.md index 4758726..b046447 100644 --- a/README.md +++ b/README.md @@ -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.   @@ -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: @@ -40,17 +40,19 @@ A simple CLI for offline signing of ethereum transactions. Usage: etheroff [--help] etheroff version + etheroff generateRandom etheroff [--keyfile=] etheroff signTransaction [--gasLimit=] [--gasPrice=] [--data=] [--chainId=] [--keyfile=] [--logLevel=] Commands: - ❍ 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. ❍ Ethereum address to send the transaction to. ❍ The nonce to be used for the ethereum transaction. ❍ How much ether to send (in Wei!) + ❍ Run the interactive Q&A version of this tool. Options: @@ -62,6 +64,7 @@ Options: --gasPrice= ❍ The gas price for the ETH transaction. [default: 20000000000] --logLevel= ❍ Define the level of logging in the tool's output as one of: `none`, `info`, `debug`, `trace` or `error`. [default: none] + ```   @@ -143,4 +146,19 @@ You'll find a sample script in the __`./example/`__ directory. Run it to see the f869820539850df847580082753094fedfe2616eb3661cb8fed2782f5f0cc91d59dcac01830decaf2aa0c8a9434fa0775488d27f5395bcd4e1180b0b67800d58bc3a69f1e9071e45d3eba06084d3d8e723188c441403e0ecd6d7cd894346730a28d557eda393fc2eb0fda3 ``` +  + +## :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.