Add @paima/rest tsoa endpoint

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 bin
+.nx
 **/dist
 **/build
 **/lib

.prettierignore

@@ -2,3 +2,4 @@
 **/*.d.ts
 contract-types/
 packaged/
+packages/engine/paima-rest/src/tsoa/routes.ts

package.json

@@ -19,12 +19,12 @@
   "devDependencies": {
     "@eslint/eslintrc": "^2.1.2",
     "@eslint/js": "~8.50.0",
-    "@nx/esbuild": "16.9.1",
-    "@nx/jest": "16.10.0",
-    "@nx/js": "16.10.0",
-    "@nx/linter": "^16.9.1",
+    "@nx/esbuild": "17.1.3",
+    "@nx/jest": "17.1.3",
+    "@nx/js": "17.1.3",
+    "@nx/linter": "17.1.3",
     "@types/eslint-plugin-prettier": "^3.1.1",
-    "@types/jest": "^29.4.0",
+    "@types/jest": "^29.5.10",
     "@types/node": "^18.17.1",
     "@typescript-eslint/eslint-plugin": "^6.7.3",
     "@typescript-eslint/parser": "^6.7.3",
@@ -38,7 +38,7 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-require-extensions": "^0.1.3",
     "husky": "^8.0.3",
-    "jest": "^29.4.1",
+    "jest": "29.7.0",
     "json5": "^2.2.3",
     "nx": "16.9.1",
     "prettier": "^3.0.3",
@@ -47,7 +47,7 @@
     "syncpack": "^11.2.1",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2"
   },
   "overrides": {
     "web3-eth-contract": "1.10.0"

packages/admin-panel/package.json

@@ -21,7 +21,7 @@
     "@types/react": "^18.0.0",
     "@types/react-dom": "^18.0.0",
     "@vitejs/plugin-react": "^1.3.0",
-    "typescript": "^5.2.2",
+    "typescript": "^5.3.2",
     "vite": "^2.9.9"
   }
 }

packages/batcher/webserver/src/index.ts

@@ -177,7 +177,7 @@ async function initializeServer(
         console.log('[webserver/track_user_input] error:', err);
         res.status(500).json({
           success: false,
-          message: 'Unknown server error, please contact admin',
+          message: 'Unknown server error, please batcher operator',
         });
       }
     }
@@ -297,7 +297,7 @@ async function initializeServer(
         console.log('[webserver/submit_self_signed_input] error:', err);
         res.status(500).json({
           success: false,
-          message: 'Unknown server error, please contact admin',
+          message: 'Unknown server error, please contact batcher operator',
         });
       }
     }
@@ -421,7 +421,7 @@ async function initializeServer(
         console.log('[webserver/submit_user_input] error:', err);
         res.status(500).json({
           success: false,
-          message: 'Unknown server error, please contact admin',
+          message: 'Unknown server error, please contact batcher operator',
         });
       }
     }

packages/engine/paima-funnel/package.json

@@ -14,7 +14,7 @@
   },
   "author": "Paima Studios",
   "devDependencies": {
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2"
   },
   "dependencies": {
     "assert-never": "^1.2.1"

packages/engine/paima-funnel/src/cde/erc20.ts

@@ -3,7 +3,7 @@ import type {
   CdeErc20TransferDatum,
   ChainDataExtensionDatum,
   ChainDataExtensionErc20,
-} from '@paima/runtime';
+} from '@paima/sm';
 import type { Transfer } from '@paima/utils/src/contract-types/ERC20Contract.js';
 import { DEFAULT_FUNNEL_TIMEOUT } from '@paima/utils';
 

packages/engine/paima-funnel/src/cde/erc20Deposit.ts

@@ -1,5 +1,5 @@
 import { ChainDataExtensionDatumType, timeout } from '@paima/utils';
-import type { ChainDataExtensionDatum, ChainDataExtensionErc20Deposit } from '@paima/runtime';
+import type { ChainDataExtensionDatum, ChainDataExtensionErc20Deposit } from '@paima/sm';
 import type { Transfer } from '@paima/utils/src/contract-types/ERC20Contract.js';
 import { DEFAULT_FUNNEL_TIMEOUT } from '@paima/utils';
 

packages/engine/paima-funnel/src/cde/erc6551Registry.ts

@@ -8,7 +8,7 @@ import type {
   CdeErc6551RegistryDatum,
   ChainDataExtensionDatum,
   ChainDataExtensionErc6551Registry,
-} from '@paima/runtime';
+} from '@paima/sm';
 import type { AccountCreated } from '@paima/utils/src/contract-types/ERC6551RegistryContract.js';
 
 export default async function getCdeData(

packages/engine/paima-funnel/src/cde/erc721.ts

@@ -4,7 +4,7 @@ import type {
   CdeErc721TransferDatum,
   ChainDataExtensionDatum,
   ChainDataExtensionErc721,
-} from '@paima/runtime';
+} from '@paima/sm';
 import type { Transfer } from '@paima/utils/src/contract-types/ERC721Contract.js';
 
 export default async function getCdeData(

packages/engine/paima-funnel/src/cde/generic.ts

@@ -4,7 +4,7 @@ import type {
   CdeGenericDatum,
   ChainDataExtensionDatum,
   ChainDataExtensionGeneric,
-} from '@paima/runtime';
+} from '@paima/sm';
 
 export default async function getCdeData(
   extension: ChainDataExtensionGeneric,

packages/engine/paima-funnel/src/cde/paimaErc721.ts

@@ -9,7 +9,7 @@ import type {
   CdeErc721TransferDatum,
   ChainDataExtensionDatum,
   ChainDataExtensionPaimaErc721,
-} from '@paima/runtime';
+} from '@paima/sm';
 import type { Minted, Transfer } from '@paima/utils/src/contract-types/PaimaERC721Contract.js';
 
 export default async function getCdeData(

packages/engine/paima-funnel/src/cde/reading.ts

@@ -1,7 +1,7 @@
 import type Web3 from 'web3';
 
 import { ChainDataExtensionType } from '@paima/utils';
-import type { ChainDataExtensionDatum, ChainDataExtension } from '@paima/runtime';
+import type { ChainDataExtensionDatum, ChainDataExtension } from '@paima/sm';
 
 import getCdeErc20Data from './erc20.js';
 import getCdeErc721Data from './erc721.js';

packages/engine/paima-funnel/src/funnels/BaseFunnel.ts

@@ -1,4 +1,5 @@
-import type { ChainData, ChainDataExtension, ChainFunnel, PresyncChainData } from '@paima/runtime';
+import type { ChainFunnel } from '@paima/runtime';
+import type { ChainData, ChainDataExtension, PresyncChainData } from '@paima/sm';
 import type { PaimaL2Contract, Web3 } from '@paima/utils';
 import type { FunnelCacheManager } from './FunnelCache.js';
 import type { PoolClient } from 'pg';

packages/engine/paima-funnel/src/funnels/FunnelCache.ts

@@ -1,4 +1,4 @@
-import type { ChainData } from '@paima/runtime';
+import type { ChainData } from '@paima/sm';
 
 export interface FunnelCacheEntry {
   /**

packages/engine/paima-funnel/src/funnels/block/funnel.ts

@@ -1,5 +1,6 @@
 import { ENV, doLog, timeout } from '@paima/utils';
-import type { ChainData, ChainFunnel, PresyncChainData } from '@paima/runtime';
+import type { ChainFunnel } from '@paima/runtime';
+import type { ChainData, PresyncChainData } from '@paima/sm';
 import { getBaseChainDataMulti, getBaseChainDataSingle } from '../../reading.js';
 import { getUngroupedCdeData } from '../../cde/reading.js';
 import { composeChainData, groupCdeData } from '../../utils.js';

packages/engine/paima-funnel/src/funnels/emulated/funnel.ts

@@ -1,7 +1,8 @@
 import type { PoolClient } from 'pg';
 
 import Prando from '@paima/prando';
-import type { ChainData, ChainFunnel, PresyncChainData } from '@paima/runtime';
+import type { ChainFunnel } from '@paima/runtime';
+import type { ChainData, PresyncChainData } from '@paima/sm';
 import { ENV, doLog } from '@paima/utils';
 import {
   emulatedSelectLatestPrior,

packages/engine/paima-funnel/src/funnels/emulated/utils.ts

@@ -1,6 +1,7 @@
 import type { PoolClient } from 'pg';
 
-import type { ChainDataExtensionDatum, ChainFunnel } from '@paima/runtime';
+import type { ChainDataExtensionDatum } from '@paima/sm';
+import type { ChainFunnel } from '@paima/runtime';
 import { EmulatedBlocksFunnel } from './funnel.js';
 import { DEFAULT_FUNNEL_TIMEOUT, doLog, logError, timeout } from '@paima/utils';
 import type { FunnelSharedData } from '../BaseFunnel.js';

packages/engine/paima-funnel/src/index.ts

@@ -2,7 +2,8 @@ import type { PoolClient } from 'pg';
 
 import { ENV, getPaimaL2Contract, initWeb3, validatePaimaL2ContractAddress } from '@paima/utils';
 import { loadChainDataExtensions } from '@paima/runtime';
-import type { ChainDataExtension, ChainFunnel, IFunnelFactory } from '@paima/runtime';
+import type { ChainFunnel, IFunnelFactory } from '@paima/runtime';
+import type { ChainDataExtension } from '@paima/sm';
 import { wrapToEmulatedBlocksFunnel } from './funnels/emulated/utils.js';
 import { BlockFunnel } from './funnels/block/funnel.js';
 import type { FunnelSharedData } from './funnels/BaseFunnel.js';

packages/engine/paima-funnel/src/paima-l2-processing.ts

@@ -1,6 +1,4 @@
 import type Web3 from 'web3';
-import web3UtilsPkg from 'web3-utils';
-
 import { AddressType, doLog, getReadNamespaces } from '@paima/utils';
 import type { SubmittedData } from '@paima/runtime';
 import type { PaimaGameInteraction } from '@paima/utils/src/contract-types/PaimaL2Contract.js';
@@ -11,9 +9,7 @@ import {
   createMessageForBatcher,
   extractBatches,
 } from '@paima/concise';
-import { sha3 } from 'web3-utils';
-
-const { toBN, hexToUtf8 } = web3UtilsPkg;
+import { toBN, hexToUtf8, sha3 } from 'web3-utils';
 
 interface ValidatedSubmittedData extends SubmittedData {
   validated: boolean;

packages/engine/paima-funnel/src/reading.ts

@@ -3,7 +3,8 @@ import type { BlockTransactionString } from 'web3-eth';
 
 import { timeout, cutAfterFirstRejected, DEFAULT_FUNNEL_TIMEOUT, doLog, delay } from '@paima/utils';
 import type { PaimaL2Contract } from '@paima/utils';
-import { TimeoutError, type ChainData } from '@paima/runtime';
+import { TimeoutError } from '@paima/runtime';
+import type { ChainData } from '@paima/sm';
 import type { PaimaGameInteraction } from '@paima/utils/src/contract-types/PaimaL2Contract.js';
 
 import { extractSubmittedData } from './paima-l2-processing.js';

packages/engine/paima-funnel/src/utils.ts

@@ -1,4 +1,4 @@
-import type { ChainData, ChainDataExtensionDatum, PresyncChainData } from '@paima/runtime';
+import type { ChainData, ChainDataExtensionDatum, PresyncChainData } from '@paima/sm';
 
 export function groupCdeData(
   fromBlock: number,

packages/engine/paima-funnel/tsconfig.json

@@ -13,5 +13,6 @@
     { "path": "../../node-sdk/paima-utils-backend" },
     { "path": "../../paima-sdk/paima-crypto/tsconfig.build.json" },
     { "path": "../../paima-sdk/paima-concise/tsconfig.build.json" },
+    { "path": "../paima-sm" },
   ]
 }

packages/engine/paima-rest/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@paima/rest",
+  "version": "1.0.0",
+  "description": "Paima Engine REST, defining the REST endpoints for the Paima node",
+  "main": "build/index.js",
+  "type": "module",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "lint:eslint": "eslint .",
+    "build": "tsc --build tsconfig.build.json",
+    "prebuild": "npm run compile:api",
+    "compile:api": "npx tsoa spec-and-routes"
+  },
+  "author": "Paima Studios",
+  "dependencies": {
+    "express": "^4.18.1",
+    "yaml": "^2.3.1",
+    "tsoa": "^6.0.0-rc.5"
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.12",
+    "@types/express": "^4.17.20",
+    "@types/node": "^18.17.1"
+  }
+}

packages/engine/paima-rest/src/EngineService.ts

@@ -0,0 +1,18 @@
+import type { GameStateMachine } from '@paima/sm';
+
+export class EngineService {
+  public static INSTANCE = new EngineService();
+
+  private runtime: GameStateMachine | undefined = undefined;
+
+  getSM = (): GameStateMachine => {
+    if (this.runtime == null) {
+      throw new Error('EngineService: SM not initialized');
+    }
+    return this.runtime;
+  };
+
+  updateSM = (runtime: GameStateMachine): void => {
+    this.runtime = runtime;
+  };
+}