docs(readme): updtated README.md

Author: samooyo

README.md

@@ -1,14 +1,18 @@
 # hardhat-gui-baker
 
-_A simple plugin that automatically generate GUI for smartcontracts_
+_A simple plugin that automatically generates GUI for smartcontracts_
 
 ## What
 
-This plugin will help you quickly test smartcontracts by localy creating a website in next so you can interact with it. You will have access to all your functions and a toolkit to impersonate accounts on the go or receive ERC20.
+This plugin will help you quickly test smartcontracts by locally creating a website in [viteJs](https://vitejs.dev/) so you can interact with it. You will have access to all your functions and a toolkit to impersonate accounts on the go or receive ERC20.
 
 ## Installation
 
 ```sh
+pnpm i hardhat-gui-baker
+
+yarn add hardhat-gui-baker
+
 npm install hardhat-gui-baker
 ```
 
@@ -24,68 +28,56 @@ Or if you are using TypeScript, in your `hardhat.config.ts`:
 import "hardhat-gui-baker";
 ```
 
-<!-- ## Required plugins
-
-- [wighawag/hardhat-deploy](https://github.com/wighawag/hardhat-deploy) -->
-
 ## Tasks
 
 This plugin adds the gui-baker task to Hardhat:
 
 ```
-Usage: hardhat [GLOBAL OPTIONS] gui-baker [--opt-network <STRING>]
+Usage: hardhat [GLOBAL OPTIONS] gui-baker [--opt-port <STRING>] [--show-logs]
 
 OPTIONS:
 
-  --opt-network Optional : Wich network will be used
-```
-
-<!--
-## Environment extensions
-
+  --opt-port    Optional : Wich port will be used to expose the GUI
+  --show-logs   Show logs
 
-This plugin extends the Hardhat Runtime Environment by adding an `example` field
-whose type is `ExampleHardhatRuntimeEnvironmentField`. -->
-<!--
-## Configuration
-
-<_A description of each extension to the HardhatConfig or to its fields_>
-
-This plugin extends the `HardhatUserConfig`'s `ProjectPathsUserConfig` object with an optional
-`newPath` field.
-
-This is an example of how to set it:
-
-```js
-module.exports = {
-  paths: {
-    newPath: "new-path",
-  },
-}; -->
+gui-baker: Create a simple Gui to test your smartcontracts
+```
 
 ## Usage
 
 (Remember to log the deployed contract address in your deployment script, you will need to provide it in the GUI)
 
 lanch your node :
 
-```
-hardhat node
+```sh
+npm hardhat node
 ```
 
 deploy your smartcontract :
 
-```
-hardhat run scripts/deploy.ts
+```sh
+npm hardhat run pathToYourDeployementScript.ts
 ```
 
 bake your GUI :
 
+```sh
+npm hardhat gui-baker
 ```
-hardhat gui-baker
-```
 
-enjoy your bakery on defalut : _localhost:4157_
+enjoy your bakery on (defalut) : _https://localhost:4157_
+
+You will need to connect your wallet and be able to interact with your contract, that's it!
+
+## Whats next ?
+
+- A configuration page will soon be added so that you will have to possibility to add all contract addresses only once.
+
+- Switch from ethers to viem.sh.
+
+- Basic rpc tools to change the BlockTime, BlockNumber...
+
+- Integration of Hardhat network tools like impersonating accounts, resetting the node...
 
 <br/><br/>
 

package.json

@@ -33,7 +33,6 @@
     "@types/node": "^8.10.38",
     "chai": "^4.2.0",
     "cz-conventional-changelog": "^3.3.0",
-    "hardhat": "^2.0.0",
     "mocha": "^7.1.2",
     "prettier": "2.0.5",
     "ts-node": "^8.1.0",
@@ -47,6 +46,7 @@
     "@nomiclabs/hardhat-ethers": "^2.2.2",
     "commitizen": "^4.3.0",
     "ethers": "^5.7.2",
+    "hardhat": "^2.0.0",
     "replace-in-file": "^6.3.5"
   },
   "config": {

src/index.ts

@@ -1,12 +1,13 @@
-import { task } from "hardhat/config";
+import { findRootSync } from "@manypkg/find-root";
 import { spawnSync } from "child_process";
 import { existsSync } from "fs";
+import { task } from "hardhat/config";
+
 import { parseContracts } from "./utils";
-import { findRootSync } from "@manypkg/find-root";
 
 const baseVitePath: string = "/node_modules/hardhat-gui-baker/gui-baker";
 
-task("gui-baker", "Create a simple front to test your smartcontract")
+task("gui-baker", "Create a simple Gui to test your smartcontracts")
   .addOptionalParam(
     "optPort",
     "Optional : Wich port will be used to expose the GUI"
@@ -22,8 +23,9 @@ task("gui-baker", "Create a simple front to test your smartcontract")
     const vitePath = root.rootDir + baseVitePath;
 
     console.log("\nCreating your GUI recipe...");
-    if (!existsSync(".gui-baker"))
+    if (!existsSync(".gui-baker")) {
       spawnSync("cp", ["-r", vitePath, ".gui-baker"], { stdio: logs });
+    }
 
     spawnSync("npm", ["i"], { cwd: ".gui-baker", stdio: logs });
     await parseContracts(hre);

src/utils.ts

@@ -9,7 +9,9 @@ export async function parseContracts(hre: HardhatRuntimeEnvironment) {
   const artifatcsName = await hre.artifacts.getAllFullyQualifiedNames();
 
   for (const name of artifatcsName) {
-    if (name.includes("@openzeppelin")) continue;
+    if (name.includes("@openzeppelin")) {
+      continue;
+    }
 
     const contract = await hre.artifacts.readArtifact(name);
     exportAbi(contract);
@@ -21,8 +23,9 @@ export async function parseContracts(hre: HardhatRuntimeEnvironment) {
 }
 
 export function deleteExistingContext() {
-  if (existsSync(contextPath + `/ContractContext.ts`))
+  if (existsSync(contextPath + `/ContractContext.ts`)) {
     unlinkSync(contextPath + `/ContractContext.ts`);
+  }
 }
 
 export function exportAbi(contract: Artifact) {