Merge pull request #380 from LIT-Protocol/feature/lit-2547-js-sdk-sen…

…d-epoch-number-on-each-request

feat: send epoch number on each request

.gitignore

@@ -67,4 +67,4 @@ storage.test.db
 
 .nx
 
-.yalc
+.yalc

e2e-nodejs/0_manual-tests/test-epoch-cache.mjs

@@ -0,0 +1,32 @@
+import { LitNodeClient } from '@lit-protocol/lit-node-client';
+import crypto from '../polyfills.mjs';
+
+if (typeof globalThis.crypto === 'undefined') {
+  globalThis.crypto = crypto;
+}
+
+globalThis.litConfig = {
+  debug: true,
+};
+
+const DATA_TO_SIGN = new Uint8Array(
+  await crypto.subtle.digest('SHA-256', new TextEncoder().encode('Hello world'))
+);
+
+export async function main() {
+  // ==================== Test Logic ====================
+  const litNodeClient = new LitNodeClient({
+    litNetwork: 'cayenne',
+    debug: true,
+  });
+
+  await litNodeClient.connect();
+
+  // for every second, get new epoch number
+  setInterval(async () => {
+    const epochNumber = await litNodeClient.getCurrentEpochNumber();
+    console.log('epochNumber:', epochNumber);
+  }, 1000);
+}
+
+main();

package.json

@@ -151,8 +151,6 @@
     "@nx/jest": "17.3.0",
     "@nx/js": "17.3.0",
     "@nx/linter": "17.3.0",
-    "@nx/next": "17.3.0",
-    "@nx/node": "17.3.0",
     "@nx/plugin": "17.3.0",
     "@nx/react": "17.3.0",
     "@nx/web": "17.3.0",
@@ -200,7 +198,9 @@
     "ts-jest": "29.1.2",
     "ts-node": "10.9.1",
     "typedoc": "^0.23.10",
-    "typescript": "~4.7.2"
+    "typescript": "~4.7.2",
+    "@nx/next": "17.3.0",
+    "@nx/node": "17.3.0"
   },
   "workspaces": [
     "packages/*"

packages/access-control-conditions/package.json

@@ -24,4 +24,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/auth-browser/package.json

@@ -33,4 +33,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/auth-helpers/package.json

@@ -31,4 +31,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/bls-sdk/package.json

@@ -30,4 +30,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/constants/package.json

@@ -23,4 +23,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/constants/src/lib/constants/autogen_internal.ts

@@ -1,13 +1,13 @@
-// Last Modified: 2024-03-12 02:06:57 
-  // This file is auto-generated by tools/scripts/gen-internal-dev.mjs
+// Last Modified: 2024-02-24 04:15:54
+// This file is auto-generated by tools/scripts/gen-internal-dev.mjs
 export const INTERNAL_DEV = [
-  "https://167.114.17.205:443",
-  "https://64.131.85.108:443",
-  "https://167.114.17.202:443",
-  "https://167.114.17.203:443",
-  "https://167.114.17.204:443",
-  "https://64.131.85.106:443",
-  "https://167.114.17.201:443"
+  'https://167.114.17.205:443',
+  'https://64.131.85.108:443',
+  'https://167.114.17.202:443',
+  'https://167.114.17.203:443',
+  'https://167.114.17.204:443',
+  'https://64.131.85.106:443',
+  'https://167.114.17.201:443',
 ];
 
 export const INTERNAL_MIN_NODE_COUNT = 2;
@@ -17,14 +17,14 @@ export const INTERNAL_DEFAULT_CONFIG = {
   minNodeCount: 2,
   debug: true,
   bootstrapUrls: [
-  "https://167.114.17.205:443",
-  "https://64.131.85.108:443",
-  "https://167.114.17.202:443",
-  "https://167.114.17.203:443",
-  "https://167.114.17.204:443",
-  "https://64.131.85.106:443",
-  "https://167.114.17.201:443"
-],
+    'https://167.114.17.205:443',
+    'https://64.131.85.108:443',
+    'https://167.114.17.202:443',
+    'https://167.114.17.203:443',
+    'https://167.114.17.204:443',
+    'https://64.131.85.106:443',
+    'https://167.114.17.201:443',
+  ],
   litNetwork: 'internalDev',
   connectTimeout: 20000,
 };

packages/contracts-sdk/package.json

@@ -35,4 +35,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/core/package.json

@@ -27,4 +27,4 @@
   ],
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/core/src/lib/lit-core.ts

@@ -73,6 +73,8 @@ import {
 import { ethers } from 'ethers';
 import { LitContracts } from '@lit-protocol/contracts-sdk';
 
+export const DELAY_BEFORE_NEXT_EPOCH = 30000;
+// export const MAX_CACHE_AGE = 30000;
 export class LitCore {
   config: LitNodeClientConfig;
   connectedNodes: SetConstructor | Set<any> | any;
@@ -86,6 +88,16 @@ export class LitCore {
   lastBlockHashRetrieved: number | null;
   networkSyncInterval: any | null;
 
+  private epochChangeListenerSet = false;
+
+  epochCache: {
+    number: number | null;
+    lastUpdateTime: number | null;
+  } = {
+      number: null,
+      lastUpdateTime: null,
+    };
+
   // ========== Constructor ==========
   constructor(args: any[LitNodeClientConfig | CustomNetwork | any]) {
     const customConfig = args;
@@ -294,6 +306,12 @@ export class LitCore {
    * @returns {Promise<void>} A promise that resolves when the listener is successfully set up.
    */
   listenForNewEpoch = async (): Promise<void> => {
+    // Check if we've already set up the listener to avoid duplicates
+    if (this.epochChangeListenerSet) {
+      log('Epoch change listener already set.');
+      return;
+    }
+
     if (
       this.config.litNetwork === LitNetwork.Manzano ||
       this.config.litNetwork === LitNetwork.Habanero ||
@@ -305,10 +323,17 @@ export class LitCore {
       );
       log(
         'listening for state change on staking contract: ',
-        stakingContract.address
+        stakingContract['address']
       );
 
       stakingContract.on('StateChanged', async (state: StakingStates) => {
+        // (epoch) step 2: listen for epoch changes and update the cache accordingly, with a 30-second delay for using the new epoch number
+        setTimeout(async () => {
+          const newEpochNumber = await this.getCurrentEpochNumber();
+          this.updateEpochCache(newEpochNumber);
+
+        }, DELAY_BEFORE_NEXT_EPOCH);
+
         log(`New state detected: "${state}"`);
         if (state === StakingStates.NextValidatorSetLocked) {
           log(
@@ -348,7 +373,13 @@ export class LitCore {
               );
           }
         }
+
+        const newEpochNumber = await this.getCurrentEpochNumber();
+        this.updateEpochCache(newEpochNumber);
       });
+
+      // Mark that we've set up the listener
+      this.epochChangeListenerSet = true;
     }
   };
 
@@ -390,7 +421,12 @@ export class LitCore {
   connect = async (): Promise<any> => {
     // -- handshake with each node
     await this.setNewConfig();
+
+    // (epoch) step 1: Initialize epoch number cache
+    this.epochCache.number = await this.getCurrentEpochNumber();
+    this.epochCache.lastUpdateTime = Date.now();
     await this.listenForNewEpoch();
+
     await this._runHandshakeWithBootstrapUrls();
   };
 
@@ -604,13 +640,10 @@ export class LitCore {
           const now = Date.now();
           if (now - startTime > this.config.connectTimeout) {
             clearInterval(interval);
-            const msg = `Error: Could not connect to enough nodes after timeout of ${
-              this.config.connectTimeout
-            }ms.  Could only connect to ${
-              Object.keys(this.serverKeys).length
-            } of ${
-              this.config.bootstrapUrls.length
-            } required nodes.  Please check your network connection and try again.  Note that you can control this timeout with the connectTimeout config option which takes milliseconds.`;
+            const msg = `Error: Could not connect to enough nodes after timeout of ${this.config.connectTimeout
+              }ms.  Could only connect to ${Object.keys(this.serverKeys).length
+              } of ${this.config.minNodeCount
+              } required nodes.  Please check your network connection and try again.  Note that you can control this timeout with the connectTimeout config option which takes milliseconds.`;
             logErrorWithRequestId(requestId, msg);
             reject(msg);
           }
@@ -696,6 +729,49 @@ export class LitCore {
     return res as NodeCommandServerKeysResponse;
   };
 
+  updateEpochCache = async (epochNumber: number): Promise<void> => {
+    this.epochCache.number = epochNumber;
+    this.epochCache.lastUpdateTime = Date.now();
+  };
+
+  getCurrentEpochNumber = async (): Promise<number> => {
+    try {
+      // (epoch) step 3: first check the cache and use the cached value if it's not more than 30 seconds old. If it's a cache miss or the cached value is too old, fall back to fetching the current epoch number
+      // const now = Date.now();
+      // const cacheAge = now - this.epochCache.lastUpdateTime!;
+
+      // if (
+      this.epochCache.number !== null
+      // && cacheAge <= MAX_CACHE_AGE
+      // ) {
+      //   log('Using cached epoch number', this.epochCache.number);
+      //   return this.epochCache.number;
+      // }
+
+      // Cache miss or cached value too old, fetch new epoch number
+      const stakingContract = await LitContracts.getStakingContract(
+        this.config.litNetwork as any,
+        this.config.contractContext
+      );
+
+      log('Fetching current epoch number');
+      const epoch = await stakingContract['epoch']();
+      const epochNumber = epoch.number.toNumber();
+
+      // Update the cache
+      // this.epochCache.number = epochNumber;
+      // this.epochCache.lastUpdateTime = Date.now();
+
+      return epochNumber;
+    } catch (error) {
+      return throwError({
+        message: `Error getting current epoch number: ${error}`,
+        errorKind: LIT_ERROR.UNKNOWN_ERROR.kind,
+        errorCode: LIT_ERROR.UNKNOWN_ERROR.name,
+      });
+    }
+  };
+
   // ==================== SENDING COMMAND ====================
   /**
    *
@@ -711,6 +787,10 @@ export class LitCore {
     data,
     requestId,
   }: SendNodeCommand): Promise<any> => {
+    const epochNumber = await this.getCurrentEpochNumber();
+
+    data = { ...data, epochNumber };
+
     logWithRequestId(
       requestId,
       `sendCommandToNode with url ${url} and data`,

packages/crypto/package.json

@@ -24,4 +24,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/ecdsa-sdk/package.json

@@ -27,4 +27,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/encryption/package.json

@@ -28,4 +28,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/lit-auth-client/package.json

@@ -32,4 +32,4 @@
   },
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/lit-node-client-nodejs/package.json

@@ -27,4 +27,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/lit-node-client/package.json

@@ -28,4 +28,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/logger/package.json

@@ -11,4 +11,4 @@
   },
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/misc-browser/package.json

@@ -24,4 +24,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/misc/package.json

@@ -27,4 +27,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/nacl/package.json

@@ -24,4 +24,4 @@
   "version": "3.2.5",
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}

packages/pkp-base/package.json

@@ -27,4 +27,4 @@
   ],
   "main": "./dist/src/index.js",
   "typings": "./dist/src/index.d.ts"
-}
+}