Fix joinFederation return type in tests (#89)

* fix: types and comments * fix: joinFederation return type in tests
fedimint · Oct 23, 2024 · 3c80dd4 · 3c80dd4
1 parent 7b67b6d
commit 3c80dd4
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/packages/core-web/src/services/BalanceService.test.ts b/packages/core-web/src/services/BalanceService.test.ts
@@ -11,7 +11,7 @@ beforeAll(async () => {
   expect(wallet).toBeDefined()
   await expect(
     wallet.joinFederation(wallet.testing.TESTING_INVITE, randomTestingId),
-  ).resolves.toBeUndefined()
+  ).resolves.toBe(true)
   expect(wallet.isOpen()).toBe(true)
 
   // Cleanup after all tests

diff --git a/packages/core-web/src/services/LightningService.ts b/packages/core-web/src/services/LightningService.ts
@@ -88,6 +88,7 @@ export class LightningService {
     })
   }
 
+  // TODO: Document
   subscribeLnClaim(
     operationId: string,
     onSuccess: (state: LnReceiveState) => void = () => {},
@@ -104,6 +105,8 @@ export class LightningService {
     return unsubscribe
   }
 
+  // TODO: Document (for external payments only)
+  // TODO: Make this work for BOTH internal and external payments
   subscribeLnPay(
     operationId: string,
     onSuccess: (state: LnPayState) => void = () => {},
@@ -120,6 +123,7 @@ export class LightningService {
     return unsubscribe
   }
 
+  // TODO: Document
   subscribeLnReceive(
     operationId: string,
     onSuccess: (state: LnReceiveState) => void = () => {},
@@ -136,6 +140,7 @@ export class LightningService {
     return unsubscribe
   }
 
+  // TODO: Document
   async waitForReceive(operationId: string): Promise<LnReceiveState> {
     return new Promise((resolve, reject) => {
       let unsubscribe: () => void

diff --git a/packages/core-web/src/test/fixtures.ts b/packages/core-web/src/test/fixtures.ts
@@ -16,7 +16,7 @@ export const walletTest = test.extend<{
     const inviteCode = await wallet.testing.getInviteCode()
     await expect(
       wallet.joinFederation(inviteCode, randomTestingId),
-    ).resolves.toBeUndefined()
+    ).resolves.toBe(true)
 
     await use(wallet)
 

diff --git a/packages/core-web/src/types/wallet.ts b/packages/core-web/src/types/wallet.ts
@@ -38,7 +38,7 @@ type LnPayState =
   | { funded: { block_height: number } }
   | { waiting_for_refund: { error_reason: string } }
   | 'awaiting_change'
-  | { Success: { preimage: string } }
+  | { success: { preimage: string } }
   | { refunded: { gateway_error: string } }
   | { unexpected_error: { error_message: string } }