fix: types

fedimint · Oct 21, 2024 · c846f89 · c846f89
1 parent d1ad74c
commit c846f89
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 30 deletions.
diff --git a/packages/core-web/src/services/FederationService.ts b/packages/core-web/src/services/FederationService.ts
@@ -1,10 +1,10 @@
-import type { JSONValue } from '../types'
+import type { RpcFederationMaybeLoading } from '../types'
 import { WorkerClient } from '../worker'
 
 export class FederationService {
   constructor(private client: WorkerClient) {}
 
-  async getConfig(): Promise<JSONValue> {
+  async getConfig(): Promise<RpcFederationMaybeLoading> {
     return await this.client.rpcSingle('', 'get_config', {})
   }
 
@@ -16,7 +16,7 @@ export class FederationService {
     return await this.client.rpcSingle('', 'get_invite_code', { peer })
   }
 
-  async listOperations(): Promise<JSONValue[]> {
+  async listOperations(): Promise<RpcFederationMaybeLoading[]> {
     return await this.client.rpcSingle('', 'list_operations', {})
   }
 }
diff --git a/packages/core-web/src/services/LightningService.ts b/packages/core-web/src/services/LightningService.ts
@@ -3,7 +3,7 @@ import type {
   CreateBolt11Response,
   GatewayInfo,
   JSONObject,
-  JSONValue,
+  RpcFederationMaybeLoading,
   LightningGateway,
   LnPayState,
   LnReceiveState,
@@ -175,7 +175,7 @@ export class LightningService {
     return await this.client.rpcSingle('ln', 'list_gateways', {})
   }
 
-  async updateGatewayCache(): Promise<JSONValue> {
+  async updateGatewayCache(): Promise<RpcFederationMaybeLoading> {
     return await this.client.rpcSingle('ln', 'update_gateway_cache', {})
   }
 }
diff --git a/packages/core-web/src/services/MintService.ts b/packages/core-web/src/services/MintService.ts
@@ -2,7 +2,7 @@ import { WorkerClient } from '../worker'
 import type {
   Duration,
   JSONObject,
-  JSONValue,
+  RpcFederationMaybeLoading,
   MintSpendNotesResponse,
   MSats,
   ReissueExternalNotesState,
@@ -30,7 +30,7 @@ export class MintService {
 
   subscribeReissueExternalNotes(
     operationId: string,
-    onSuccess: (state: JSONValue) => void = () => {},
+    onSuccess: (state: RpcFederationMaybeLoading) => void = () => {},
     onError: (error: string) => void = () => {},
   ) {
     const unsubscribe = this.client.rpcStream<ReissueExternalNotesState>(
@@ -51,7 +51,7 @@ export class MintService {
     // the notes at this time, the notes will not be cancelled.
     tryCancelAfter: number | Duration = 3600 * 24, // defaults to 1 day
     includeInvite: boolean = false,
-    extraMeta: JSONValue = {},
+    extraMeta: RpcFederationMaybeLoading = {},
   ): Promise<MintSpendNotesResponse> {
     const duration =
       typeof tryCancelAfter === 'number'
@@ -91,7 +91,7 @@ export class MintService {
 
   subscribeSpendNotes(
     operationId: string,
-    onSuccess: (state: JSONValue) => void = () => {},
+    onSuccess: (state: RpcFederationMaybeLoading) => void = () => {},
     onError: (error: string) => void = () => {},
   ) {
     const unsubscribe = this.client.rpcStream(
@@ -105,7 +105,7 @@ export class MintService {
     return unsubscribe
   }
 
-  async awaitSpendOobRefund(operationId: string): Promise<JSONValue> {
+  async awaitSpendOobRefund(operationId: string): Promise<RpcFederationMaybeLoading> {
     return await this.client.rpcSingle('mint', 'await_spend_oob_refund', {
       operation_id: operationId,
     })

diff --git a/packages/core-web/src/services/RecoveryService.ts b/packages/core-web/src/services/RecoveryService.ts
@@ -1,4 +1,4 @@
-import type { JSONValue } from '../types'
+import type { RpcFederationMaybeLoading } from '../types'
 import { WorkerClient } from '../worker'
 
 export class RecoveryService {
@@ -13,12 +13,12 @@ export class RecoveryService {
   }
 
   subscribeToRecoveryProgress(
-    onSuccess: (progress: { module_id: number; progress: JSONValue }) => void,
+    onSuccess: (progress: { module_id: number; progress: RpcFederationMaybeLoading }) => void,
     onError: (error: string) => void,
   ): () => void {
     const unsubscribe = this.client.rpcStream<{
       module_id: number
-      progress: JSONValue
+      progress: RpcFederationMaybeLoading
     }>('', 'subscribe_to_recovery_progress', {}, onSuccess, onError)
 
     return unsubscribe

diff --git a/packages/core-web/src/types/utils.ts b/packages/core-web/src/types/utils.ts
@@ -12,14 +12,22 @@ type Duration = {
 type MSats = Alias<number>
 type Sats = Alias<number>
 
-type JSONValue =
+type RpcFederationMaybeLoading =
   | string
   | number
   | boolean
   | null
-  | { [key: string]: JSONValue }
-  | JSONValue[]
+  | { [key: string]: RpcFederationMaybeLoading }
+  | RpcFederationMaybeLoading[]
 
-type JSONObject = Record<string, JSONValue>
+type JSONObject = Record<string, RpcFederationMaybeLoading>
 
-export { Alias, Resolve, Duration, MSats, Sats, JSONValue, JSONObject }
+export {
+  Alias,
+  Resolve,
+  Duration,
+  MSats,
+  Sats,
+  RpcFederationMaybeLoading,
+  JSONObject,
+}
diff --git a/packages/core-web/src/types/wallet.ts b/packages/core-web/src/types/wallet.ts
@@ -1,4 +1,4 @@
-import { MSats, Duration, JSONValue } from './utils'
+import { MSats, Duration, RpcFederationMaybeLoading } from './utils'
 
 const MODULE_KINDS = ['', 'ln', 'mint'] as const
 type ModuleKind = (typeof MODULE_KINDS)[number]
@@ -64,7 +64,7 @@ type StreamError = {
   end: never
 }
 
-type StreamSuccess<T extends JSONValue> = {
+type StreamSuccess<T extends RpcFederationMaybeLoading> = {
   data: T
   error: never
   end: never
@@ -76,7 +76,7 @@ type StreamEnd = {
   error: never
 }
 
-type StreamResult<T extends JSONValue> =
+type StreamResult<T extends RpcFederationMaybeLoading> =
   | StreamSuccess<T>
   | StreamError
   | StreamEnd

diff --git a/packages/core-web/src/worker/WorkerClient.ts b/packages/core-web/src/worker/WorkerClient.ts
@@ -1,6 +1,6 @@
 import type {
   CancelFunction,
-  JSONValue,
+  RpcFederationMaybeLoading,
   ModuleKind,
   StreamError,
   StreamResult,
@@ -67,8 +67,8 @@ export class WorkerClient {
   // TODO: Handle multiple errors
 
   sendSingleMessage<
-    Response extends JSONValue = JSONValue,
-    Payload extends JSONValue = JSONValue,
+    Response extends RpcFederationMaybeLoading = RpcFederationMaybeLoading,
+    Payload extends RpcFederationMaybeLoading = RpcFederationMaybeLoading,
   >(type: WorkerMessageType, payload?: Payload): Promise<Response> {
     return new Promise((resolve, reject) => {
       const requestId = ++this.requestCounter
@@ -121,8 +121,8 @@ export class WorkerClient {
    *
    */
   rpcStream<
-    Response extends JSONValue = JSONValue,
-    Body extends JSONValue = JSONValue,
+    Response extends RpcFederationMaybeLoading = RpcFederationMaybeLoading,
+    Body extends RpcFederationMaybeLoading = RpcFederationMaybeLoading,
   >(
     module: ModuleKind,
     method: string,
@@ -167,8 +167,8 @@ export class WorkerClient {
   }
 
   private async _rpcStreamInner<
-    Response extends JSONValue = JSONValue,
-    Body extends JSONValue = JSONValue,
+    Response extends RpcFederationMaybeLoading = RpcFederationMaybeLoading,
+    Body extends RpcFederationMaybeLoading = RpcFederationMaybeLoading,
   >(
     requestId: number,
     module: ModuleKind,
@@ -209,10 +209,10 @@ export class WorkerClient {
     })
   }
 
-  rpcSingle<Response extends JSONValue = JSONValue>(
+  rpcSingle<Response extends RpcFederationMaybeLoading = RpcFederationMaybeLoading>(
     module: ModuleKind,
     method: string,
-    body: JSONValue,
+    body: RpcFederationMaybeLoading,
   ): Promise<Response> {
     logger.debug('WorkerClient - rpcSingle', module, method, body)
     return new Promise((resolve, reject) => {