pool+batches: fetch lease durations into batchStore

Author: jamaljsr

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

@@ -5,7 +5,11 @@ import { waitFor } from '@testing-library/react';
 import * as config from 'config';
 import { hex } from 'util/strings';
 import { injectIntoGrpcUnary } from 'util/tests';
-import { poolBatchSnapshot, sampleApiResponses } from 'util/tests/sampleData';
+import {
+  poolBatchSnapshot,
+  poolLeaseDurations,
+  sampleApiResponses,
+} from 'util/tests/sampleData';
 import { BatchStore, createStore, Store } from 'store';
 import { BATCH_QUERY_LIMIT } from 'store/stores/batchStore';
 
@@ -23,15 +27,20 @@ describe('BatchStore', () => {
     // mock the BatchSnapshot response to return a unique id for each batch
     // to avoid overwriting the same record in the store
     index = 0;
-    grpcMock.unary.mockImplementation((_, opts) => {
-      const res = {
-        batchesList: [...Array(20)].map((_, i) => ({
-          ...poolBatchSnapshot,
-          batchId: `${index + i}-${poolBatchSnapshot.batchId}`,
-          prevBatchId: `${index + i}-${poolBatchSnapshot.prevBatchId}`,
-        })),
-      };
-      index += BATCH_QUERY_LIMIT;
+    grpcMock.unary.mockImplementation((desc, opts) => {
+      let res: any;
+      if (desc.methodName === 'BatchSnapshots') {
+        res = {
+          batchesList: [...Array(20)].map((_, i) => ({
+            ...poolBatchSnapshot,
+            batchId: `${index + i}-${poolBatchSnapshot.batchId}`,
+            prevBatchId: `${index + i}-${poolBatchSnapshot.prevBatchId}`,
+          })),
+        };
+        index += BATCH_QUERY_LIMIT;
+      } else if (desc.methodName === 'LeaseDurations') {
+        res = poolLeaseDurations;
+      }
       opts.onEnd({
         status: grpc.Code.OK,
         message: { toObject: () => res },
@@ -149,6 +158,27 @@ describe('BatchStore', () => {
     );
   });
 
+  it('should fetch lease durations', async () => {
+    expect(store.leaseDurations.size).toBe(0);
+    await store.fetchLeaseDurations();
+    expect(store.leaseDurations.size).toBe(
+      poolLeaseDurations.leaseDurationBucketsMap.length,
+    );
+    expect(store.selectedLeaseDuration).toBe(
+      poolLeaseDurations.leaseDurationBucketsMap[0][0],
+    );
+  });
+
+  it('should handle errors when fetching lease durations', async () => {
+    grpcMock.unary.mockImplementationOnce(() => {
+      throw new Error('test-err');
+    });
+    expect(rootStore.appView.alerts.size).toBe(0);
+    await store.fetchLeaseDurations();
+    expect(rootStore.appView.alerts.size).toBe(1);
+    expect(values(rootStore.appView.alerts)[0].message).toBe('test-err');
+  });
+
   it('should fetch node tier', async () => {
     // return sample data from gRPC requests instead of the batches defined in beforeEach()
     grpcMock.unary.mockImplementation((desc, opts) => {

app/src/api/pool.ts

@@ -261,6 +261,15 @@ class PoolApi extends BaseApi<PoolEvents> {
     return res.toObject();
   }
 
+  /**
+   * call the pool `LeaseDurations` RPC and return the response
+   */
+  async leaseDurations(): Promise<POOL.LeaseDurationResponse.AsObject> {
+    const req = new POOL.LeaseDurationRequest();
+    const res = await this._grpc.request(Trader.LeaseDurations, req, this._meta);
+    return res.toObject();
+  }
+
   //
   // Utility functions to convert user-facing units to API units
   //

app/src/store/stores/batchStore.ts

@@ -23,6 +23,12 @@ export default class BatchStore {
   private _pollingInterval?: NodeJS.Timeout;
   private _nextBatchTimer?: NodeJS.Timeout;
 
+  /** the selected lease duration */
+  selectedLeaseDuration = 0;
+
+  /** the collection of lease durations as a mapping from duration (blocks) to DurationBucketState */
+  leaseDurations: ObservableMap<number, number> = observable.map();
+
   /** the collection of batches */
   batches: ObservableMap<string, Batch> = observable.map();
 
@@ -185,6 +191,30 @@ export default class BatchStore {
     }
   }
 
+  /**
+   * fetches the list of lease durations from the API
+   */
+  async fetchLeaseDurations() {
+    this._store.log.info('fetching lease durations');
+    try {
+      const res = await this._store.api.pool.leaseDurations();
+      runInAction(() => {
+        res.leaseDurationBucketsMap.forEach(([duration, state]) => {
+          this.leaseDurations.set(duration, state);
+
+          // set the active lease duration if it is not set
+          if (!this.selectedLeaseDuration) this.selectedLeaseDuration = duration;
+        });
+        this._store.log.info(
+          'updated batchStore.leaseDurations',
+          toJS(this.leaseDurations),
+        );
+      });
+    } catch (error) {
+      this._store.appView.handleError(error, 'Unable to fetch lease durations');
+    }
+  }
+
   /**
    * 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

app/src/util/tests/sampleData.ts

@@ -643,6 +643,16 @@ export const poolBatchSnapshots: AUCT.BatchSnapshotsResponse.AsObject = {
   })),
 };
 
+export const poolLeaseDurations: POOL.LeaseDurationResponse.AsObject = {
+  leaseDurationsMap: [], // deprecated
+  leaseDurationBucketsMap: [
+    [2016, AUCT.DurationBucketState.MARKET_OPEN],
+    [4032, AUCT.DurationBucketState.MARKET_CLOSED],
+    [6048, AUCT.DurationBucketState.ACCEPTING_ORDERS],
+    [8064, AUCT.DurationBucketState.NO_MARKET],
+  ],
+};
+
 export const poolNextBatchInfo: POOL.NextBatchInfoResponse.AsObject = {
   clearTimestamp: 1605936138,
   confTarget: 6,
@@ -772,6 +782,7 @@ export const sampleApiResponses: Record<string, any> = {
   'poolrpc.Trader.CancelOrder': poolCancelOrder,
   'poolrpc.Trader.BatchSnapshot': poolBatchSnapshot,
   'poolrpc.Trader.BatchSnapshots': poolBatchSnapshots,
+  'poolrpc.Trader.LeaseDurations': poolLeaseDurations,
   'poolrpc.Trader.NextBatchInfo': poolNextBatchInfo,
   'poolrpc.Trader.NodeRatings': poolNodeRatings,
   'poolrpc.Trader.Leases': poolLeases,