docs: add tsdocs

packages/metadata/src/interfaces/metadata.interface.ts

@@ -1,6 +1,30 @@
 import { Token, TokenType, ZKChainMetadata } from "@zkchainhub/shared";
 
+/**
+ * Represents a metadata provider that retrieves chains and tokens metadata.
+ */
 export interface IMetadataProvider {
+    /**
+     * Retrieves the metadata for ZK chains of the ecosystem
+     *
+     * @returns A promise that resolves to the metadata of ZK chains.
+     *
+     * @throws {FetchError}
+     * If there is an issue with the network request.
+     *
+     *
+     * @throws {InvalidSchema}
+     * If the response data is invalid or cannot be parsed.
+     */
     getChainsMetadata(): Promise<ZKChainMetadata>;
+
+    /**
+     * Retrieves metadata for tokens of the ecosystem
+     *
+     * @returns A promise that resolves to an array of token metadata.
+     *
+     * @throws {FetchError} If there is an issue with the network request.
+     * @throws {InvalidSchema} If the response data is invalid or cannot be parsed.
+     */
     getTokensMetadata(): Promise<Token<TokenType>[]>;
 }

packages/metadata/src/providers/githubMetadata.provider.ts

@@ -34,6 +34,7 @@ export class GithubMetadataProvider implements IMetadataProvider {
         });
     }
 
+    /** @inheritdoc */
     async getChainsMetadata(): Promise<ZKChainMetadata> {
         let cachedData = await this.cache.get<ZKChainMetadata | undefined>(
             `${GITHUB_METADATA_PREFIX}-chains`,
@@ -66,6 +67,7 @@ export class GithubMetadataProvider implements IMetadataProvider {
         return cachedData;
     }
 
+    /** @inheritdoc */
     async getTokensMetadata(): Promise<Token<TokenType>[]> {
         let cachedData = await this.cache.get<Token<TokenType>[] | undefined>(
             `${GITHUB_METADATA_PREFIX}-tokens`,

packages/metadata/src/providers/localFileMetadata.provider.ts

@@ -16,7 +16,7 @@ import { ChainSchema, TokenSchema } from "../schemas/index.js";
 export const LOCALFILE_METADATA_PREFIX = "local-metadata";
 
 /**
- * Represents a local file metadata provider.
+ * Represents a provider that retrieves metadata from local files.
  */
 export class LocalFileMetadataProvider implements IMetadataProvider {
     /**
@@ -42,6 +42,7 @@ export class LocalFileMetadataProvider implements IMetadataProvider {
         }
     }
 
+    /** @inheritdoc */
     async getChainsMetadata(): Promise<ZKChainMetadata> {
         let cachedData = await this.cache.get<ZKChainMetadata>(
             `${LOCALFILE_METADATA_PREFIX}-chains`,
@@ -70,6 +71,7 @@ export class LocalFileMetadataProvider implements IMetadataProvider {
         return cachedData;
     }
 
+    /** @inheritdoc */
     async getTokensMetadata(): Promise<Token<TokenType>[]> {
         let cachedData = await this.cache.get<Token<TokenType>[]>(
             `${LOCALFILE_METADATA_PREFIX}-tokens`,

packages/metadata/src/providers/staticMetadata.provider.ts

@@ -2,10 +2,16 @@ import { Token, tokens, TokenType, ZKChainMetadata, zkChainsMetadata } from "@zk
 
 import { IMetadataProvider } from "../interfaces/index.js";
 
+/**
+ * Represents a provider that retrieves metadata from static data of mainnet.
+ */
 export class StaticMetadataProvider implements IMetadataProvider {
+    /** @inheritdoc */
     async getChainsMetadata(): Promise<ZKChainMetadata> {
         return structuredClone(zkChainsMetadata);
     }
+
+    /** @inheritdoc */
     async getTokensMetadata(): Promise<Token<TokenType>[]> {
         return Array.from(tokens);
     }