docs

packages/ethernaut-util/README.md

@@ -0,0 +1,101 @@
+# ethernaut-util
+
+Simple, everyday utilities for Ethereum devs
+
+## What
+
+This plugin facilitates a collection of tools for everyday Ethereum development or hacking needs, such as converting between units, searching for logs, converting from and to bytes, etc.
+
+## Installation
+
+```bash
+npm install ethernaut-util
+```
+
+Import the plugin in your `hardhat.config.js`:
+
+```js
+require('ethernaut-util')
+```
+
+Or if you are using TypeScript, in your `hardhat.config.ts`:
+
+```ts
+import 'ethernaut-util'
+```
+
+## Required plugins
+
+This plugin does not require any other plugins.
+
+## Tasks
+
+This plugin adds the tasks listed below.
+
+### bytes
+
+```
+Usage: hardhat [GLOBAL OPTIONS] util bytes [--non-interactive] [value]
+
+OPTIONS:
+
+  --non-interactive     Disable interactivity
+
+POSITIONAL ARGUMENTS:
+
+  value The value to convert. Will always be treated as a string. Cannot be longer than a bytes32 string.
+
+bytes: Converts strings to bytes32
+
+For global options help run: hardhat help
+```
+
+### string
+
+```
+Usage: hardhat [GLOBAL OPTIONS] util string [--non-interactive] [value]
+
+OPTIONS:
+
+--non-interactive Disable interactivity
+
+POSITIONAL ARGUMENTS:
+
+value The value to convert
+
+string: Converts bytes32 to string
+
+For global options help run: hardhat help
+```
+
+### unit
+
+```
+Usage: hardhat [GLOBAL OPTIONS] util unit [--from <SPECIAL>] [--non-interactive] [--to <SPECIAL>] [value]
+
+OPTIONS:
+
+  --from                The unit to convert from (default: "ether")
+  --non-interactive     Disable interactivity
+  --to                  The unit to convert to (default: "wei")
+
+POSITIONAL ARGUMENTS:
+
+  value The value to convert
+
+unit: Converts between different units of Ether. E.g. 1 ether is 1000000000000000000 wei. Units can be one of ether,wei,kwei,mwei,gwei,szabo,finney.
+
+For global options help run: hardhat help
+```
+
+## Environment extensions
+
+This plugin doesn't add any fields to the hre.
+
+## Configuration
+
+This plugin doesn't add any fields to the hardhat configuration file.
+
+## Usage
+
+Just install it and all tasks will be available with `npx hardhat <task> <params>`