feat: Add siwe auth endpoints

src/endpoint.ts

@@ -16,38 +16,42 @@ export function postEndpoint<T extends keyof paths>(
   baseUrl: string,
   path: T,
   params?: paths[T] extends PostEndpoint ? paths[T]['post']['parameters'] : never,
+  includeCredentials?: boolean,
 ): Promise<paths[T] extends PostEndpoint ? paths[T]['post']['responses'][200]['schema'] : never> {
   const url = makeUrl(baseUrl, path as string, params?.path, params?.query)
-  return fetchData(url, 'POST', params?.body, params?.headers)
+  return fetchData(url, 'POST', params?.body, params?.headers, includeCredentials)
 }
 
 export function putEndpoint<T extends keyof paths>(
   baseUrl: string,
   path: T,
   params?: paths[T] extends PutEndpoint ? paths[T]['put']['parameters'] : never,
+  includeCredentials?: boolean,
 ): Promise<paths[T] extends PutEndpoint ? paths[T]['put']['responses'][200]['schema'] : never> {
   const url = makeUrl(baseUrl, path as string, params?.path, params?.query)
-  return fetchData(url, 'PUT', params?.body, params?.headers)
+  return fetchData(url, 'PUT', params?.body, params?.headers, includeCredentials)
 }
 
 export function deleteEndpoint<T extends keyof paths>(
   baseUrl: string,
   path: T,
   params?: paths[T] extends DeleteEndpoint ? paths[T]['delete']['parameters'] : never,
+  includeCredentials?: boolean,
 ): Promise<paths[T] extends DeleteEndpoint ? paths[T]['delete']['responses'][200]['schema'] : never> {
   const url = makeUrl(baseUrl, path as string, params?.path, params?.query)
-  return fetchData(url, 'DELETE', params?.body, params?.headers)
+  return fetchData(url, 'DELETE', params?.body, params?.headers, includeCredentials)
 }
 
 export function getEndpoint<T extends keyof paths>(
   baseUrl: string,
   path: T,
   params?: paths[T] extends GetEndpoint ? paths[T]['get']['parameters'] : never,
   rawUrl?: string,
+  includeCredentials?: boolean,
 ): Promise<paths[T] extends GetEndpoint ? paths[T]['get']['responses'][200]['schema'] : never> {
   if (rawUrl) {
-    return getData(rawUrl)
+    return getData(rawUrl, undefined, includeCredentials)
   }
   const url = makeUrl(baseUrl, path as string, params?.path, params?.query)
-  return getData(url, params?.headers)
+  return getData(url, params?.headers, includeCredentials)
 }

src/index.ts

@@ -29,6 +29,7 @@ import type { DelegateResponse, DelegatesRequest } from './types/delegates'
 import type { GetEmailResponse } from './types/emails'
 import type { RelayCountResponse, RelayTransactionResponse } from './types/relay'
 import type { Contract } from './types/contracts'
+import type { AuthNonce } from './types/auth'
 
 export * from './types/safe-info'
 export * from './types/safe-apps'
@@ -640,4 +641,19 @@ export function getContract(chainId: string, contractAddress: string): Promise<C
   })
 }
 
+export function getAuthNonce(): Promise<AuthNonce> {
+  return getEndpoint(baseUrl, '/v1/auth/nonce', undefined, undefined, true)
+}
+
+export function verifyAuth(body: operations['verify_auth']['parameters']['body']) {
+  return postEndpoint(
+    baseUrl,
+    '/v1/auth/verify',
+    {
+      body,
+    },
+    true,
+  )
+}
+
 /* eslint-enable @typescript-eslint/explicit-module-boundary-types */

src/types/api.ts

@@ -45,6 +45,7 @@ import type {
 import type { RelayCountResponse, RelayTransactionRequest, RelayTransactionResponse } from './relay'
 import type { RegisterRecoveryModuleRequestBody } from './recovery'
 import type { Contract } from './contracts'
+import type { AuthNonce } from './auth'
 
 export type Primitive = string | number | boolean | null
 
@@ -452,6 +453,22 @@ export interface paths extends PathRegistry {
       }
     }
   }
+  '/v1/auth/nonce': {
+    get: operations['get_auth_nonce']
+    parameters: {
+      path: null
+    }
+  }
+  '/v1/auth/verify': {
+    post: operations['verify_auth']
+    parameters: {
+      path: null
+      body: {
+        message: string
+        signature: string
+      }
+    }
+  }
 }
 
 export interface operations {
@@ -1179,4 +1196,25 @@ export interface operations {
       }
     }
   }
+  get_auth_nonce: {
+    parameters: null
+    responses: {
+      200: {
+        schema: AuthNonce
+      }
+    }
+  }
+  verify_auth: {
+    parameters: {
+      body: {
+        message: string
+        signature: string
+      }
+    }
+    responses: {
+      200: {
+        schema: void
+      }
+    }
+  }
 }

src/types/auth.ts

@@ -0,0 +1,3 @@
+export type AuthNonce = {
+  nonce: string
+}

src/utils.ts

@@ -62,6 +62,7 @@ export async function fetchData<T>(
   method: 'POST' | 'PUT' | 'DELETE',
   body?: unknown,
   headers?: Record<string, string>,
+  includeCredentials?: boolean,
 ): Promise<T> {
   const requestHeaders: Record<string, string> = {
     'Content-Type': 'application/json',
@@ -73,6 +74,10 @@ export async function fetchData<T>(
     headers: requestHeaders,
   }
 
+  if (includeCredentials) {
+    options['credentials'] = 'include'
+  }
+
   if (body != null) {
     options.body = typeof body === 'string' ? body : JSON.stringify(body)
   }
@@ -82,7 +87,11 @@ export async function fetchData<T>(
   return parseResponse<T>(resp)
 }
 
-export async function getData<T>(url: string, headers?: Record<string, string>): Promise<T> {
+export async function getData<T>(
+  url: string,
+  headers?: Record<string, string>,
+  includeCredentials?: boolean,
+): Promise<T> {
   const options: RequestInit = {
     method: 'GET',
   }
@@ -94,6 +103,10 @@ export async function getData<T>(url: string, headers?: Record<string, string>):
     }
   }
 
+  if (includeCredentials) {
+    options['credentials'] = 'include'
+  }
+
   const resp = await fetch(url, options)
 
   return parseResponse<T>(resp)

tests/endpoint.test.ts

@@ -18,7 +18,7 @@ describe('getEndpoint', () => {
       success: true,
     })
 
-    expect(getData).toHaveBeenCalledWith('https://test.test/v1/balances/supported-fiat-codes', undefined)
+    expect(getData).toHaveBeenCalledWith('https://test.test/v1/balances/supported-fiat-codes', undefined, undefined)
   })
 
   it('should accept a path param', async () => {
@@ -28,7 +28,7 @@ describe('getEndpoint', () => {
       }),
     ).resolves.toEqual({ success: true })
 
-    expect(getData).toHaveBeenCalledWith('https://test.test/v1/chains/4/safes/0x123', undefined)
+    expect(getData).toHaveBeenCalledWith('https://test.test/v1/chains/4/safes/0x123', undefined, undefined)
   })
 
   it('should accept several path params', async () => {
@@ -39,7 +39,7 @@ describe('getEndpoint', () => {
       }),
     ).resolves.toEqual({ success: true })
 
-    expect(getData).toHaveBeenCalledWith('https://test.test/v1/chains/4/safes/0x123/balances/usd', undefined)
+    expect(getData).toHaveBeenCalledWith('https://test.test/v1/chains/4/safes/0x123/balances/usd', undefined, undefined)
   })
 
   it('should accept query params', async () => {
@@ -53,6 +53,7 @@ describe('getEndpoint', () => {
     expect(getData).toHaveBeenCalledWith(
       'https://test.test/v1/chains/4/safes/0x123/balances/usd?exclude_spam=true',
       undefined,
+      undefined,
     )
   })
 
@@ -86,6 +87,7 @@ describe('getEndpoint', () => {
       'POST',
       body,
       undefined,
+      undefined,
     )
   })
 
@@ -99,7 +101,7 @@ describe('getEndpoint', () => {
       ),
     ).resolves.toEqual({ success: true })
 
-    expect(getData).toHaveBeenCalledWith('/test-url?raw=true')
+    expect(getData).toHaveBeenCalledWith('/test-url?raw=true', undefined, undefined)
   })
 
   it('should call a data decoder POST endpoint', async () => {
@@ -115,6 +117,7 @@ describe('getEndpoint', () => {
       'POST',
       { data: '0x123' },
       undefined,
+      undefined,
     )
   })
 
@@ -131,6 +134,7 @@ describe('getEndpoint', () => {
       'POST',
       { data: '0x456' },
       undefined,
+      undefined,
     )
   })
 
@@ -157,6 +161,7 @@ describe('getEndpoint', () => {
       'PUT',
       body,
       headers,
+      undefined,
     )
   })
 
@@ -177,6 +182,7 @@ describe('getEndpoint', () => {
       'DELETE',
       body,
       undefined,
+      undefined,
     )
   })
 })