chore(backend, auth): use open-payments-specifications as submodule (#3615)

* chore: add open-payments-specifications submodule (v1.0.3) and load specs via @interledger/openapi createOpenAPI

* chore: format

* fix: attempt to fix CI fetching of submodule

* fix(ci): add submodule to .prettierignore

* chore(backend): copy specs for token introspection, update readmes

* chore(backend): update lock file

* fix: attempt to fix ci

* fix: attempt to fix ci

* fix: attempt to fix ci

* fix: attempt to fix ci

* fix: attempt to fix ci

* fix: attempt to fix ci

* fix: revert refs in token introspection

* chore(token-introspection): remove copy script for OP specs

* chore(ci): remove submodules fetch

* chore(token-introspection): remove duplicate spec file

* fix(token-introspection): update spec path

Co-authored-by: Max Kurapov <[email protected]>

* chore(token-introspection): generate types

---------

Co-authored-by: Max Kurapov <[email protected]>

Author: sanducb

.github/workflows/node-build.yml

@@ -27,6 +27,9 @@ jobs:
     timeout-minutes: 25
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
       - uses: ./.github/workflows/rafiki/env-setup
       - run: pnpm --filter backend build:deps
       - run: NODE_OPTIONS="--max-old-space-size=4096" pnpm --filter backend test:ci
@@ -53,6 +56,9 @@ jobs:
     timeout-minutes: 5
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
       - uses: ./.github/workflows/rafiki/env-setup
       - run: pnpm --filter auth build:deps
       - run: pnpm --filter auth test
@@ -143,6 +149,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
 
       - name: Setup environment
         uses: ./.github/workflows/rafiki/env-setup
@@ -166,6 +175,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
 
       - name: Setup environment
         uses: ./.github/workflows/rafiki/env-setup
@@ -396,6 +408,8 @@ jobs:
           - backend
           - frontend
     steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
       - name: Build

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "open-payments-specifications"]
+	path = open-payments-specifications
+	url = https://github.com/interledger/open-payments-specifications.git

.prettierignore

@@ -14,4 +14,5 @@ build
 **/styles/*.css
 .docusaurus
 .cache-loader
-.astro
+.astro
+open-payments-specifications/**

README.md

@@ -67,6 +67,7 @@ Clone the Rafiki repository
 ```sh
 git clone https://github.com/interledger/rafiki.git
 cd rafiki
+git submodule update --init --recursive
 ```
 
 Install Node.js
@@ -94,6 +95,22 @@ Install dependencies
 pnpm i
 ```
 
+### Git submodules
+
+This repository uses a git submodule for Open Payments specifications located at `open-payments-specifications/`.
+
+- Initialize submodules after cloning:
+
+```sh
+git submodule update --init --recursive
+```
+
+- Alternatively, clone the repository with submodules in one step:
+
+```sh
+git clone --recurse-submodules https://github.com/interledger/rafiki.git
+```
+
 ### Local Development
 
 The Rafiki local environment is the best way to explore Rafiki locally. The [localenv](localenv) directory contains instructions for setting up a local playground. Please refer to the README for each individual package for more details.

localenv/README.md

@@ -79,6 +79,20 @@ Remove volumes and images
 pnpm localenv:compose down --volumes --rmi all
 ```
 
+### Note on git submodules
+
+Rafiki uses a git submodule for Open Payments specifications (`open-payments-specifications/`). Ensure submodules are initialized before building or running the Local Playground:
+
+```sh
+git submodule update --init --recursive
+```
+
+Alternatively, clone the repository with submodules in one step:
+
+```sh
+git clone --recurse-submodules https://github.com/interledger/rafiki.git
+```
+
 # Environment components
 
 ![Docker compose environment](../packages/documentation/public/img/localenv.png)

open-payments-specifications

@@ -35,6 +35,7 @@ FROM base AS builder
 COPY package.json pnpm-workspace.yaml .npmrc tsconfig.json tsconfig.build.json ./
 COPY packages/auth ./packages/auth
 COPY packages/token-introspection ./packages/token-introspection
+COPY open-payments-specifications/openapi ./open-payments-specifications/openapi
 
 RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
     pnpm install \
@@ -59,6 +60,7 @@ COPY --from=prod-deps /home/rafiki/packages/auth/knexfile.js ./packages/auth/kne
 COPY --from=builder /home/rafiki/packages/auth/migrations/ ./packages/auth/migrations
 COPY --from=builder /home/rafiki/packages/auth/dist ./packages/auth/dist
 COPY --from=builder /home/rafiki/packages/token-introspection/dist ./packages/token-introspection/dist
+COPY --from=builder /home/rafiki/open-payments-specifications/openapi ./open-payments-specifications/openapi
 
 USER root
 

packages/auth/Dockerfile.prod

@@ -14,10 +14,7 @@ import { createAccessTokenRoutes } from './accessToken/routes'
 import { createGrantRoutes } from './grant/routes'
 import { createInteractionRoutes } from './interaction/routes'
 import { createOpenAPI } from '@interledger/openapi'
-import {
-  createUnauthenticatedClient as createOpenPaymentsClient,
-  getAuthServerOpenAPI
-} from '@interledger/open-payments'
+import { createUnauthenticatedClient as createOpenPaymentsClient } from '@interledger/open-payments'
 import { createInteractionService } from './interaction/service'
 import { getTokenIntrospectionOpenAPI } from 'token-introspection'
 import { Redis } from 'ioredis'
@@ -187,7 +184,12 @@ export function initIocContainer(
   )
 
   container.singleton('openApi', async () => {
-    const authServerSpec = await getAuthServerOpenAPI()
+    const authServerSpec = await createOpenAPI(
+      path.resolve(
+        __dirname,
+        '../../../open-payments-specifications/openapi/auth-server.yaml'
+      )
+    )
     const idpSpec = await createOpenAPI(
       path.resolve(__dirname, './openapi/specs/id-provider.yaml')
     )

packages/auth/src/index.ts

@@ -35,6 +35,7 @@ FROM base AS builder
 COPY package.json pnpm-workspace.yaml .npmrc tsconfig.json tsconfig.build.json ./
 COPY packages/backend ./packages/backend
 COPY packages/token-introspection ./packages/token-introspection
+COPY open-payments-specifications/openapi ./open-payments-specifications/openapi
 
 RUN --mount=type=cache,id=pnpm,target=/pnpm/store \
     pnpm install \
@@ -60,6 +61,7 @@ COPY --from=builder /home/rafiki/packages/backend/migrations/ ./packages/backend
 COPY --from=builder /home/rafiki/packages/backend/dist ./packages/backend/dist
 COPY --from=builder /home/rafiki/packages/token-introspection/dist ./packages/token-introspection/dist
 COPY --from=builder /home/rafiki/packages/backend/knexfile.js ./packages/backend/knexfile.js
+COPY --from=builder /home/rafiki/open-payments-specifications/openapi ./open-payments-specifications/openapi
 
 USER root
 

packages/backend/Dockerfile.prod

@@ -9,11 +9,9 @@ import net from 'net'
 import dns from 'dns'
 import { createHmac } from 'crypto'
 
-import {
-  createAuthenticatedClient as createOpenPaymentsClient,
-  getResourceServerOpenAPI,
-  getWalletAddressServerOpenAPI
-} from '@interledger/open-payments'
+import { createAuthenticatedClient as createOpenPaymentsClient } from '@interledger/open-payments'
+import { createOpenAPI } from '@interledger/openapi'
+import path from 'path'
 import { StreamServer } from '@interledger/stream-receiver'
 import axios from 'axios'
 import {
@@ -301,8 +299,18 @@ export function initIocContainer(
   })
 
   container.singleton('openApi', async () => {
-    const resourceServerSpec = await getResourceServerOpenAPI()
-    const walletAddressServerSpec = await getWalletAddressServerOpenAPI()
+    const resourceServerSpec = await createOpenAPI(
+      path.resolve(
+        __dirname,
+        '../../../open-payments-specifications/openapi/resource-server.yaml'
+      )
+    )
+    const walletAddressServerSpec = await createOpenAPI(
+      path.resolve(
+        __dirname,
+        '../../../open-payments-specifications/openapi/wallet-address-server.yaml'
+      )
+    )
 
     return {
       resourceServerSpec,