pool: determine order type based on Pool version

Author: jamaljsr

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;

app/src/util/tests/sampleData.ts

@@ -157,6 +157,7 @@ export const lndPendingChannel: LND.PendingChannelsResponse.PendingChannel.AsObj
   remoteChanReserveSat: '5000',
   remoteNodePub: '03bb934930cdcd25576aa61d08cc95214e0036f1219c435c06976e561558703290',
   numForwardingPackages: '7',
+  chanStatusFlags: '',
 };
 
 export const lndPendingChannels: LND.PendingChannelsResponse.AsObject = {
@@ -197,6 +198,7 @@ export const lndPendingChannels: LND.PendingChannelsResponse.AsObject = {
         remoteTxid: '9850a4b1cfcfbf972f8541b26b8061ed3091ee8cbed5875167080be4be9524e7',
       },
       limboBalance: '0',
+      closingTxid: '6c151252215b73547a5415051c82dd25c725c4309b93fed4f38c4c5b610c3fb0',
     },
   ],
   pendingForceClosingChannelsList: [
@@ -392,6 +394,26 @@ export const poolRenewAccount: POOL.RenewAccountResponse.AsObject = {
   account: poolInitAccount,
 };
 
+export const poolGetInfo: POOL.GetInfoResponse.AsObject = {
+  version: '0.5.4-alpha commit=v0.5.4-alpha.0.20220114202858-525fe156d240',
+  accountsTotal: 5,
+  accountsActive: 1,
+  accountsActiveExpired: 0,
+  accountsArchived: 4,
+  ordersTotal: 16,
+  ordersActive: 0,
+  ordersArchived: 16,
+  currentBlockHeight: 2164104,
+  batchesInvolved: 8,
+  nodeRating: {
+    nodePubkey: '027433f335bbea5f5631bda2bcf45f57d069a084c800aa80148909bc392b99103c',
+    nodeTier: AUCT.NodeTier.TIER_1,
+  },
+  lsatTokens: 1,
+  subscribedToAuctioneer: true,
+  newNodesOnly: false,
+};
+
 export const poolListAccounts: POOL.ListAccountsResponse.AsObject = {
   accountsList: [
     poolInitAccount,
@@ -859,6 +881,7 @@ export const sampleApiResponses: Record<string, any> = {
   'looprpc.SwapClient.GetLoopInQuote': loopInQuote,
   'looprpc.SwapClient.LoopIn': loopSwapResponse,
   'looprpc.SwapClient.LoopOut': loopSwapResponse,
+  'poolrpc.Trader.GetInfo': poolGetInfo,
   'poolrpc.Trader.ListAccounts': poolListAccounts,
   'poolrpc.Trader.QuoteAccount': poolQuoteAccount,
   'poolrpc.Trader.InitAccount': poolInitAccount,