diff --git a/.github/demo-restart.gif b/.github/demo-restart.gif deleted file mode 100644 index 26b6402a..00000000 Binary files a/.github/demo-restart.gif and /dev/null differ diff --git a/.github/demo-start.gif b/.github/demo-start.gif deleted file mode 100644 index bbe13b48..00000000 Binary files a/.github/demo-start.gif and /dev/null differ diff --git a/.github/docker-compose-settings.png b/.github/docker-compose-settings.png index 696aa159..c1d688ae 100644 Binary files a/.github/docker-compose-settings.png and b/.github/docker-compose-settings.png differ diff --git a/.github/docker-file-sharing-settings.png b/.github/docker-file-sharing-settings.png new file mode 100644 index 00000000..1a5e046a Binary files /dev/null and b/.github/docker-file-sharing-settings.png differ diff --git a/.github/docker-socket-settings.png b/.github/docker-socket-settings.png new file mode 100644 index 00000000..e4a04362 Binary files /dev/null and b/.github/docker-socket-settings.png differ diff --git a/.github/settings.png b/.github/settings.png index 37d3357c..a9cb5c5a 100644 Binary files a/.github/settings.png and b/.github/settings.png differ diff --git a/README.md b/README.md index dbbf7eb0..6ec93f9b 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The Hedera Local Node project allows developers to set up their own local network. The local network is composed of one mirror node and one consensus node. You can set this up by either using the CLI tool or by running Docker.

-> **_NOTE:_** It's recomended to start using the CLI Tool. +> **_NOTE:_** It's recommended to start using the CLI Tool. - [Docker](#docker) - [CLI Tool](#cli-tool---hashgraphhedera-local) @@ -18,24 +18,24 @@ The Hedera Local Node project allows developers to set up their own local networ # Requirements -- [Node.js](https://nodejs.org/) `>= v14.x` +- [Node.js](https://nodejs.org/) `>= v20.11.0` - Node version check: `node -v` -- NPM `>= v6.14.17` +- NPM `>= v10.2.4` - NPM version check: `npm -v` -- [Docker](https://www.docker.com/) `>= v20.10.x` +- [Docker](https://www.docker.com/) `>= v27.3.1` - Docker version check: `docker -v` -- [Docker Compose](https://docs.docker.com/compose/) `=> v2.12.2` +- [Docker Compose](https://docs.docker.com/compose/) `=> v2.29.7` - Docker Compose version check: `docker compose version` - Minimum 16GB RAM ### Note: -- **Ensure the `VirtioFS` file sharing implementation is enabled in the docker settings.** +- Ensure the **VirtioFS** file sharing implementation is enabled in the docker settings **Note**: The image may look different if you are on a different version ![docker-compose-settings.png](.github/docker-compose-settings.png) -- Ensure the following configurations are set at minimum in Docker **Settings** -> **Resources** and are available for use +- Ensure the following configurations are set at minimum in Docker **Settings -> Resources** and are available for use. - **CPUs:** 6 - **Memory:** 8GB - **Swap:** 1 GB @@ -44,10 +44,15 @@ The Hedera Local Node project allows developers to set up their own local networ **Note**: The image may look different if you are on a different version ![settings.png](.github/settings.png) -- Ensure the **`Allow the default Docker sockets to be used (requires password)`** is enabled in Docker **Settings -> Advanced**. +- Ensure the hedera-local-node folder is added to Docker File Sharing **Settings -> Resources -> File Sharing**. **Note**: The image may look different if you are on a different version -![docker-socket-setting](https://github.com/hashgraph/hedera-local-node/assets/56278409/9946dad6-27a9-4293-b37b-5286dd30d250) +![docker-file-sharing-settings.png](.github/docker-file-sharing-settings.png) + +- Ensure the *Allow the default Docker sockets to be used (requires password)* is enabled in Docker **Settings -> Advanced**. + +**Note**: The image may look different if you are on a different version +![docker-socket-setting](.github/docker-socket-settings.png) # CLI Tool - @hashgraph/hedera-local @@ -105,22 +110,22 @@ Local Hedera Package - Runs consensus and mirror nodes on localhost: Available commands: start - Starts the local hedera network. options: - --verbose set the verbose level. Defaults to 'info' choices are "info" & "trace" + --verbose to set the verbose level. Defaults to 'info' choices are "info" & "trace" --h or --host to override the default host. --l or --limits to enable/disable the JSON-RPC relay rate limits. Defaults to true. --dev to enable/disable developer mode. --full to enable/disable full mode. Production local-node. - --multinode Enable or disable multi-node mode. + --multinode to enable or disable multi-node mode. --balance to set starting hbar balance of the created accounts. --async to enable or disable asynchronous creation of accounts. --b or --blocklist to enable or disable account blocklisting. Depending on how many private keys are blocklisted, this will affect the generated on startup accounts. - --enable-debug Enable or disable debugging of the local node [boolean] [default: false] - --network-tag Select custom network node tag [string] [defaults: predefined selected configuration] - --mirror-tag Select custom mirror node tag [string] [defaults: predefined selected configuration] - --relay-tag Select custom hedera-json-rpc relay tag [string] [defaults: predefined selected configuration] - --workdir Path to the working directory for local node [string] [default: "[USER APP DATA]/hedera-local"] + --enable-debug to enable or disable debugging of the local node [boolean] [default: false] + --network-tag to select custom network node tag [string] [defaults: predefined selected configuration] + --mirror-tag to select custom mirror node tag [string] [defaults: predefined selected configuration] + --relay-tag to select custom hedera-json-rpc relay tag [string] [defaults: predefined selected configuration] + --workdir path to the working directory for local node [string] [default: "[USER APP DATA]/hedera-local"] stop - Stops the local hedera network and delete all the existing data. - restart - Restart the local hedera network. + restart - Restarts the local hedera network. generate-accounts - Generates N accounts, default 10. options: --h or --host to override the default host. @@ -139,24 +144,6 @@ Note: Read more about `developer mode` [here](https://github.com/hashgraph/heder #### `hedera start ` -![Demo](.github/demo-start.gif) - -- --accounts - Default is 10. Specify the number of accounts to generate at startup. The first 10 are with predefined - private keys, and the next ones are with random generated private keys. - -- --h / --host - Override the default host. - -#### `hedera restart ` - -![Demo](.github/demo-restart.gif) - -- --accounts - Default is 10. Specify the number of accounts to generate at startup. The first 10 are with predefined - private keys, and the next ones are with random generated private keys. - -- --h / --host - Override the default host. - -#### `hedera start -d ` - ```bash $ hedera start [Hedera-Local-Node] INFO (StateController) Starting start procedure! @@ -293,7 +280,7 @@ No available options --- -#### `hedera restart -d ` +#### `hedera restart ` ```bash $ hedera restart