Add scaffolding for PRC-1 achievements API

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

@@ -9,20 +9,23 @@ import {
   type Player,
   getNftOwner,
 } from '@paima/utils-backend';
-import { getAchievementTypes, getAchievementProgress } from '@paima/db';
+import { getAchievementTypes, getAchievementProgress, getMainAddress } from '@paima/db';
 
 // ----------------------------------------------------------------------------
 // Controller and routes per PRC-1
 
 @Route('achievements')
 export class AchievementsController extends Controller {
   private async game(): Promise<Game> {
-    return { id: 'TODO' };
+    return {
+      id: 'TODO',
+      // TODO: name, version
+    };
   }
 
   private async validity(): Promise<Validity> {
     return {
-      caip2: ENV.CHAIN_ID,
+      caip2: `eip155:${ENV.CHAIN_ID}`,
       block: await EngineService.INSTANCE.getSM().latestProcessedBlockHeight(),
       time: new Date().toISOString(),
     };
@@ -57,10 +60,16 @@ export class AchievementsController extends Controller {
     /** Comma-separated list. */
     @Query() name?: string
   ): Promise<PlayerAchievements> {
-    const names = name ? name.split(',') : [];
-    const player: Player = { wallet };
-
     const db = EngineService.INSTANCE.getSM().getReadonlyDbConn();
+    const { address, id } = await getMainAddress(wallet, db);
+
+    const player: Player = {
+      wallet: address,
+      userId: String(id),
+      // TODO: walletType, userName
+    };
+
+    const names = name ? name.split(',') : ['*'];
     const rows = await getAchievementProgress.run({ wallet, names }, db);
 
     this.setHeader('Content-Language', 'en');
@@ -97,14 +106,15 @@ export class AchievementsController extends Controller {
         const wallet = await getNftOwner(db, cde, BigInt(token_id));
         if (wallet) {
           return await this.wallet(wallet, name);
+        } else {
+          // TODO: throw a different error if no CDE with that name exists
+          this.setStatus(404);
+          throw new Error('No owner for that NFT');
         }
-        break;
-      case 'erc6551':
-        // TODO
-        break;
+      // Future expansion: erc6551
+      default:
+        this.setStatus(404);
+        throw new Error(`No support for /erc/${erc}`);
     }
-
-    this.setStatus(404);
-    throw new Error('Not found');
   }
 }

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

@@ -117,7 +117,7 @@ const models: TsoaRoute.Models = {
             "name": {"dataType":"string"},
             "version": {"dataType":"string"},
             "block": {"dataType":"double","required":true},
-            "caip2": {"dataType":"double","required":true},
+            "caip2": {"dataType":"string","required":true},
             "time": {"dataType":"string"},
             "achievements": {"dataType":"array","array":{"dataType":"refObject","ref":"Achievement"},"required":true},
         },
@@ -139,7 +139,7 @@ const models: TsoaRoute.Models = {
         "dataType": "refObject",
         "properties": {
             "block": {"dataType":"double","required":true},
-            "caip2": {"dataType":"double","required":true},
+            "caip2": {"dataType":"string","required":true},
             "time": {"dataType":"string"},
             "wallet": {"dataType":"string","required":true},
             "walletType": {"dataType":"string"},

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

@@ -223,8 +223,7 @@
 						"description": "Data block height (0 always valid)"
 					},
 					"caip2": {
-						"type": "number",
-						"format": "double",
+						"type": "string",
 						"description": "CAIP-2 blockchain identifier"
 					},
 					"time": {
@@ -299,8 +298,7 @@
 						"description": "Data block height (0 always valid)"
 					},
 					"caip2": {
-						"type": "number",
-						"format": "double",
+						"type": "string",
 						"description": "CAIP-2 blockchain identifier"
 					},
 					"time": {

packages/node-sdk/paima-db/README.md

@@ -15,6 +15,4 @@ Specific game databases do not need to contain these tables, as they will be cre
 
 ## Development
 
-To re-generate the queries, you will need a database running with the same connection info as [the config](./pgtypedconfig.json) and then run `npm run compile`.
-
-Before running `npm run compile`, you will need to initialize the DB using `sudo -u postgres psql -d postgres -a -f migrations/up.sql`
+To re-generate the queries, run `npm run compile`, which will use Docker to run a temporary Postgres database initialized with `migrations/up.sql` and then watch for query changes. Ctrl+C and restart to reflect changes to `up.sql`.

packages/node-sdk/paima-db/migrations/up.sql

@@ -257,4 +257,4 @@ CREATE TABLE achievement_progress(
   progress INTEGER,
   total INTEGER,
   PRIMARY KEY (wallet, name)
-);--
+);

packages/node-sdk/paima-db/src/delegate-wallet.ts

@@ -10,6 +10,7 @@ import {
   getMainAddressFromAddress,
 } from './sql/wallet-delegation.queries.js';
 import type { PoolClient, Notification, Client } from 'pg';
+import type { IDatabaseConnection } from '@pgtyped/runtime/lib/tag';
 
 export type WalletDelegate = { address: string; id: number };
 export const NO_USER_ID = -1;
@@ -26,7 +27,7 @@ export const addressCache = new Map<string, WalletDelegate>();
 // If wallet does not exist, It will NOT be created in address table.
 export async function getMainAddress(
   _address: string,
-  DBConn: PoolClient
+  DBConn: IDatabaseConnection
 ): Promise<WalletDelegate> {
   const address = _address.toLocaleLowerCase();
   let addressMapping: WalletDelegate | undefined = addressCache.get(address);

packages/node-sdk/paima-db/src/index.ts

@@ -6,7 +6,7 @@ import { DataMigrations } from './data-migrations.js';
 
 export * from './delegate-wallet.js';
 
-// resolve ambiguity because pgtyped generates multiple Json types
+// https://github.com/adelsz/pgtyped/issues/565
 export type { Json } from './sql/cde-generic.queries.js';
 
 export * from './sql/achievements.queries.js';

packages/node-sdk/paima-db/src/paima-tables.ts

@@ -576,6 +576,55 @@ const TABLE_DATA_DELEGATIONS: TableData = {
   creationQuery: QUERY_CREATE_TABLE_DELEGATIONS,
 };
 
+const QUERY_CREATE_TABLE_ACHIEVEMENT_TYPE = `
+CREATE TABLE achievement_type(
+  name TEXT NOT NULL PRIMARY KEY,
+  is_active BOOLEAN NOT NULL DEFAULT true,
+  display_name TEXT NOT NULL,
+  description TEXT NOT NULL DEFAULT '',
+  metadata JSONB NOT NULL DEFAULT '{}'
+);
+`;
+
+const TABLE_DATA_ACHIEVEMENT_TYPE: TableData = {
+  tableName: 'achievement_type',
+  primaryKeyColumns: ['name'],
+  columnData: packTuples([
+    ['name', 'text', 'NO', ''],
+    ['is_active', 'boolean', 'NO', 'true'],
+    ['display_name', 'text', 'NO', ''],
+    ['description', 'text', 'NO', "''"],
+    ['metadata', 'jsonb', 'NO', "'{}'"],
+  ]),
+  serialColumns: [],
+  creationQuery: QUERY_CREATE_TABLE_ACHIEVEMENT_TYPE,
+};
+
+const QUERY_CREATE_TABLE_ACHIEVEMENT_PROGRESS = `
+CREATE TABLE achievement_progress(
+  wallet TEXT NOT NULL,
+  name TEXT NOT NULL,
+  completed_date TIMESTAMP,
+  progress INTEGER,
+  total INTEGER,
+  PRIMARY KEY (wallet, name)
+);
+`;
+
+const TABLE_DATA_ACHIEVEMENT_PROGRESS: TableData = {
+  tableName: 'achievement_progress',
+  primaryKeyColumns: ['wallet', 'name'],
+  columnData: packTuples([
+    ['wallet', 'text', 'NO', ''],
+    ['name', 'text', 'NO', ''],
+    ['completed_date', 'timestamp', 'YES', ''],
+    ['progress', 'integer', 'YES', ''],
+    ['total', 'integer', 'YES', ''],
+  ]),
+  serialColumns: [],
+  creationQuery: QUERY_CREATE_TABLE_ACHIEVEMENT_PROGRESS,
+};
+
 const FUNCTION_NOTIFY_WALLET_CONNECT: string = `
 create or replace function public.notify_wallet_connect()
   returns trigger
@@ -663,4 +712,6 @@ export const TABLES: TableData[] = [
   TABLE_DATA_CDE_TRACKING_CARDANO_PAGINATION,
   TABLE_DATA_CDE_CARDANO_TRANSFER,
   TABLE_DATA_CDE_CARDANO_MINT_BURN,
+  TABLE_DATA_ACHIEVEMENT_TYPE,
+  TABLE_DATA_ACHIEVEMENT_PROGRESS,
 ];

packages/node-sdk/paima-utils-backend/src/achievements.ts

@@ -16,7 +16,7 @@ export interface Validity {
   /** Data block height (0 always valid) */
   block: number;
   /** CAIP-2 blockchain identifier */
-  caip2: number;
+  caip2: string;
   /** Optional date. ISO8601, like YYYY-MM-DDTHH:mm:ss.sssZ */
   time?: string;
 }