docs: add docs and rename variables for clarity

defi-wonderland · Jan 9, 2025 · 4885d84 · 4885d84
1 parent c3276a3
commit 4885d84
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 8 deletions.
diff --git a/apps/processing/src/services/sharedDependencies.service.ts b/apps/processing/src/services/sharedDependencies.service.ts
@@ -71,19 +71,19 @@ export class SharedDependenciesService {
             env.DATABASE_SCHEMA,
         );
         const pricingRepository = new KyselyPricingCache(kyselyDatabase, env.DATABASE_SCHEMA);
-        const _pricingProvider = PricingProviderFactory.create(env, {
+        const pricingProvider = PricingProviderFactory.create(env, {
             logger,
         });
-        const pricingProvider = new CachingPricingProvider(
-            _pricingProvider,
+        const cachedPricingProvider = new CachingPricingProvider(
+            pricingProvider,
             pricingRepository,
             logger,
         );
 
         const metadataRepository = new KyselyMetadataCache(kyselyDatabase, env.DATABASE_SCHEMA);
-        const _metadataProvider = new IpfsProvider(env.IPFS_GATEWAYS_URL, logger);
-        const metadataProvider = new CachingMetadataProvider(
-            _metadataProvider,
+        const metadataProvider = new IpfsProvider(env.IPFS_GATEWAYS_URL, logger);
+        const cachedMetadataProvider = new CachingMetadataProvider(
+            metadataProvider,
             metadataRepository,
             logger,
         );
@@ -118,9 +118,9 @@ export class SharedDependenciesService {
                 projectRepository,
                 roundRepository,
                 applicationRepository,
-                pricingProvider,
+                pricingProvider: cachedPricingProvider,
                 donationRepository,
-                metadataProvider,
+                metadataProvider: cachedMetadataProvider,
                 applicationPayoutRepository,
                 transactionManager,
             },

diff --git a/packages/repository/src/repositories/kysely/prices.repository.ts b/packages/repository/src/repositories/kysely/prices.repository.ts
@@ -6,12 +6,19 @@ import { Database, handlePostgresError, ICache } from "../../internal.js";
 
 export type PriceCacheKey = { tokenCode: TokenCode; timestampMs: number };
 
+/**
+ * A cache for token prices using Kysely.
+ * This cache is used to store and retrieve token prices for a given token and timestamp.
+ * It uses the `priceCache` table in the database to store the prices.
+ * Note: no eviction strategy is implemented since is not needed for the current use case.
+ */
 export class KyselyPricingCache implements ICache<PriceCacheKey, TokenPrice> {
     constructor(
         private readonly db: Kysely<Database>,
         private readonly schema: string,
     ) {}
 
+    /** @inheritdoc */
     async get(key: { tokenCode: TokenCode; timestampMs: number }): Promise<TokenPrice | undefined> {
         const { tokenCode, timestampMs } = key;