feat(open-payments): replace axios with ky

.github/workflows/deploy-docs.yaml

@@ -24,7 +24,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - uses: pnpm/action-setup@v2
         name: Install pnpm

.github/workflows/env-setup/action.yaml

@@ -9,7 +9,7 @@ runs:
         version: 7
     - uses: actions/setup-node@v3
       with:
-        node-version: '18'
+        node-version: '20'
         cache: 'pnpm'
     - name: Install dependencies
       shell: bash

.github/workflows/test-docs-build.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
 
       - uses: pnpm/action-setup@v2
         name: Install pnpm

.nvmrc

@@ -0,0 +1 @@
+lts/iron

README.md

@@ -68,9 +68,8 @@ More phone numbers: https://tel.meet/htd-eefo-ovn?hs=5
 ### Environment Setup
 
 ```sh
-# install node 18
-nvm install lts/hydrogen
-nvm use lts/hydrogen
+# install node from `./.nvmrc`
+nvm install
 
 # install pnpm
 corepack enable

jest.config.base.js

@@ -2,7 +2,7 @@
 
 module.exports = {
   transform: {
-    '^.+\\.tsx?$': ['@swc/jest']
+    '^.+\\.(t|j)sx?$': ['@swc/jest']
   },
   testEnvironment: 'node',
   moduleDirectories: ['node_modules', './'],

package.json

@@ -3,8 +3,10 @@
   "license": "Apache-2.0",
   "repository": "https://github.com/interledger/open-payments",
   "engines": {
-    "node": "18"
+    "pnpm": "^8.15.6",
+    "node": "20"
   },
+  "packageManager": "pnpm@8.15.6",
   "scripts": {
     "preinstall": "npx only-allow pnpm",
     "lint": "eslint --max-warnings=0 --fix .",

packages/http-signature-utils/package.json

@@ -30,7 +30,7 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@types/node": "^18.7.12",
+    "@types/node": "^20.12.7",
     "@types/uuid": "^9.0.0",
     "typescript": "^4.9.5"
   }

packages/open-payments/jest.config.js

@@ -4,6 +4,8 @@ const baseConfig = require('../../jest.config.base.js')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const packageName = 'open-payments'
 
+const esModules = ['ky']
+
 module.exports = {
   ...baseConfig,
   clearMocks: true,
@@ -13,5 +15,6 @@ module.exports = {
   modulePaths: [`<rootDir>/packages/${packageName}/src/`],
   id: packageName,
   displayName: packageName,
-  rootDir: '../..'
+  rootDir: '../..',
+  transformIgnorePatterns: [`node_modules/(?!.pnpm|${esModules.join('|')})`]
 }

packages/open-payments/package.json

@@ -30,18 +30,18 @@
     "test": "jest --passWithNoTests"
   },
   "devDependencies": {
-    "@types/node": "^18.7.12",
+    "@types/node": "^20.12.7",
     "@types/uuid": "^9.0.0",
-    "nock": "^13.3.0",
+    "nock": "14.0.0-beta.5",
     "openapi-typescript": "^4.5.0",
     "typescript": "^4.9.5"
   },
   "dependencies": {
     "@interledger/http-signature-utils": "workspace:2.0.2",
     "@interledger/openapi": "workspace:2.0.1",
-    "axios": "^1.6.0",
     "base64url": "^3.0.1",
     "http-message-signatures": "^0.1.2",
+    "ky": "^1.2.3",
     "pino": "^8.11.0",
     "uuid": "^9.0.0"
   }

packages/open-payments/src/client/incoming-payment.test.ts

@@ -64,7 +64,7 @@ describe('incoming-payment', (): void => {
         },
         openApiValidators.successfulValidator
       )
-      expect(result).toStrictEqual(incomingPayment)
+      expect(result).toEqual(incomingPayment)
     })
 
     test('throws if incoming payment does not pass validation', async (): Promise<void> => {
@@ -133,7 +133,7 @@ describe('incoming-payment', (): void => {
         },
         openApiValidators.successfulValidator
       )
-      expect(result).toStrictEqual(publicIncomingPayment)
+      expect(result).toEqual(publicIncomingPayment)
     })
 
     test('throws if incoming payment does not pass open api validation', async (): Promise<void> => {
@@ -176,13 +176,13 @@ describe('incoming-payment', (): void => {
         const result = await createIncomingPayment(
           deps,
           { url: serverAddress, accessToken },
-          openApiValidators.successfulValidator,
           {
             walletAddress,
             incomingAmount,
             expiresAt,
             metadata
-          }
+          },
+          openApiValidators.successfulValidator
         )
 
         scope.done()
@@ -211,8 +211,8 @@ describe('incoming-payment', (): void => {
         await createIncomingPayment(
           deps,
           { url: serverAddress, accessToken },
-          openApiValidators.successfulValidator,
-          { walletAddress }
+          { walletAddress },
+          openApiValidators.successfulValidator
         )
       } catch (error) {
         assert.ok(error instanceof OpenPaymentsClientError)
@@ -237,8 +237,8 @@ describe('incoming-payment', (): void => {
         createIncomingPayment(
           deps,
           { url: serverAddress, accessToken },
-          openApiValidators.failedValidator,
-          { walletAddress }
+          { walletAddress },
+          openApiValidators.failedValidator
         )
       ).rejects.toThrowError()
       scope.done()
@@ -266,7 +266,7 @@ describe('incoming-payment', (): void => {
 
       scope.done()
 
-      expect(result).toStrictEqual(incomingPayment)
+      expect(result).toEqual(incomingPayment)
     })
 
     test('throws if the incoming payment does not pass validation', async (): Promise<void> => {
@@ -364,7 +364,7 @@ describe('incoming-payment', (): void => {
             }
           )
 
-          expect(result).toStrictEqual(incomingPaymentPaginationResult)
+          expect(result).toEqual(incomingPaymentPaginationResult)
           scope.done()
         }
       )
@@ -407,7 +407,7 @@ describe('incoming-payment', (): void => {
             }
           )
 
-          expect(result).toStrictEqual(incomingPaymentPaginationResult)
+          expect(result).toEqual(incomingPaymentPaginationResult)
           scope.done()
         }
       )
@@ -498,9 +498,7 @@ describe('incoming-payment', (): void => {
         completed: true
       })
 
-      expect(validateIncomingPayment(incomingPayment)).toStrictEqual(
-        incomingPayment
-      )
+      expect(validateIncomingPayment(incomingPayment)).toEqual(incomingPayment)
     })
 
     test('throws if receiving and incoming amount asset scales are different', async (): Promise<void> => {
@@ -557,7 +555,7 @@ describe('incoming-payment', (): void => {
         }
       })
 
-      expect(validateCreatedIncomingPayment(incomingPayment)).toStrictEqual(
+      expect(validateCreatedIncomingPayment(incomingPayment)).toEqual(
         incomingPayment
       )
     })
@@ -593,7 +591,7 @@ describe('incoming-payment', (): void => {
         completed: true
       })
 
-      expect(validateCompletedIncomingPayment(incomingPayment)).toStrictEqual(
+      expect(validateCompletedIncomingPayment(incomingPayment)).toEqual(
         incomingPayment
       )
     })

packages/open-payments/src/client/index.ts

@@ -14,12 +14,8 @@ import {
   createWalletAddressRoutes,
   WalletAddressRoutes
 } from './wallet-address'
-import {
-  createAxiosInstance,
-  createCustomAxiosInstance,
-  InterceptorFn
-} from './requests'
-import { AxiosInstance } from 'axios'
+import { createHttpClient, HttpClient, InterceptorFn } from './requests'
+
 import { createGrantRoutes, GrantRoutes } from './grant'
 import {
   createOutgoingPaymentRoutes,
@@ -37,7 +33,7 @@ import {
 export * from './error'
 
 export interface BaseDeps {
-  axiosInstance: AxiosInstance
+  httpClient: HttpClient
   logger: Logger
   useHttp: boolean
 }
@@ -52,7 +48,7 @@ interface AuthenticatedClientDeps extends UnauthenticatedClientDeps {
 }
 
 export interface RouteDeps extends BaseDeps {
-  axiosInstance: AxiosInstance
+  httpClient: HttpClient
   openApi: OpenAPI
   logger: Logger
 }
@@ -140,7 +136,7 @@ const createUnauthenticatedDeps = async ({
     logger.level = args.logLevel
   }
 
-  const axiosInstance = createAxiosInstance({
+  const httpClient = createHttpClient({
     requestTimeoutMs:
       args?.requestTimeoutMs ?? config.DEFAULT_REQUEST_TIMEOUT_MS
   })
@@ -149,7 +145,7 @@ const createUnauthenticatedDeps = async ({
   const resourceServerOpenApi = await getResourceServerOpenAPI()
 
   return {
-    axiosInstance,
+    httpClient,
     walletAddressServerOpenApi,
     resourceServerOpenApi,
     logger,
@@ -183,20 +179,20 @@ const createAuthenticatedClientDeps = async ({
     })
   }
 
-  let axiosInstance: AxiosInstance | undefined
+  let httpClient: ReturnType<typeof createHttpClient>
 
   if ('authenticatedRequestInterceptor' in args) {
-    axiosInstance = createCustomAxiosInstance({
+    httpClient = createHttpClient({
       requestTimeoutMs:
         args?.requestTimeoutMs ?? config.DEFAULT_REQUEST_TIMEOUT_MS,
       authenticatedRequestInterceptor: args.authenticatedRequestInterceptor
     })
   } else {
-    axiosInstance = createAxiosInstance({
-      privateKey,
-      keyId: args.keyId,
+    httpClient = createHttpClient({
       requestTimeoutMs:
-        args?.requestTimeoutMs ?? config.DEFAULT_REQUEST_TIMEOUT_MS
+        args?.requestTimeoutMs ?? config.DEFAULT_REQUEST_TIMEOUT_MS,
+      privateKey,
+      keyId: args.keyId
     })
   }
 
@@ -205,7 +201,7 @@ const createAuthenticatedClientDeps = async ({
   const authServerOpenApi = await getAuthServerOpenAPI()
 
   return {
-    axiosInstance,
+    httpClient,
     walletAddressServerOpenApi,
     resourceServerOpenApi,
     authServerOpenApi,

packages/open-payments/src/client/outgoing-payment.test.ts

@@ -55,7 +55,7 @@ describe('outgoing-payment', (): void => {
         },
         openApiValidators.successfulValidator
       )
-      expect(result).toStrictEqual(outgoingPayment)
+      expect(result).toEqual(outgoingPayment)
       scope.done()
     })
 
@@ -159,7 +159,7 @@ describe('outgoing-payment', (): void => {
               cursor
             }
           )
-          expect(result).toStrictEqual(outgoingPaymentPaginationResult)
+          expect(result).toEqual(outgoingPaymentPaginationResult)
           scope.done()
         }
       )
@@ -201,7 +201,7 @@ describe('outgoing-payment', (): void => {
               cursor
             }
           )
-          expect(result).toStrictEqual(outgoingPaymentPaginationResult)
+          expect(result).toEqual(outgoingPaymentPaginationResult)
           scope.done()
         }
       )
@@ -387,9 +387,7 @@ describe('outgoing-payment', (): void => {
     test('returns outgoing payment if passes validation', async (): Promise<void> => {
       const outgoingPayment = mockOutgoingPayment()
 
-      expect(validateOutgoingPayment(outgoingPayment)).toStrictEqual(
-        outgoingPayment
-      )
+      expect(validateOutgoingPayment(outgoingPayment)).toEqual(outgoingPayment)
     })
 
     test('throws if send amount and sent amount asset scales are different', async (): Promise<void> => {

packages/open-payments/src/client/quote.test.ts

@@ -42,7 +42,7 @@ describe('quote', (): void => {
         },
         openApiValidators.successfulValidator
       )
-      expect(result).toStrictEqual(quote)
+      expect(result).toEqual(quote)
       scope.done()
     })
 
@@ -75,7 +75,7 @@ describe('quote', (): void => {
         openApiValidators.successfulValidator,
         { receiver: quote.receiver, method: 'ilp', walletAddress }
       )
-      expect(result).toStrictEqual(quote)
+      expect(result).toEqual(quote)
       scope.done()
     })