Merge pull request #337 from lightninglabs/pool-order-version

pool: determine order type based on Pool version

Author: jamaljsr

app/package.json

@@ -47,6 +47,7 @@
     "react-toastify": "6.0.6",
     "react-virtualized": "9.21.2",
     "reactour": "1.18.0",
+    "semver": "^7.3.5",
     "styled-components": "5.1.1"
   },
   "devDependencies": {
@@ -73,6 +74,7 @@
     "@types/react-router": "5.1.8",
     "@types/react-virtualized": "9.21.10",
     "@types/reactour": "1.17.1",
+    "@types/semver": "^7.3.9",
     "@typescript-eslint/eslint-plugin": "5.17.0",
     "@typescript-eslint/parser": "5.17.0",
     "cross-env": "7.0.2",

app/scripts/build-protos.js

@@ -52,28 +52,28 @@ const protoSources = async () => {
 const filePatches = {
   lnd: {
     patch: 'lnrpc: {}',
-    folder: 'proto'
+    folder: 'proto',
   },
   loop: {
     patch: 'looprpc: {}',
-    folder: 'proto'
+    folder: 'proto',
   },
   common: {
     patch: 'looprpc: {}',
-    folder: 'proto'
+    folder: 'proto',
   },
   trader: {
     patch: 'poolrpc: {}',
-    folder: 'proto'
+    folder: 'proto',
   },
   'auctioneerrpc/auctioneer': {
     patch: 'poolrpc: {}',
-    folder: 'proto'
+    folder: 'proto',
   },
   'lit-sessions': {
     patch: 'litrpc: {}',
-    folder: 'litrpc'
-  }
+    folder: 'litrpc',
+  },
 };
 
 /**
@@ -132,9 +132,9 @@ const generate = async () => {
     '.bin',
     platform() === 'win32' ? 'protoc-gen-ts.cmd' : 'protoc-gen-ts',
   );
-  const files = Object
-      .keys(filePatches)
-      .map(name => `../${filePatches[name].folder}/${name}.proto`);
+  const files = Object.keys(filePatches).map(
+    name => `../${filePatches[name].folder}/${name}.proto`,
+  );
   const protocCmd = [
     'protoc',
     `-I../proto`,
@@ -185,13 +185,35 @@ const patch = async () => {
   }
 };
 
+/**
+ * *Temporary* patch to workaround a grpc-web issue with deserializing the GetInfoResponse.market_info field.
+ * This patch will just comment it out in the proto file, which will omit the field in the JS/TS serialization
+ * code that is generated by the protoc-gen-ts plugin.
+ * See: https://github.com/lightninglabs/lightning-terminal/pull/337
+ */
+const patchPool = async () => {
+  console.log('\nPatching Pool proto file');
+  const path = join(appPath, '..', 'proto', 'trader.proto');
+
+  console.log(` - ${path}`);
+  let content = await fs.readFile(path);
+
+  // comment out the `market_info` field
+  const line = 'map<uint32, MarketInfo> market_info = 15;';
+  const patch = '// [workaround, see patchPool() in build-protos.js] ';
+  content = content.toString().replace(line, patch + line);
+
+  await fs.writeFile(path, content);
+};
+
 /**
  * An async wrapper with error handling around the two funcs above
  */
 const main = async () => {
   try {
     await download();
     await sanitize();
+    await patchPool();
     await generate();
     await patch();
   } catch (error) {

app/src/__tests__/components/pool/OrderFormSection.spec.tsx

@@ -1,11 +1,14 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 import React from 'react';
 import * as POOL from 'types/generated/trader_pb';
+import { grpc } from '@improbable-eng/grpc-web';
 import { fireEvent, waitFor } from '@testing-library/react';
-import { injectIntoGrpcUnary, renderWithProviders } from 'util/tests';
+import { injectIntoGrpcUnary, renderWithProviders, sampleGrpcResponse } from 'util/tests';
 import { createStore, Store } from 'store';
 import OrderFormSection from 'components/pool/OrderFormSection';
 
+const grpcMock = grpc as jest.Mocked<typeof grpc>;
+
 describe('OrderFormSection', () => {
   let store: Store;
 
@@ -64,14 +67,21 @@ describe('OrderFormSection', () => {
     changeInput('Max Batch Fee Rate', '1');
     await changeSelect('Min Node Tier', 'T0 - All Nodes');
 
-    let bid: Required<POOL.Bid.AsObject>;
+    // handle the GetInfo call
+    grpcMock.unary.mockImplementationOnce((desc, opts) => {
+      opts.onEnd(sampleGrpcResponse(desc));
+      return undefined as any;
+    });
+    let bid: Required<POOL.Bid.AsObject> = {} as any;
     // capture the rate that is sent to the API
     injectIntoGrpcUnary((_, props) => {
       bid = (props.request.toObject() as any).bid;
     });
 
     fireEvent.click(getByText('Place Bid Order'));
-    expect(bid!.details.amt).toBe('1000000');
+    await waitFor(() => {
+      expect(bid!.details.amt).toBe('1000000');
+    });
     expect(bid!.details.rateFixed).toBe(4960);
     expect(bid!.details.minUnitsMatch).toBe(1);
     expect(bid!.leaseDurationBlocks).toBe(2016);
@@ -88,14 +98,21 @@ describe('OrderFormSection', () => {
     changeInput('Minimum Channel Size', '100000');
     changeInput('Max Batch Fee Rate', '1');
 
+    // handle the GetInfo call
+    grpcMock.unary.mockImplementationOnce((desc, opts) => {
+      opts.onEnd(sampleGrpcResponse(desc));
+      return undefined as any;
+    });
     let ask: Required<POOL.Ask.AsObject>;
     // capture the rate that is sent to the API
     injectIntoGrpcUnary((_, props) => {
       ask = (props.request.toObject() as any).ask;
     });
 
     fireEvent.click(getByText('Place Ask Order'));
-    expect(ask!.details.amt).toBe('1000000');
+    await waitFor(() => {
+      expect(ask!.details.amt).toBe('1000000');
+    });
     expect(ask!.details.rateFixed).toBe(4960);
     expect(ask!.details.minUnitsMatch).toBe(1);
     expect(ask!.leaseDurationBlocks).toBe(2016);
@@ -112,14 +129,21 @@ describe('OrderFormSection', () => {
     await changeSelect('Channel Duration', '1 month (open)');
     await changeSelect('Min Node Tier', 'T0 - All Nodes');
 
+    // handle the GetInfo call
+    grpcMock.unary.mockImplementationOnce((desc, opts) => {
+      opts.onEnd(sampleGrpcResponse(desc));
+      return undefined as any;
+    });
     let bid: Required<POOL.Bid.AsObject>;
     // capture the rate that is sent to the API
     injectIntoGrpcUnary((_, props) => {
       bid = (props.request.toObject() as any).bid;
     });
 
     fireEvent.click(getByText('Place Bid Order'));
-    expect(bid!.details.amt).toBe('1000000');
+    await waitFor(() => {
+      expect(bid!.details.amt).toBe('1000000');
+    });
     expect(bid!.details.rateFixed).toBe(2480);
     expect(bid!.details.minUnitsMatch).toBe(1);
     expect(bid!.leaseDurationBlocks).toBe(4032);

app/src/__tests__/store/orderStore.spec.ts

@@ -5,6 +5,7 @@ import { grpc } from '@improbable-eng/grpc-web';
 import { waitFor } from '@testing-library/react';
 import Big from 'big.js';
 import { hex } from 'util/strings';
+import { sampleGrpcResponse } from 'util/tests';
 import { poolInvalidOrder, poolListOrders, poolSubmitOrder } from 'util/tests/sampleData';
 import { createStore, OrderStore, Store } from 'store';
 import { Order } from 'store/models';
@@ -101,6 +102,12 @@ describe('OrderStore', () => {
 
   it('should handle invalid orders', async () => {
     await rootStore.accountStore.fetchAccounts();
+    // handle the GetInfo call
+    grpcMock.unary.mockImplementationOnce((desc, opts) => {
+      opts.onEnd(sampleGrpcResponse(desc));
+      return undefined as any;
+    });
+    // mock the SubmitOrder response
     grpcMock.unary.mockImplementationOnce((desc, opts) => {
       if (desc.methodName === 'SubmitOrder') {
         const res = {

app/src/api/pool.ts

@@ -3,6 +3,7 @@ import * as POOL from 'types/generated/trader_pb';
 import { Trader } from 'types/generated/trader_pb_service';
 import Big from 'big.js';
 import { Buffer } from 'buffer';
+import { coerce, satisfies } from 'semver';
 import { b64 } from 'util/strings';
 import { OrderType, Tier } from 'store/models/order';
 import BaseApi from './base';
@@ -20,9 +21,17 @@ export const ONE_UNIT = 100000;
 // The minimum batch fee rate in sats/kw
 export const MIN_FEE_RATE_KW = 253;
 
-// The latest order version. This should be updated along with pool CLI
-// see: https://github.com/lightninglabs/pool/blob/master/order/interface.go#L35
-export const ORDER_VERSION = 4;
+// The default order version to use if the Pool version cannot be detected
+export const DEFAULT_ORDER_VERSION = 2;
+
+// maps from the Pool version semver condition to a compatible order version
+// see: https://github.com/lightninglabs/pool/blob/master/order/interfaces.go#L42
+export const ORDER_VERSION_COMPAT: Record<string, number> = {
+  '>=0.5.2-alpha': 5,
+  '>=0.5.0-alpha': 4,
+  '>=0.4.0-alpha': 2,
+  '>=0.2.7-alpha': 1,
+};
 
 const POOL_INITIATOR = 'lit-ui';
 
@@ -41,6 +50,15 @@ class PoolApi extends BaseApi<PoolEvents> {
     this._grpc = grpc;
   }
 
+  /**
+   * call the pool `GetInfo` RPC and return the response
+   */
+  async getInfo(): Promise<POOL.GetInfoResponse.AsObject> {
+    const req = new POOL.GetInfoRequest();
+    const res = await this._grpc.request(Trader.GetInfo, req, this._meta);
+    return res.toObject();
+  }
+
   /**
    * call the pool `QuoteAccount` RPC and return the response
    */
@@ -201,6 +219,9 @@ class PoolApi extends BaseApi<PoolEvents> {
       throw new Error(`The rate is too low. it must equate to at least 1 sat per block`);
     }
 
+    const info = await this.getInfo();
+    const orderVersion = this.getOrderVersion(info.version);
+
     const req = new POOL.SubmitOrderRequest();
     req.setInitiator(POOL_INITIATOR);
 
@@ -215,15 +236,15 @@ class PoolApi extends BaseApi<PoolEvents> {
       case OrderType.Bid:
         const bid = new POOL.Bid();
         bid.setLeaseDurationBlocks(duration);
-        bid.setVersion(ORDER_VERSION);
+        bid.setVersion(orderVersion);
         if (minNodeTier !== undefined) bid.setMinNodeTier(minNodeTier);
         bid.setDetails(order);
         req.setBid(bid);
         break;
       case OrderType.Ask:
         const ask = new POOL.Ask();
         ask.setLeaseDurationBlocks(duration);
-        ask.setVersion(ORDER_VERSION);
+        ask.setVersion(orderVersion);
         ask.setDetails(order);
         req.setAsk(ask);
         break;
@@ -358,6 +379,26 @@ class PoolApi extends BaseApi<PoolEvents> {
   calcPctRate(fixedRate: Big, duration: Big) {
     return +fixedRate.mul(duration).div(FEE_RATE_TOTAL_PARTS);
   }
+
+  /**
+   * Determines which order version to use based on the provided version string
+   * @param version the version of pool
+   *    (ex: 0.5.4-alpha commit=v0.5.4-alpha.0.20220114202858-525fe156d240)
+   */
+  getOrderVersion(version: string): number {
+    // try to convert the pool version string to a SemVer object (ex: 0.5.4)
+    const verNum = coerce(version);
+    if (!verNum) return DEFAULT_ORDER_VERSION;
+
+    // find the first key which the pool version satisfies
+    const matchedKey = Object.keys(ORDER_VERSION_COMPAT).find(condition =>
+      satisfies(verNum, condition),
+    );
+    if (!matchedKey) return DEFAULT_ORDER_VERSION;
+
+    // return the order version that was matched
+    return ORDER_VERSION_COMPAT[matchedKey];
+  }
 }
 
 export default PoolApi;