Organize testing & benchmarking and add default setup (#113)

* Replace benchmarking

* Add defaults to benchmark script

Author: adam-maj

.env.benchmark.example

@@ -1,29 +1,46 @@
-THIRDWEB_SDK_SECRET_KEY=
+# ============================================================================= #
+# This file let's you configure what gets tested by the benchmarking script.
+# At minimum, you just need to configure a chain where you have a funded admin
+# wallet in order to send transactions.
+#
+# In addition, there are other optional configuration variables that let you
+# customize exactly which endpoints you hit with which payloads.
+#
+# If optional configuration is left blank, the benchmark script will initially
+# deploy a new contract for you to test with.
+# ============================================================================= #
 
-# benchmark vars
-NODE_ENV=benchmark
-BENCHMARK_HOST='http://127.0.0.1:3005'
-BENCHMARK_URL_PATH='/contract/polygon/0x01De66609582B874FA34ab288859ACC4592aec04/write'
-BENCHMARK_POST_BODY='{
-    "function_name": "mintTo",
-    "args": ["0xCF3D06a19263976A540CFf8e7Be7b026801C52A6", "0","", "1"]
-}'
-# Total request has to be more than the total concurrency
-BENCHMARK_CONCURRENCY=2
-BENCHMARK_REQUESTS=2
-SAMPLE_EDITION_CONTRACT_INFO='{
-  "contractMetadata": {
-    "name": "TW WEB3API",
-    "description": "thirdweb web3API sample collection for testing",
-    "image": "ipfs://QmYxT4LnK8sqLupjbS6eRvu1si7Ly2wFQAqFebxhWntcf6",
-    "external_link": "",
-    "app_uri": "",
-    "seller_fee_basis_points": 0,
-    "fee_recipient": "0xCF3D06a19263976A540CFf8e7Be7b026801C52A6",
-    "symbol": "TWT",
-    "platform_fee_basis_points": 0,
-    "platform_fee_recipient": "0xCF3D06a19263976A540CFf8e7Be7b026801C52A6",
-    "primary_sale_recipient": "0xCF3D06a19263976A540CFf8e7Be7b026801C52A6",
-    "trusted_forwarders": []
-  }
-}'
+THIRDWEB_API_SECRET_KEY = ""
+
+# At minimum, you need to configure a chain
+# ============================================================================= #
+BENCHMARK_CHAIN = "mumbai"
+
+# Then you can configure the contract address and function to call
+# NOTE: If you don't configure a contract address and function call, an ERC20
+# contract will be deployed by default for testing.
+
+# BENCHMARK_CONTRACT_ADDRESS = "0x365b83D67D5539C6583b9c0266A548926Bf216F4"
+# BENCHMARK_FUNCTION_NAME = "mintTo"
+# BENCHMARK_FUNCTION_ARGS = '["0x43CAe0d7fe86C713530E679Ce02574743b2Ee9FC", "1000000000"]'
+# ============================================================================= #
+
+# Alternatively, you can directly configure the url to hit and the payload body
+# ============================================================================= #
+# BENCHMARK_PATH = "/contract/mumbai/0x365b83D67D5539C6583b9c0266A548926Bf216F4/write"
+# BENCHMARK_BODY = '{
+#   "function_name": "mintTo",
+#   "args": ["0x43CAe0d7fe86C713530E679Ce02574743b2Ee9FC", "1000000000"]
+# }'
+# ============================================================================= #
+
+# And you also need to configure how many requests to make at what concurrency
+# ============================================================================= #
+BENCHMARK_REQUESTS = 100
+BENCHMARK_CONCURRENCY = 10
+# ============================================================================= #
+
+# You can also configure a different api url to benchmark against
+# ============================================================================= #
+# BENCHMARK_HOST = "http://localhost:3005"
+# ============================================================================= #

.mocharc.json

@@ -1,6 +1,6 @@
 {
-  "require": ["./e2e/setup-init.ts", "./worker/index.ts"],
-  "spec": "e2e/**/*.test.ts",
+  "require": ["./test/e2e/setup-init.ts", "./worker/index.ts"],
+  "spec": "test/e2e/**/*.test.ts",
   "extension": ["ts"],
   "node-option": [
     "experimental-specifier-resolution=node",

Makefile

@@ -14,7 +14,7 @@ export THIRDWEB_SDK_SECRET_KEY=klRsqmatrdlEpik_pHKgYy_q2YzGe3bTewO1VC26eY_H184Kc
 
 test-evm: FORCE
 	docker compose -f docker-compose-test.yml up -d
-	./scripts/waitForHardhatNode.sh
+	./test/e2e/hardhat/waitForHardhatNode.sh
 	yarn test:all
 	docker compose -f docker-compose-test.yml down
 

docker-compose-test.yml

@@ -20,4 +20,4 @@ services:
     ports:
       - 8545:8545
     volumes:
-      - ./e2e/hardhat.config.js:/hardhat/hardhat.config.js
+      - ./test/e2e/hardhat/hardhat.config.js:/hardhat/hardhat.config.js

package.json

@@ -24,7 +24,7 @@
     "lint:fix": "eslint --fix 'server/**/*.ts'",
     "test": "make test-evm",
     "test:all": "mocha --exit",
-    "benchmark": "ts-node ./scripts/benchmark/index.ts"
+    "benchmark": "ts-node ./test/benchmark/index.ts"
   },
   "dependencies": {
     "@aws-sdk/client-kms": "^3.398.0",