chore: Update type compilation (#71)

* chore: converted WorkerMessageType enum to type * fix: add dts rollup plugin to properly resolve types * fix: types organization and aliasing * chore: update docs with example types
fedimint · Oct 4, 2024 · ae528a0 · ae528a0
1 parent 24d561f
commit ae528a0
Show file tree

Hide file tree

Showing 26 changed files with 184 additions and 130 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -5,4 +5,5 @@ packages/wasm-web/**
 packages/wasm-bundler/**
 examples/bare-js/**
 tmp/**
-*.html
+*.html
+packages/*/dist/**
diff --git a/docs/core/FedimintWallet/BalanceService/getBalance.md b/docs/core/FedimintWallet/BalanceService/getBalance.md
@@ -4,10 +4,14 @@
 
 Get the current balance of the wallet.
 
-```ts
-// const wallet = new FedimintWallet()
-// wallet.open()
+```ts twoslash
+// @esModuleInterop
+import { FedimintWallet } from '@fedimint/core-web'
 
+const wallet = new FedimintWallet()
+wallet.open()
+
+// ---cut---
 const mSats = await wallet.balance.getBalance()
 
 // 1000 mSats = 1 satoshi

diff --git a/docs/core/FedimintWallet/BalanceService/subscribeBalance.md b/docs/core/FedimintWallet/BalanceService/subscribeBalance.md
@@ -4,10 +4,13 @@
 
 Subscribe to balance updates as they occur.
 
-```ts
-// const wallet = new FedimintWallet()
-// wallet.open()
+```ts twoslash
+import { FedimintWallet } from '@fedimint/core-web'
 
+const wallet = new FedimintWallet()
+wallet.open()
+
+// ---cut---
 const unsubscribe = wallet.balance.subscribeBalance((mSats) => {
   console.log('Balance updated:', mSats)
   // 1000 mSats = 1 satoshi

diff --git a/examples/vite-core/src/App.tsx b/examples/vite-core/src/App.tsx
@@ -28,7 +28,7 @@ const useBalance = (checkIsOpen: () => void) => {
   const [balance, setBalance] = useState(0)
 
   useEffect(() => {
-    const unsubscribe = wallet.balance.subscribeBalance((balance: number) => {
+    const unsubscribe = wallet.balance.subscribeBalance((balance) => {
       // checks if the wallet is open when the first
       // subscription event fires.
       // TODO: make a subscription to the wallet open status

diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "build": "pnpm run --r --filter \"./packages/**\" build",
+    "build": "pnpm clean && pnpm run --r --filter \"./packages/**\" build",
     "clean": "pnpm run --r --parallel clean && rm -rf packages/**/*.json.tmp",
     "clean:deep": "rm -rf node_modules && pnpm run --r --parallel clean:deep",
     "deps": "pnpx taze -r",

diff --git a/packages/core-web/package.json b/packages/core-web/package.json
@@ -33,6 +33,7 @@
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/node": "^20.14.8",
     "rollup": "^4.21.2",
+    "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-typescript2": "^0.36.0",
     "tslib": "^2.7.0",
     "typescript": "^5.2.2"

diff --git a/packages/core-web/rollup.config.js b/packages/core-web/rollup.config.js
@@ -1,6 +1,7 @@
 /** @type {import('rollup').RollupOptions} */
 import typescript from '@rollup/plugin-typescript'
 import terser from '@rollup/plugin-terser'
+import { dts } from 'rollup-plugin-dts'
 
 export default [
   {
@@ -16,4 +17,9 @@ export default [
     plugins: [typescript(), terser()],
     external: ['@fedimint/fedimint-client-wasm-bundler'],
   },
+  {
+    input: './dist/dts/index.d.ts',
+    output: [{ file: 'dist/index.d.ts', format: 'es' }],
+    plugins: [dts()],
+  },
 ]
diff --git a/packages/core-web/src/FedimintWallet.ts b/packages/core-web/src/FedimintWallet.ts
@@ -1,4 +1,4 @@
-import { WorkerClient, WorkerMessageType } from './worker'
+import { WorkerClient } from './worker'
 import {
   BalanceService,
   MintService,
@@ -19,7 +19,7 @@ export class FedimintWallet {
   public federation: FederationService
   public recovery: RecoveryService
 
-  private _openPromise: Promise<void> | null = null
+  private _openPromise: Promise<void> | undefined = undefined
   private _resolveOpen: () => void = () => {}
   private _isOpen: boolean = false
 
@@ -85,12 +85,9 @@ export class FedimintWallet {
     await this._client.initialize()
     // TODO: Determine if this should be safe or throw
     if (this._isOpen) throw new Error('The FedimintWallet is already open.')
-    const { success } = await this._client.sendSingleMessage(
-      WorkerMessageType.Open,
-      {
-        clientName,
-      },
-    )
+    const { success } = await this._client.sendSingleMessage<{
+      success: boolean
+    }>('open', { clientName })
     if (success) {
       this._isOpen = !!success
       this._resolveOpen()
@@ -108,12 +105,9 @@ export class FedimintWallet {
       throw new Error(
         'The FedimintWallet is already open. You can only call `joinFederation` on closed clients.',
       )
-    const response = await this._client.sendSingleMessage(
-      WorkerMessageType.Join,
-      {
-        inviteCode,
-        clientName,
-      },
+    const response = await this._client.sendSingleMessage<{ success: boolean }>(
+      'join',
+      { inviteCode, clientName },
     )
     if (response.success) {
       this._isOpen = true
@@ -126,7 +120,7 @@ export class FedimintWallet {
    * After this call, the FedimintWallet instance should be discarded.
    */
   async cleanup() {
-    this._openPromise = null
+    this._openPromise = undefined
     this._isOpen = false
     this._client.cleanup()
   }

diff --git a/packages/core-web/src/index.ts b/packages/core-web/src/index.ts
@@ -1,10 +1,2 @@
 export { FedimintWallet } from './FedimintWallet'
-export type {
-  LightningGateway,
-  RouteHint,
-  FeeToAmount,
-  OutgoingLightningPayment,
-  PayType,
-  LnPayState,
-  CreateBolt11Response,
-} from './types/wallet'
+export type * from './types'
diff --git a/packages/core-web/src/services/BalanceService.ts b/packages/core-web/src/services/BalanceService.ts
@@ -1,3 +1,4 @@
+import type { MSats } from '../types'
 import { WorkerClient } from '../worker'
 
 /**
@@ -9,19 +10,19 @@ export class BalanceService {
   constructor(private client: WorkerClient) {}
 
   /**
-   * Get the balance of the current wallet
+   * Get the balance of the current wallet in milli-satoshis (MSats)
    *
    * @example
    * ```ts
    * const balance = await wallet.balance.getBalance()
    * ```
    */
-  async getBalance(): Promise<number> {
+  async getBalance(): Promise<MSats> {
     return await this.client.rpcSingle('', 'get_balance', {})
   }
 
   /**
-   * Subscribe to the balance of the current wallet
+   * Subscribe to the balance of the current wallet in milli-satoshis (MSats)
    *
    * @example
    * ```ts
@@ -34,7 +35,7 @@ export class BalanceService {
    * ```
    */
   subscribeBalance(
-    onSuccess: (balance: number) => void = () => {},
+    onSuccess: (balance: MSats) => void = () => {},
     onError: (error: string) => void = () => {},
   ) {
     const unsubscribe = this.client.rpcStream<string>(

diff --git a/packages/core-web/src/services/FederationService.ts b/packages/core-web/src/services/FederationService.ts
@@ -1,4 +1,4 @@
-import { JSONValue } from '../types/wallet'
+import type { JSONValue } from '../types'
 import { WorkerClient } from '../worker'
 
 export class FederationService {

diff --git a/packages/core-web/src/services/LightningService.test.ts b/packages/core-web/src/services/LightningService.test.ts
@@ -25,6 +25,18 @@ walletTest(
   },
 )
 
+walletTest('createInvoice with expiry', async ({ wallet }) => {
+  expect(wallet).toBeDefined()
+  expect(wallet.isOpen()).toBe(true)
+
+  const invoice = await wallet.lightning.createInvoice(100, 'test', 1000, {})
+  expect(invoice).toBeDefined()
+  expect(invoice).toMatchObject({
+    invoice: expect.any(String),
+    operation_id: expect.any(String),
+  })
+})
+
 walletTest(
   'listGateways should return a list of gateways',
   async ({ wallet }) => {

diff --git a/packages/core-web/src/services/LightningService.ts b/packages/core-web/src/services/LightningService.ts
@@ -1,22 +1,23 @@
 import { WorkerClient } from '../worker'
-import {
+import type {
   CreateBolt11Response,
   GatewayInfo,
   JSONObject,
   JSONValue,
   LightningGateway,
   LnPayState,
   LnReceiveState,
+  MSats,
   OutgoingLightningPayment,
-} from '../types/wallet'
+} from '../types'
 
 export class LightningService {
   constructor(private client: WorkerClient) {}
 
   async createInvoiceWithGateway(
-    amount: number,
+    amount: MSats,
     description: string,
-    expiryTime: number | null = null,
+    expiryTime: number | null = null, // in seconds
     extraMeta: JSONObject = {},
     gatewayInfo: GatewayInfo,
   ) {
@@ -30,9 +31,9 @@ export class LightningService {
   }
 
   async createInvoice(
-    amount: number,
+    amount: MSats,
     description: string,
-    expiryTime: number | null = null,
+    expiryTime: number | null = null, // in seconds
     extraMeta: JSONObject = {},
   ): Promise<CreateBolt11Response> {
     await this.updateGatewayCache()

diff --git a/packages/core-web/src/services/MintService.test.ts b/packages/core-web/src/services/MintService.test.ts
@@ -9,11 +9,18 @@ walletTest('redeemEcash should error on invalid ecash', async ({ wallet }) => {
 })
 
 walletTest(
-  'reissueExternalNotes should reissue external notes',
+  'reissueExternalNotes should throw if wallet is empty',
   async ({ wallet }) => {
     expect(wallet).toBeDefined()
     expect(wallet.isOpen()).toBe(true)
 
     await expect(wallet.mint.reissueExternalNotes('test')).rejects.toThrow()
   },
 )
+
+walletTest('spendNotes should throw if wallet is empty', async ({ wallet }) => {
+  expect(wallet).toBeDefined()
+  expect(wallet.isOpen()).toBe(true)
+
+  await expect(wallet.mint.spendNotes(100)).rejects.toThrow()
+})
diff --git a/packages/core-web/src/services/MintService.ts b/packages/core-web/src/services/MintService.ts
@@ -1,11 +1,12 @@
 import { WorkerClient } from '../worker'
-import {
+import type {
   Duration,
   JSONObject,
   JSONValue,
   MintSpendNotesResponse,
+  MSats,
   ReissueExternalNotesState,
-} from '../types/wallet'
+} from '../types'
 
 export class MintService {
   constructor(private client: WorkerClient) {}
@@ -44,12 +45,12 @@ export class MintService {
   }
 
   async spendNotes(
-    minAmount: number,
+    minAmount: MSats,
     // Tells the wallet to automatically try to cancel the spend if it hasn't completed
     // after the specified number of milliseconds.
     // If the receiver has already redeemed the notes at this time,
     // the notes will not be cancelled
-    tryCancelAfter: number | Duration = 0,
+    tryCancelAfter: number | Duration = 0, // in seconds or Duration object
     includeInvite: boolean = false,
     extraMeta: JSONValue = {},
   ): Promise<MintSpendNotesResponse> {
@@ -77,7 +78,7 @@ export class MintService {
     }
   }
 
-  async validateNotes(oobNotes: string): Promise<number> {
+  async parseNotes(oobNotes: string): Promise<MSats> {
     return await this.client.rpcSingle('mint', 'validate_notes', {
       oob_notes: oobNotes,
     })

diff --git a/packages/core-web/src/services/RecoveryService.ts b/packages/core-web/src/services/RecoveryService.ts
@@ -1,4 +1,4 @@
-import { JSONValue } from '../types/wallet'
+import type { JSONValue } from '../types'
 import { WorkerClient } from '../worker'
 
 export class RecoveryService {

diff --git a/packages/core-web/src/types/index.ts b/packages/core-web/src/types/index.ts
@@ -0,0 +1,3 @@
+export * from './wallet'
+export * from './utils'
+export * from './worker'
diff --git a/packages/core-web/src/types/utils.ts b/packages/core-web/src/types/utils.ts
@@ -0,0 +1,25 @@
+type Alias<T> = T & {}
+type Resolve<T> = T & unknown
+
+type Seconds = Alias<number>
+type Nanos = Alias<number>
+
+type Duration = {
+  nanos: Nanos
+  secs: Seconds
+}
+
+type MSats = Alias<number>
+type Sats = Alias<number>
+
+type JSONValue =
+  | string
+  | number
+  | boolean
+  | null
+  | { [key: string]: JSONValue }
+  | JSONValue[]
+
+type JSONObject = Record<string, JSONValue>
+
+export { Alias, Resolve, Duration, MSats, Sats, JSONValue, JSONObject }