feat: verifiedAddresses in public API interface

src/services/basePayId.ts

@@ -29,6 +29,7 @@ export function formatPaymentInfo(
         addressDetails: address.details,
       }
     }),
+    verifiedAddresses: [],
     ...(payId && { payId }),
   }
 

src/types/publicAPI.ts

@@ -1,3 +1,8 @@
+/* eslint-disable import/no-cycle --
+Cycle between this file and types/verifiedAddress.ts. Should we combine these into one?
+*/
+import { VerifiedAddress } from './verifiedAddress'
+
 /**
  * Type of payment address in PaymentInformation.
  */
@@ -27,8 +32,9 @@ export interface FiatAddressDetails {
  * case of a GET request to the base path /).
  */
 export interface PaymentInformation {
-  readonly addresses: Address[]
   readonly payId?: string
+  readonly addresses: Address[]
+  readonly verifiedAddresses: VerifiedAddress[]
   readonly memo?: string
 }
 

src/types/verifiedAddress.ts

@@ -1,9 +1,10 @@
+/* eslint-disable import/no-cycle --
+Cycle between this file and types/publicApi.ts. Should we combine these into one? */
 import { Address } from './publicAPI'
 
 /**
  * Object containing address information alongside signatures.
  */
-// eslint-disable-next-line import/no-unused-modules -- will disable in next PR
 export interface VerifiedAddress {
   readonly payload: VerifiedAddressPayload
   readonly signatures: readonly VerifiedAddressSignature[]

test/integration/e2e/public-api/basePayId.test.ts

@@ -31,6 +31,7 @@ describe('E2E - publicAPIRouter - Base PayID', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$127.0.0.1',
     }
 
@@ -62,6 +63,7 @@ describe('E2E - publicAPIRouter - Base PayID', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$127.0.0.1',
     }
 
@@ -93,6 +95,7 @@ describe('E2E - publicAPIRouter - Base PayID', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$127.0.0.1',
     }
 
@@ -124,6 +127,7 @@ describe('E2E - publicAPIRouter - Base PayID', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$127.0.0.1',
     }
 

test/integration/e2e/public-api/contentNegotiation.test.ts

@@ -33,6 +33,7 @@ describe('E2E - publicAPIRouter - Content Negotiation', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$127.0.0.1',
     }
 
@@ -68,6 +69,7 @@ describe('E2E - publicAPIRouter - Content Negotiation', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$127.0.0.1',
     }
 
@@ -104,6 +106,7 @@ describe('E2E - publicAPIRouter - Content Negotiation', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$127.0.0.1',
     }
 
@@ -141,6 +144,7 @@ describe('E2E - publicAPIRouter - Content Negotiation', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$127.0.0.1',
     }
 

test/unit/formatPaymentInfo.test.ts

@@ -43,6 +43,7 @@ describe('Base PayID - formatPaymentInfo()', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$example.com',
     }
 
@@ -75,6 +76,7 @@ describe('Base PayID - formatPaymentInfo()', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
     }
 
     // WHEN we format it and don't pass in a PayID
@@ -108,6 +110,7 @@ describe('Base PayID - formatPaymentInfo()', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
     }
 
     // WHEN we format it
@@ -141,6 +144,7 @@ describe('Base PayID - formatPaymentInfo()', function (): void {
           },
         },
       ],
+      verifiedAddresses: [],
       payId: 'alice$example.com',
       memo: 'memo',
     }