feat(benchmark): Add quantified benchmarking for nonce management

.env.benchmark.example

@@ -0,0 +1,29 @@
+THIRDWEB_SDK_SECRET_KEY=
+
+# 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": []
+  }
+}'

.env.example

@@ -54,7 +54,6 @@ CHAIN_OVERRIDES=<path_or_url_to_file>
 # from "http://example1.com" or from a subdomain of "example2.com".
 ACCESS_CONTROL_ALLOW_ORIGIN=*
 
-
 # benchmark vars [Optional]
 BENCHMARK_HOST='http://localhost:3005'
 BENCHMARK_URL_PATH='/contract/mumbai/0xc8be6265C06aC376876b4F62670adB3c4d72EABA/write'
@@ -64,3 +63,4 @@ BENCHMARK_POST_BODY='{
 }'
 BENCHMARK_CONCURRENCY=10
 BENCHMARK_REQUESTS=10
+

.gitignore

@@ -74,6 +74,7 @@ web_modules/
 
 # dotenv environment variable files
 .env
+.env.benchmark
 .env.development.local
 .env.test.local
 .env.production.local

Makefile

@@ -3,7 +3,6 @@
 SHELL := /bin/bash
 
 export NODE_ENV=testing
-export THIRDWEB_API_KEY=TEST
 export POSTGRES_HOST=localhost
 export POSTGRES_DATABASE_NAME=postgres
 export POSTGRES_USER=postgres

README.md

@@ -205,6 +205,16 @@ The API defaults to `http://localhost:3005`
 
 </details>
 
+## Local Benchmarking
+
+As a way to support quantifying the robustness of our system, we have added benchmarking. Benchmark results may vary based on the machine that is being used.
+
+To run the benchmark:
+
+1. Run local server with `yarn dev`
+1. Set-up `.env.benchmark` (For sensible defaults: `cp .env.benchmark.example .env.benchmark`)
+1. Run benchmark in a separate terminal with `yarn benchmark`
+
 ## Contributing
 
 We welcome contributions from all developers, regardless of experience level. If you are interested in contributing, please read our [Contributing Guide](./.github/contributing.md) where you'll learn how the repo works, how to test your changes, and how to submit a pull request.

core/database/dbConnect.ts

@@ -89,7 +89,7 @@ export const connectWithDatabase = async (): Promise<Knex> => {
   };
 
   // Set the appropriate databse client package
-  let dbClientPackage: any;
+  let dbClientPackage: typeof pg;
   switch (dbClient) {
     case "pg":
       dbClientPackage = pg;

core/database/sql-schemas/transactions.sql

@@ -40,4 +40,6 @@ ALTER COLUMN "maxFeePerGas" TYPE VARCHAR(255),
 ALTER COLUMN "txType" TYPE VARCHAR(255),
 ADD COLUMN IF NOT EXISTS "deployedContractAddress" VARCHAR(255),
 ADD COLUMN IF NOT EXISTS "contractType" VARCHAR(255),
-ADD COLUMN IF NOT EXISTS "errorMessage" TEXT DEFAULT NULL;
+ADD COLUMN IF NOT EXISTS "errorMessage" TEXT DEFAULT NULL,
+ADD COLUMN IF NOT EXISTS "txMinedTimestamp" TIMESTAMP,
+ADD COLUMN IF NOT EXISTS "blockNumber" BIGINT;

core/services/benchmark.ts

@@ -0,0 +1,41 @@
+// ! Winston Notes: This file is currently not in used.
+// Keeping it around for when we might want to track specific function timings.
+// Note that you cannot track functions in worker and output timings in server.
+// Tracking and outputting timings must be done in the same docker image.
+// Might release this as my own npm package and bring it in as a dependency in the future
+import { randomUUID } from "crypto";
+import { PerformanceObserver, performance } from "perf_hooks";
+
+export const watchPerformance = (
+  onNewEntry: (entry: PerformanceEntry) => void,
+) => {
+  const performanceObserver = new PerformanceObserver((items) => {
+    items.getEntries().forEach((entry) => {
+      onNewEntry(entry);
+    });
+  });
+  performanceObserver.observe({ entryTypes: ["measure"], buffered: true });
+};
+
+export const timeFunction = <
+  F extends (...args: any) => any,
+  Args = F extends (args: infer A) => any ? A : never,
+>(
+  fn: F,
+  resultTag: (args: Awaited<ReturnType<F>>) => string,
+) => {
+  const result = async (args: Args): Promise<Awaited<ReturnType<F>>> => {
+    const marker = randomUUID();
+    const markerStart = `${marker}-start`;
+    const markerEnd = `${marker}-end`;
+
+    performance.mark(markerStart);
+    const fnResult = await fn(args);
+    performance.mark(markerEnd);
+
+    const measureName = resultTag(fnResult);
+    performance.measure(measureName, markerStart, markerEnd);
+    return fnResult;
+  };
+  return result;
+};

core/services/blockchain.ts

@@ -14,3 +14,13 @@ export const getWalletNonce = async (
     throw error;
   }
 };
+
+export const getFeeData = async (provider: providers.Provider) => {
+  try {
+    const feeData = await provider.getFeeData();
+
+    return feeData;
+  } catch (error) {
+    throw error;
+  }
+};

package.json

@@ -23,7 +23,8 @@
     "lint": "eslint 'server/**/*.ts'",
     "lint:fix": "eslint --fix 'server/**/*.ts'",
     "test": "make test-evm",
-    "test:all": "mocha --exit"
+    "test:all": "mocha --exit",
+    "benchmark": "ts-node ./scripts/benchmark/index.ts"
   },
   "dependencies": {
     "@fastify/cookie": "^8.3.0",
@@ -59,6 +60,7 @@
   "devDependencies": {
     "@nomiclabs/hardhat-ethers": "^2.2.3",
     "@swc/core": "^1.3.41",
+    "@types/autocannon": "^7.9.1",
     "@types/chai": "^4.3.5",
     "@types/cookie": "^0.5.1",
     "@types/express": "^4.17.17",
@@ -71,6 +73,7 @@
     "@types/ws": "^8.5.5",
     "@typescript-eslint/eslint-plugin": "^5.55.0",
     "@typescript-eslint/parser": "^5.55.0",
+    "autocannon": "^7.12.0",
     "chai": "^4.3.7",
     "eslint": "^8.36.0",
     "eslint-config-prettier": "^8.7.0",