Add version field to signed API

api3dao · Dec 5, 2023 · 4ea7258 · 4ea7258
1 parent 1c3b93a
commit 4ea7258
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 4 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -68,4 +68,4 @@ RUN addgroup -S deployed-api && \
 USER deployed-api
 
 COPY --chown=deployed-api:deployed-api --from=deployed-api /app/deployed-api .
-ENTRYPOINT ["node", "dist/index.js"]
+ENTRYPOINT ["node", "dist/src/index.js"]
diff --git a/packages/api/README.md b/packages/api/README.md
@@ -213,6 +213,10 @@ An identifier of the deployment stage. This is used to distinguish between diffe
 example `dev`, `staging` or `production`. The stage value can have 256 characters at maximum and can only include
 lowercase alphanumeric characters and hyphens.
 
+##### `version`
+
+The version specified in the config must match the version of the Signed API at deployment time.
+
 ## API
 
 The API provides the following endpoints:

diff --git a/packages/api/config/signed-api.example.json b/packages/api/config/signed-api.example.json
@@ -10,5 +10,6 @@
     }
   ],
   "allowedAirnodes": ["0xbF3137b0a7574563a23a8fC8badC6537F98197CC"],
-  "stage": "local"
+  "stage": "local",
+  "version": "0.1.0"
 }
diff --git a/packages/api/deployment/cloudformation-template.json b/packages/api/deployment/cloudformation-template.json
@@ -44,7 +44,7 @@
             "EntryPoint": [
               "/bin/sh",
               "-c",
-              "wget -O - <SIGNED_API_CONFIGURATION_URL> >> ./config/signed-api.json && node dist/index.js"
+              "wget -O - <SIGNED_API_CONFIGURATION_URL> >> ./config/signed-api.json && node dist/src/index.js"
             ],
             "PortMappings": [
               {

diff --git a/packages/api/package.json b/packages/api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "api",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "engines": {
     "node": "^18.18.2",
     "pnpm": "^8.11.0"

diff --git a/packages/api/src/schema.ts b/packages/api/src/schema.ts
@@ -2,6 +2,8 @@ import { type LogFormat, logFormatOptions, logLevelOptions, type LogLevel } from
 import { uniqBy } from 'lodash';
 import { z } from 'zod';
 
+import packageJson from '../package.json';
+
 export const evmAddressSchema = z.string().regex(/^0x[\dA-Fa-f]{40}$/, 'Must be a valid EVM address');
 
 export const evmIdSchema = z.string().regex(/^0x[\dA-Fa-f]{64}$/, 'Must be a valid EVM ID');
@@ -38,6 +40,7 @@ export const configSchema = z.strictObject({
   stage: z
     .string()
     .regex(/^[\da-z-]{1,256}$/, 'Only lowercase letters, numbers and hyphens are allowed (max 256 characters)'),
+  version: z.string().refine((version) => version === packageJson.version, 'Invalid Signed API version'),
 });
 
 export type Config = z.infer<typeof configSchema>;