Add wallet list detection, scripts to make release builds (#123)

SpaceManiac · web-flow · commit 2cdd6f96e793 · 2024-11-06T14:25:44.000-08:00
- Add esbuild configuration so backend can be packed for deployment - Minify middleware and add scripts to pack it properly for deployment - Tweak Hardhat configs to be able to test emulated blocks - Serve list of detected EVM wallets to frontend See PaimaStudios/paima-engine#439
diff --git a/.env.devnet b/.env.devnet
diff --git a/.env.mainnet b/.env.mainnet
diff --git a/api/src/controllers/allConfigs.ts b/api/src/controllers/allConfigs.ts
@@ -13,7 +13,7 @@ export class userConfigsController extends Controller {
   @Get()
   public async get(@Query() creator: string): Promise<UserConfigsResponse> {
     const pool = requirePool();
-    creator = (await getMainAddress(creator, pool)).address;
+    //creator = (await getMainAddress(creator, pool)).address;
     const configs = await getUserConfigs.run({ creator }, pool);
     return { configs };
   }
diff --git a/api/src/controllers/openLobbies.ts b/api/src/controllers/openLobbies.ts
@@ -29,7 +29,7 @@ export class openLobbiesController extends Controller {
       throw new ValidateError({ count: { message: 'invalid number' } }, '');
     }
 
-    wallet = (await getMainAddress(wallet, pool)).address;
+    //wallet = (await getMainAddress(wallet, pool)).address;
     const p = valPage.right;
     const c = valCount.right;
     const offset = (p - 1) * c;
diff --git a/api/src/controllers/searchOpenLobbies.ts b/api/src/controllers/searchOpenLobbies.ts
@@ -26,7 +26,7 @@ export class SearchOpenLobbiesController extends Controller {
     if (searchQuery.length < MIN_SEARCH_LENGTH || searchQuery.length > LOBBY_ID_LENGTH)
       return emptyResponse;
 
-    wallet = (await getMainAddress(wallet, pool)).address;
+    //wallet = (await getMainAddress(wallet, pool)).address;
 
     if (searchQuery.length == LOBBY_ID_LENGTH) {
       const lobbies = await getOpenLobbyById.run({ searchQuery, wallet }, pool);
diff --git a/api/src/controllers/userFinishedLobbies.ts b/api/src/controllers/userFinishedLobbies.ts
@@ -30,7 +30,7 @@ export class UserFinishedLobbiesController extends Controller {
     }
 
     // after typecheck, valid data output is given in .right
-    wallet = (await getMainAddress(wallet, pool)).address;
+    //wallet = (await getMainAddress(wallet, pool)).address;
     const p = valPage.right;
     const c = valCount.right;
     const offset = (p - 1) * c;
diff --git a/api/src/controllers/userLobbies.ts b/api/src/controllers/userLobbies.ts
@@ -35,7 +35,7 @@ export class UserLobbiesController extends Controller {
     }
 
     // after typecheck, valid data output is given in .right
-    wallet = (await getMainAddress(wallet, pool)).address;
+    //wallet = (await getMainAddress(wallet, pool)).address;
     const p = valPage.right;
     const c = valCount.right;
     const offset = (p - 1) * c;
diff --git a/api/src/controllers/userLobbiesBlockheight.ts b/api/src/controllers/userLobbiesBlockheight.ts
@@ -14,7 +14,7 @@ export class UserLobbiesBlockheightController extends Controller {
   @Get()
   public async get(@Query() wallet: string, @Query() blockHeight: number): Promise<UserLobbiesBlockheightResponse> {
     const pool = requirePool();
-    wallet = (await getMainAddress(wallet, pool)).address;
+    //wallet = (await getMainAddress(wallet, pool)).address;
     const valBH = psqlNum.decode(blockHeight);
     if (isLeft(valBH)) {
       throw new ValidateError({ blockHeight: { message: 'invalid number' } }, '');
diff --git a/api/src/controllers/userNFT.ts b/api/src/controllers/userNFT.ts
@@ -12,7 +12,7 @@ export class userNFTController extends Controller {
   @Get()
   public async get(@Query() wallet: string): Promise<UserNftResponse> {
     const pool = requirePool();
-    wallet = (await getMainAddress(wallet, pool)).address;
+    //wallet = (await getMainAddress(wallet, pool)).address;
     const [nft] = await getLatestUserNft.run({ wallet }, pool);
     return { nft };
   }
diff --git a/api/src/controllers/userStats.ts b/api/src/controllers/userStats.ts
@@ -12,7 +12,7 @@ export class userStatsController extends Controller {
   @Get()
   public async get(@Query() wallet: string): Promise<UserStatsResponse> {
     const pool = requirePool();
-    wallet = (await getMainAddress(wallet, pool)).address;
+    //wallet = (await getMainAddress(wallet, pool)).address;
     const [stats] = await getUserStats.run({ wallet }, pool);
     return { stats };
   }
diff --git a/backend/esbuildconfig.js b/backend/esbuildconfig.js
@@ -0,0 +1,26 @@
+import { build } from 'esbuild';
+
+await build({
+  outfile: 'build/index.bundle.js',
+  // JS output from previous compilation step used here instead of index.ts to have more control over the TS build process
+  entryPoints: ['build/index.js'],
+
+  bundle: true,
+  format: 'esm',
+  platform: 'node',
+
+  minify: true,
+  treeShaking: true,
+  sourcemap: true,
+  // source map is just for crash stack traces, so source content isn't needed
+  sourcesContent: false,
+
+  define: {
+    __dirname: 'import.meta.dirname',
+    __filename: 'import.meta.filename',
+  },
+
+  banner: {
+    js: "import { createRequire } from 'module'; const require = createRequire(import.meta.url);",
+  },
+});
diff --git a/backend/package.json b/backend/package.json
@@ -2,11 +2,17 @@
   "name": "@tower-defense/backend",
   "version": "1.0.0",
   "description": "",
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
   "type": "module",
   "author": "",
   "license": "ISC",
+  "scripts": {
+    "prepack": "(cd .. && npm run build) && node ./esbuildconfig.js && cp $(npm ls --parseable @dcspark/cardano-multiplatform-lib-nodejs | head -1)/cardano_multiplatform_lib_bg.wasm build/"
+  },
+  "files": [
+    "build/index.bundle.js",
+    "build/index.bundle.js.map",
+    "build/cardano_multiplatform_lib_bg.wasm"
+  ],
   "dependencies": {
     "@paima/db": "5.0.0",
     "@paima/executors": "^5.0.0",
diff --git a/backend/src/stf/v2/parser.ts b/backend/src/stf/v2/parser.ts
@@ -50,7 +50,7 @@ const createdLobby: ParserRecord<CreatedLobbyInput> = {
     value => conciseFactionMap[value as RoleSettingConcise]
   ),
   numOfRounds: PaimaParser.NumberParser(3, 1000),
-  roundLength: PaimaParser.DefaultRoundLength(parseInt(process.env.BLOCK_TIME || '4', 0)),
+  roundLength: PaimaParser.DefaultRoundLength(/* always in units of 2s regardless of real block speed */ 2),
   isHidden: PaimaParser.TrueFalseParser(false),
   map: PaimaParser.EnumParser(maps),
   isPractice: PaimaParser.TrueFalseParser(false),
diff --git a/backend/src/stf/v2/persist/lobby.ts b/backend/src/stf/v2/persist/lobby.ts
@@ -18,6 +18,7 @@ import { blankStats } from './stats.js';
 import { practiceRound } from '../transition.js';
 import { persistNewRound } from './match.js';
 import { generateMatchState } from '@tower-defense/game-logic';
+import { ENV } from '@paima/utils';
 
 // Persist creation of a lobby
 export function persistLobbyCreation(
@@ -34,7 +35,7 @@ export function persistLobbyCreation(
     lobby_creator_token_id: tokenId,
     creator_faction: inputData.creatorFaction,
     num_of_rounds: inputData.numOfRounds,
-    round_length: inputData.roundLength,
+    round_length: inputData.roundLength * 2 / ENV.BLOCK_TIME,  // convert from 2-second units to BLOCK_TIME-second units
     current_round: 0,
     creation_block_height: blockHeight,
     map: inputData.map,
@@ -70,7 +71,7 @@ export function persistPracticeLobbyCreation(
     lobby_creator_token_id: tokenId,
     creator_faction: inputData.creatorFaction,
     num_of_rounds: inputData.numOfRounds,
-    round_length: inputData.roundLength,
+    round_length: inputData.roundLength * 2 / ENV.BLOCK_TIME,  // convert from 2-second units to BLOCK_TIME-second units
     current_round: 0,
     creation_block_height: blockHeight,
     map: inputData.map,
diff --git a/contracts/evm/hardhat.config.ts b/contracts/evm/hardhat.config.ts
@@ -9,6 +9,10 @@ import 'hardhat-dependency-compiler';
 import 'hardhat-interact';
 import { task, type HardhatUserConfig } from 'hardhat/config';
 import { type HardhatRuntimeEnvironment } from 'hardhat/types';
+import * as dotenv from 'dotenv';
+
+const xai: Record<string, string> = {};
+dotenv.config({ path: '../../.env.xai', processEnv: xai });
 
 const config: HardhatUserConfig = {
   solidity: '0.8.20',
@@ -27,9 +31,18 @@ const config: HardhatUserConfig = {
       chainId: 31337,
       mining: {
         auto: true,
-        interval: 2000,
+        // Xai runs at *approximately* 250ms per block, but if we ask Hardhat to
+        // produce multiple blocks per second, it pushes timestamps into the future
+        // instead of allowing them to repeat like Xai does, causing the emulated
+        // funnel to also run into the future, so we can't simulate Xai exactly.
+        interval: 1000,
       },
     },
+    xai: {
+      chainId: 660279,
+      url: 'https://xai-chain.net/rpc',
+      accounts: xai.DEPLOYER_PRIVATE_KEY ? [xai.DEPLOYER_PRIVATE_KEY] : [],
+    },
   },
   dependencyCompiler: {
     paths: [
@@ -63,9 +76,11 @@ task('node').setAction(async (args, hre: HardhatRuntimeEnvironment, runSuper) =>
       'ignition',
       'deploy',
       './ignition/modules/deploy.ts',
-      '--parameters', './ignition/parameters.json',
-      '--network', 'localhost',
-      '--reset',  // So we don't have to manually rm -rf the deploy journal.
+      '--parameters',
+      './ignition/parameters.json',
+      '--network',
+      'localhost',
+      '--reset', // So we don't have to manually rm -rf the deploy journal.
     ],
     {
       stdio: 'inherit',
diff --git a/contracts/evm/ignition/modules/deploy.ts b/contracts/evm/ignition/modules/deploy.ts
@@ -1,3 +1,5 @@
+// A Hardhat module representing what should be deployed locally.
+// Includes a Genesis Trainer contract so we have something to test against.
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules';
 import type { IgnitionModuleBuilder } from '@nomicfoundation/ignition-core';
 
diff --git a/contracts/evm/ignition/modules/xai.ts b/contracts/evm/ignition/modules/xai.ts
@@ -0,0 +1,12 @@
+// A Hardhat module that represents what TD should actually deploy to Xai.
+// Excludes Tarochi Genesis Trainers because that contract's deployment is
+// not Tower Defense's responsibility.
+import { buildModule } from '@nomicfoundation/hardhat-ignition/modules';
+import type { IgnitionModuleBuilder } from '@nomicfoundation/ignition-core';
+
+export default buildModule('L2Contract', (m: IgnitionModuleBuilder) => {
+  // https://github.com/NomicFoundation/hardhat-ignition/issues/673
+  const l2Contract = m.contract('PaimaL2Contract', [m.getAccount(0), 1]);
+
+  return { l2Contract };
+});
diff --git a/contracts/evm/package.json b/contracts/evm/package.json
@@ -12,6 +12,7 @@
     "@nomicfoundation/hardhat-ignition-viem": "^0.15.1",
     "@nomicfoundation/hardhat-toolbox-viem": "^3.0.0",
     "@openzeppelin/contracts": "^5.0.2",
+    "dotenv": "^16.4.1",
     "hardhat": "^2.19.4",
     "hardhat-abi-exporter": "github:paimaStudios/hardhat-abi-exporter#export-ts-wrapper",
     "hardhat-dependency-compiler": "^1.1.3",
diff --git a/middleware/debug-build b/middleware/debug-build
@@ -0,0 +1,16 @@
+#!/bin/bash
+# middleware/debug-build: copy paimaMiddleware.js, source map, and env.js into
+# a Unity build output directory.
+# $1 = where to put the files
+# $NETWORK = what .env to use, default `localhost`
+set -euo pipefail
+
+dest="${1:?first argument should be destination directory}"
+if ! test -f "$dest/index.html"; then
+    printf "destination directory should already contain 'index.html' from Unity build" >&2
+    exit 1
+fi
+set -x
+npm -w middleware run build
+cp middleware/packaged/paimaMiddleware.js{,.map} "$dest"
+middleware/make-env-json ".env.${NETWORK:-localhost}" >"$dest/env.js"
diff --git a/middleware/esbuildconfig.cjs b/middleware/esbuildconfig.cjs
diff --git a/middleware/esbuildconfig.js b/middleware/esbuildconfig.js
@@ -0,0 +1,28 @@
+import { NodeModulesPolyfillPlugin } from '@esbuild-plugins/node-modules-polyfill';
+import { build } from 'esbuild';
+
+await build({
+  outfile: 'packaged/paimaMiddleware.js',
+  // JS output from previous compilation step used here instead of index.ts to have more control over the TS build process
+  entryPoints: ['build/index.js'],
+
+  bundle: true,
+  format: 'esm',
+
+  minify: true,
+  treeShaking: true,
+  sourcemap: true,
+  // source map is for browser debugging, so include source content
+  sourcesContent: true,
+
+  define: {
+    global: 'window',
+    'process.env': 'PaimaProcessEnv',
+  },
+
+  plugins: [NodeModulesPolyfillPlugin()],
+
+  banner: {
+    js: "import PaimaProcessEnv from './env.js';",
+  },
+});
diff --git a/middleware/make-env-json b/middleware/make-env-json
diff --git a/middleware/package.json b/middleware/package.json
diff --git a/middleware/scripts/build.sh b/middleware/scripts/build.sh
diff --git a/middleware/src/index.ts b/middleware/src/index.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/utils/src/index.ts b/utils/src/index.ts

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export class userConfigsController extends Controller {`
`13`	`13`	`@Get()`
`14`	`14`	`public async get(@Query() creator: string): Promise<UserConfigsResponse> {`
`15`	`15`	`const pool = requirePool();`
`16`		`- creator = (await getMainAddress(creator, pool)).address;`
	`16`	`+ //creator = (await getMainAddress(creator, pool)).address;`
`17`	`17`	`const configs = await getUserConfigs.run({ creator }, pool);`
`18`	`18`	`return { configs };`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ export class openLobbiesController extends Controller {`
`29`	`29`	`throw new ValidateError({ count: { message: 'invalid number' } }, '');`
`30`	`30`	`}`
`31`	`31`
`32`		`- wallet = (await getMainAddress(wallet, pool)).address;`
	`32`	`+ //wallet = (await getMainAddress(wallet, pool)).address;`
`33`	`33`	`const p = valPage.right;`
`34`	`34`	`const c = valCount.right;`
`35`	`35`	`const offset = (p - 1) * c;`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ export class UserFinishedLobbiesController extends Controller {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`// after typecheck, valid data output is given in .right`
`33`		`- wallet = (await getMainAddress(wallet, pool)).address;`
	`33`	`+ //wallet = (await getMainAddress(wallet, pool)).address;`
`34`	`34`	`const p = valPage.right;`
`35`	`35`	`const c = valCount.right;`
`36`	`36`	`const offset = (p - 1) * c;`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ export class UserLobbiesController extends Controller {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`// after typecheck, valid data output is given in .right`
`38`		`- wallet = (await getMainAddress(wallet, pool)).address;`
	`38`	`+ //wallet = (await getMainAddress(wallet, pool)).address;`
`39`	`39`	`const p = valPage.right;`
`40`	`40`	`const c = valCount.right;`
`41`	`41`	`const offset = (p - 1) * c;`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ export class userNFTController extends Controller {`
`12`	`12`	`@Get()`
`13`	`13`	`public async get(@Query() wallet: string): Promise<UserNftResponse> {`
`14`	`14`	`const pool = requirePool();`
`15`		`- wallet = (await getMainAddress(wallet, pool)).address;`
	`15`	`+ //wallet = (await getMainAddress(wallet, pool)).address;`
`16`	`16`	`const [nft] = await getLatestUserNft.run({ wallet }, pool);`
`17`	`17`	`return { nft };`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ export class userStatsController extends Controller {`
`12`	`12`	`@Get()`
`13`	`13`	`public async get(@Query() wallet: string): Promise<UserStatsResponse> {`
`14`	`14`	`const pool = requirePool();`
`15`		`- wallet = (await getMainAddress(wallet, pool)).address;`
	`15`	`+ //wallet = (await getMainAddress(wallet, pool)).address;`
`16`	`16`	`const [stats] = await getUserStats.run({ wallet }, pool);`
`17`	`17`	`return { stats };`
`18`	`18`	`}`