Add test suite

Author: d4mr

test/e2e/.env.test.example

@@ -0,0 +1,3 @@
+ENGINE_ACCESS_TOKEN=""
+ENGINE_URL=""
+ANVIL_URL=""

test/e2e/.gitignore

@@ -0,0 +1,177 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches 
+
+.cache
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
+
+.env.test

test/e2e/README.md

@@ -0,0 +1,27 @@
+# engine e2e test suite
+## Configuration
+1. Create a `.env.test` file (use `.env.test.example` as a template) and fill in the necessary values.
+2. Check `config.ts` to configure the test suite.
+3. Run `bun test` within the directory to run the tests.
+
+Note: make sure `engine` is running, and `anvil` is installed if running the tests on a local environment. (You can get the latest version of `anvil` by installing [`forge`](https://book.getfoundry.sh/getting-started/installation))
+
+## Running tests
+The test suite depends on a local SDK to run tests. To run the tests, you need to generate the SDK. To do this, run the following command from the root of the repository:
+
+```bash
+yarn generate:sdk
+```
+Run all subsequent commands from the `test/e2e` directory.
+
+Some tests contains load tests which take a long time to run. To ensure they don't timeout, use the following command:
+
+```bash
+bun test --timeout 300000
+```
+
+To run a specific test, use the following command:
+
+```bash
+bun test tests/<test_name>.test.ts
+```

test/e2e/bun.lockb

@@ -0,0 +1,41 @@
+import assert from "assert";
+import type { Chain } from "viem";
+import { anvil } from "viem/chains";
+
+assert(process.env.ENGINE_URL, "ENGINE_URL is required");
+assert(process.env.ENGINE_ACCESS_TOKEN, "ENGINE_ACCESS_TOKEN is required");
+
+export const CONFIG: Config = {
+  ACCESS_TOKEN: process.env.ENGINE_ACCESS_TOKEN,
+  URL: process.env.ENGINE_URL,
+
+  // CHAIN_ID: 1993,
+  // CHAIN_NAME: "anvil",
+  // RPC_URL: "http://localhost:8545",
+  // RPC_URL: "http://localhost:8545",
+  // USE_LOCAL_CHAIN: true,
+  // CHAIN: arbitrumSepolia,
+
+  USE_LOCAL_CHAIN: true,
+  CHAIN: anvil,
+
+  TRANSACTION_COUNT: 500,
+  TRANSACTIONS_PER_BATCH: 100,
+  POLLING_INTERVAL: 1000,
+
+  STAGGER_MAX: 500,
+  INITIAL_BALANCE: "10000", // in Ether
+};
+
+type Config = {
+  ACCESS_TOKEN: string;
+  URL: string;
+  TRANSACTION_COUNT: number;
+  TRANSACTIONS_PER_BATCH: number;
+  POLLING_INTERVAL: number;
+  STAGGER_MAX: number;
+  INITIAL_BALANCE: string;
+
+  CHAIN: Chain;
+  USE_LOCAL_CHAIN?: boolean;
+};

test/e2e/chain.test.ts

@@ -0,0 +1,18 @@
+{
+  "name": "e2e",
+  "module": "index.ts",
+  "devDependencies": {
+    "@types/bun": "latest",
+    "tsup": "^8.2.3"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "type": "module",
+  "dependencies": {
+    "@thirdweb-dev/sdk": "^4.0.99",
+    "ethers": "5",
+    "thirdweb": "^5.43.2",
+    "viem": "^2.18.1"
+  }
+}

test/e2e/config.ts

@@ -0,0 +1,33 @@
+// Anvil chain outputs every RPC call to stdout
+// You can save the output to a file and then use this script to count the number of times a specific RPC call is made.
+
+import { readFile } from "fs/promises";
+import { join } from "path";
+
+const file = join(__dirname, "rpc_spam.txt");
+
+async function countLines(file: string) {
+  const data = await readFile(file, "utf-8");
+  const lines = data.split("\n");
+  const statements = new Map<string, number>();
+
+  for (const line of lines) {
+    if (!line.trim()) {
+      continue;
+    }
+
+    if (statements.has(line)) {
+      statements.set(line, statements.get(line)! + 1);
+    } else {
+      statements.set(line, 1);
+    }
+  }
+
+  return statements;
+}
+
+countLines(file).then((lines) => {
+  for (const [line, count] of lines) {
+    console.log(`${line}: ${count}`);
+  }
+});