Merge pull request #796 from LIT-Protocol/LIT-4207-refresh-node-prices

LIT-4207 - Implement node price re-fetching when running lit node commands

Author: Ansonhkg

packages/constants/src/index.ts

@@ -5,7 +5,6 @@ export * from './lib/version';
 export * from './lib/constants/constants';
 export * from './lib/constants/mappers';
 export * from './lib/constants/endpoints';
-export * from './lib/constants/mappers';
 export * from './lib/constants/curves';
 
 // ----------- Interfaces -----------

packages/contracts-sdk/src/index.ts

@@ -1,2 +1,6 @@
+import { getPriceFeedInfo, getNodePrices } from './lib/price-feed-info-manager';
+
 export * from './lib/contracts-sdk';
 export * from './lib/utils';
+
+export { getPriceFeedInfo, getNodePrices };

packages/contracts-sdk/src/lib/contracts-sdk.ts

@@ -1,5 +1,3 @@
-// import * as util from 'node:util'; // For inspecting bigInt payloads for pricing data
-
 import {
   Abi,
   AbiFunction,
@@ -14,21 +12,20 @@ import {
   AUTH_METHOD_SCOPE_VALUES,
   AUTH_METHOD_TYPE_VALUES,
   HTTP,
-  HTTPS,
   HTTP_BY_NETWORK,
+  HTTPS,
   InitError,
   InvalidArgumentException,
   LIT_NETWORK,
   LIT_NETWORK_VALUES,
   METAMASK_CHAIN_INFO_BY_NETWORK,
   NETWORK_CONTEXT_BY_NETWORK,
-  PRODUCT_IDS,
   ParamsMissingError,
   RPC_URL_BY_NETWORK,
   TransactionError,
   WrongNetworkException,
 } from '@lit-protocol/constants';
-import { LogManager, Logger } from '@lit-protocol/logger';
+import { Logger, LogManager } from '@lit-protocol/logger';
 import { derivedAddresses, isBrowser, isNode } from '@lit-protocol/misc';
 import {
   ContractName,
@@ -47,13 +44,12 @@ import {
 import { getAuthIdByAuthMethod, stringToArrayify } from './auth-utils';
 import {
   CIDParser,
-  IPFSHash,
   getBytes32FromMultihash,
+  IPFSHash,
 } from './helpers/getBytes32FromMultihash';
 import { decToHex, hexToDec, intToIP } from './hex2dec';
-import { ValidatorStruct, type ValidatorWithPrices } from './types';
-
-const PRODUCT_IDS_ARRAY = Object.values(PRODUCT_IDS);
+import { getPriceFeedInfo } from './price-feed-info-manager';
+import { ValidatorStruct } from './types';
 
 // CHANGE: this should be dynamically set, but we only have 1 net atm.
 const REALM_ID = 1;
@@ -924,81 +920,14 @@ export class LitContracts {
     };
   };
 
-  public static getPriceFeedInfo = async ({
-    realmId,
-    litNetwork,
-    networkContext,
-    rpcUrl,
-    nodeProtocol,
-  }: {
+  public static getPriceFeedInfo = async (params: {
     realmId: number;
     litNetwork: LIT_NETWORKS_KEYS;
     networkContext?: LitContractContext | LitContractResolverContext;
     rpcUrl?: string;
     nodeProtocol?: typeof HTTP | typeof HTTPS | null;
   }) => {
-    const priceFeedContract = await LitContracts.getPriceFeedContract(
-      litNetwork,
-      networkContext,
-      rpcUrl
-    );
-
-    const nodesForRequest = await priceFeedContract['getNodesForRequest'](
-      realmId,
-      PRODUCT_IDS_ARRAY
-    );
-
-    const epochId: number[] = nodesForRequest[0].toNumber();
-    const minNodeCount: number[] = nodesForRequest[1].toNumber();
-    const nodesAndPrices: ValidatorWithPrices[] = nodesForRequest[2];
-
-    const networkUrls = LitContracts.generateValidatorURLs({
-      activeValidatorStructs: nodesAndPrices.map(({ validator }) => validator),
-      litNetwork,
-      nodeProtocol,
-    });
-
-    const prices = networkUrls
-      .reduce<{ url: string; prices: bigint[] }[]>((acc, network, index) => {
-        acc.push({
-          url: network,
-          prices: nodesAndPrices[index].prices.map((ethersPrice) =>
-            ethersPrice.toBigInt()
-          ),
-        });
-        return acc;
-      }, [])
-      .sort(({ prices: pricesA }, { prices: pricesB }) => {
-        // Sort by any price since the cheapest for _any_ product will be the cheapest for _all_ products
-        const diff = pricesA[0] - pricesB[0];
-        if (diff > 0n) {
-          return 1;
-        } else if (diff < 0n) {
-          return -1;
-        } else {
-          return 0;
-        }
-      });
-
-    // console.log(
-    //   'getPriceFeedInfo()',
-    //   util.inspect(
-    //     {
-    //       epochId,
-    //       minNodeCount,
-    //       networkPrices: {
-    //         mapByAddress: networkPriceMap,
-    //       },
-    //     },
-    //     { depth: 4 }
-    //   )
-    // );
-
-    return {
-      epochId,
-      minNodeCount,
-      networkPrices: prices,
-    };
+    return getPriceFeedInfo(params);
   };
 
   private static _resolveContractContext(

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

@@ -0,0 +1,141 @@
+// import * as util from 'node:util'; // For inspecting bigInt payloads for pricing data
+
+import { HTTP, HTTPS, PRODUCT_IDS } from '@lit-protocol/constants';
+import {
+  LIT_NETWORKS_KEYS,
+  LitContractContext,
+  LitContractResolverContext,
+} from '@lit-protocol/types';
+
+import { LitContracts } from './contracts-sdk';
+
+import type { ValidatorWithPrices } from './types';
+
+type GetPriceFeedInfoArgs = Parameters<typeof LitContracts.getPriceFeedInfo>;
+type PriceFeedInfo = Awaited<ReturnType<typeof fetchPriceFeedInfo>>;
+
+const STALE_PRICES_SECONDS = 3 * 1000; // Update prices if > X seconds old
+const PRODUCT_IDS_ARRAY = Object.values(PRODUCT_IDS);
+
+let priceFeedInfo: PriceFeedInfo | null = null;
+let fetchingPriceFeedInfo: null | Promise<PriceFeedInfo> = null;
+let lastUpdatedTimestamp = 0;
+
+async function fetchPriceFeedInfo({
+  realmId,
+  litNetwork,
+  networkContext,
+  rpcUrl,
+  nodeProtocol,
+}: {
+  realmId: number;
+  litNetwork: LIT_NETWORKS_KEYS;
+  networkContext?: LitContractContext | LitContractResolverContext;
+  rpcUrl?: string;
+  nodeProtocol?: typeof HTTP | typeof HTTPS | null;
+}) {
+  const priceFeedContract = await LitContracts.getPriceFeedContract(
+    litNetwork,
+    networkContext,
+    rpcUrl
+  );
+
+  const nodesForRequest = await priceFeedContract['getNodesForRequest'](
+    realmId,
+    PRODUCT_IDS_ARRAY
+  );
+
+  const epochId: number[] = nodesForRequest[0].toNumber();
+  const minNodeCount: number[] = nodesForRequest[1].toNumber();
+  const nodesAndPrices: ValidatorWithPrices[] = nodesForRequest[2];
+
+  const networkUrls = LitContracts.generateValidatorURLs({
+    activeValidatorStructs: nodesAndPrices.map(({ validator }) => validator),
+    litNetwork,
+    nodeProtocol,
+  });
+
+  const prices = networkUrls
+    .reduce<{ url: string; prices: bigint[] }[]>((acc, network, index) => {
+      acc.push({
+        url: network,
+        prices: nodesAndPrices[index].prices.map((ethersPrice) =>
+          ethersPrice.toBigInt()
+        ),
+      });
+      return acc;
+    }, [])
+    .sort(({ prices: pricesA }, { prices: pricesB }) => {
+      // Sort by any price since the cheapest for _any_ product will be the cheapest for _all_ products
+      const diff = pricesA[0] - pricesB[0];
+      if (diff > 0n) {
+        return 1;
+      } else if (diff < 0n) {
+        return -1;
+      } else {
+        return 0;
+      }
+    });
+
+  // console.log(
+  //   'getPriceFeedInfo()',
+  //   util.inspect(
+  //     {
+  //       epochId,
+  //       minNodeCount,
+  //       networkPrices: {
+  //         mapByAddress: networkPriceMap,
+  //       },
+  //     },
+  //     { depth: 4 }
+  //   )
+  // );
+
+  return {
+    epochId,
+    minNodeCount,
+    networkPrices: prices,
+  };
+}
+
+async function fetchPriceFeedInfoWithLocalPromise(
+  ...params: GetPriceFeedInfoArgs
+): Promise<PriceFeedInfo> {
+  try {
+    fetchingPriceFeedInfo = fetchPriceFeedInfo(...params);
+
+    priceFeedInfo = await fetchingPriceFeedInfo;
+    lastUpdatedTimestamp = Date.now();
+
+    return priceFeedInfo;
+  } finally {
+    fetchingPriceFeedInfo = null;
+  }
+}
+
+export async function getPriceFeedInfo(...params: GetPriceFeedInfoArgs) {
+  // If there's a local promise, an update is in progress; wait for that
+  if (fetchingPriceFeedInfo) {
+    return fetchingPriceFeedInfo;
+  }
+
+  // If we have updated prices in the last 2 seconds, return our current prices
+  if (
+    priceFeedInfo &&
+    Date.now() - lastUpdatedTimestamp < STALE_PRICES_SECONDS
+  ) {
+    return priceFeedInfo;
+  }
+
+  // If we get here, we've got prices that are at least 2 seconds out-of-date.
+  // Fetch the new ones, update local cache values, and return them
+  return fetchPriceFeedInfoWithLocalPromise(...params);
+}
+
+export async function getNodePrices(
+  ...params: GetPriceFeedInfoArgs
+): Promise<PriceFeedInfo['networkPrices']> {
+  const priceInfo = await getPriceFeedInfo(...params);
+
+  return priceInfo.networkPrices;
+}

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

@@ -1,19 +1,5 @@
 import { ethers } from 'ethers';
 
-import {
-  canonicalAccessControlConditionFormatter,
-  canonicalEVMContractConditionFormatter,
-  canonicalSolRpcConditionFormatter,
-  canonicalUnifiedAccessControlConditionFormatter,
-  hashAccessControlConditions,
-  hashEVMContractConditions,
-  hashSolRpcConditions,
-  hashUnifiedAccessControlConditions,
-  validateAccessControlConditionsSchema,
-  validateEVMContractConditionsSchema,
-  validateSolRpcConditionsSchema,
-  validateUnifiedAccessControlConditionsSchema,
-} from '@lit-protocol/access-control-conditions';
 import {
   CENTRALISATION_BY_NETWORK,
   HTTP,
@@ -59,15 +45,12 @@ import {
   CustomNetwork,
   EpochInfo,
   EthBlockhashInfo,
-  FormattedMultipleAccs,
   JsonHandshakeResponse,
   LitNodeClientConfig,
-  MultipleAccessControlConditions,
   NodeSet,
   RejectedNodePromises,
   SessionSigsMap,
   SuccessNodePromises,
-  SupportedJsonRequests,
 } from '@lit-protocol/types';
 
 import { composeLitUrl } from './endpoint-version';
@@ -132,8 +115,6 @@ export type LitNodeClientConfigWithDefaults = Required<
     bootstrapUrls: string[];
   } & {
     nodeProtocol?: typeof HTTP | typeof HTTPS | null;
-  } & {
-    nodePrices: { url: string; prices: bigint[] }[]; // eg. <nodeAddress, price[]>
   };
 
 export class LitCore {
@@ -146,7 +127,6 @@ export class LitCore {
     minNodeCount: 2, // Default value, should be replaced
     bootstrapUrls: [], // Default value, should be replaced
     nodeProtocol: null,
-    nodePrices: [],
   };
   connectedNodes = new Set<string>();
   serverKeys: Record<string, JsonHandshakeResponse> = {};
@@ -521,7 +501,6 @@ export class LitCore {
     this._stakingContract = validatorData.stakingContract;
     this.config.minNodeCount = validatorData.minNodeCount;
     this.config.bootstrapUrls = validatorData.bootstrapUrls;
-    this.config.nodePrices = validatorData.nodePrices;
 
     this._epochState = await this._fetchCurrentEpochState(
       validatorData.epochInfo