feat(runes): add runes api to codebase (#449)

* new code

* add ci

* files

* standard

* Update api/runes/package.json

Co-authored-by: ASuciuX <151519329+ASuciuX@users.noreply.github.com>

---------

Co-authored-by: ASuciuX <151519329+ASuciuX@users.noreply.github.com>

Author: rafaelcr

.github/workflows/ci.yaml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        suite: [ordinals]
+        suite: [ordinals, runes]
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -41,8 +41,9 @@ jobs:
           path: |
             ~/.npm
             **/node_modules
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          key: ${{ runner.os }}-build-${{ matrix.suite }}-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
+            ${{ runner.os }}-build-${{ matrix.suite }}-${{ env.cache-name }}-
             ${{ runner.os }}-build-${{ env.cache-name }}-
             ${{ runner.os }}-build-
             ${{ runner.os }}-
@@ -63,7 +64,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        suite: [ordinals]
+        suite: [ordinals, runes]
     defaults:
       run:
         working-directory: ./api/${{ matrix.suite }}
@@ -86,8 +87,9 @@ jobs:
           path: |
             ~/.npm
             **/node_modules
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          key: ${{ runner.os }}-build-${{ matrix.suite }}-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
+            ${{ runner.os }}-build-${{ matrix.suite }}-${{ env.cache-name }}-
             ${{ runner.os }}-build-${{ env.cache-name }}-
             ${{ runner.os }}-build-
             ${{ runner.os }}-
@@ -260,7 +262,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        suite: [ordinals]
+        suite: [ordinals, runes]
     runs-on: ubuntu-latest
     needs: semantic-release
     steps:
@@ -285,7 +287,7 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            hirosystems/${{ matrix.suite }}-api
+            hirosystems/bitcoin-indexer-${{ matrix.suite }}-api
           tags: |
             type=ref,event=branch
             type=ref,event=pr

.vscode/launch.json

@@ -126,5 +126,26 @@
         "PGPASSWORD": "postgres",
       },
     },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "test: runes-api",
+      "program": "${workspaceFolder}/api/runes/node_modules/jest/bin/jest",
+      "cwd": "${workspaceFolder}/api/runes/",
+      "args": [
+        "--testTimeout=3600000",
+        "--runInBand",
+        "--no-cache",
+      ],
+      "outputCapture": "std",
+      "console": "integratedTerminal",
+      "preLaunchTask": "npm: testenv:run",
+      "postDebugTask": "npm: testenv:stop",
+      "env": {
+        "PGHOST": "localhost",
+        "PGUSER": "postgres",
+        "PGPASSWORD": "postgres",
+      },
+    },
   ]
 }

api/ordinals/.editorconfig renamed to api/.editorconfig

@@ -0,0 +1,2 @@
+node_modules/
+.eslintrc.js

api/ordinals/.gitignore renamed to api/.gitignore

@@ -0,0 +1,29 @@
+module.exports = {
+  root: true,
+  extends: ['@stacks/eslint-config', 'prettier'],
+  overrides: [],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: './tsconfig.json',
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+  ignorePatterns: ['*.config.js', 'config/*', '*.mjs', 'tests/*.js', 'client/*'],
+  plugins: ['@typescript-eslint', 'eslint-plugin-tsdoc', 'prettier'],
+  rules: {
+    'prettier/prettier': 'error',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/camelcase': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-use-before-define': ['error', 'nofunc'],
+    '@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: true }],
+    'no-warning-comments': 'warn',
+    'tsdoc/syntax': 'error',
+    // TODO: Remove this when `any` abi type is fixed.
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+  },
+};

api/ordinals/.commitlintrc.json

@@ -0,0 +1 @@
+20

api/ordinals/.env.example

@@ -0,0 +1 @@
+# Runes API