fix: circular reference with PRODUCT_IDS

Author: FedericoAmura

local-tests/setup/tinny-environment.ts

@@ -4,13 +4,13 @@ import {
   CENTRALISATION_BY_NETWORK,
   LIT_NETWORK,
   LIT_NETWORK_VALUES,
+  PRODUCT_IDS,
   RPC_URL_BY_NETWORK,
 } from '@lit-protocol/constants';
 import { LitContracts } from '@lit-protocol/contracts-sdk';
 import { LitNodeClient } from '@lit-protocol/lit-node-client';
 import {
   AuthSig,
-  PRODUCT_IDS,
   LitContractContext,
   LitContractResolverContext,
 } from '@lit-protocol/types';

packages/constants/src/lib/constants/mappers.ts

@@ -23,3 +23,18 @@ export const GLOBAL_OVERWRITE_IPFS_CODE_BY_NETWORK: {
   'naga-dev': false,
   custom: false,
 } as const;
+
+/**
+ * Product IDs used for price feed and node selection
+ *
+ * - DECRYPTION (0): Used for decryption operations
+ * - SIGN (1): Used for signing operations
+ * - LA (2): Used for Lit Actions execution
+ */
+export const PRODUCT_IDS = {
+  DECRYPTION: 0, // For decryption operations
+  SIGN: 1, // For signing operations
+  LIT_ACTION: 2, // For Lit Actions execution
+} as const;
+export type PRODUCT_IDS_TYPE = keyof typeof PRODUCT_IDS;
+export type PRODUCT_IDS_VALUES = (typeof PRODUCT_IDS)[keyof typeof PRODUCT_IDS];

packages/contracts-sdk/src/lib/price-feed-info-manager.ts

@@ -1,11 +1,10 @@
 // import * as util from 'node:util'; // For inspecting bigInt payloads for pricing data
 
-import { HTTP, HTTPS } from '@lit-protocol/constants';
+import { HTTP, HTTPS, PRODUCT_IDS } from '@lit-protocol/constants';
 import {
   LIT_NETWORKS_KEYS,
   LitContractContext,
   LitContractResolverContext,
-  PRODUCT_IDS,
 } from '@lit-protocol/types';
 
 import { LitContracts } from './contracts-sdk';

packages/lit-node-client-nodejs/src/lib/helpers/get-max-prices-for-node-product.ts

@@ -1,5 +1,4 @@
-import { MaxPriceTooLow } from '@lit-protocol/constants';
-import { PRODUCT_IDS } from '@lit-protocol/types';
+import { MaxPriceTooLow, PRODUCT_IDS } from '@lit-protocol/constants';
 
 interface MaxPricesForNodes {
   nodePrices: { url: string; prices: bigint[] }[];

packages/lit-node-client-nodejs/src/lib/helpers/get-max-prices-for-nodes.test.ts

@@ -1,4 +1,4 @@
-import { PRODUCT_IDS } from '@lit-protocol/types';
+import { PRODUCT_IDS } from '@lit-protocol/constants';
 
 import { getMaxPricesForNodeProduct } from './get-max-prices-for-node-product';
 

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

@@ -33,6 +33,8 @@ import {
   LOCAL_STORAGE_KEYS,
   ParamNullError,
   ParamsMissingError,
+  PRODUCT_IDS,
+  PRODUCT_IDS_TYPE,
   SIWE_URI_PREFIX,
   UnknownError,
   UnsupportedMethodError,
@@ -71,7 +73,6 @@ import { nacl } from '@lit-protocol/nacl';
 import {
   AuthMethod,
   ExecuteJsValueResponse,
-  PRODUCT_IDS,
   LitNodeSignature,
 } from '@lit-protocol/types';
 import {
@@ -144,7 +145,7 @@ export class LitNodeClientNodeJs extends LitCore implements ILitNodeClient {
    *
    * If the user never sets a max price, it means 'unlimited'
    */
-  defaultMaxPriceByProduct: Record<keyof typeof PRODUCT_IDS, bigint> = {
+  defaultMaxPriceByProduct: Record<PRODUCT_IDS_TYPE, bigint> = {
     DECRYPTION: BigInt(-1),
     SIGN: BigInt(-1),
     LIT_ACTION: BigInt(-1),
@@ -1536,7 +1537,7 @@ export class LitNodeClientNodeJs extends LitCore implements ILitNodeClient {
     product,
   }: {
     userMaxPrice?: bigint;
-    product: keyof typeof PRODUCT_IDS;
+    product: PRODUCT_IDS_TYPE;
   }) => {
     log('getMaxPricesForNodeProduct()', { product });
     const getUserMaxPrice = () => {

packages/types/src/lib/ILitNodeClient.ts

@@ -16,18 +16,9 @@ import {
 } from './interfaces';
 import { ClaimProcessor, ClaimRequest } from './types';
 
-/**
- * Product IDs used for price feed and node selection
- *
- * - DECRYPTION (0): Used for decryption operations
- * - SIGN (1): Used for signing operations
- * - LA (2): Used for Lit Actions execution
- */
-export const PRODUCT_IDS = {
-  DECRYPTION: 0, // For decryption operations
-  SIGN: 1, // For signing operations
-  LIT_ACTION: 2, // For Lit Actions execution
-} as const;
+// keyof typeof @lit-protocol/constants -> PRODUCT_IDS. Importing creates a circular reference
+export type PRODUCT_IDS_TYPE = 'DECRYPTION' | 'SIGN' | 'LIT_ACTION';
+export type PRODUCT_IDS_VALUES = 0 | 1 | 2;
 
 export interface ILitNodeClient {
   config: LitNodeClientConfig;
@@ -53,7 +44,7 @@ export interface ILitNodeClient {
    * @param product - The product type to set the max price for
    * @param price - The max price to set
    */
-  setDefaultMaxPrice(product: keyof typeof PRODUCT_IDS, price: bigint): void;
+  setDefaultMaxPrice(product: PRODUCT_IDS_TYPE, price: bigint): void;
 
   /**
    * Get PKP authentication context
@@ -68,7 +59,7 @@ export interface ILitNodeClient {
    */
   getMaxPricesForNodeProduct(params: {
     userMaxPrice?: bigint;
-    product: keyof typeof PRODUCT_IDS;
+    product: PRODUCT_IDS_TYPE;
   }): Promise<{ url: string; price: bigint }[]>;
 
   /**
@@ -96,7 +87,7 @@ export interface ILitNodeClient {
 
   /**
    * Execute JS on the nodes and combine and return any resulting signatures
-   * @param { ExecuteJsRequest } params
+   * @param { JsonExecutionSdkParams } params
    * @returns { ExecuteJsResponse }
    */
   executeJs(