Feature/lit 3139 identify private methods in litnodeclient

cypress/e2e/spec.cy.ts

@@ -549,7 +549,7 @@ describe('Lit Action', () => {
       url: 'https://cayenne.litgateway.com:7371/web/execute',
       data,
     };
-    const res = await savedParams.litNodeClient.sendCommandToNode(reqBody);
+    const res = await savedParams.litNodeClient._sendCommandToNode(reqBody);
     expect(res).to.have.property('success', true);
   });
 

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

@@ -35,7 +35,6 @@ import {
 import {
   bootstrapLogManager,
   executeWithRetry,
-  getIpAddress,
   isBrowser,
   isNode,
   log,
@@ -173,7 +172,7 @@ export class LitCore {
     }
 
     // -- set bootstrapUrls to match the network litNetwork unless it's set to custom
-    this.setCustomBootstrapUrls();
+    this.#setCustomBootstrapUrls();
 
     // -- set global variables
     globalThis.litConfig = this.config;
@@ -437,9 +436,9 @@ export class LitCore {
    * that the client's configuration is always in sync with the current state of the
    * staking contract.
    *
-   * @returns {Promise<void>} A promise that resolves when the listener is successfully set up.
+   * @returns { void }
    */
-  private _listenForNewEpoch() {
+  #listenForNewEpoch(): void {
     // Check if we've already set up the listener to avoid duplicates
     if (this._stakingContractListener) {
       // Already listening, do nothing
@@ -473,13 +472,14 @@ export class LitCore {
     if (globalThis.litConfig) delete globalThis.litConfig;
   }
 
-  _stopNetworkPolling() {
+  protected _stopNetworkPolling() {
     if (this._networkSyncInterval) {
       clearInterval(this._networkSyncInterval);
       this._networkSyncInterval = null;
     }
   }
-  _stopListeningForNewEpoch() {
+
+  protected _stopListeningForNewEpoch() {
     if (this._stakingContract && this._stakingContractListener) {
       this._stakingContract.off('StateChanged', this._stakingContractListener);
       this._stakingContractListener = null;
@@ -493,7 +493,7 @@ export class LitCore {
    * @returns { void }
    *
    */
-  setCustomBootstrapUrls = (): void => {
+  #setCustomBootstrapUrls = (): void => {
     // -- validate
     if (this.config.litNetwork === 'custom') return;
 
@@ -575,8 +575,8 @@ export class LitCore {
       await this._runHandshakeWithBootstrapUrls();
     Object.assign(this, { ...coreNodeConfig, connectedNodes, serverKeys });
 
-    this._scheduleNetworkSync();
-    this._listenForNewEpoch();
+    this.#scheduleNetworkSync();
+    this.#listenForNewEpoch();
 
     // FIXME: don't create global singleton; multiple instances of `core` should not all write to global
     // @ts-expect-error typeof globalThis is not defined. We're going to get rid of the global soon.
@@ -607,7 +607,7 @@ export class LitCore {
   }): Promise<JsonHandshakeResponse> {
     const challenge = this.getRandomHexString(64);
 
-    const handshakeResult = await this.handshakeWithNode(
+    const handshakeResult = await this.#handshakeWithNode(
       { url, challenge },
       requestId
     );
@@ -697,7 +697,7 @@ export class LitCore {
     coreNodeConfig: CoreNodeConfig;
   }> {
     // -- handshake with each node
-    const requestId: string = this.getRequestId();
+    const requestId: string = this.#getRequestId();
 
     // track connectedNodes for the new handshake operation
     const connectedNodes = new Set<string>();
@@ -819,7 +819,7 @@ export class LitCore {
    * We can remove this network sync code entirely if we refactor our code to fetch latest blockhash on-demand.
    * @private
    */
-  private _scheduleNetworkSync() {
+  #scheduleNetworkSync() {
     if (this._networkSyncInterval) {
       clearInterval(this._networkSyncInterval);
     }
@@ -862,7 +862,7 @@ export class LitCore {
    * @returns { string }
    *
    */
-  getRequestId() {
+  #getRequestId(): string {
     return Math.random().toString(16).slice(2);
   }
 
@@ -873,7 +873,7 @@ export class LitCore {
    * @returns { string }
    */
 
-  getRandomHexString(size: number) {
+  getRandomHexString(size: number): string {
     return [...Array(size)]
       .map(() => Math.floor(Math.random() * 16).toString(16))
       .join('');
@@ -887,7 +887,7 @@ export class LitCore {
    * @returns { Promise<NodeCommandServerKeysResponse> }
    *
    */
-  handshakeWithNode = async (
+  #handshakeWithNode = async (
     params: HandshakeWithNode,
     requestId: string
   ): Promise<NodeCommandServerKeysResponse> => {
@@ -909,7 +909,7 @@ export class LitCore {
           challenge: params.challenge,
         };
 
-        return await this.sendCommandToNode({
+        return await this._sendCommandToNode({
           url: urlWithPath,
           data,
           requestId,
@@ -967,7 +967,7 @@ export class LitCore {
    * @returns { Promise<any> }
    *
    */
-  sendCommandToNode = async ({
+  protected _sendCommandToNode = async ({
     url,
     data,
     requestId,
@@ -1005,7 +1005,7 @@ export class LitCore {
    * @returns { Array<Promise<any>> }
    *
    */
-  getNodePromises = (
+  protected _getNodePromises = (
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     callback: (url: string) => Promise<any>
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1030,7 +1030,7 @@ export class LitCore {
    * @returns The session signature for the given URL.
    * @throws An error if sessionSigs is not provided or if the session signature for the URL is not found.
    */
-  getSessionSigByUrl = ({
+  protected _getSessionSigByUrl = ({
     sessionSigs,
     url,
   }: {
@@ -1136,7 +1136,7 @@ export class LitCore {
    * @param { number } minNodeCount number of nodes we need valid results from in order to resolve
    * @returns { Promise<SuccessNodePromises<T> | RejectedNodePromises> }
    */
-  handleNodePromises = async <T>(
+  protected _handleNodePromises = async <T>(
     nodePromises: Promise<T>[],
     requestId: string,
     minNodeCount: number
@@ -1219,7 +1219,10 @@ export class LitCore {
    * @returns { void }
    *
    */
-  _throwNodeError = (res: RejectedNodePromises, requestId: string): void => {
+  protected _throwNodeError = (
+    res: RejectedNodePromises,
+    requestId: string
+  ): void => {
     if (res.error) {
       if (
         ((res.error.errorCode &&

packages/lit-node-client-nodejs/src/lib/helpers/get-expiration.test.ts

@@ -0,0 +1,17 @@
+import { getExpiration } from './get-expiration';
+
+describe('getExpiration', () => {
+  it('should return the expiration date and time as an ISO string', () => {
+    // Arrange
+    const currentDate = new Date();
+    const expectedExpiration = new Date(
+      currentDate.getTime() + 1000 * 60 * 60 * 24
+    ).toISOString();
+
+    // Act
+    const result = getExpiration();
+
+    // Assert
+    expect(result).toBe(expectedExpiration);
+  });
+});

packages/lit-node-client-nodejs/src/lib/helpers/get-expiration.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns the expiration date and time as an ISO string.
+ * The expiration is set to 24 hours from the current date and time.
+ *
+ * @returns {string} The expiration date and time as an ISO string.
+ */
+export const getExpiration = () => {
+  return new Date(Date.now() + 1000 * 60 * 60 * 24).toISOString();
+};