Merge pull request #552 from lightninglabs/enable-macaroons

Enable macaroons

Author: tanx

assets/script/setup_local_cluster.md

@@ -11,19 +11,19 @@ After initiating the wallet and setting your password close the app again.
 ```
 btcd --txindex --simnet --rpcuser=kek --rpcpass=kek --datadir=data/btcd/data --logdir=data/btcd/logs
 
-lnd --rpclisten=localhost:10009 --listen=localhost:10019 --restlisten=localhost:8009 --lnddir=data/lnd --debuglevel=info --bitcoin.simnet --bitcoin.active --bitcoin.node=btcd --btcd.rpcuser=kek --btcd.rpcpass=kek --no-macaroons
+lnd --rpclisten=localhost:10009 --listen=localhost:10019 --restlisten=localhost:8009 --lnddir=data/lnd --debuglevel=info --bitcoin.simnet --bitcoin.active --bitcoin.node=btcd --btcd.rpcuser=kek --btcd.rpcpass=kek
 
-lncli --rpcserver=localhost:10009 --no-macaroons --lnddir=data/lnd unlock
+lncli --rpcserver=localhost:10009 --lnddir=data/lnd unlock
 
-lnd --rpclisten=localhost:10002 --listen=localhost:10012 --restlisten=localhost:8002 --lnddir=data/lnd2 --debuglevel=info --bitcoin.simnet --bitcoin.active --bitcoin.node=btcd --btcd.rpcuser=kek --btcd.rpcpass=kek --no-macaroons --noencryptwallet
+lnd --rpclisten=localhost:10002 --listen=localhost:10012 --restlisten=localhost:8002 --lnddir=data/lnd2 --debuglevel=info --bitcoin.simnet --bitcoin.active --bitcoin.node=btcd --btcd.rpcuser=kek --btcd.rpcpass=kek --noencryptwallet
 ```
 
 ## Fund wallets addresses
 
 ```
-lncli --rpcserver=localhost:10009 --no-macaroons --lnddir=data/lnd newaddress np2wkh
+lncli --rpcserver=localhost:10009 --lnddir=data/lnd newaddress np2wkh
 
-lncli --rpcserver=localhost:10002 --no-macaroons --lnddir=data/lnd2 newaddress np2wkh
+lncli --rpcserver=localhost:10002 --lnddir=data/lnd2 newaddress np2wkh
 
 btcd --txindex --simnet --rpcuser=kek --rpcpass=kek --datadir=data/btcd/data --logdir=data/btcd/logs --miningaddr=NEW_ADDRESS
 
@@ -33,19 +33,19 @@ btcctl --simnet --rpcuser=kek --rpcpass=kek generate 400
 ## Open channel and send payment
 
 ```
-lncli --rpcserver=localhost:10009 --no-macaroons --lnddir=data/lnd getinfo
+lncli --rpcserver=localhost:10009 --lnddir=data/lnd getinfo
 
-lncli --rpcserver=localhost:10002 --no-macaroons --lnddir=data/lnd2 getinfo
+lncli --rpcserver=localhost:10002 --lnddir=data/lnd2 getinfo
 
-lncli --rpcserver=localhost:10009 --no-macaroons --lnddir=data/lnd connect PUB_KEY@localhost:10012
+lncli --rpcserver=localhost:10009 --lnddir=data/lnd connect PUB_KEY@localhost:10012
 
-lncli --rpcserver=localhost:10009 --no-macaroons --lnddir=data/lnd openchannel --node_key=PUB_KEY --local_amt=16000000
+lncli --rpcserver=localhost:10009 --lnddir=data/lnd openchannel --node_key=PUB_KEY --local_amt=16000000
 
 btcctl --simnet --rpcuser=kek --rpcpass=kek generate 6
 
-lncli --rpcserver=localhost:10009 --no-macaroons --lnddir=data/lnd listchannels
+lncli --rpcserver=localhost:10009 --lnddir=data/lnd listchannels
 
-lncli --rpcserver=localhost:10002 --no-macaroons --lnddir=data/lnd2 addinvoice --amt=10000
+lncli --rpcserver=localhost:10002 --lnddir=data/lnd2 addinvoice --amt=10000
 
-lncli --rpcserver=localhost:10009 --no-macaroons --lnddir=data/lnd sendpayment --pay_req=ENCODED_INVOICE
+lncli --rpcserver=localhost:10009 --lnddir=data/lnd sendpayment --pay_req=ENCODED_INVOICE
 ```

public/electron.js

@@ -9,7 +9,7 @@ const { startLndProcess, startBtcdProcess } = require('./lnd-child-process');
 const grcpClient = require('./grpc-client');
 const {
   PREFIX_NAME,
-  MACAROONS_ENABLED,
+  NETWORK,
   LND_PORT,
   LND_PEER_PORT,
   LND_INIT_DELAY,
@@ -123,7 +123,7 @@ function createWindow() {
     ipcMain,
     lndSettingsDir,
     lndPort: LND_PORT,
-    macaroonsEnabled: MACAROONS_ENABLED,
+    network: isDev ? 'simnet' : NETWORK,
   });
 }
 
@@ -138,7 +138,6 @@ const startLnd = async () => {
     lndProcess = await startLndProcess({
       isDev,
       lndSettingsDir,
-      macaroonsEnabled: MACAROONS_ENABLED,
       lndPort: LND_PORT,
       lndPeerPort: LND_PEER_PORT,
       logger: Logger,

public/grpc-client.js

@@ -32,23 +32,27 @@ async function getCredentials(lndSettingsDir) {
   return grpc.credentials.createSsl(lndCert);
 }
 
-function getMetadata(lndSettingsDir) {
-  const metadata = new grpc.Metadata();
-  const macaroonPath = path.join(lndSettingsDir, 'admin.macaroon');
-  const macaroonHex = fs.readFileSync(macaroonPath).toString('hex');
-  metadata.add('macaroon', macaroonHex);
-  return metadata;
+function getMacaroonCreds(lndSettingsDir, network) {
+  return grpc.credentials.createFromMetadataGenerator((args, callback) => {
+    const metadata = new grpc.Metadata();
+    const macaroonPath = path.join(
+      lndSettingsDir,
+      `data/chain/bitcoin/${network}/admin.macaroon`
+    );
+    const macaroonHex = fs.readFileSync(macaroonPath).toString('hex');
+    metadata.add('macaroon', macaroonHex);
+    callback(null, metadata);
+  });
 }
 
 module.exports.init = async function({
   ipcMain,
   lndPort,
   lndSettingsDir,
-  macaroonsEnabled,
+  network,
 }) {
   let credentials;
   let protoPath;
-  let metadata;
   let lnrpc;
   let unlocker;
   let lnd;
@@ -57,9 +61,6 @@ module.exports.init = async function({
     credentials = await getCredentials(lndSettingsDir);
     protoPath = path.join(__dirname, '..', 'assets', 'rpc.proto');
     lnrpc = grpc.load(protoPath).lnrpc;
-    if (macaroonsEnabled) {
-      metadata = getMetadata(lndSettingsDir);
-    }
     unlocker = new lnrpc.WalletUnlocker(`localhost:${lndPort}`, credentials);
     grpc.waitForClientReady(unlocker, Infinity, err => {
       event.sender.send('unlockReady', { err });
@@ -72,6 +73,11 @@ module.exports.init = async function({
   });
 
   ipcMain.on('lndInit', event => {
+    const macaroonCreds = getMacaroonCreds(lndSettingsDir, network);
+    credentials = grpc.credentials.combineChannelCredentials(
+      credentials,
+      macaroonCreds
+    );
     lnd = new lnrpc.Lightning(`localhost:${lndPort}`, credentials);
     grpc.waitForClientReady(lnd, Infinity, err => {
       event.sender.send('lndReady', { err });
@@ -88,33 +94,21 @@ module.exports.init = async function({
     const handleResponse = (err, response) => {
       event.sender.send(`unlockResponse_${method}`, { err, response });
     };
-    if (metadata) {
-      unlocker[method](body, metadata, { deadline }, handleResponse);
-    } else {
-      unlocker[method](body, { deadline }, handleResponse);
-    }
+    unlocker[method](body, { deadline }, handleResponse);
   });
 
   ipcMain.on('lndRequest', (event, { method, body }) => {
     const deadline = new Date(new Date().getTime() + GRPC_TIMEOUT);
     const handleResponse = (err, response) => {
       event.sender.send(`lndResponse_${method}`, { err, response });
     };
-    if (metadata) {
-      lnd[method](body, metadata, { deadline }, handleResponse);
-    } else {
-      lnd[method](body, { deadline }, handleResponse);
-    }
+    lnd[method](body, { deadline }, handleResponse);
   });
 
   const streams = {};
   ipcMain.on('lndStreamRequest', (event, { method, body }) => {
     let stream;
-    if (metadata) {
-      stream = lnd[method](metadata, body);
-    } else {
-      stream = lnd[method](body);
-    }
+    stream = lnd[method](body);
     const send = res => event.sender.send(`lndStreamEvent_${method}`, res);
     stream.on('data', data => send({ event: 'data', data }));
     stream.on('end', () => send({ event: 'end' }));

public/lnd-child-process.js

@@ -47,7 +47,6 @@ function startBlockingProcess(name, args, logger) {
 
 module.exports.startLndProcess = async function({
   isDev,
-  macaroonsEnabled,
   lndSettingsDir,
   lndPort,
   lndPeerPort,
@@ -61,7 +60,6 @@ module.exports.startLndProcess = async function({
     '--bitcoin.active',
     '--debuglevel=info',
     `--lnddir=${lndSettingsDir}`,
-    macaroonsEnabled ? '' : '--no-macaroons',
     lndPort ? `--rpclisten=localhost:${lndPort}` : '',
     lndPeerPort ? `--listen=localhost:${lndPeerPort}` : '',
     lndRestPort ? `--restlisten=localhost:${lndRestPort}` : '',

src/config.js

@@ -9,7 +9,7 @@ module.exports.RATE_DELAY = 15 * 60 * 1000;
 
 module.exports.LND_PORT = 10009;
 module.exports.LND_PEER_PORT = 10019;
-module.exports.MACAROONS_ENABLED = false;
+module.exports.NETWORK = 'testnet';
 module.exports.BTCD_MINING_ADDRESS = 'rfu4i1Mo2NF7TQsN9bMVLFSojSzcyQCEH5';
 
 const prefixName = 'lightning';

test/integration/action/action-integration.spec.js

@@ -25,6 +25,7 @@ const grcpClient = require('../../../public/grpc-client');
 /* eslint-disable no-unused-vars */
 
 const isDev = true;
+const NETWORK = 'simnet';
 const BTCD_PORT = 18555;
 const BTCD_SETTINGS_DIR = 'test/data/btcd';
 const LND_SETTINGS_DIR_1 = 'test/data/lnd_1';
@@ -37,7 +38,6 @@ const LND_REST_PORT_1 = 8001;
 const LND_REST_PORT_2 = 8002;
 const HOST_1 = `localhost:${LND_PEER_PORT_1}`;
 const HOST_2 = `localhost:${LND_PEER_PORT_2}`;
-const MACAROONS_ENABLED = false;
 const NAP_TIME = process.env.NAP_TIME || 5000;
 const walletPassword = 'bitconeeeeeect';
 
@@ -111,7 +111,6 @@ describe('Action Integration Tests', function() {
     await poll(() => isPortOpen(BTCD_PORT));
     const lndProcess1Promise = startLndProcess({
       isDev,
-      macaroonsEnabled: MACAROONS_ENABLED,
       lndSettingsDir: LND_SETTINGS_DIR_1,
       lndPort: LND_PORT_1,
       lndPeerPort: LND_PEER_PORT_1,
@@ -120,7 +119,6 @@ describe('Action Integration Tests', function() {
     });
     const lndProcess2Promise = startLndProcess({
       isDev,
-      macaroonsEnabled: MACAROONS_ENABLED,
       lndSettingsDir: LND_SETTINGS_DIR_2,
       lndPort: LND_PORT_2,
       lndPeerPort: LND_PEER_PORT_2,
@@ -135,13 +133,13 @@ describe('Action Integration Tests', function() {
       ipcMain: ipcMainStub1,
       lndPort: LND_PORT_1,
       lndSettingsDir: LND_SETTINGS_DIR_1,
-      macaroonsEnabled: MACAROONS_ENABLED,
+      network: NETWORK,
     });
     await grcpClient.init({
       ipcMain: ipcMainStub2,
       lndPort: LND_PORT_2,
       lndSettingsDir: LND_SETTINGS_DIR_2,
-      macaroonsEnabled: MACAROONS_ENABLED,
+      network: NETWORK,
     });
 
     db1 = sinon.createStubInstance(AppStorage);