Release 0.0.6 (#73)

* Updating version number * Display Invoice Rune (#56) * Display Invoice Rune * Cosmetic updates for Invoice Rune * Update plus/add icon svg (#70) * Resolve commando-rune deprecation and use createrune instead (#72) * Change invoice and offer to lowercase (#68) * Add tests for address casing fix (#69) * Update jsx camelCase property name * Adding mock use-http hook * Add tests for invoice and offer capital casing --------- Co-authored-by: Michael Evans <[email protected]> Co-authored-by: afxsoftware <[email protected]>
ElementsProject · Sep 7, 2024 · 4399d8c · 4399d8c
1 parent 180e141
commit 4399d8c
Show file tree

Hide file tree

Showing 44 changed files with 627 additions and 120 deletions.
diff --git a/README.md b/README.md
@@ -91,7 +91,7 @@
   - ### Commando Authentication
       - This application utilizes [lnmessage](https://github.com/aaronbarnardsound/lnmessage) and [commando](https://docs.corelightning.org/reference/lightning-commando) for connecting with core lightning node. The connection is trustless and end-to-end encrypted. Commando manages authentication and authorization through runes, which can grant either full or fine-grained permissions. 
       - The backend server reads `LIGHTNING_PUBKEY` & `LIGHTNING_RUNE` from the `COMMANDO_CONFIG` file for this communication. 
-      - Values can either be set manually or script `entrypoint.sh` can be used to call `getinfo` and `commando-rune` methods and save values in `COMMANDO_CONFIG`.
+      - Values can either be set manually or script `entrypoint.sh` can be used to call `getinfo` and `createrune` methods and save values in `COMMANDO_CONFIG`.
       - `entrypoint.sh` can only run for the locally installed lightning. If `cln-application` is running remotely then pubkey and 
       rune can be set manually.
       - Sample commando config should look like:

diff --git a/apps/backend/dist/controllers/shared.js b/apps/backend/dist/controllers/shared.js
@@ -6,6 +6,7 @@ import handleError from '../shared/error-handler.js';
 import { APIError } from '../models/errors.js';
 import { setSharedApplicationConfig, overrideSettingsWithEnvVariables } from '../shared/utils.js';
 import { sep } from 'path';
+import { LNMessage } from '../service/lightning.service.js';
 class SharedController {
     getApplicationSettings(req, res, next) {
         try {
@@ -72,6 +73,7 @@ class SharedController {
                     .replace('-----BEGIN CERTIFICATE-----', '')
                     .replace('-----END CERTIFICATE-----', '');
             }
+            LNMessage.refreshEnvVariables();
             const CONNECT_WALLET_SETTINGS = {
                 LOCAL_HOST: process.env.LOCAL_HOST || '',
                 DEVICE_DOMAIN_NAME: process.env.DEVICE_DOMAIN_NAME || '',
@@ -87,6 +89,7 @@ class SharedController {
                 NODE_PUBKEY: process.env.LIGHTNING_PUBKEY || '',
                 COMMANDO_RUNE: process.env.COMMANDO_RUNE,
                 APP_VERSION: JSON.parse(packageData).version || '',
+                INVOICE_RUNE: process.env.INVOICE_RUNE || '',
             };
             res.status(200).json(CONNECT_WALLET_SETTINGS);
         }
@@ -119,5 +122,24 @@ class SharedController {
             handleError(error, req, res, next);
         }
     }
+    async saveInvoiceRune(req, res, next) {
+        try {
+            logger.info('Saving Invoice Rune');
+            const showRunes = await LNMessage.call('showrunes', []);
+            const invoiceRune = showRunes.runes.find(rune => rune.restrictions.some(restriction => restriction.alternatives.some(alternative => alternative.value === 'invoice')) &&
+                rune.restrictions.some(restriction => restriction.alternatives.some(alternative => alternative.value === 'listinvoices')));
+            if (invoiceRune && fs.existsSync(APP_CONSTANTS.COMMANDO_ENV_LOCATION)) {
+                const invoiceRuneString = `INVOICE_RUNE="${invoiceRune.rune}"\n`;
+                fs.appendFileSync(APP_CONSTANTS.COMMANDO_ENV_LOCATION, invoiceRuneString, 'utf-8');
+                res.status(201).send();
+            }
+            else {
+                throw new Error('Invoice rune not found or .commando-env does not exist.');
+            }
+        }
+        catch (error) {
+            handleError(error, req, res, next);
+        }
+    }
 }
 export default new SharedController();
diff --git a/apps/backend/dist/models/showrunes.type.js b/apps/backend/dist/models/showrunes.type.js
@@ -0,0 +1 @@
+export {};
diff --git a/apps/backend/dist/routes/v1/shared.js b/apps/backend/dist/routes/v1/shared.js
@@ -25,6 +25,9 @@ export class SharedRoutes extends CommonRoutesConfig {
         this.app
             .route(API_VERSION + SHARED_ROUTE + '/rate/:fiatCurrency')
             .get(SharedController.getFiatRate);
+        this.app
+            .route(API_VERSION + SHARED_ROUTE + '/saveinvoicerune/')
+            .post(AuthController.isUserAuthenticated, SharedController.saveInvoiceRune);
         return this.app;
     }
 }
diff --git a/apps/backend/dist/service/lightning.service.js b/apps/backend/dist/service/lightning.service.js
@@ -4,17 +4,14 @@ import Lnmessage from 'lnmessage';
 import { LightningError } from '../models/errors.js';
 import { HttpStatusCode, APP_CONSTANTS, LN_MESSAGE_CONFIG } from '../shared/consts.js';
 import { logger } from '../shared/logger.js';
+import { readFileSync } from 'fs';
 export class LightningService {
     lnMessage = null;
     constructor() {
         try {
             logger.info('Getting Commando Rune');
             if (fs.existsSync(APP_CONSTANTS.COMMANDO_ENV_LOCATION)) {
-                const DATA_SPLIT = (Buffer.from(fs.readFileSync(APP_CONSTANTS.COMMANDO_ENV_LOCATION)).toString() || '\n').split('\n');
-                process.env.LIGHTNING_PUBKEY = DATA_SPLIT[0].substring(18, DATA_SPLIT[0].length - 1);
-                process.env.COMMANDO_RUNE = DATA_SPLIT[1].substring(16, DATA_SPLIT[1].length - 1);
-                LN_MESSAGE_CONFIG.remoteNodePublicKey = process.env.LIGHTNING_PUBKEY;
-                APP_CONSTANTS.COMMANDO_RUNE = process.env.COMMANDO_RUNE;
+                this.refreshEnvVariables();
                 logger.info('lnMessage connecting with config: ' + JSON.stringify(LN_MESSAGE_CONFIG));
                 this.lnMessage = new Lnmessage(LN_MESSAGE_CONFIG);
                 this.lnMessage.connect();
@@ -53,5 +50,32 @@ export class LightningService {
             }
         });
     };
+    refreshEnvVariables() {
+        const envVars = this.parseEnvFile(APP_CONSTANTS.COMMANDO_ENV_LOCATION);
+        process.env.LIGHTNING_PUBKEY = envVars.LIGHTNING_PUBKEY;
+        process.env.COMMANDO_RUNE = envVars.LIGHTNING_RUNE;
+        process.env.INVOICE_RUNE = envVars.INVOICE_RUNE !== undefined ? envVars.INVOICE_RUNE : '';
+        LN_MESSAGE_CONFIG.remoteNodePublicKey = process.env.LIGHTNING_PUBKEY;
+        APP_CONSTANTS.COMMANDO_RUNE = process.env.COMMANDO_RUNE;
+    }
+    parseEnvFile(filePath) {
+        try {
+            const content = readFileSync(filePath, 'utf8');
+            const lines = content.split('\n');
+            const envVars = {};
+            for (let line of lines) {
+                line = line.trim();
+                if (line && line.indexOf('=') !== -1 && !line.startsWith('#')) {
+                    const [key, ...value] = line.split('=');
+                    envVars[key] = value.join('=').replace(/(^"|"$)/g, '');
+                }
+            }
+            return envVars;
+        }
+        catch (err) {
+            logger.error('Error reading .commando-env file:', err);
+            return {};
+        }
+    }
 }
 export const LNMessage = new LightningService();
diff --git a/apps/backend/package.json b/apps/backend/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cln-application-backend",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Core lightning application backend",
   "private": true,
   "license": "MIT",

diff --git a/apps/backend/source/controllers/shared.ts b/apps/backend/source/controllers/shared.ts
@@ -8,6 +8,8 @@ import handleError from '../shared/error-handler.js';
 import { APIError } from '../models/errors.js';
 import { setSharedApplicationConfig, overrideSettingsWithEnvVariables } from '../shared/utils.js';
 import { sep } from 'path';
+import { LNMessage } from '../service/lightning.service.js';
+import { ShowRunes } from '../models/showrunes.type.js';
 
 class SharedController {
   getApplicationSettings(req: Request, res: Response, next: NextFunction) {
@@ -82,6 +84,7 @@ class SharedController {
           .replace('-----BEGIN CERTIFICATE-----', '')
           .replace('-----END CERTIFICATE-----', '');
       }
+      LNMessage.refreshEnvVariables();
       const CONNECT_WALLET_SETTINGS = {
         LOCAL_HOST: process.env.LOCAL_HOST || '',
         DEVICE_DOMAIN_NAME: process.env.DEVICE_DOMAIN_NAME || '',
@@ -97,6 +100,7 @@ class SharedController {
         NODE_PUBKEY: process.env.LIGHTNING_PUBKEY || '',
         COMMANDO_RUNE: process.env.COMMANDO_RUNE,
         APP_VERSION: JSON.parse(packageData).version || '',
+        INVOICE_RUNE: process.env.INVOICE_RUNE || '',
       };
       res.status(200).json(CONNECT_WALLET_SETTINGS);
     } catch (error: any) {
@@ -127,6 +131,31 @@ class SharedController {
       handleError(error, req, res, next);
     }
   }
+
+  async saveInvoiceRune(req: Request, res: Response, next: NextFunction) {
+    try {
+      logger.info('Saving Invoice Rune');
+      const showRunes: ShowRunes = await LNMessage.call('showrunes', []);
+      const invoiceRune = showRunes.runes.find(
+        rune =>
+          rune.restrictions.some(restriction =>
+            restriction.alternatives.some(alternative => alternative.value === 'invoice'),
+          ) &&
+          rune.restrictions.some(restriction =>
+            restriction.alternatives.some(alternative => alternative.value === 'listinvoices'),
+          ),
+      );
+      if (invoiceRune && fs.existsSync(APP_CONSTANTS.COMMANDO_ENV_LOCATION)) {
+        const invoiceRuneString = `INVOICE_RUNE="${invoiceRune.rune}"\n`;
+        fs.appendFileSync(APP_CONSTANTS.COMMANDO_ENV_LOCATION, invoiceRuneString, 'utf-8');
+        res.status(201).send();
+      } else {
+        throw new Error('Invoice rune not found or .commando-env does not exist.');
+      }
+    } catch (error: any) {
+      handleError(error, req, res, next);
+    }
+  }
 }
 
 export default new SharedController();
diff --git a/apps/backend/source/models/showrunes.type.ts b/apps/backend/source/models/showrunes.type.ts
@@ -0,0 +1,28 @@
+export type ShowRunes = {
+  runes: Rune[];
+  isLoading: boolean;
+  error?: any;
+};
+
+export type Rune = {
+  rune: string;
+  unique_id: string;
+  restrictions: Restriction[];
+  restrictions_as_english: string;
+  stored?: boolean;
+  blacklisted?: boolean;
+  last_used?: number;
+  our_rune?: boolean;
+};
+
+export type Restriction = {
+  alternatives: Alternative[];
+  english: string;
+};
+
+export type Alternative = {
+  fieldname: string;
+  value: string;
+  condition: string;
+  english: string;
+};
diff --git a/apps/backend/source/routes/v1/shared.ts b/apps/backend/source/routes/v1/shared.ts
@@ -30,6 +30,9 @@ export class SharedRoutes extends CommonRoutesConfig {
     this.app
       .route(API_VERSION + SHARED_ROUTE + '/rate/:fiatCurrency')
       .get(SharedController.getFiatRate);
+    this.app
+      .route(API_VERSION + SHARED_ROUTE + '/saveinvoicerune/')
+      .post(AuthController.isUserAuthenticated, SharedController.saveInvoiceRune);
     return this.app;
   }
 }
diff --git a/apps/backend/source/service/lightning.service.ts b/apps/backend/source/service/lightning.service.ts
@@ -4,6 +4,7 @@ import Lnmessage from 'lnmessage';
 import { LightningError } from '../models/errors.js';
 import { HttpStatusCode, APP_CONSTANTS, LN_MESSAGE_CONFIG } from '../shared/consts.js';
 import { logger } from '../shared/logger.js';
+import { readFileSync } from 'fs';
 
 export class LightningService {
   private lnMessage: any = null;
@@ -12,13 +13,7 @@ export class LightningService {
     try {
       logger.info('Getting Commando Rune');
       if (fs.existsSync(APP_CONSTANTS.COMMANDO_ENV_LOCATION)) {
-        const DATA_SPLIT = (
-          Buffer.from(fs.readFileSync(APP_CONSTANTS.COMMANDO_ENV_LOCATION)).toString() || '\n'
-        ).split('\n');
-        process.env.LIGHTNING_PUBKEY = DATA_SPLIT[0].substring(18, DATA_SPLIT[0].length - 1);
-        process.env.COMMANDO_RUNE = DATA_SPLIT[1].substring(16, DATA_SPLIT[1].length - 1);
-        LN_MESSAGE_CONFIG.remoteNodePublicKey = process.env.LIGHTNING_PUBKEY;
-        APP_CONSTANTS.COMMANDO_RUNE = process.env.COMMANDO_RUNE;
+        this.refreshEnvVariables();
         logger.info('lnMessage connecting with config: ' + JSON.stringify(LN_MESSAGE_CONFIG));
         this.lnMessage = new Lnmessage(LN_MESSAGE_CONFIG);
         this.lnMessage.connect();
@@ -67,6 +62,37 @@ export class LightningService {
         }
       });
   };
+
+  refreshEnvVariables() {
+    const envVars = this.parseEnvFile(APP_CONSTANTS.COMMANDO_ENV_LOCATION);
+
+    process.env.LIGHTNING_PUBKEY = envVars.LIGHTNING_PUBKEY;
+    process.env.COMMANDO_RUNE = envVars.LIGHTNING_RUNE;
+    process.env.INVOICE_RUNE = envVars.INVOICE_RUNE !== undefined ? envVars.INVOICE_RUNE : '';
+    LN_MESSAGE_CONFIG.remoteNodePublicKey = process.env.LIGHTNING_PUBKEY;
+    APP_CONSTANTS.COMMANDO_RUNE = process.env.COMMANDO_RUNE;
+  }
+
+  private parseEnvFile(filePath: string): { [key: string]: string } {
+    try {
+      const content = readFileSync(filePath, 'utf8');
+      const lines = content.split('\n');
+      const envVars: { [key: string]: string } = {};
+
+      for (let line of lines) {
+        line = line.trim();
+        if (line && line.indexOf('=') !== -1 && !line.startsWith('#')) {
+          const [key, ...value] = line.split('=');
+          envVars[key] = value.join('=').replace(/(^"|"$)/g, '');
+        }
+      }
+
+      return envVars;
+    } catch (err) {
+      logger.error('Error reading .commando-env file:', err);
+      return {};
+    }
+  }
 }
 
 export const LNMessage = new LightningService();
diff --git a/apps/frontend/build/asset-manifest.json b/apps/frontend/build/asset-manifest.json
@@ -1,17 +1,17 @@
 {
   "files": {
-    "main.css": "/static/css/main.6598f92c.css",
-    "main.js": "/static/js/main.7b5c5d6e.js",
+    "main.css": "/static/css/main.1ce19166.css",
+    "main.js": "/static/js/main.2875dcdc.js",
     "static/media/Inter-Bold.ttf": "/static/media/Inter-Bold.88fa7ae373b07b41ecce.ttf",
     "static/media/Inter-SemiBold.ttf": "/static/media/Inter-SemiBold.4d56bb21f2399db8ad48.ttf",
     "static/media/Inter-Medium.ttf": "/static/media/Inter-Medium.6dcbc9bed1ec438907ee.ttf",
     "static/media/Inter-Thin.ttf": "/static/media/Inter-Thin.f341ca512063c66296d1.ttf",
     "index.html": "/index.html",
-    "main.6598f92c.css.map": "/static/css/main.6598f92c.css.map",
-    "main.7b5c5d6e.js.map": "/static/js/main.7b5c5d6e.js.map"
+    "main.1ce19166.css.map": "/static/css/main.1ce19166.css.map",
+    "main.2875dcdc.js.map": "/static/js/main.2875dcdc.js.map"
   },
   "entrypoints": [
-    "static/css/main.6598f92c.css",
-    "static/js/main.7b5c5d6e.js"
+    "static/css/main.1ce19166.css",
+    "static/js/main.2875dcdc.js"
   ]
 }
diff --git a/apps/frontend/build/index.html b/apps/frontend/build/index.html
@@ -1 +1 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./images/cln-favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="color-scheme" content="light dark"><meta name="description" content="Core lightning application"/><link rel="apple-touch-icon" href="./images/cln-logo-dark.png"/><title>Core Lightning</title><script defer="defer" src="/static/js/main.7b5c5d6e.js"></script><link href="/static/css/main.6598f92c.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="./images/cln-favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="color-scheme" content="light dark"><meta name="description" content="Core lightning application"/><link rel="apple-touch-icon" href="./images/cln-logo-dark.png"/><title>Core Lightning</title><script defer="defer" src="/static/js/main.2875dcdc.js"></script><link href="/static/css/main.1ce19166.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>
diff --git a/...ontend/build/static/css/main.6598f92c.css → ...ontend/build/static/css/main.1ce19166.css b/...ontend/build/static/css/main.6598f92c.css → ...ontend/build/static/css/main.1ce19166.css
diff --git a/apps/frontend/build/static/css/main.1ce19166.css.map b/apps/frontend/build/static/css/main.1ce19166.css.map
diff --git a/apps/frontend/build/static/css/main.6598f92c.css.map b/apps/frontend/build/static/css/main.6598f92c.css.map
diff --git a/apps/frontend/build/static/js/main.2875dcdc.js b/apps/frontend/build/static/js/main.2875dcdc.js
diff --git a/...ld/static/js/main.7b5c5d6e.js.LICENSE.txt → ...ld/static/js/main.2875dcdc.js.LICENSE.txt b/...ld/static/js/main.7b5c5d6e.js.LICENSE.txt → ...ld/static/js/main.2875dcdc.js.LICENSE.txt
diff --git a/apps/frontend/build/static/js/main.2875dcdc.js.map b/apps/frontend/build/static/js/main.2875dcdc.js.map
diff --git a/apps/frontend/build/static/js/main.4501e70f.js b/apps/frontend/build/static/js/main.4501e70f.js