@fedimint/types 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -1,16 +1,18 @@
 export type JSONValue = string | number | boolean | null | {
     [key: string]: JSONValue;
 } | JSONValue[];
-export declare const TRANSPORT_MESSAGE_TYPES: readonly ["init", "initialized", "rpc", "log", "open", "join", "error", "unsubscribe", "cleanup", "parseInviteCode", "parseBolt11Invoice", "previewFederation"];
+export declare const TRANSPORT_MESSAGE_TYPES: readonly ["init", "error", "cleanup", "set_mnemonic", "generate_mnemonic", "get_mnemonic", "join_federation", "open_client", "close_client", "client_rpc", "cancel_rpc", "parse_invite_code", "parse_bolt11_invoice", "preview_federation"];
 export type TransportMessageType = (typeof TRANSPORT_MESSAGE_TYPES)[number];
 export type TransportRequest = {
     type: TransportMessageType;
     requestId?: number;
     payload?: JSONValue;
 };
+declare const TransportResponseTypes: readonly ["data", "error", "end", "log"];
+type TransportResponseType = (typeof TransportResponseTypes)[number];
 export type TransportMessage = {
-    type: TransportMessageType | string;
-    requestId?: number;
+    type: TransportResponseType;
+    request_id?: number;
 } & Record<string, unknown>;
 export type TransportMessageHandler = (message: TransportMessage) => void;
 export type TransportErrorHandler = (error: unknown) => void;
@@ -18,11 +20,13 @@ export type TransportErrorHandler = (error: unknown) => void;
  * Generic Transport interface for communicating with a specific
  * target of the FedimintClient. Can be Wasm, React Native, Node, etc.
  */
-export interface Transport {
-    postMessage(message: TransportRequest): void;
+export declare abstract class Transport {
+    protected messageHandler: TransportMessageHandler;
+    protected errorHandler: TransportErrorHandler;
+    abstract logger: TransportLogger;
+    abstract postMessage(message: TransportRequest): void;
     setMessageHandler(handler: TransportMessageHandler): void;
     setErrorHandler(handler: TransportErrorHandler): void;
-    logger: TransportLogger;
 }
 /**
  * Generic logger interface based on console-style logging.
@@ -33,4 +37,5 @@ export type TransportLogger = {
     warn(message: string, ...args: any[]): void;
     error(message: string, ...args: any[]): void;
 };
+export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAC5B,SAAS,EAAE,CAAA;AAEf,eAAO,MAAM,uBAAuB,iKAa1B,CAAA;AAEV,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,oBAAoB,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,SAAS,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAAA;IACnC,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3B,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAA;AAEzE,MAAM,MAAM,qBAAqB,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;AAE5D;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAC5C,iBAAiB,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAA;IACzD,eAAe,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAA;IACrD,MAAM,EAAE,eAAe,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC5C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;CAC7C,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAC5B,SAAS,EAAE,CAAA;AAEf,eAAO,MAAM,uBAAuB,6OAiB1B,CAAA;AAEV,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,oBAAoB,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,SAAS,CAAA;CACpB,CAAA;AAED,QAAA,MAAM,sBAAsB,0CAA2C,CAAA;AACvE,KAAK,qBAAqB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAA;AAEpE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,qBAAqB,CAAA;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3B,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAA;AAEzE,MAAM,MAAM,qBAAqB,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;AAE5D;;;GAGG;AACH,8BAAsB,SAAS;IAC7B,SAAS,CAAC,cAAc,EAAE,uBAAuB,CAAW;IAC5D,SAAS,CAAC,YAAY,EAAE,qBAAqB,CAAW;IACxD,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;IAChC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI;IACrD,iBAAiB,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI;IAGzD,eAAe,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI;CAGtD;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC5C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAC3C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;CAC7C,CAAA"}

package/dist/index.js

@@ -1,15 +1,36 @@
 export const TRANSPORT_MESSAGE_TYPES = [
     'init',
-    'initialized',
-    'rpc',
-    'log',
-    'open',
-    'join',
     'error',
-    'unsubscribe',
     'cleanup',
-    'parseInviteCode',
-    'parseBolt11Invoice',
-    'previewFederation',
+    // Defined in fedimint-client-rpc crate: https://github.com/fedimint/fedimint/blob/master/fedimint-client-rpc/src/lib.rs#L60
+    // TODO: generate this list automatically
+    'set_mnemonic',
+    'generate_mnemonic',
+    'get_mnemonic',
+    'join_federation',
+    'open_client',
+    'close_client',
+    'client_rpc',
+    'cancel_rpc',
+    'parse_invite_code',
+    'parse_bolt11_invoice',
+    'preview_federation',
 ];
+const TransportResponseTypes = ['data', 'error', 'end', 'log'];
+/**
+ * Generic Transport interface for communicating with a specific
+ * target of the FedimintClient. Can be Wasm, React Native, Node, etc.
+ */
+export class Transport {
+    constructor() {
+        this.messageHandler = () => { };
+        this.errorHandler = () => { };
+    }
+    setMessageHandler(handler) {
+        this.messageHandler = handler;
+    }
+    setErrorHandler(handler) {
+        this.errorHandler = handler;
+    }
+}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,MAAM;IACN,aAAa;IACb,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,OAAO;IACP,aAAa;IACb,SAAS;IACT,iBAAiB;IACjB,oBAAoB;IACpB,mBAAmB;CACX,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,MAAM;IACN,OAAO;IACP,SAAS;IACT,4HAA4H;IAC5H,yCAAyC;IACzC,cAAc;IACd,mBAAmB;IACnB,cAAc;IACd,iBAAiB;IACjB,aAAa;IACb,cAAc;IACd,YAAY;IACZ,YAAY;IACZ,mBAAmB;IACnB,sBAAsB;IACtB,oBAAoB;CACZ,CAAA;AAUV,MAAM,sBAAsB,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAU,CAAA;AAYvE;;;GAGG;AACH,MAAM,OAAgB,SAAS;IAA/B;QACY,mBAAc,GAA4B,GAAG,EAAE,GAAE,CAAC,CAAA;QAClD,iBAAY,GAA0B,GAAG,EAAE,GAAE,CAAC,CAAA;IAS1D,CAAC;IANC,iBAAiB,CAAC,OAAgC;QAChD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAA;IAC/B,CAAC;IACD,eAAe,CAAC,OAA8B;QAC5C,IAAI,CAAC,YAAY,GAAG,OAAO,CAAA;IAC7B,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedimint/types",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Shared transport interfaces for Fedimint client implementations",
   "repository": {
     "type": "git",
@@ -16,7 +16,7 @@
   ],
   "sideEffects": false,
   "devDependencies": {
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.3"
   },
   "scripts": {
     "build": "tsc --project tsconfig.json",

package/src/index.ts

@@ -8,17 +8,21 @@ export type JSONValue =
 
 export const TRANSPORT_MESSAGE_TYPES = [
   'init',
-  'initialized',
-  'rpc',
-  'log',
-  'open',
-  'join',
   'error',
-  'unsubscribe',
   'cleanup',
-  'parseInviteCode',
-  'parseBolt11Invoice',
-  'previewFederation',
+  // Defined in fedimint-client-rpc crate: https://github.com/fedimint/fedimint/blob/master/fedimint-client-rpc/src/lib.rs#L60
+  // TODO: generate this list automatically
+  'set_mnemonic',
+  'generate_mnemonic',
+  'get_mnemonic',
+  'join_federation',
+  'open_client',
+  'close_client',
+  'client_rpc',
+  'cancel_rpc',
+  'parse_invite_code',
+  'parse_bolt11_invoice',
+  'preview_federation',
 ] as const
 
 export type TransportMessageType = (typeof TRANSPORT_MESSAGE_TYPES)[number]
@@ -29,9 +33,12 @@ export type TransportRequest = {
   payload?: JSONValue
 }
 
+const TransportResponseTypes = ['data', 'error', 'end', 'log'] as const
+type TransportResponseType = (typeof TransportResponseTypes)[number]
+
 export type TransportMessage = {
-  type: TransportMessageType | string
-  requestId?: number
+  type: TransportResponseType
+  request_id?: number
 } & Record<string, unknown>
 
 export type TransportMessageHandler = (message: TransportMessage) => void
@@ -42,11 +49,17 @@ export type TransportErrorHandler = (error: unknown) => void
  * Generic Transport interface for communicating with a specific
  * target of the FedimintClient. Can be Wasm, React Native, Node, etc.
  */
-export interface Transport {
-  postMessage(message: TransportRequest): void
-  setMessageHandler(handler: TransportMessageHandler): void
-  setErrorHandler(handler: TransportErrorHandler): void
-  logger: TransportLogger
+export abstract class Transport {
+  protected messageHandler: TransportMessageHandler = () => {}
+  protected errorHandler: TransportErrorHandler = () => {}
+  abstract logger: TransportLogger
+  abstract postMessage(message: TransportRequest): void
+  setMessageHandler(handler: TransportMessageHandler): void {
+    this.messageHandler = handler
+  }
+  setErrorHandler(handler: TransportErrorHandler): void {
+    this.errorHandler = handler
+  }
 }
 
 /**