lightning 5.4.2 → 5.6.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Versions
 
+## 5.6.2
+
+- `payViaRoutes`, `subscribeToPayViaRoutes`: Add support for relay messages
+
+## 5.5.0
+
+- `partiallySignPsbt`: Add method to partially sign a PSBT
+
 ## 5.4.2
 
 - `deletePendingChannel`: Add method to delete a stuck pending channel

package/README.md

@@ -206,8 +206,10 @@ To access unauthenticated methods like the wallet unlocker, use
     chosen to be spent.
 - [openChannel](https://github.com/alexbosworth/ln-service#openchannel): Create a new channel
     to another node.
-- [openChannels](https://github.com/alexbosworth/ln-service#openchannels): Open multiple
-    channels in a single on-chain transaction batch.
+- [openChannels](https://github.com/alexbosworth/ln-service#openchannels): Open
+     multiple channels in a single on-chain transaction batch.
+- [partiallySignPsbt](https://github.com/alexbosworth/ln-service#partiallysignpsbt):
+    Add a partial signature to a PSBT
 - [pay](https://github.com/alexbosworth/ln-service#pay): Make an off-chain payment.
 - [payViaPaymentDetails](https://github.com/alexbosworth/ln-service#payviapaymentdetails): Pay
     off-chain using details about a destination invoice.

package/lnd_methods/info/constants.json

@@ -20,6 +20,7 @@
   "versions": {
     "0d5b0fefa4d9082f7964836f5e58c3a6bda8e471": "0.10.2-beta",
     "1a3194d302f33bb52823297d9d7f75cd37516053": "0.10.0-beta",
+    "1e511be523eb8e97c4e2d9c89a7a263963a3929f": "0.14.2-beta",
     "3ae46d81f4a2edad06ef778b2940d9b06386d93b": "0.11.0-beta",
     "4f567577db9d85b6f392f960b3aabddcad3cd02c": "0.13.3-beta",
     "52bb3f33707b81972c67937c7a89addcdf00991c": "0.10.1-beta",

package/lnd_methods/offchain/pay_via_routes.d.ts

@@ -27,6 +27,12 @@ export type PayViaRoutesArgs = AuthenticatedLightningArgs<{
       forward: number;
       /** Forward Millitokens */
       forward_mtokens: string;
+      messages?: {
+        /** Message Type number */
+        type: string;
+        /** Message Raw Value Hex Encoded */
+        value: string;
+      }[];
       /** Public Key Hex */
       public_key?: string;
       /** Timeout Block Height */

package/lnd_methods/offchain/pay_via_routes.js

@@ -29,6 +29,10 @@ const notFound = -1;
         fee_mtokens: <Fee Millitokens String>
         forward: <Forward Tokens Number>
         forward_mtokens: <Forward Millitokens String>
+        [messages]: [{
+          type: <Message Type Number String>
+          value: <Message Raw Value Hex Encoded String>
+        }]
         [public_key]: <Public Key Hex String>
         timeout: <Timeout Block Height Number>
       }]

package/lnd_methods/offchain/subscribe_to_pay_via_routes.js

@@ -43,6 +43,10 @@ const unknownWireError = 'unknown wire error';
         fee_mtokens: <Fee Millitokens String>
         forward: <Forward Tokens Number>
         forward_mtokens: <Forward Millitokens String>
+        [messages]: [{
+          type: <Message Type Number String>
+          value: <Message Raw Value Hex Encoded String>
+        }]
         public_key: <Public Key Hex String>
         timeout: <Timeout Block Height Number>
       }]

package/lnd_methods/onchain/fund_psbt.js

@@ -1,6 +1,7 @@
 const asyncAuto = require('async/auto');
 const {decodePsbt} = require('psbt');
 const {returnResult} = require('asyncjs-util');
+const tinysecp = require('tiny-secp256k1');
 const {Transaction} = require('bitcoinjs-lib');
 
 const {isLnd} = require('./../../lnd_requests');
@@ -67,6 +68,9 @@ const txIdFromHash = hash => hash.reverse().toString('hex');
 module.exports = (args, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
+      // Import ECPair library
+      ecp: async () => (await import('ecpair')).ECPairFactory(tinysecp),
+
       // Check arguments
       validate: cbk => {
         if (!isLnd({method, type, lnd: args.lnd})) {
@@ -201,11 +205,11 @@ module.exports = (args, cbk) => {
       }],
 
       // Derive the raw transaction from the funded PSBT
-      tx: ['fund', ({fund}, cbk) => {
+      tx: ['fund', ({ecp, fund}, cbk) => {
         const {psbt} = fund;
 
         try {
-          const tx = fromHex(decodePsbt({psbt}).unsigned_transaction);
+          const tx = fromHex(decodePsbt({ecp, psbt}).unsigned_transaction);
 
           return cbk(null, tx);
         } catch (err) {

package/lnd_methods/onchain/index.d.ts

@@ -14,6 +14,7 @@ export * from './get_utxos';
 export * from './lock_utxo';
 export * from './open_channel';
 export * from './open_channels';
+export * from './partially_sign_psbt';
 export * from './prepare_for_channel_proposal';
 export * from './propose_channel';
 export * from './request_chain_fee_increase';

package/lnd_methods/onchain/partially_sign_psbt.d.ts

@@ -0,0 +1,28 @@
+import {
+  AuthenticatedLightningArgs,
+  AuthenticatedLightningMethod,
+} from '../../typescript';
+
+export type PartiallySignPsbtArgs = AuthenticatedLightningArgs<{
+  /** Funded PSBT Hex String */
+  psbt: string;
+}>;
+
+export type PartiallySignPsbtResult = {
+  /** Partially Signed PSBT Hex String */
+  psbt: string;
+};
+
+/**
+ * Sign a PSBT to produce a partially signed PSBT
+ *
+ * Requires `onchain:write` permission
+ *
+ * Requires LND built with `walletrpc` tag
+ *
+ * This method is not supported in LND 0.14.2 and below
+ */
+export const partiallySignPsbt: AuthenticatedLightningMethod<
+  PartiallySignPsbtArgs,
+  PartiallySignPsbtResult
+>;

package/lnd_methods/onchain/partially_sign_psbt.js

@@ -16,7 +16,7 @@ const type = 'wallet';
 
   Requires LND built with `walletrpc` tag
 
-  This method is not supported in LND 0.14.1 and below
+  This method is not supported in LND 0.14.2 and below
 
   {
     lnd: <Authenticated LND API Object>

package/lnd_methods/unauthenticated/create_wallet.d.ts

@@ -12,9 +12,17 @@ export type CreateWalletArgs = UnauthenticatedLightningArgs<{
   seed: string;
 }>;
 
+export type CreateWalletResult = {
+  /** Base64 Encoded Admin Macaroon String */
+  macaroon: string;
+};
+
 /**
  * Create a wallet
  *
  * Requires unlocked lnd and unauthenticated LND
  */
-export const createWallet: UnauthenticatedLightningMethod<CreateWalletArgs>;
+export const createWallet: UnauthenticatedLightningMethod<
+  CreateWalletArgs,
+  CreateWalletResult
+>;

package/lnd_requests/rpc_hop_from_hop.js

@@ -1,5 +1,6 @@
 const {chanNumber} = require('bolt07');
 
+const hexAsBuffer = hex => Buffer.from(hex, 'hex');
 const isNumber = n => !isNaN(n);
 const millitokensAsTokens = n => Number(BigInt(n) / BigInt(1e3));
 
@@ -12,6 +13,10 @@ const millitokensAsTokens = n => Number(BigInt(n) / BigInt(1e3));
     fee_mtokens: <Fee Millitokens String>
     forward: <Forward Tokens Number>
     forward_mtokens: <Forward Millitokens String>
+    [messages]: [{
+      type: <Message Type Number String>
+      value: <Message Raw Value Hex Encoded String>
+    }]
     [public_key]: <Forward Edge Public Key Hex String>
     timeout: <Timeout Block Height Number>
   }
@@ -25,10 +30,12 @@ const millitokensAsTokens = n => Number(BigInt(n) / BigInt(1e3));
     amt_to_forward_msat: <Millitokens to Forward String>
     chan_id: <Numeric Format Channel Id String>
     chan_capacity: <Channel Capacity Number>
+    [custom_records]: {<TLV Type Number String>: <TLV Value Buffer Object>}
     expiry: <Timeout Chain Height Number>
     fee: <Fee in Tokens Number>
     fee_msat: <Fee in Millitokens String>
     [pub_key]: <Next Hop Public Key Hex String>
+    [tlv_payload]: <Has Extra TLV Data Bool>
   }
 */
 module.exports = args => {
@@ -44,7 +51,7 @@ module.exports = args => {
     throw new Error('ExpectedFeeMillitokensToMapRpcHopFromHop');
   }
 
-  return {
+  const hop = {
     amt_to_forward: millitokensAsTokens(args.forward_mtokens).toString(),
     amt_to_forward_msat: args.forward_mtokens,
     chan_id: chanNumber({channel: args.channel}).number,
@@ -54,4 +61,21 @@ module.exports = args => {
     fee_msat: args.fee_mtokens,
     pub_key: args.public_key,
   };
+
+  // Exit early when there are no messages to encode in this hop
+  if (!args.messages || !args.messages.length) {
+    return hop;
+  }
+
+  // Set custom TLV payload records for this hop
+  hop.tlv_payload = true;
+
+  hop.custom_records = args.messages.reduce((tlv, n) => {
+    tlv[n.type] = hexAsBuffer(n.value);
+
+    return tlv;
+  },
+  {});
+
+  return hop;
 };

package/lnd_requests/rpc_route_from_route.js

@@ -14,6 +14,10 @@ const isNumber = n => !isNaN(n);
       fee_mtokens: <Fee Millitokens String>
       forward: <Forward Tokens Number>
       forward_mtokens: <Forward Millitokens String>
+      [messages]: [{
+        type: <Message Type Number String>
+        value: <Message Raw Value Hex Encoded String>
+      }]
       [public_key]: <Forward Edge Public Key Hex String>
       timeout: <Timeout Block Height Number>
     }]
@@ -38,6 +42,7 @@ const isNumber = n => !isNaN(n);
       amt_to_forward_msat: <Millitokens to Forward String>
       chan_id: <Numeric Format Channel Id String>
       chan_capacity: <Channel Capacity Number>
+      [custom_records]: {<TLV Type Number String>: <TLV Value Buffer Object>}
       expiry: <Timeout Chain Height Number>
       fee: <Fee in Tokens Number>
       fee_msat: <Fee in Millitokens Number>
@@ -79,7 +84,7 @@ module.exports = args => {
     };
   }
 
-  // Set custom TLV payload records
+  // Set custom TLV payload records on the final hop
   if (!!args.messages && !!args.messages.length) {
     hops[finalHopIndex].tlv_payload = true;
 
@@ -88,7 +93,7 @@ module.exports = args => {
 
       return tlv;
     },
-    {});
+    hops[finalHopIndex].custom_records || {});
   }
 
   return {

package/package.json

@@ -7,10 +7,10 @@
     "url": "https://github.com/alexbosworth/lightning/issues"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.5.3",
+    "@grpc/grpc-js": "1.5.4",
     "@grpc/proto-loader": "0.6.9",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.13",
+    "@types/node": "17.0.15",
     "@types/request": "2.48.8",
     "@types/ws": "8.2.2",
     "async": "3.2.3",
@@ -21,10 +21,12 @@
     "bolt07": "1.8.0",
     "bolt09": "0.2.1",
     "cbor": "8.1.0",
+    "ecpair": "2.0.1",
     "express": "4.17.2",
     "invoices": "2.0.3",
-    "psbt": "1.1.11",
-    "type-fest": "2.11.0"
+    "psbt": "2.0.0",
+    "tiny-secp256k1": "2.2.0",
+    "type-fest": "2.11.1"
   },
   "description": "Lightning Network client library",
   "devDependencies": {
@@ -57,5 +59,5 @@
     "directory": "test/typescript"
   },
   "types": "index.d.ts",
-  "version": "5.4.2"
+  "version": "5.6.2"
 }

package/test/lnd_requests/test_rpc_hop_from_hop.js

@@ -41,6 +41,32 @@ const tests = [
       pub_key: 'public_key',
     },
   },
+  {
+    args: {
+      channel: '0x0x1',
+      channel_capacity: 1,
+      fee: 1,
+      fee_mtokens: '1000',
+      forward: '1',
+      forward_mtokens: '1000',
+      messages: [{type: '12', value: '34'}],
+      public_key: 'public_key',
+      timeout: 1,
+    },
+    description: 'Hop is mapped to RPC hop',
+    expected: {
+      amt_to_forward: '1',
+      amt_to_forward_msat: '1000',
+      chan_id: '1',
+      chan_capacity: '1',
+      custom_records: {'12': Buffer.from('34', 'hex')},
+      expiry: 1,
+      fee: '1',
+      fee_msat: '1000',
+      pub_key: 'public_key',
+      tlv_payload: true,
+    },
+  },
 ];
 
 tests.forEach(({args, description, error, expected}) => {

package/test/typescript/create_wallet.test-d.ts

@@ -1,6 +1,6 @@
 import {expectError, expectType} from 'tsd';
 import {UnauthenticatedLnd} from '../../lnd_grpc';
-import {createWallet} from '../../lnd_methods';
+import {createWallet, CreateWalletResult} from '../../lnd_methods';
 
 const lnd = {} as UnauthenticatedLnd;
 
@@ -20,8 +20,14 @@ expectError(createWallet({lnd, seed}));
 expectError(createWallet({lnd, passphrase, password}));
 expectError(createWallet({lnd, passphrase, seed}));
 
-expectType<void>(await createWallet({lnd, password, seed}));
-expectType<void>(await createWallet({lnd, passphrase, password, seed}));
+expectType<CreateWalletResult>(await createWallet({lnd, password, seed}));
+expectType<CreateWalletResult>(
+  await createWallet({lnd, passphrase, password, seed})
+);
 
-expectType<void>(createWallet({lnd, password, seed}, () => {}));
-expectType<void>(createWallet({lnd, passphrase, password, seed}, () => {}));
+createWallet({lnd, password, seed}, (err, res) => {
+  expectType<CreateWalletResult>(res);
+});
+createWallet({lnd, passphrase, password, seed}, (err, res) => {
+  expectType<CreateWalletResult>(res);
+});

package/test/typescript/partially_sign_psbt.test-d.ts

@@ -0,0 +1,18 @@
+import {expectError, expectType} from 'tsd';
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {partiallySignPsbt, PartiallySignPsbtResult} from '../../lnd_methods';
+
+const lnd = {} as AuthenticatedLnd;
+const psbt = 'psbt';
+
+expectError(partiallySignPsbt());
+expectError(partiallySignPsbt({}));
+expectError(partiallySignPsbt({lnd}));
+
+expectType<PartiallySignPsbtResult>(await partiallySignPsbt({lnd, psbt}));
+
+expectType<void>(
+  partiallySignPsbt({lnd, psbt}, (error, result) => {
+    expectType<PartiallySignPsbtResult>(result);
+  })
+);