Fix types warnings

package.json

@@ -30,7 +30,8 @@
     "prepare": "husky install",
     "version": "npx genversion --es6 src/logger/package-version.ts && git add src/logger/package-version.ts",
     "postversion": "git push --follow-tags",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "doc": "typedoc"
   },
   "devDependencies": {
     "@types/body-parser": "^1.19.1",
@@ -59,6 +60,7 @@
     "prettier-plugin-organize-imports": "^2.3.4",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
+    "typedoc": "^0.22.15",
     "typescript": "^4.6.4",
     "web3": "^1.7.3"
   },

scripts/markdown-magic/build-readme.sh

@@ -1,4 +1,4 @@
-npx typedoc --json scripts/markdown-magic/typedoc.out.json --pretty src/index.ts
+npm run doc
 npx markdown-magic
 # add a newline above all markdown magic comments
 # This was breaking the docusaurus jsx rendering otherwise

src/index.ts

@@ -1,15 +1,26 @@
 import { Contract } from './classes/Contract';
-import { FallthroughProvider } from './providers/FallthroughProvider';
+import {
+  ConstructorOptions,
+  FallthroughProvider,
+} from './providers/FallthroughProvider';
 import { JsonRpcProvider, jsonRpcProvider } from './providers/JsonRpcProvider';
 import { tinyBig, TinyBig } from './shared/tiny-big/tiny-big';
-import { BlockResponse } from './types/Block.types';
+import { BlockResponse, BlockTag, RPCBlock } from './types/Block.types';
 import {
   ContractTypes,
   JSONABI,
   JSONABIArgument,
 } from './types/Contract.types';
 import { Network } from './types/Network.types';
-import { TransactionResponse } from './types/Transaction.types';
+import {
+  BlockTransactionResponse,
+  Log,
+  RPCLog,
+  RPCTransaction,
+  RPCTransactionReceipt,
+  TransactionReceipt,
+  TransactionResponse,
+} from './types/Transaction.types';
 import { computeAddress } from './utils/compute-address';
 import { computePublicKey } from './utils/compute-public-key';
 import { etherToGwei } from './utils/ether-to-gwei';
@@ -52,4 +63,13 @@ export {
   JSONABIArgument,
   Network,
   TransactionResponse,
+  RPCBlock,
+  RPCTransaction,
+  RPCTransactionReceipt,
+  TransactionReceipt,
+  BlockTag,
+  RPCLog,
+  Log,
+  BlockTransactionResponse,
+  ConstructorOptions,
 };

src/providers/FallthroughProvider.ts

@@ -10,7 +10,7 @@ const promiseTimeout = (prom: Promise<any>, time: number) =>
     ),
   ]);
 
-interface ConstructorOptions {
+export interface ConstructorOptions {
   timeoutDuration?: number;
 }
 const DEFAULT_TIMEOUT_DURATION = 8000;

src/types/Block.types.ts

@@ -1,6 +1,7 @@
 import { BlockTransactionResponse, RPCTransaction } from './Transaction.types';
 
 type Modify<T, R> = Omit<T, keyof R> & R;
+
 export type BlockResponse = Modify<
   RPCBlock,
   {

src/types/Transaction.types.ts

@@ -1,6 +1,7 @@
 import { TinyBig } from '../shared/tiny-big/tiny-big';
 
 type Modify<T, R> = Omit<T, keyof R> & R;
+
 export interface RPCTransaction extends RPCBlockTransaction {
   // not in getBlock transactions, only in getTransaction response
   maxFeePerGas: string /* "0xfc21e1832", */;