Merge pull request #115 from getwax/start-scripts-docs

Add docs for start scripts

account-integrations/safe/README.md

@@ -21,6 +21,8 @@ To run the hardhat tests, you'll need to run a node and a bundler as some of the
 1. Start a geth node, fund accounts and deploy Safe contracts:
 
 ```bash
+# Note: This uses geth. There is also start-hardhat.sh for using hardhat. See
+# docs inside each script for more information.
 ./script/start.sh
 ```
 

account-integrations/safe/script/start-hardhat.sh

@@ -1,5 +1,17 @@
 #!/bin/bash
 
+# Runs a hardhat node and deploys contracts in one script, ensuring proper
+# cleanup when errors occur.
+#
+# Advantages of using hardhat:
+# - Good debug output
+# - Support for console.log
+#
+# Disadvantages:
+# - Bundler needs to be run in unsafe mode, so its restrictions on user ops
+#   are not tested
+# - Slower than geth
+
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 
 set -meuo pipefail

account-integrations/safe/script/start.sh

@@ -1,5 +1,13 @@
 #!/bin/bash
 
+# Runs a geth node and deploys contracts in one script, ensuring proper cleanup
+# when errors occur.
+#
+# Advantages of using geth:
+# - Exposes special trace methods needed to run the bundler, enabling testing of
+#   the bundler's restrictions on user ops
+# - Fast
+
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 
 set -meuo pipefail