fix+refactor: fix dependency cycle in types

src/hooks/memo.ts

@@ -1,4 +1,4 @@
-import { PaymentInformation } from '../types/publicAPI'
+import { PaymentInformation } from '../types/protocol'
 
 /**
  * This function is expected to be overwritten by companies deploying

src/services/basePayId.ts

@@ -1,5 +1,5 @@
 import { AddressInformation } from '../types/database'
-import { AddressDetailsType, PaymentInformation } from '../types/publicAPI'
+import { AddressDetailsType, PaymentInformation } from '../types/protocol'
 
 import { ParsedAcceptHeader } from './headers'
 

src/types/database.ts

@@ -1,4 +1,4 @@
-import { CryptoAddressDetails, FiatAddressDetails } from './publicAPI'
+import { CryptoAddressDetails, FiatAddressDetails } from './protocol'
 
 /**
  * Model of the Account table schema for the database.

src/types/publicAPI.ts → src/types/protocol.ts

@@ -1,8 +1,3 @@
-/* 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.
  */
@@ -41,9 +36,30 @@ export interface PaymentInformation {
 /**
  * Address information included inside of a PaymentInformation object.
  */
-export interface Address {
+interface Address {
   readonly paymentNetwork: string
   readonly environment?: string
   readonly addressDetailsType: AddressDetailsType
   readonly addressDetails: CryptoAddressDetails | FiatAddressDetails
 }
+
+/**
+ * Object containing address information alongside signatures.
+ */
+interface VerifiedAddress {
+  readonly payload: VerifiedAddressPayload
+  readonly signatures: readonly VerifiedAddressSignature[]
+}
+
+interface VerifiedAddressPayload {
+  payId: string
+  payIdAddress: Address
+}
+
+/**
+ * JWS object for verification.
+ */
+interface VerifiedAddressSignature {
+  protected: string
+  signature: string
+}

test/unit/formatPaymentInfo.test.ts

@@ -1,7 +1,7 @@
 import { assert } from 'chai'
 
 import { formatPaymentInfo } from '../../src/services/basePayId'
-import { AddressDetailsType } from '../../src/types/publicAPI'
+import { AddressDetailsType } from '../../src/types/protocol'
 
 describe('Base PayID - formatPaymentInfo()', function (): void {
   it('Returns CryptoAddressDetails & FiatAddressDetails for addressDetailsTypes when formatting array with multiple AddressInformation', function () {

test/unit/getAddressDetailsType.test.ts

@@ -1,7 +1,7 @@
 import { assert } from 'chai'
 
 import { getAddressDetailsType } from '../../src/services/basePayId'
-import { AddressDetailsType } from '../../src/types/publicAPI'
+import { AddressDetailsType } from '../../src/types/protocol'
 
 describe('Base PayID - getAddressDetailsType()', function (): void {
   it('Returns FiatAddressDetails for addressDetailsType when formatting ACH AddressInformation', function () {