update app version build (#24)

DenisCarriere · web-flow · commit a7849dd2b609 · 2025-03-23T14:41:26.000-04:00
diff --git a/.github/workflows/ghcr.yml b/.github/workflows/ghcr.yml
@@ -38,14 +38,17 @@ jobs:
                       type=sha,prefix=,suffix=-{{date 'X'}}
                       type=raw,enable=${{ !startsWith(github.ref, 'refs/tags/') }},value=develop
                       type=semver,pattern={{raw}}
-
+            - run: echo "GIT_DATE=$(git log -1 --format=%cd --date=short)" >> $GITHUB_ENV
+            - run: echo "GIT_VERSION=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
             - name: Build and push Docker image
               uses: docker/build-push-action@v5
               with:
                   context: .
                   push: true
                   tags: ${{ steps.meta.outputs.tags }}
                   labels: ${{ steps.meta.outputs.labels }}
-                  # Pass github.sha to Docker as GIT_COMMIT
+                  # Pass github.sha to Docker as GIT_COMMIT & GIT_DATE
                   build-args: |
-                    GIT_COMMIT=${{ github.sha }}
+                    GIT_COMMIT=${{ github.sha }}
+                    GIT_DATE=${{ env.GIT_DATE }}
+                    GIT_VERSION=${{ env.GIT_VERSION }}
diff --git a/Dockerfile b/Dockerfile
@@ -6,8 +6,17 @@ RUN bun install
 
 # Declare a build argument for the Git commit hash
 ARG GIT_COMMIT
+ARG GIT_VERSION
+ARG GIT_DATE
 
 # Set an environment variable inside the container
 ENV GIT_COMMIT=${GIT_COMMIT}
+ENV GIT_VERSION=${GIT_VERSION}
+ENV GIT_DATE=${GIT_DATE}
+
+# https://github.com/opencontainers/image-spec/blob/main/annotations.md
+LABEL org.opencontainers.image.revision=$GIT_COMMIT
+LABEL org.opencontainers.image.version=$GIT_VERSION
+LABEL org.opencontainers.image.created=$GIT_DATE
 
 ENTRYPOINT [ "bun", "run", "start" ]
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
-# The Graph: `Token API`
+# `Token API`
 
-[![.github/workflows/bun-test.yml](https://github.com/graphprotocol/token-api/actions/workflows/bun-test.yml/badge.svg)](https://github.com/graphprotocol/token-api/actions/workflows/bun-test.yml)
-![license](https://img.shields.io/github/license/graphprotocol/token-api)
+[![.github/workflows/bun-test.yml](https://github.com/pinax-network/pinax-token-api/actions/workflows/bun-test.yml/badge.svg)](https://github.com/pinax-network/pinax-token-api/actions/workflows/bun-test.yml)
+![license](https://img.shields.io/github/license/pinax-network/pinax-token-api)
 
-> Power your apps with real-time token data.
+> Power your apps & AI agents with real-time token data.
 
 ![banner](banner.jpg)
 
@@ -76,6 +76,8 @@ docker pull ghcr.io/graphprotocol/token-api:develop
 ```bash
 docker build \
   --build-arg GIT_COMMIT="$(git rev-parse HEAD)" \
+  --build-arg GIT_DATE="$(git log -1 --format=%cd --date=short)" \
+  --build-arg GIT_VERSION="$(git describe --tags --abbrev=0)" \
   -t token-api .
 ```
 
diff --git a/bun.lock b/bun.lock
@@ -21,7 +21,7 @@
         "zod-openapi": "^4.2.3",
       },
       "devDependencies": {
-        "bun-types": "^1.2.5",
+        "@types/bun": "^1.2.5",
         "typescript": "^5.8.2",
       },
     },
@@ -55,6 +55,8 @@
 
     "@tokenizer/token": ["@tokenizer/token@0.3.0", "", {}, "sha512-OvjF+z51L3ov0OyAU0duzsYuvO01PH7x4t6DJx+guahgTnBHkhJdG7soQeTSFLWN3efnHyibZ4Z8l2EuWwJN3A=="],
 
+    "@types/bun": ["@types/bun@1.2.5", "", { "dependencies": { "bun-types": "1.2.5" } }, "sha512-w2OZTzrZTVtbnJew1pdFmgV99H0/L+Pvw+z1P67HaR18MHOzYnTYOi6qzErhK8HyT+DB782ADVPPE92Xu2/Opg=="],
+
     "@types/json-schema": ["@types/json-schema@7.0.15", "", {}, "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA=="],
 
     "@types/node": ["@types/node@22.13.11", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-iEUCUJoU0i3VnrCmgoWCXttklWcvoCIx4jzcP22fioIVSdTmjgoEvmAO/QPw6TcS9k5FrNgn4w7q5lGOd1CT5g=="],
diff --git a/index.ts b/index.ts
@@ -27,7 +27,7 @@ app.get('/openapi', openAPISpecs(app, {
     documentation: {
         info: {
             title: 'Token API (Beta)',
-            version: APP_VERSION.version,
+            version: APP_VERSION,
             description: 'Power your apps & AI agents with real-time token data.',
         },
         servers: [
diff --git a/package.json b/package.json
@@ -1,9 +1,8 @@
 {
     "private": true,
     "name": "token-api",
-    "description": "The Graph: Token API",
-    "version": "0.1.0",
-    "homepage": "https://github.com/graphprotocol/token-api",
+    "description": "Token API",
+    "homepage": "https://github.com/pinax-network/pinax-token-api",
     "license": "Apache-2.0",
     "type": "module",
     "authors": [
@@ -51,6 +50,6 @@
     },
     "devDependencies": {
         "typescript": "^5.8.2",
-        "bun-types": "^1.2.5"
+        "@types/bun": "^1.2.5"
     }
 }
diff --git a/src/config.ts b/src/config.ts
@@ -1,6 +1,7 @@
 import "dotenv/config";
-import { z } from 'zod';
+import { date, z } from 'zod';
 import { Option, program } from "commander";
+import { $ } from "bun";
 
 import pkg from "../package.json" with { type: "json" };
 
@@ -20,24 +21,30 @@ export const DEFAULT_IDLE_TIMEOUT = 60;
 export const DEFAULT_PRETTY_LOGGING = false;
 export const DEFAULT_VERBOSE = false;
 export const DEFAULT_SORT_BY = "DESC";
-export const APP_NAME = pkg.name;
-export const APP_DESCRIPTION = pkg.description;
-export const GIT_COMMIT = process.env.GIT_COMMIT || "unknown";
-export const APP_VERSION = {
-    version: pkg.version as `${number}.${number}.${number}`,
-    commit: GIT_COMMIT
-};
 export const DEFAULT_AGE = 30;
 export const DEFAULT_MAX_AGE = 180;
 export const DEFAULT_PAGE = 1;
 export const DEFAULT_LIMIT = 10;
 export const DEFAULT_NETWORK_ID = "mainnet";
 export const DEFAULT_NETWORKS = "arbitrum-one,base,bsc,mainnet"
 
+// GitHub metadata
+const GIT_COMMIT = process.env.GIT_COMMIT || await $`git rev-parse HEAD`.text();
+const GIT_DATE = process.env.GIT_DATE ?? await $`git log -1 --format=%cd --date=short`.text();
+const GIT_VERSION = process.env.GIT_VERSION ?? await $`git describe --tags --abbrev=0`.text();
+export const GIT_APP = {
+    version: GIT_VERSION.replace(/\n/, "") as `${number}.${number}.${number}`,
+    commit: GIT_COMMIT.slice(0, 7),
+    date: GIT_DATE.replace(/\n/, "") as `${number}-${number}-${number}`,
+};
+export const APP_NAME = pkg.name;
+export const APP_DESCRIPTION = pkg.description;
+export const APP_VERSION = `${GIT_APP.version}+${GIT_APP.commit} (${GIT_APP.date})`;
+
 // parse command line options
 const opts = program
     .name(pkg.name)
-    .version(`${APP_VERSION.version}+${APP_VERSION.commit}`)
+    .version(APP_VERSION)
     .description(APP_DESCRIPTION)
     .showHelpAfterError()
     .addOption(new Option("-p, --port <number>", "HTTP port on which to attach the API").env("PORT").default(DEFAULT_PORT))
diff --git a/src/logger.ts b/src/logger.ts
@@ -1,11 +1,11 @@
 import { Logger, type ILogObj } from "tslog";
-import { APP_NAME, APP_VERSION, config } from "./config.js";
+import { APP_VERSION, config } from "./config.js";
 
 class TsLogger extends Logger<ILogObj> {
     constructor() {
         super();
         this.settings.minLevel = 5;
-        this.settings.name = `${APP_NAME}:${APP_VERSION.version}+${APP_VERSION.commit}`;
+        this.settings.name = APP_VERSION;
     }
 
     public enable(type: "pretty" | "json" = "pretty") {
diff --git a/src/mcp/index.ts b/src/mcp/index.ts
@@ -1,14 +1,14 @@
 import { FastMCP } from "fastmcp";
 
-import { APP_DESCRIPTION, APP_VERSION, config } from "../config.js";
+import { APP_VERSION, config, GIT_APP } from "../config.js";
 import { logger } from "../logger.js";
 import tools from "./tools.js";
 import prompts from "./prompts.js";
 import { resources, resourceTemplates } from "./resources.js";
 
 const mcp = new FastMCP({
-    name: APP_DESCRIPTION,
-    version: APP_VERSION.version,
+    name: APP_VERSION,
+    version: GIT_APP.version,
 });
 
 // Catch session errors (default MCP SDK timeout of 10 seconds) and close connection
diff --git a/src/routes/version.ts b/src/routes/version.ts
@@ -1,13 +1,14 @@
 import { Hono } from 'hono'
 import { describeRoute } from 'hono-openapi'
 import { resolver } from 'hono-openapi/zod'
-import { APP_VERSION } from '../config.js'
+import { GIT_APP } from '../config.js'
 import { z } from 'zod'
 
 const route = new Hono();
 
 const responseSchema = z.object({
     version: z.string(),
+    date: z.string(),
     commit: z.string(),
 });
 
@@ -18,17 +19,14 @@ const openapi = describeRoute({
         200: {
             description: 'Successful Response',
             content: {
-                'application/json': { schema: resolver(responseSchema), example: {
-                    version: APP_VERSION.version,
-                    commit: APP_VERSION.commit,
-                } },
+                'application/json': { schema: resolver(responseSchema), example: GIT_APP },
             },
         },
     },
 })
 
 route.get('/version', openapi, (c) => {
-    return c.json(APP_VERSION)
+    return c.json(GIT_APP)
 });
 
 export default route;
diff --git a/src/sql/index.ts b/src/sql/index.ts
@@ -4,40 +4,40 @@ import { logger } from '../logger.js';
 
 /**
  * Loads all SQL files from a specified directory (non-recursive) into a key-value object
- * 
+ *
  * @param folderPath - The path to the directory containing SQL files.
  * Note that if using relative paths, the starting directory will be the current working directory (i.e. `process.cwd()`)
  * @returns A promise that resolves to an object where:
  *   - Keys are the filenames without the .sql extension
  *   - Values are the contents of the corresponding SQL files as strings
- * 
+ *
  * @example
  * // Load SQL files from the 'balances_for_account' directory
  * const sqlQueries = await loadSqlFiles('./src/sql/balances_for_account');
- * 
+ *
  * // Access a specific query for a chain
  * const evmQuery = sqlQueries['evm'];
- * 
+ *
  * @throws Will throw an error if the directory cannot be read or if a file cannot be loaded
  */
 export async function loadSqlFiles(folderPath: string): Promise<Record<string, string>> {
     const sqlFiles: Record<string, string> = {};
-  
+
     try {
         const files = await readdir(folderPath);
-    
+
         for (const file of files) {
             if (file.endsWith('.sql')) {
                 const filePath = join(folderPath, file);
                 const content = await readFile(filePath, 'utf-8');
-        
+
                 // Use the filename without extension as the key
                 const key = file.replace('.sql', '');
                 // Fold multiline statement into single line
                 sqlFiles[key] = content.replace(/\n|;/g, ' ').trim();
             }
         }
-    
+
         return sqlFiles;
     } catch (error) {
         logger.error('Error loading SQL files:', error);
@@ -48,20 +48,20 @@ export async function loadSqlFiles(folderPath: string): Promise<Record<string, s
 const sqlQueries: Record<string, Record<string, string>> = {};
 try {
     const subdirs = await readdir("./src/sql", { withFileTypes: true });
-    
+
     for (const dirent of subdirs) {
         if (dirent.isDirectory()) {
             const subfolderName = dirent.name;
             const subfolderPath = join("./src/sql", subfolderName);
-        
+
             const subfolderQueries = await loadSqlFiles(subfolderPath);
             sqlQueries[subfolderName] = subfolderQueries;
         }
-    }    
+    }
 } catch (error) {
     logger.error('Error loading SQL files from subdirectories:', error);
     throw error;
 }
 
-logger.trace(`Loaded SQL queries:\n`, sqlQueries);
+logger.trace(`Loaded SQL queries:\n`, Object.keys(sqlQueries));
 export { sqlQueries };

-Original file line number
+Diff line change
         "zod-openapi": "^4.2.3",
       },
       "devDependencies": {
 -        "bun-types": "^1.2.5",
 +        "@types/bun": "^1.2.5",
         "typescript": "^5.8.2",
       },
     },
     "@tokenizer/token": ["@tokenizer/[email protected]", "", {}, "sha512-OvjF+z51L3ov0OyAU0duzsYuvO01PH7x4t6DJx+guahgTnBHkhJdG7soQeTSFLWN3efnHyibZ4Z8l2EuWwJN3A=="],
 +    "@types/bun": ["@types/[email protected]", "", { "dependencies": { "bun-types": "1.2.5" } }, "sha512-w2OZTzrZTVtbnJew1pdFmgV99H0/L+Pvw+z1P67HaR18MHOzYnTYOi6qzErhK8HyT+DB782ADVPPE92Xu2/Opg=="],
++
     "@types/json-schema": ["@types/[email protected]", "", {}, "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA=="],
     "@types/node": ["@types/[email protected]", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-iEUCUJoU0i3VnrCmgoWCXttklWcvoCIx4jzcP22fioIVSdTmjgoEvmAO/QPw6TcS9k5FrNgn4w7q5lGOd1CT5g=="],
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"private": true,`
`3`	`3`	`"name": "token-api",`
`4`		`- "description": "The Graph: Token API",`
`5`		`- "version": "0.1.0",`
`6`		`- "homepage": "https://github.com/graphprotocol/token-api",`
	`4`	`+ "description": "Token API",`
	`5`	`+ "homepage": "https://github.com/pinax-network/pinax-token-api",`
`7`	`6`	`"license": "Apache-2.0",`
`8`	`7`	`"type": "module",`
`9`	`8`	`"authors": [`
`@@ -51,6 +50,6 @@`
`51`	`50`	`},`
`52`	`51`	`"devDependencies": {`
`53`	`52`	`"typescript": "^5.8.2",`
`54`		`- "bun-types": "^1.2.5"`
	`53`	`+ "@types/bun": "^1.2.5"`
`55`	`54`	`}`
`56`	`55`	`}`