add event logs to stf and db

packages/batcher/runtime/tsconfig.json

@@ -13,7 +13,6 @@
     { "path": "../../paima-sdk/paima-providers/tsconfig.build.json" },
     { "path": "../../paima-sdk/paima-utils/tsconfig.build.json" },
     { "path": "../../node-sdk/paima-utils-backend" },
-    { "path": "../../paima-sdk/paima-mw-core/tsconfig.json" },
-    { "path": "../../node-sdk/paima-broker/tsconfig.build.json" },
+    { "path": "../../paima-sdk/paima-mw-core/tsconfig.json" }
   ]
 }

packages/build-utils/paima-build-utils/src/standalone-esbuildconfig.template.cts

@@ -4,7 +4,8 @@ import type esbuild from 'esbuild';
 export function generateConfig(
   apiFolder: string,
   stfFolder: string,
-  precompilesFolder: string
+  precompilesFolder: string,
+  eventsFolder: string
 ): {
   config: esbuild.BuildOptions;
   outFiles: Record<string, string>;
@@ -19,6 +20,7 @@ export function generateConfig(
     [apiFolder]: 'endpoints.cjs',
     [stfFolder]: 'gameCode.cjs',
     [precompilesFolder]: 'precompiles.cjs',
+    [eventsFolder]: 'events.cjs',
   };
 
   const config: esbuild.BuildOptions = {

packages/engine/paima-rest/src/controllers/BasicControllers.ts

@@ -1,4 +1,4 @@
-import { Controller, Response, Query, Get, Route } from 'tsoa';
+import { Controller, Response, Query, Get, Route, Body, Post } from 'tsoa';
 import { doLog, logError, ENV } from '@paima/utils';
 import type {
   InternalServerErrorResult,
@@ -15,6 +15,7 @@ import {
   getInputsForAddress,
   getInputsForBlock,
   getScheduledDataByBlockHeight,
+  getEvents,
 } from '@paima/db';
 import type { Pool } from 'pg';
 import { StatusCodes } from 'http-status-codes';
@@ -397,3 +398,110 @@ export class TransactionContentController extends Controller {
     }
   }
 }
+
+type GetLogsResponse = Result<any[]>;
+type GetLogsParams = {
+  fromBlock: number;
+  toBlock: number;
+  address: string;
+  filters?: { [fieldName: string]: string };
+  topic: string;
+};
+
+@Route('get_logs')
+export class GetLogsController extends Controller {
+  @Response<FailedResult>(StatusCodes.NOT_FOUND)
+  @Response<FailedResult>(StatusCodes.BAD_REQUEST)
+  @Response<InternalServerErrorResult>(StatusCodes.INTERNAL_SERVER_ERROR)
+  @Post()
+  public async post(@Body() params: GetLogsParams): Promise<GetLogsResponse> {
+    if (
+      params.toBlock < params.fromBlock ||
+      params.toBlock - params.fromBlock > ENV.GET_LOGS_MAX_BLOCK_RANGE
+    ) {
+      this.setStatus(StatusCodes.BAD_REQUEST);
+      return {
+        success: false,
+        errorMessage: 'Invalid block range',
+      };
+    }
+
+    const gameStateMachine = EngineService.INSTANCE.getSM();
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const eventDefinition = ((): any => {
+      const appEvents = gameStateMachine.getAppEvents();
+
+      for (const defs of Object.values(appEvents)) {
+        for (const def of defs) {
+          if (def.topicHash === params.topic) {
+            return def;
+          }
+        }
+      }
+
+      return undefined;
+    })();
+
+    if (!eventDefinition) {
+      this.setStatus(StatusCodes.NOT_FOUND);
+      return {
+        success: false,
+        errorMessage: 'Topic not found',
+      };
+    }
+
+    if (params.filters) {
+      const indexedFields = new Set();
+      for (const field of eventDefinition.definition.fields) {
+        if (field.indexed) {
+          indexedFields.add(field.name);
+        }
+      }
+
+      for (const fieldName of Object.keys(params.filters)) {
+        if (!indexedFields.has(fieldName)) {
+          this.setStatus(StatusCodes.NOT_FOUND);
+          return {
+            success: false,
+            errorMessage: `Field is not indexed: ${fieldName}`,
+          };
+        }
+      }
+    }
+
+    try {
+      const DBConn = gameStateMachine.getReadonlyDbConn();
+      const base: Record<string, number | string | undefined> & { topic: string } = {
+        from: params.fromBlock,
+        to: params.toBlock,
+        address: params.address,
+        topic: params.topic,
+      };
+
+      if (params.filters) {
+        const keys = Object.keys(params.filters);
+
+        for (let i = 0; i < keys.length; i++) {
+          base['field' + i] = keys[i];
+          base['value' + i] = params.filters[keys[i]];
+        }
+      }
+
+      const rows = await getEvents.run(base, DBConn);
+
+      return {
+        success: true,
+        result: rows,
+      };
+    } catch (err) {
+      doLog(`Unexpected webserver error:`);
+      logError(err);
+      this.setStatus(StatusCodes.INTERNAL_SERVER_ERROR);
+      return {
+        success: false,
+        errorMessage: 'Unknown error, please contact game node operator',
+      };
+    }
+  }
+}

packages/engine/paima-rest/src/tsoa/routes.ts

@@ -19,6 +19,8 @@ import { TransactionCountController } from './../controllers/BasicControllers';
 // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
 import { TransactionContentController } from './../controllers/BasicControllers';
 // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+import { GetLogsController } from './../controllers/BasicControllers';
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
 import { AchievementsController } from './../controllers/AchievementsController';
 import type { Request as ExRequest, Response as ExResponse, RequestHandler, Router } from 'express';
 
@@ -168,6 +170,30 @@ const models: TsoaRoute.Models = {
         "type": {"dataType":"union","subSchemas":[{"ref":"SuccessfulResult_TransactionContentResponse_"},{"ref":"FailedResult"}],"validators":{}},
     },
     // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "SuccessfulResult_any-Array_": {
+        "dataType": "refObject",
+        "properties": {
+            "success": {"dataType":"enum","enums":[true],"required":true},
+            "result": {"dataType":"array","array":{"dataType":"any"},"required":true},
+        },
+        "additionalProperties": false,
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "Result_any-Array_": {
+        "dataType": "refAlias",
+        "type": {"dataType":"union","subSchemas":[{"ref":"SuccessfulResult_any-Array_"},{"ref":"FailedResult"}],"validators":{}},
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "GetLogsResponse": {
+        "dataType": "refAlias",
+        "type": {"ref":"Result_any-Array_","validators":{}},
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    "GetLogsParams": {
+        "dataType": "refAlias",
+        "type": {"dataType":"nestedObjectLiteral","nestedProperties":{"topic":{"dataType":"string","required":true},"filters":{"dataType":"nestedObjectLiteral","nestedProperties":{},"additionalProperties":{"dataType":"string"}},"address":{"dataType":"string","required":true},"toBlock":{"dataType":"double","required":true},"fromBlock":{"dataType":"double","required":true}},"validators":{}},
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
     "Achievement": {
         "dataType": "refObject",
         "properties": {
@@ -517,6 +543,36 @@ export function RegisterRoutes(app: Router) {
             }
         });
         // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        app.post('/get_logs',
+            ...(fetchMiddlewares<RequestHandler>(GetLogsController)),
+            ...(fetchMiddlewares<RequestHandler>(GetLogsController.prototype.post)),
+
+            async function GetLogsController_post(request: ExRequest, response: ExResponse, next: any) {
+            const args: Record<string, TsoaRoute.ParameterSchema> = {
+                    params: {"in":"body","name":"params","required":true,"ref":"GetLogsParams"},
+            };
+
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+            let validatedArgs: any[] = [];
+            try {
+                validatedArgs = templateService.getValidatedArgs({ args, request, response });
+
+                const controller = new GetLogsController();
+
+              await templateService.apiHandler({
+                methodName: 'post',
+                controller,
+                response,
+                next,
+                validatedArgs,
+                successStatus: undefined,
+              });
+            } catch (err) {
+                return next(err);
+            }
+        });
+        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
         app.get('/achievements/public/list',
             ...(fetchMiddlewares<RequestHandler>(AchievementsController)),
             ...(fetchMiddlewares<RequestHandler>(AchievementsController.prototype.public_list)),

packages/engine/paima-rest/src/tsoa/swagger.json

@@ -307,6 +307,72 @@
 					}
 				]
 			},
+			"SuccessfulResult_any-Array_": {
+				"properties": {
+					"success": {
+						"type": "boolean",
+						"enum": [
+							true
+						],
+						"nullable": false
+					},
+					"result": {
+						"items": {},
+						"type": "array"
+					}
+				},
+				"required": [
+					"success",
+					"result"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
+			"Result_any-Array_": {
+				"anyOf": [
+					{
+						"$ref": "#/components/schemas/SuccessfulResult_any-Array_"
+					},
+					{
+						"$ref": "#/components/schemas/FailedResult"
+					}
+				]
+			},
+			"GetLogsResponse": {
+				"$ref": "#/components/schemas/Result_any-Array_"
+			},
+			"GetLogsParams": {
+				"properties": {
+					"topic": {
+						"type": "string"
+					},
+					"filters": {
+						"properties": {},
+						"additionalProperties": {
+							"type": "string"
+						},
+						"type": "object"
+					},
+					"address": {
+						"type": "string"
+					},
+					"toBlock": {
+						"type": "number",
+						"format": "double"
+					},
+					"fromBlock": {
+						"type": "number",
+						"format": "double"
+					}
+				},
+				"required": [
+					"topic",
+					"address",
+					"toBlock",
+					"fromBlock"
+				],
+				"type": "object"
+			},
 			"Achievement": {
 				"properties": {
 					"name": {
@@ -1083,6 +1149,74 @@
 				]
 			}
 		},
+		"/get_logs": {
+			"post": {
+				"operationId": "GetLogsPost",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/GetLogsResponse"
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/FailedResult"
+								},
+								"examples": {
+									"Example 1": {}
+								}
+							}
+						}
+					},
+					"404": {
+						"description": "",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/FailedResult"
+								},
+								"examples": {
+									"Example 1": {}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/InternalServerErrorResult"
+								},
+								"examples": {
+									"Example 1": {}
+								}
+							}
+						}
+					}
+				},
+				"security": [],
+				"parameters": [],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/GetLogsParams"
+							}
+						}
+					}
+				}
+			}
+		},
 		"/achievements/public/list": {
 			"get": {
 				"operationId": "AchievementsPublic_list",