feat: properly typified getNodePromises

Author: FedericoAmura

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

@@ -64,6 +64,7 @@ import {
   MultipleAccessControlConditions,
   NodeClientErrorV0,
   NodeClientErrorV1,
+  NodeCommandResponse,
   NodeCommandServerKeysResponse,
   RejectedNodePromises,
   SendNodeCommand,
@@ -1055,21 +1056,16 @@ export class LitCore {
   };
 
   /**
-   *
    * Get and gather node promises
    *
-   * @param { any } callback
+   * @param { function } callback
    *
-   * @returns { Array<Promise<any>> }
+   * @returns { Array<Promise<NodeCommandResponse>> }
    *
    */
   getNodePromises = (
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    callback: (url: string) => Promise<any>
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  ): Promise<any>[] => {
-    // FIXME: Replace <any> usage with explicit, strongly typed handlers
-
+    callback: (url: string) => Promise<NodeCommandResponse>
+  ): Promise<NodeCommandResponse>[] => {
     const nodePromises = [];
 
     for (const url of this.connectedNodes) {
@@ -1080,10 +1076,8 @@ export class LitCore {
   };
 
   getRandomNodePromise(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    callback: (url: string) => Promise<any>
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  ): Promise<any>[] {
+    callback: (url: string) => Promise<NodeCommandResponse>
+  ): Promise<NodeCommandResponse>[] {
     const randomNodeIndex = Math.floor(
       Math.random() * this.connectedNodes.size
     );

packages/schemas/src/lib/ILitNodeClient.ts

@@ -18,6 +18,7 @@ import {
   JsonHandshakeResponseSchema,
   MultipleAccessControlConditionsSchema,
   NodeBlsSigningShareSchema,
+  NodeCommandResponseSchema,
   NodeCommandServerKeysResponseSchema,
   RejectedNodePromisesSchema,
   SendNodeCommandSchema,
@@ -100,18 +101,39 @@ export const ILitNodeClientSchema = z.object({
   // ========== Promise Handlers ==========
 
   /**
-   *
    * Get and gather node promises
    *
-   * @param { any } callback
+   * @param { function } callback
    *
-   * @returns { Array<Promise<any>> }
+   * @returns { Array<Promise<NodeCommandResponse>> }
    *
    */
   getNodePromises: z
     .function()
-    .args(z.function().args(z.string()).returns(z.promise(z.any()))) // TODO improve
-    .returns(z.array(z.promise(z.any()))), // TODO
+    .args(
+      z
+        .function()
+        .args(z.string().url())
+        .returns(z.promise(NodeCommandResponseSchema))
+    )
+    .returns(z.array(z.promise(NodeCommandResponseSchema))),
+  /**
+   * Get one node promise
+   *
+   * @param { function } callback
+   *
+   * @returns { Array<Promise<NodeCommandResponse>> }
+   *
+   */
+  getRandomNodePromise: z
+    .function()
+    .args(
+      z
+        .function()
+        .args(z.string().url())
+        .returns(z.promise(NodeCommandResponseSchema))
+    )
+    .returns(z.array(z.promise(NodeCommandResponseSchema)).length(1)),
   /**
    * Handle node promises
    *

packages/schemas/src/lib/schemas.ts

@@ -62,6 +62,12 @@ export const LitAbilitySchema = z.enum([
   'lit-action-execution',
 ] as const);
 
+export const CapacityDelegationRequestSchema = z.object({
+  nft_id: z.array(z.string()).optional(), // Optional array of strings
+  delegate_to: z.array(z.string()).optional(), // Optional array of modified address strings
+  uses: z.string().optional(),
+});
+
 /**
  * Type for a contract resolver instance which will be used
  * In place of LitContractContext for loading addresses of lit contracts
@@ -695,3 +701,57 @@ export const SuccessNodePromisesSchema = z.object({
   success: z.literal(true),
   values: z.array(z.any()), // TODO add back generics
 });
+
+/**
+ * Struct in rust
+ * -----
+ pub struct JsonExecutionRequest {
+ pub auth_sig: AuthSigItem,
+ #[serde(default = "default_epoch")]
+ pub epoch: u64,
+
+ pub ipfs_id: Option<String>,
+ pub code: Option<String>,
+ pub js_params: Option<Value>,
+ pub auth_methods: Option<Vec<AuthMethod>>,
+ }
+ */
+export const JsonExecutionRequestSchema = LitActionSdkParamsSchema.pick({
+  jsParams: true,
+}).extend({
+  authSig: AuthSigSchema,
+  /**
+   * auto-filled before sending each command to the node, but
+   * in the rust struct, this type is required.
+   */
+  // epoch: z.string(),
+  ipfsId: z.string().optional(),
+  code: z.string().optional(),
+  authMethods: z.array(AuthMethodSchema).optional(),
+});
+
+export const CallRequestSchema = z.object({
+  // to - The address of the contract that will be queried
+  to: z.string(),
+  // The address calling the function.
+  from: z.string().optional(),
+  // Hex encoded data to send to the contract.
+  data: z.string(),
+});
+
+export const JsonSignChainDataRequestSchema = z.object({
+  callRequests: z.array(z.string()),
+  chain: ChainSchema,
+  iat: z.number(),
+  exp: z.number(),
+});
+
+export const JsonRequestSchema = z.union([
+  JsonExecutionRequestSchema,
+  JsonSignChainDataRequestSchema,
+]);
+
+export const NodeCommandResponseSchema = z.object({
+  url: z.string(),
+  data: JsonRequestSchema,
+});

packages/types/src/lib/interfaces.ts

@@ -41,6 +41,10 @@ import {
   RejectedNodePromisesSchema,
   NodeAttestationSchema,
   ExecuteJsAdvancedOptionsSchema,
+  CapacityDelegationRequestSchema,
+  JsonExecutionRequestSchema,
+  NodeCommandResponseSchema,
+  CallRequestSchema,
 } from '@lit-protocol/schemas';
 
 import { ILitNodeClient } from './ILitNodeClient';
@@ -181,21 +185,6 @@ export interface ClaimKeyResponse {
   mintTx: string;
 }
 
-/**
- * Struct in rust
- * -----
-pub struct JsonExecutionRequest {
-  pub auth_sig: AuthSigItem,
-  #[serde(default = "default_epoch")]
-  pub epoch: u64,
-
-  pub ipfs_id: Option<String>,
-  pub code: Option<String>,
-    pub js_params: Option<Value>,
-    pub auth_methods: Option<Vec<AuthMethod>>,
-}
- */
-
 export interface BaseJsonPkpSignRequest {
   authMethods?: AuthMethod[];
   toSign: ArrayLike<number>;
@@ -365,19 +354,7 @@ export interface JsonExecutionRequestTargetNode extends JsonExecutionRequest {
   targetNodeRange: number;
 }
 
-export interface JsonExecutionRequest
-  extends Pick<LitActionSdkParams, 'jsParams'> {
-  authSig: AuthSig;
-
-  /**
-   * auto-filled before sending each command to the node, but
-   * in the rust struct, this type is required.
-   */
-  // epoch: number;
-  ipfsId?: string;
-  code?: string;
-  authMethods?: AuthMethod[];
-}
+export type JsonExecutionRequest = z.infer<typeof JsonExecutionRequestSchema>;
 
 export type SessionSigsOrAuthSig = z.infer<typeof SessionSigsOrAuthSigSchema>;
 
@@ -563,16 +540,7 @@ export interface NodeLog {
   logs: any;
 }
 
-export interface CallRequest {
-  // to - The address of the contract that will be queried
-  to: string;
-
-  // The address calling the function.
-  from?: string;
-
-  // Hex encoded data to send to the contract.
-  data: string;
-}
+export type CallRequest = z.infer<typeof CallRequestSchema>;
 
 export interface SignedChainDataToken {
   // The call requests to make.  The responses will be signed and returned.
@@ -582,10 +550,7 @@ export interface SignedChainDataToken {
   chain: Chain;
 }
 
-export interface NodeCommandResponse {
-  url: string;
-  data: JsonRequest;
-}
+export type NodeCommandResponse = z.infer<typeof NodeCommandResponseSchema>;
 
 export type NodeCommandServerKeysResponse = z.infer<
   typeof NodeCommandServerKeysResponseSchema
@@ -1425,11 +1390,9 @@ export interface CapacityDelegationFields extends BaseSiweMessage {
   uses?: string;
 }
 
-export interface CapacityDelegationRequest {
-  nft_id?: string[]; // Optional array of strings
-  delegate_to?: string[]; // Optional array of modified address strings
-  uses?: string;
-}
+export type CapacityDelegationRequest = z.infer<
+  typeof CapacityDelegationRequestSchema
+>;
 
 export interface CapacityCreditsReq {
   dAppOwnerWallet: SignerLike;