feat: commando connector

.storybook/main.js

@@ -32,6 +32,12 @@ module.exports = {
       ],
       include: path.resolve(__dirname, "../"),
     });
+    config.module.rules.push({
+      test: /\.m?js/,
+      resolve: {
+        fullySpecified: false,
+      },
+    });
     config.resolve.plugins = [new TsconfigPathsPlugin()];
     return config;
   },

package.json

@@ -54,6 +54,7 @@
     "html5-qrcode": "^2.2.1",
     "i18next": "^21.9.2",
     "i18next-browser-languagedetector": "^6.1.5",
+    "lnmessage": "^0.0.3",
     "lodash": "^4.17.21",
     "pubsub-js": "^1.9.4",
     "react": "^18.2.0",

src/app/router/connectorRoutes.tsx

@@ -13,6 +13,7 @@ import NewWallet from "@screens/connectors/NewWallet";
 import i18n from "~/i18n/i18nConfig";
 import { translationI18nNamespace } from "~/i18n/namespaces";
 
+import ConnectCommando from "../screens/connectors/ConnectCommando";
 import alby from "/static/assets/icons/alby.png";
 import btcpay from "/static/assets/icons/btcpay.svg";
 import citadel from "/static/assets/icons/citadel.png";
@@ -190,6 +191,19 @@ function getConnectorRoutes() {
       ),
       logo: btcpay,
     },
+    {
+      path: "commando",
+      element: <ConnectCommando />,
+      title: i18n.t(
+        "choose_connector.commando.title",
+        translationI18nNamespace
+      ),
+      description: i18n.t(
+        "choose_connector.commando.description",
+        translationI18nNamespace
+      ),
+      logo: btcpay,
+    },
   ];
 }
 

src/app/screens/connectors/ConnectCommando/index.tsx

@@ -0,0 +1,131 @@
+import ConnectorForm from "@components/ConnectorForm";
+import TextField from "@components/form/TextField";
+import ConnectionErrorToast from "@components/toasts/ConnectionErrorToast";
+import { useState } from "react";
+import { useTranslation } from "react-i18next";
+import { useNavigate } from "react-router-dom";
+import { toast } from "react-toastify";
+import utils from "~/common/lib/utils";
+
+export default function ConnectCommando() {
+  const navigate = useNavigate();
+  const { t } = useTranslation("translation", {
+    keyPrefix: `choose_connector.commando`,
+  });
+  const [formData, setFormData] = useState({
+    host: "",
+    pubkey: "",
+    rune: "",
+  });
+  const [loading, setLoading] = useState(false);
+
+  function handleChange(event: React.ChangeEvent<HTMLInputElement>) {
+    setFormData({
+      ...formData,
+      [event.target.name]: event.target.value.trim(),
+    });
+  }
+
+  function getConnectorType() {
+    return "commando";
+  }
+
+  async function handleSubmit(event: React.FormEvent<HTMLFormElement>) {
+    event.preventDefault();
+    setLoading(true);
+    const host = formData.host;
+    const pubkey = formData.pubkey;
+    const rune = formData.rune;
+    const account = {
+      name: "commando",
+      config: {
+        host,
+        pubkey,
+        rune,
+      },
+      connector: getConnectorType(),
+    };
+
+    try {
+      let validation;
+      // TODO: for native connectors we currently skip the validation because it is too slow (booting up Tor etc.)
+      if (account.connector === "nativelndhub") {
+        validation = { valid: true, error: "" };
+      } else {
+        validation = await utils.call("validateAccount", account);
+      }
+
+      if (validation.valid) {
+        const addResult = await utils.call("addAccount", account);
+        if (addResult.accountId) {
+          await utils.call("selectAccount", {
+            id: addResult.accountId,
+          });
+          navigate("/test-connection");
+        }
+      } else {
+        console.error(validation);
+        toast.error(
+          <ConnectionErrorToast message={validation.error as string} />
+        );
+      }
+    } catch (e) {
+      console.error(e);
+      let message = t("errors.connection_failed");
+      if (e instanceof Error) {
+        message += `\n\n${e.message}`;
+      }
+      toast.error(message);
+    }
+    setLoading(false);
+  }
+
+  return (
+    <ConnectorForm
+      title={t("page.title")}
+      description={t("page.description")}
+      submitLoading={loading}
+      submitDisabled={
+        formData.host === "" && formData.pubkey === "" && formData.rune === ""
+      }
+      onSubmit={handleSubmit}
+    >
+      <div className="mb-6">
+        <TextField
+          id="host"
+          label={t("host.label")}
+          type="text"
+          required
+          placeholder="host"
+          title="host"
+          value={formData.host}
+          onChange={handleChange}
+        />
+      </div>
+      <div className="mb-6">
+        <TextField
+          id="pubkey"
+          label={t("pubkey.label")}
+          type="text"
+          required
+          placeholder="pubkey"
+          title="pubkey"
+          value={formData.pubkey}
+          onChange={handleChange}
+        />
+      </div>
+      <div className="mb-6">
+        <TextField
+          id="rune"
+          label={t("rune.label")}
+          type="text"
+          required
+          placeholder="rune"
+          title="rune"
+          value={formData.rune}
+          onChange={handleChange}
+        />
+      </div>
+    </ConnectorForm>
+  );
+}

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

@@ -0,0 +1,151 @@
+import LnMessage from "lnmessage";
+import { v4 as uuidv4 } from "uuid";
+
+import Connector, {
+  CheckPaymentArgs,
+  CheckPaymentResponse,
+  GetBalanceResponse,
+  GetInfoResponse,
+  GetInvoicesResponse,
+  KeysendArgs,
+  MakeInvoiceArgs,
+  MakeInvoiceResponse,
+  SendPaymentArgs,
+  SendPaymentResponse,
+  SignMessageArgs,
+  SignMessageResponse,
+} from "./connector.interface";
+
+interface Config {
+  host: string;
+  port: number;
+  rune: string;
+  pubkey: string;
+  wsProxy: string;
+  privateKey: string;
+}
+
+type CommandoGetInfoResponse = {
+  alias: string;
+  id: string;
+  color: string;
+};
+type CommandoMakeInvoiceResponse = {
+  bolt11: string;
+  payment_hash: string;
+  payment_secret: string;
+};
+type CommandoChannel = {
+  peer_id: string;
+  channel_sat: number;
+  amount_msat: number;
+  funding_txid: string;
+  funding_output: number;
+  connected: boolean;
+  state: string;
+};
+type CommandoListFundsResponse = {
+  channels: CommandoChannel[];
+};
+
+export default class Commando implements Connector {
+  config: Config;
+  ln: LnMessage;
+
+  constructor(config: Config) {
+    this.config = config;
+    this.ln = new LnMessage({
+      remoteNodePublicKey: this.config.pubkey,
+      wsProxy: this.config.wsProxy || "wss://lnwsproxy.regtest.getalby.com",
+      ip: this.config.host,
+      port: this.config.port || 9735,
+      privateKey:
+        this.config.privateKey ||
+        "d6a2eba36168cc31e97396a781a4dd46dd3648c001d3f4fde221d256e41715ea",
+    });
+  }
+
+  async init() {
+    // initiate the connection to the remote node
+    await this.ln.connect();
+  }
+
+  unload() {
+    return Promise.resolve();
+  }
+
+  // not yet implemented
+  connectPeer() {
+    console.error(
+      `${this.constructor.name} does not implement the getInvoices call`
+    );
+    return new Error("Not yet supported with the currently used account.");
+  }
+
+  async getInvoices(): Promise<GetInvoicesResponse> {
+    throw new Error("Not yet supported with the currently used account.");
+  }
+
+  async getInfo(): Promise<GetInfoResponse> {
+    const response = (await this.ln.commando({
+      method: "getinfo",
+      params: [],
+      rune: this.config.rune,
+    })) as CommandoGetInfoResponse;
+    return {
+      data: {
+        alias: response.alias,
+        pubkey: response.id,
+        color: response.color,
+      },
+    };
+  }
+
+  async getBalance(): Promise<GetBalanceResponse> {
+    const response = (await this.ln.commando({
+      method: "listfunds",
+      params: [],
+      rune: this.config.rune,
+    })) as CommandoListFundsResponse;
+    let lnBalance = 0;
+    for (let i = 0; i < response.channels.length; i++) {
+      lnBalance = lnBalance + response.channels[i].channel_sat;
+    }
+    return {
+      data: {
+        balance: lnBalance,
+      },
+    };
+  }
+
+  async sendPayment(args: SendPaymentArgs): Promise<SendPaymentResponse> {
+    throw new Error("Not yet supported with the currently used account.");
+  }
+
+  async keysend(args: KeysendArgs): Promise<SendPaymentResponse> {
+    throw new Error("Not yet supported with the currently used account.");
+  }
+
+  async checkPayment(args: CheckPaymentArgs): Promise<CheckPaymentResponse> {
+    throw new Error("Not yet supported with the currently used account.");
+  }
+
+  signMessage(args: SignMessageArgs): Promise<SignMessageResponse> {
+    throw new Error("Not yet supported with the currently used account.");
+  }
+
+  async makeInvoice(args: MakeInvoiceArgs): Promise<MakeInvoiceResponse> {
+    const label = uuidv4();
+    const response = (await this.ln.commando({
+      method: "invoice",
+      params: [(args.amount as number) * 1000, label, args.memo],
+      rune: this.config.rune,
+    })) as CommandoMakeInvoiceResponse;
+    return {
+      data: {
+        paymentRequest: response.bolt11,
+        rHash: response.payment_hash,
+      },
+    };
+  }
+}

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

@@ -1,4 +1,5 @@
 import Citadel from "./citadel";
+import Commando from "./commando";
 import Eclair from "./eclair";
 import Galoy from "./galoy";
 import LnBits from "./lnbits";
@@ -28,6 +29,7 @@ const connectors = {
   eclair: Eclair,
   citadel: Citadel,
   nativecitadel: NativeCitadel,
+  commando: Commando,
 };
 
 export default connectors;

webpack.config.js

@@ -127,6 +127,12 @@ var options = {
         test: /\.(woff|woff2|eot|ttf|otf)$/i,
         type: "asset/resource",
       },
+      {
+        test: /\.m?js/,
+        resolve: {
+          fullySpecified: false
+        }
+      },
     ],
   },