From 8da13b19408fbe742896874d0191000f096bdd32 Mon Sep 17 00:00:00 2001 From: Jacob Gadikian Date: Tue, 22 Oct 2024 18:52:43 +0700 Subject: [PATCH] finish readme --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/README.md b/README.md index c126321..5df37ff 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,52 @@ Hardhat is a powerful tool designed to empower users to test and validate the pe ## Installation To install Hardhat, run the following commands: + +```bash +git clone https://github.com/somatic-labs/hardhat +cd hardhat +go install ./... +``` + + + +## Usage + +Hardhat comes with pre-configured mainnet settings available in the `configurations` folder. To get started: + +1. Ensure you have a file named `seedphrase` containing your seed phrase. +2. *(Optional)* Set up your own node with a larger mempool (e.g., 10 GB) that accepts a higher number of transactions (e.g., 50,000). +3. Edit the `nodes.toml` file to include your RPC URLs and adjust any other necessary settings. +4. Run `hardhat` in the same directory as your `nodes.toml` and `seedphrase` files. + +This will initiate the testing suite with your specified configurations. + +## Important Notes + +- **Responsible Use**: Hardhat is designed for use on test networks and should be used responsibly. Ensure you have proper authorization before testing on any network you do not own or operate. +- **Valid Transactions Only**: The tool operates within the bounds of valid transactions explicitly supported by the chains it tests. +- **Reporting Issues**: For questions about Hardhat's capabilities or to report potential security issues, please contact the project maintainers through the appropriate channels listed in this repository. + +## Background + +Hardhat was developed to enhance the testing capabilities for Cosmos-based blockchains after identifying areas where additional testing tools were needed. By simulating various scenarios, Hardhat helps developers and users alike to better understand the limits and robustness of their chains. + +### Specific Tests Include: + +- **Banana King Exploit Testing**: Initially reported in 2022, this test ensures that chains are secure against known exploits. +- **P2P Storms Testing**: Reported in 2021 and observed in networks like Luna Classic (2022) and Stride (2023), this test evaluates the chain's ability to handle network stress. + +## Outcomes + +The release of Hardhat has contributed to: + +- **Improved Awareness**: Highlighting potential vulnerabilities and encouraging proactive improvements in network security. +- **Enhanced Security Measures**: Prompting fixes for issues like P2P storms after thorough testing and community engagement. + +Additional information is available at [faddat/fasf-report](https://github.com/faddat/fasf-report). + +## Contributions and Feedback + +We welcome contributions from the community to enhance Hardhat's features and capabilities. If you'd like to contribute or have feedback, please open an issue or submit a pull request on GitHub. + +---