📝 Added eslint-plugin-jsdoc and fixed errors

.eslintrc.js

@@ -32,4 +32,29 @@ module.exports = {
     '@typescript-eslint/ban-ts-comment': 'warn',
     '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
   },
+  overrides: [
+    {
+      files: 'src/**/*.ts',
+      excludedFiles: '*.test.ts',
+      plugins: ['jsdoc'],
+      extends: ['plugin:jsdoc/recommended'],
+      rules: {
+        'jsdoc/check-tag-names': ['warn', { definedTags: ['alpha', 'beta'] }], // Should check that tag names are valid; include 'alpha' and 'beta' as acceptable tag names
+        'jsdoc/require-param-type': 'off', // TypeDoc automatically reads types from TypeScript types, hence param types should rarely be defined explictly -- https://typedoc.org/guides/doccomments/#%40param-%3Cparam-name%3E
+        'jsdoc/require-returns-type': 'off', // Read above note for `jsdoc/require-param-type`
+        // 'jsdoc/check-examples': 'warn', // Ensures examples match a certain format -- currently not supported for ESLint, waiting for this issue -- https://github.com/eslint/eslint/issues/14745
+        'jsdoc/check-indentation': 'warn', // Ensures proper indentation of items inside TypeDoc comments
+        'jsdoc/check-line-alignment': 'warn', // Ensures TypeDoc comments are aligned to match what it's documenting
+        'jsdoc/check-syntax': 'warn', // Ensures that documentation syntax is appropriate for Google Closure Compiler
+        'jsdoc/require-asterisk-prefix': 'warn', // Require that all documentation is prefixed with an asterisk, makes it easier to differentiate what's documentation and what isn't
+        'jsdoc/require-example': 'warn', // Ensures that all documentated functions have examples
+        'jsdoc/require-hyphen-before-param-description': ['warn', 'never'], // Prevent hyphens before description of a parameter
+        'jsdoc/require-returns': [
+          'warn',
+          { checkGetters: true, forceReturnsWithAsync: true },
+        ],
+        'jsdoc/no-multi-asterisks': ['warn', { allowWhitespace: true }],
+      },
+    },
+  ],
 };

package.json

@@ -47,7 +47,8 @@
     "dotenv": "^16.0.0",
     "eslint": "^8.16.0",
     "eslint-plugin-jest": "^26.2.2",
-    "ethers": "^5.6.8",
+    "eslint-plugin-jsdoc": "=38.0.2",
+    "ethers": "^5.6.7",
     "express": "^4.17.1",
     "husky": "^7.0.4",
     "jest": "^27.5.1",

src/classes/Contract.ts

@@ -5,6 +5,11 @@ import {
   encodeData,
 } from './utils/encode-decode-transaction';
 import { buildRPCPostBody, post } from './utils/fetchers';
+/**
+ *
+ * @param txnData
+ * @example
+ */
 function estimateGas(txnData: string) {
   // https://ethereum.stackexchange.com/questions/1570/what-does-intrinsic-gas-too-low-mean/1694
   txnData.split('').reduce((previousValue, currentValue) => {
@@ -24,9 +29,10 @@ export class BaseContract {
   private readonly _provider: JsonRpcProvider;
 
   /**
-   * @param addressOrName - The ethereum address of the smart-contract
-   * @param contractInterface - The JSON ABI of the smart-contract (like http://api.etherscan.io/api?module=contract&action=getabi&address=0x090d4613473dee047c3f2706764f49e0821d256e&format=raw)
-   * @param signerOrProvider - An instantiated essential-eth provider
+   * @param addressOrName The ethereum address of the smart-contract
+   * @param contractInterface The JSON ABI of the smart-contract (like http://api.etherscan.io/api?module=contract&action=getabi&address=0x090d4613473dee047c3f2706764f49e0821d256e&format=raw)
+   * @param signerOrProvider An instantiated essential-eth provider
+   * @example
    */
   constructor(
     addressOrName: string,
@@ -91,6 +97,11 @@ export class BaseContract {
 
 /**
  * Applies the unique contract's methods to the instantiated Contract in the constructor based-upon the provided ABI
+ *
+ * @param object
+ * @param name
+ * @param value
+ * @example
  */
 export function defineReadOnly<T>(object: T, name: string, value: any): void {
   Object.defineProperty(object, name, {
@@ -103,7 +114,7 @@ export function defineReadOnly<T>(object: T, name: string, value: any): void {
 /**
  * @alpha
  * Only accepts ABIS in JSON format. This allows for stronger typing and assurances of data-types
- * * Only read-only function calls currently supported.
+ * Only read-only function calls currently supported.
  * @example
  * ```typescript
  * import { Contract, JsonRpcProvider } from 'essential-eth';