pool+stats: fetch node tier from the Pool API

Author: jamaljsr

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

@@ -1,10 +1,11 @@
-import { values } from 'mobx';
+import { runInAction, values } from 'mobx';
+import * as AUCT from 'types/generated/auctioneer_pb';
 import { grpc } from '@improbable-eng/grpc-web';
 import { waitFor } from '@testing-library/react';
 import * as config from 'config';
 import { hex } from 'util/strings';
 import { injectIntoGrpcUnary } from 'util/tests';
-import { poolBatchSnapshot } from 'util/tests/sampleData';
+import { poolBatchSnapshot, sampleApiResponses } from 'util/tests/sampleData';
 import { BatchStore, createStore, Store } from 'store';
 import { BATCH_QUERY_LIMIT } from 'store/stores/batchStore';
 
@@ -148,6 +149,32 @@ describe('BatchStore', () => {
     );
   });
 
+  it('should fetch node tier', async () => {
+    // return sample data from gRPC requests instead of the batches defined in beforeEach()
+    grpcMock.unary.mockImplementation((desc, opts) => {
+      const path = `${desc.service.serviceName}.${desc.methodName}`;
+      opts.onEnd({
+        status: grpc.Code.OK,
+        message: { toObject: () => sampleApiResponses[path] },
+      } as any);
+      return undefined as any;
+    });
+
+    await rootStore.nodeStore.fetchInfo();
+
+    expect(store.nodeTier).toBeUndefined();
+    await store.fetchNodeTier();
+    expect(store.nodeTier).toBe(AUCT.NodeTier.TIER_1);
+
+    // set the pubkey to a random value
+    runInAction(() => {
+      rootStore.nodeStore.pubkey = 'asdf';
+    });
+    await store.fetchNodeTier();
+    // confirm the tier is set to T0 if the pubkey is not found in the response
+    expect(store.nodeTier).toBe(AUCT.NodeTier.TIER_0);
+  });
+
   it('should start and stop polling', async () => {
     let callCount = 0;
     injectIntoGrpcUnary(desc => {

app/src/api/pool.ts

@@ -234,6 +234,16 @@ class PoolApi extends BaseApi<PoolEvents> {
     return res.toObject();
   }
 
+  /**
+   * call the pool `NodeRatings` RPC and return the response
+   */
+  async nodeRatings(pubkey: string): Promise<POOL.NodeRatingResponse.AsObject> {
+    const req = new POOL.NodeRatingRequest();
+    req.addNodePubkeys(b64(pubkey));
+    const res = await this._grpc.request(Trader.NodeRatings, req, this._meta);
+    return res.toObject();
+  }
+
   //
   // Utility functions to convert user-facing units to API units
   //

app/src/store/stores/batchStore.ts

@@ -1,8 +1,18 @@
-import { makeAutoObservable, observable, ObservableMap, runInAction, toJS } from 'mobx';
+import {
+  makeAutoObservable,
+  observable,
+  ObservableMap,
+  runInAction,
+  toJS,
+  when,
+} from 'mobx';
+import { NodeTier } from 'types/generated/auctioneer_pb';
 import { IS_DEV, IS_TEST } from 'config';
 import debounce from 'lodash/debounce';
+import { hex } from 'util/strings';
 import { Store } from 'store';
 import { Batch } from 'store/models';
+import { Tier } from 'store/models/order';
 
 export const BATCH_QUERY_LIMIT = 20;
 const ZERO_BATCH_ID =
@@ -25,6 +35,9 @@ export default class BatchStore {
   /** the timestamp of the next batch in seconds */
   nextBatchTimestamp = 0;
 
+  /** the tier of the current LND node */
+  nodeTier?: Tier;
+
   /** indicates when batches are being fetched from the backend */
   loading = false;
 
@@ -148,6 +161,28 @@ export default class BatchStore {
     }
   }
 
+  /**
+   * fetches the next batch timestamp from the API
+   */
+  async fetchNodeTier() {
+    this._store.log.info('fetching node tier');
+    try {
+      const pubkey = this._store.nodeStore.pubkey;
+      const { nodeRatingsList } = await this._store.api.pool.nodeRatings(pubkey);
+      runInAction(() => {
+        const rating = nodeRatingsList.find(r => hex(r.nodePubkey) === pubkey);
+        if (rating) {
+          this.nodeTier = rating.nodeTier;
+        } else {
+          this.nodeTier = NodeTier.TIER_0;
+        }
+        this._store.log.info('updated batchStore.nodeTier', this.nodeTier);
+      });
+    } catch (error) {
+      this._store.appView.handleError(error, 'Unable to fetch the node tier');
+    }
+  }
+
   /**
    * sets the nextBatchTimestamp and creates a timer to fetch the latest batch, which
    * will trigger 3 seconds after the next batch timestamp to allow some time for the
@@ -191,4 +226,16 @@ export default class BatchStore {
       this._store.log.info('polling was already stopped');
     }
   }
+
+  /**
+   * initialize the batch store
+   */
+  init() {
+    // when the pubkey is fetched from the API and set in the nodeStore, fetch
+    // the node's tier
+    when(
+      () => !!this._store.nodeStore.pubkey && !this.nodeTier,
+      () => this.fetchNodeTier(),
+    );
+  }
 }