Merge pull request #433 from getAlby/connectors-typescript

Typed connectors

Author: dylancom

src/extension/background-script/connectors/base.js

@@ -0,0 +1,21 @@
+interface Config {
+  adminkey: string;
+  login?: string;
+  macaroon?: string;
+  password?: string;
+  url?: string;
+}
+
+class Base {
+  config: Config;
+
+  constructor(config: Config) {
+    this.config = config;
+  }
+
+  init() {
+    return Promise.resolve();
+  }
+}
+
+export default Base;

src/extension/background-script/connectors/base.ts

@@ -0,0 +1,41 @@
+import Base from "./base";
+import Connector, {
+  SendPaymentArgs,
+  SendPaymentResponse,
+  GetInfoResponse,
+  GetBalanceResponse,
+  MakeInvoiceArgs,
+  MakeInvoiceResponse,
+  SignMessageArgs,
+  SignMessageResponse,
+  VerifyMessageArgs,
+  VerifyMessageResponse,
+} from "./connector.interface";
+
+class ConnectorExample extends Base implements Connector {
+  getInfo(): Promise<GetInfoResponse> {
+    // Add your own implementation.
+  }
+
+  getBalance(): Promise<GetBalanceResponse> {
+    // Add your own implementation.
+  }
+
+  sendPayment(args: SendPaymentArgs): Promise<SendPaymentResponse> {
+    // Add your own implementation.
+  }
+
+  signMessage(args: SignMessageArgs): Promise<SignMessageResponse> {
+    // Add your own implementation.
+  }
+
+  verifyMessage(args: VerifyMessageArgs): Promise<VerifyMessageResponse> {
+    // Add your own implementation.
+  }
+
+  makeInvoice(args: MakeInvoiceArgs): Promise<MakeInvoiceResponse> {
+    // Add your own implementation.
+  }
+}
+
+export default ConnectorExample;

src/extension/background-script/connectors/connector.example

@@ -0,0 +1,76 @@
+interface WebLNNode {
+  alias: string;
+  pubkey?: string;
+  color?: string;
+}
+
+interface Route {
+  total_amt: number;
+  total_fees: number;
+}
+
+export interface MakeInvoiceArgs {
+  amount: number;
+  memo: string;
+}
+
+export interface MakeInvoiceResponse {
+  data: {
+    paymentRequest: string;
+    rHash: string;
+  };
+}
+
+export interface GetInfoResponse {
+  data: WebLNNode;
+}
+
+export interface GetBalanceResponse {
+  data: {
+    balance: number;
+  };
+}
+
+export type SendPaymentResponse =
+  | {
+      data: {
+        preimage: string;
+        paymentHash: string;
+        route: Route;
+      };
+    }
+  | { error: string };
+
+export interface SendPaymentArgs {
+  paymentRequest: string;
+}
+
+export interface SignMessageArgs {
+  message: string;
+}
+
+export interface SignMessageResponse {
+  data: {
+    signature: string;
+  };
+}
+
+export interface VerifyMessageArgs {
+  message: string;
+  signature: string;
+}
+
+export interface VerifyMessageResponse {
+  data: {
+    valid: boolean;
+  };
+}
+
+export default interface Connector {
+  getInfo(): Promise<GetInfoResponse>;
+  getBalance(): Promise<GetBalanceResponse>;
+  makeInvoice(args: MakeInvoiceArgs): Promise<MakeInvoiceResponse>;
+  sendPayment(args: SendPaymentArgs): Promise<SendPaymentResponse>;
+  signMessage(args: SignMessageArgs): Promise<SignMessageResponse>;
+  verifyMessage(args: VerifyMessageArgs): Promise<VerifyMessageResponse>;
+}

src/extension/background-script/connectors/connector.interface.ts

@@ -1,17 +1,9 @@
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore: implicitly has 'any' type error
 import Native from "./native";
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: implicitly has 'any' type error
 import Lnd from "./lnd";
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: implicitly has 'any' type error
 import LndHub from "./lndhub";
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: implicitly has 'any' type error
 import LnBits from "./lnbits";
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: implicitly has 'any' type error
 import Base from "./base";
 
 /*

src/extension/background-script/connectors/index.ts

@@ -4,9 +4,21 @@ import { parsePaymentRequest } from "invoices";
 import Base from "./base";
 import utils from "../../../common/lib/utils";
 import HashKeySigner from "../../../common/utils/signer";
+import Connector, {
+  SendPaymentArgs,
+  SendPaymentResponse,
+  GetInfoResponse,
+  GetBalanceResponse,
+  MakeInvoiceArgs,
+  MakeInvoiceResponse,
+  SignMessageArgs,
+  SignMessageResponse,
+  VerifyMessageArgs,
+  VerifyMessageResponse,
+} from "./connector.interface";
 
-class LnBits extends Base {
-  getInfo() {
+class LnBits extends Base implements Connector {
+  getInfo(): Promise<GetInfoResponse> {
     return this.request(
       "GET",
       "/api/v1/wallet",
@@ -22,7 +34,7 @@ class LnBits extends Base {
     });
   }
 
-  getBalance() {
+  getBalance(): Promise<GetBalanceResponse> {
     return this.request(
       "GET",
       "/api/v1/wallet",
@@ -40,11 +52,11 @@ class LnBits extends Base {
     });
   }
 
-  sendPayment(args) {
+  sendPayment(args: SendPaymentArgs): Promise<SendPaymentResponse> {
     const paymentRequestDetails = parsePaymentRequest({
       request: args.paymentRequest,
     });
-    const amountInSats = parseInt(paymentRequestDetails.tokens);
+    const amountInSats = paymentRequestDetails.tokens;
     return this.request("POST", "/api/v1/payments", this.config.adminkey, {
       bolt11: args.paymentRequest,
       out: true,
@@ -66,15 +78,15 @@ class LnBits extends Base {
       });
   }
 
-  checkPayment(paymentHash) {
+  checkPayment(paymentHash: string) {
     return this.request(
       "GET",
       `/api/v1/payments/${paymentHash}`,
       this.config.adminkey
     );
   }
 
-  signMessage(args) {
+  signMessage(args: SignMessageArgs): Promise<SignMessageResponse> {
     // make sure we got the config to create a new key
     if (!this.config.url || !this.config.adminkey) {
       return Promise.reject(new Error("Missing config"));
@@ -104,7 +116,7 @@ class LnBits extends Base {
     });
   }
 
-  verifyMessage(args) {
+  verifyMessage(args: VerifyMessageArgs): Promise<VerifyMessageResponse> {
     // create a signing key from the lnbits URL and the adminkey
     const keyHex = sha256(
       `LBE-LNBITS-${this.config.url}-${this.config.adminkey}`
@@ -121,7 +133,7 @@ class LnBits extends Base {
     });
   }
 
-  makeInvoice(args) {
+  makeInvoice(args: MakeInvoiceArgs): Promise<MakeInvoiceResponse> {
     return this.request("POST", "/api/v1/payments", this.config.adminkey, {
       amount: args.amount,
       memo: args.memo,
@@ -136,7 +148,13 @@ class LnBits extends Base {
     });
   }
 
-  async request(method, path, apiKey, args, defaultValues) {
+  async request(
+    method: string,
+    path: string,
+    apiKey: string,
+    args?: any,
+    defaultValues?: any
+  ) {
     let body = null;
     let query = "";
     const headers = new Headers();

src/extension/background-script/connectors/lnbits.js renamed to src/extension/background-script/connectors/lnbits.ts

@@ -1,9 +1,21 @@
 import Base64 from "crypto-js/enc-base64";
 import UTF8 from "crypto-js/enc-utf8";
 import Base from "./base";
+import Connector, {
+  SendPaymentArgs,
+  SendPaymentResponse,
+  GetInfoResponse,
+  GetBalanceResponse,
+  MakeInvoiceArgs,
+  MakeInvoiceResponse,
+  SignMessageArgs,
+  SignMessageResponse,
+  VerifyMessageArgs,
+  VerifyMessageResponse,
+} from "./connector.interface";
 
-class Lnd extends Base {
-  getInfo() {
+class Lnd extends Base implements Connector {
+  getInfo(): Promise<GetInfoResponse> {
     return this.request("GET", "/v1/getinfo", undefined, {}).then((res) => {
       return {
         data: {
@@ -15,11 +27,11 @@ class Lnd extends Base {
     });
   }
 
-  getBalance() {
+  getBalance(): Promise<GetBalanceResponse> {
     return this.getChannelsBalance();
   }
 
-  sendPayment(args) {
+  sendPayment(args: SendPaymentArgs): Promise<SendPaymentResponse> {
     return this.request(
       "POST",
       "/v1/channels/transactions",
@@ -41,7 +53,7 @@ class Lnd extends Base {
     });
   }
 
-  signMessage(args) {
+  signMessage(args: SignMessageArgs): Promise<SignMessageResponse> {
     // use v2 to use the key locator (key_loc)
     // return this.request("POST", "/v2/signer/signmessage", {
     return this.request("POST", "/v1/signmessage", {
@@ -56,7 +68,7 @@ class Lnd extends Base {
     });
   }
 
-  verifyMessage(args) {
+  verifyMessage(args: VerifyMessageArgs): Promise<VerifyMessageResponse> {
     return this.request("POST", "/v1/verifymessage", {
       msg: Base64.stringify(UTF8.parse(args.message)),
       signature: args.signature,
@@ -69,7 +81,7 @@ class Lnd extends Base {
     });
   }
 
-  makeInvoice(args) {
+  makeInvoice(args: MakeInvoiceArgs): Promise<MakeInvoiceResponse> {
     return this.request("POST", "/v1/invoices", {
       memo: args.memo,
       value: args.amount,
@@ -115,7 +127,7 @@ class Lnd extends Base {
     });
   };
 
-  async request(method, path, args, defaultValues) {
+  async request(method: string, path: string, args: any, defaultValues?: any) {
     let body = null;
     let query = "";
     const headers = new Headers();
@@ -143,10 +155,7 @@ class Lnd extends Base {
             throw new Error();
           }
         } catch (err) {
-          throw new Error({
-            statusText: res.statusText,
-            status: res.status,
-          });
+          throw new Error(res.statusText);
         }
         console.log("errBody", errBody);
         throw errBody;
@@ -156,7 +165,7 @@ class Lnd extends Base {
         data = Object.assign(Object.assign({}, defaultValues), data);
       }
       return { data };
-    } catch (err) {
+    } catch (err: any) {
       console.error(`API error calling ${method} ${path}`, err);
       // Thrown errors must be JSON serializable, so include metadata if possible
       if (err.code || err.status || !err.message) {