Add scaffolding for PRC-1 achievements API

[SpaceManiac]

Approach:

• paima-rest defines a PRC-1 compliant /achievements controller
• For achievement definitions (types + languages), it reads the achievements export from endpoints.cjs
• For achievement progress, it reads the new Paima-defined table achievement_progress
• Games can upsert into achievement_progress as needed
  • paima-db exports the setAchievementProgress query for this purpose
• In the worst case, games can fully override this controller by duplicating the relevant routes in their game, which will take priority (with a warning)

Benefits:

• TypeScript types for PRC-1 are defined in utils-backend for easy import by games in a pinch
• Exposed API is statically PRC-1 compliant, unless overridden

For future improvement:

• Currently hardcoding eip155 in the chain ID, which won't suffice when we add data availability layer support
• Looking up achievements by NFT owner could also support ERC-6551

[SebastienGllmt]

Any reason to move this out of the prebuild?

I don't remember exactly why it was here, but I think it may have to be with the fact that putting it in the prebuild ensures that it gets run before the build step of any package in paima-engine (so any package can access the generated types). I don't think this is used in practice though

[SpaceManiac]

What I ran into is that if this stays in prebuild, tsoa can't import the PRC-1 types from utils-backend on clean builds, or otherwise sees the old definitions, because they're produced on that package's build.

Maybe can somehow be improved by teaching NX to build utils-backend before prebuilding paima-rest?

[SebastienGllmt]

NX should be able to figure out dependencies based on the references inside the tsconfig IIRC

[SpaceManiac]

Seems to not work. It doesn't infer that rest:prebuild depends on utils-backend:build

~/paima-engine (patch/standard-achievements-api|✚3) $ rm -r packages/node-sdk/paima-utils-backend/build/
~/paima-engine (patch/standard-achievements-api|✚3) $ npm run build

> @paima/[email protected] prebuild
> npx nx run-many --parallel=${NX_PARALLEL:-3} -t prebuild

 
    ✔  nx run @paima/utils:prebuild (2s)

    ✖  nx run @paima/rest:prebuild
       > @paima/[email protected] prebuild
       > npm run compile:api
       
       
       > @paima/[email protected] compile:api
       > npx tsoa spec-and-routes
       
       Generate routes error.
        GenerateMetadataError: No declarations found for referenced type AchievementPublicList.
           at TypeResolver.getModelTypeDeclarations (/home/paima/paima-engine/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:1125:19)
           at TypeResolver.calcRefTypeName (/home/paima/paima-engine/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:685:39)
           at TypeResolver.calcTypeReferenceTypeName (/home/paima/paima-engine/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:876:34)
           at TypeResolver.getReferenceType (/home/paima/paima-engine/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:886:27)
           at TypeResolver.resolve (/home/paima/paima-engine/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:513:36)
           at TypeResolver.resolve (/home/paima/paima-engine/node_modules/@tsoa/cli/dist/metadataGeneration/typeResolver.js:503:118)
           at MethodGenerator.Generate (/home/paima/paima-engine/node_modules/@tsoa/cli/dist/metadataGeneration/methodGenerator.js:62:78)
           at /home/paima/paima-engine/node_modules/@tsoa/cli/dist/metadataGeneration/controllerGenerator.js:46:41
           at Array.map (<anonymous>)
           at ControllerGenerator.buildMethods (/home/paima/paima-engine/node_modules/@tsoa/cli/dist/metadataGeneration/controllerGenerator.js:46:14)
       npm ERR! Lifecycle script `compile:api` failed with error: 
       npm ERR! Error: command failed 
       npm ERR!   in workspace: @paima/[email protected] 
       npm ERR!   at location: /home/paima/paima-engine/packages/engine/paima-rest 
       npm ERR! Lifecycle script `prebuild` failed with error: 
       npm ERR! Error: command failed 
       npm ERR!   in workspace: @paima/[email protected] 
       npm ERR!   at location: /home/paima/paima-engine/packages/engine/paima-rest 
       
       

 ———————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————

 >  NX   Ran target prebuild for 2 projects (4s)
 
    ✔    1/2 succeeded [0 read from cache]
 
    ✖    1/2 targets failed, including the following:
         - nx run @paima/rest:prebuild

[SebastienGllmt]

Did we want to include these two in the db as-is despite the fact they're language-specific depending on the header field you use when querying the achievement endpoint?

[SpaceManiac]

If a table for language-agnostic info + another one for per-language info works for you, we can do that

[SebastienGllmt]

In an ideal world translations wouldn't be in the database at all, but if it has to be, probably it's best for it to be in a separate table

[SpaceManiac]

Possible alternatives:

1. Another export from packaged/endpoints.cjs
2. Another .json file in packaged/

[SpaceManiac]

Since I find putting "code" (stuff that's defined by the programmer and not by user input) in the database kind of goofy, this is what I'm looking at now:

• Game ID, achievement types, and languages are an additional packaged/endpoints.cjs export
  • But it's just a big data object, not a class with methods on it
• Achievement progress is stored in a DB table