feat: add params validations on lit node client and lit core and slightly improve its testing

Author: FedericoAmura

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

@@ -21,7 +21,6 @@ import {
   LIT_CURVE,
   LIT_CURVE_VALUES,
   LIT_ENDPOINT,
-  LIT_ERROR,
   LIT_ERROR_CODE,
   LIT_NETWORK,
   LIT_NETWORKS,
@@ -30,7 +29,6 @@ import {
   STAKING_STATES_VALUES,
   version,
   InitError,
-  InvalidParamType,
   NodeError,
   UnknownError,
   InvalidArgumentException,
@@ -57,7 +55,6 @@ import {
 import {
   AuthSig,
   BlockHashErrorResponse,
-  CustomNetwork,
   EpochInfo,
   EthBlockhashInfo,
   FormattedMultipleAccs,
@@ -74,6 +71,7 @@ import {
   SuccessNodePromises,
   SupportedJsonRequests,
 } from '@lit-protocol/types';
+import { LitNodeClientConfigSchema } from '@lit-protocol/schemas';
 
 import { composeLitUrl } from './endpoint-version';
 
@@ -166,33 +164,46 @@ export class LitCore {
     'https://block-indexer.litgateway.com/get_most_recent_valid_block';
 
   // ========== Constructor ==========
-  constructor(config: LitNodeClientConfig | CustomNetwork) {
-    if (!(config.litNetwork in LIT_NETWORKS)) {
-      const validNetworks = Object.keys(LIT_NETWORKS).join(', ');
-      throw new InvalidParamType(
-        {},
-        'Unsupported network has been provided please use a "litNetwork" option which is supported (%s)',
-        validNetworks
+  constructor(config: LitNodeClientConfig) {
+    let _args: LitNodeClientConfig;
+    try {
+      _args = LitNodeClientConfigSchema.parse(config);
+    } catch (e) {
+      throw new InvalidArgumentException(
+        {
+          cause: e,
+          info: {
+            config,
+          },
+        },
+        'must provide LitNodeClient parameters'
       );
     }
 
+    // Zod makes a deep copy hence it might drop the storageProvider class
+    if ('storageProvider' in config && config.storageProvider?.provider) {
+      _args.storageProvider = {
+        provider: config.storageProvider?.provider,
+      };
+    }
+
     // Initialize default config based on litNetwork
-    switch (config?.litNetwork) {
+    switch (_args?.litNetwork) {
       // Official networks; default value for `checkNodeAttestation` according to network provided.
       case LIT_NETWORK.DatilDev:
         this.config = {
           ...this.config,
           checkNodeAttestation: NETWORKS_REQUIRING_SEV.includes(
-            config?.litNetwork
+            _args?.litNetwork
           ),
-          ...config,
+          ..._args,
         };
         break;
       default:
         // `custom`; no opinion about checkNodeAttestation
         this.config = {
           ...this.config,
-          ...config,
+          ..._args,
         };
     }
 

packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.spec.ts

@@ -1,15 +1,8 @@
-// @ts-nocheck
-
-// This will prevent it logging the following
-// [Lit-JS-SDK v2.2.39] ✅ [BLS SDK] wasmExports loaded
-// [Lit-JS-SDK v2.2.39] ✅ [ECDSA SDK NodeJS] wasmECDSA loaded.
-global.jestTesting = true;
-
-import { LIT_NETWORK } from '@lit-protocol/constants';
+import { LIT_NETWORK, InvalidArgumentException } from '@lit-protocol/constants';
 
 import { LitNodeClientNodeJs } from './lit-node-client-nodejs';
 
-const isClass = (v) => {
+const isClass = (v: any) => {
   return typeof v === 'function' && /^\s*class\s+/.test(v.toString());
 };
 
@@ -49,9 +42,32 @@ describe('LitNodeClientNodeJs', () => {
     Object.defineProperty(globalThis, 'localStorage', { value: tmp });
   });
 
+  it('should throw when constructor is passed invalid params', () => {
+    // @ts-expect-error testing invalid params
+    expect(() => new LitNodeClientNodeJs({ litNetwork: 'invalid' })).toThrow(
+      InvalidArgumentException
+    );
+
+    expect(
+      () =>
+        new LitNodeClientNodeJs({
+          litNetwork: LIT_NETWORK.Datil,
+          // @ts-expect-error testing invalid params
+          checkNodeAttestation: 1,
+          // @ts-expect-error testing invalid params
+          minNodeCount: 'something',
+          rpcUrl: 'notAnURL',
+        })
+    ).toThrow(InvalidArgumentException);
+  });
+
   it('gets expiration', () => {
     const expiration = LitNodeClientNodeJs.getExpiration();
 
-    expect(expiration).toContain('T');
+    // Regex pattern for ISO 8601 date format
+    const dateRegex =
+      /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|([+-]\d{2}:\d{2}))?$/;
+
+    expect(expiration).toMatch(dateRegex);
   });
 });

packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts

@@ -63,6 +63,7 @@ import {
   setStorageItem,
 } from '@lit-protocol/misc-browser';
 import { nacl } from '@lit-protocol/nacl';
+import { LitNodeClientConfigSchema } from '@lit-protocol/schemas';
 import {
   uint8arrayFromString,
   uint8arrayToString,
@@ -89,7 +90,6 @@ import type {
   ClaimKeyResponse,
   ClaimProcessor,
   ClaimRequest,
-  CustomNetwork,
   DecryptRequest,
   DecryptResponse,
   EncryptRequest,
@@ -110,7 +110,6 @@ import type {
   SessionKeyPair,
   SessionSigningTemplate,
   SessionSigsMap,
-  SigShare,
   SignSessionKeyProp,
   SignSessionKeyResponse,
   Signature,
@@ -142,15 +141,27 @@ export class LitNodeClientNodeJs
   defaultAuthCallback?: (authSigParams: AuthCallbackParams) => Promise<AuthSig>;
 
   // ========== Constructor ==========
-  constructor(args: LitNodeClientConfig | CustomNetwork) {
-    if (!args) {
-      throw new ParamsMissingError({}, 'must provide LitNodeClient parameters');
+  constructor(args: LitNodeClientConfig) {
+    let _args: LitNodeClientConfig;
+    try {
+      _args = LitNodeClientConfigSchema.parse(args);
+    } catch (e) {
+      throw new InvalidArgumentException(
+        {
+          cause: e,
+          info: {
+            args,
+          },
+        },
+        'must provide LitNodeClient parameters'
+      );
     }
 
+    // Passing args instead of _args so parent can make its own assertions without the ones here interfering
     super(args);
 
-    if ('defaultAuthCallback' in args) {
-      this.defaultAuthCallback = args.defaultAuthCallback;
+    if ('defaultAuthCallback' in _args) {
+      this.defaultAuthCallback = _args.defaultAuthCallback;
     }
   }
 

packages/lit-node-client/src/lib/lit-node-client.ts

@@ -3,7 +3,7 @@ import { EITHER_TYPE } from '@lit-protocol/constants';
 import { LitNodeClientNodeJs } from '@lit-protocol/lit-node-client-nodejs';
 import { isNode, log } from '@lit-protocol/misc';
 import { getStorageItem } from '@lit-protocol/misc-browser';
-import { CustomNetwork, LitNodeClientConfig } from '@lit-protocol/types';
+import { LitNodeClientConfig } from '@lit-protocol/types';
 
 /**
  * You can find all these available networks in the `constants` package
@@ -19,7 +19,7 @@ import { CustomNetwork, LitNodeClientConfig } from '@lit-protocol/types';
  * ```
  */
 export class LitNodeClient extends LitNodeClientNodeJs {
-  constructor(args: LitNodeClientConfig | CustomNetwork) {
+  constructor(args: LitNodeClientConfig) {
     super({
       ...args,
       defaultAuthCallback: checkAndSignAuthMessage,

packages/schemas/src/lib/schemas.ts

@@ -383,15 +383,6 @@ export const LitNodeClientConfigSchema = z.object({
   rpcUrl: z.string().optional(),
 });
 
-export const CustomNetworkSchema = z.intersection(
-  LitNodeClientConfigSchema.pick({
-    litNetwork: true,
-    contractContext: true,
-    checkNodeAttestation: true,
-  }),
-  LitNodeClientConfigSchema.pick({ minNodeCount: true }).partial()
-);
-
 export const DerivedAddressesSchema = z.object({
   publicKey: z.string(),
   publicKeyBuffer: z.instanceof(Buffer),
@@ -886,7 +877,7 @@ export const ILitNodeClientSchema = z.object({
 
   // ========== Constructor ==========
   // ** IMPORTANT !! You have to create your constructor when implementing this class **
-  // constructor: z.function().args(z.union([LitNodeClientConfigSchema, CustomNetworkSchema])),
+  // constructor: z.function().args(LitNodeClientConfigSchema),
 
   // ========== Scoped Class Helpers ==========
 

packages/types/src/lib/interfaces.ts

@@ -10,7 +10,6 @@ import {
   AuthCallbackParamsSchema,
   StorageProviderSchema,
   LitNodeClientConfigSchema,
-  CustomNetworkSchema,
   EncryptResponseSchema,
   JsonHandshakeResponseSchema,
   BlsSignatureShareSchema,
@@ -169,8 +168,6 @@ export type StorageProvider = z.infer<typeof StorageProviderSchema>;
 /** ---------- Lit Node Client ---------- */
 export type LitNodeClientConfig = z.infer<typeof LitNodeClientConfigSchema>;
 
-export type CustomNetwork = z.infer<typeof CustomNetworkSchema>;
-
 export interface Signature {
   r: string;
   s: string;