docs: @links to class constructor methods (#4041)

* typedoc: don't ignore evm

* Add @links to constructor methods for class objects

---------

Co-authored-by: Holger Drewes <[email protected]>

Author: ScottyPoi

packages/binarytree/src/binaryTree.ts

@@ -30,6 +30,10 @@ interface Path {
 
 /**
  * The basic binary tree interface, use with `import { BinaryTree } from '@ethereumjs/binarytree'`.
+ *
+ * A BinaryTree object can be created with the constructor method:
+ *
+ * - {@link createBinaryTree}
  */
 export class BinaryTree {
   /** The options for instantiating the binary tree */

packages/blockchain/src/blockchain.ts

@@ -51,6 +51,10 @@ import type {
  * Proof-of-Stake consensus is validated by the Ethereum consensus layer.
  * If consensus validation is desired for Ethash or Clique blockchains the
  * optional `consensusDict` option can be used to pass in validation objects.
+ *
+ * A Blockchain object can be created with the constructor method:
+ *
+ * - {@link createBlockchain}
  */
 export class Blockchain implements BlockchainInterface {
   db: DB<Uint8Array | string, Uint8Array | string | DBObject>

packages/common/src/common.ts

@@ -38,9 +38,12 @@ import type {
  * Common class to access chain and hardfork parameters and to provide
  * a unified and shared view on the network and hardfork state.
  *
- * Use the {@link Common.custom} static constructor for creating simple
+ * Use the {@link createCustomCommon} constructor for creating simple
  * custom chain {@link Common} objects (more complete custom chain setups
  * can be created via the main constructor).
+ *
+ * Use the {@link createCommonFromGethGenesis} constructor for creating
+ * a Common object from a Geth genesis file.
  */
 export class Common {
   readonly DEFAULT_HARDFORK: string | Hardfork

packages/evm/src/evm.ts

@@ -124,10 +124,11 @@ export function defaultBlock(): Block {
 }
 
 /**
- * EVM is responsible for executing an EVM message fully
- * (including any nested calls and creates), processing the results
- * and storing them to state (or discarding changes in case of exceptions).
- * @ignore
+ * The EVM (Ethereum Virtual Machine) is responsible for executing EVM bytecode, processing transactions, and managing state changes. It handles both contract calls and contract creation operations.
+ *
+ * An EVM instance can be created with the constructor method:
+ *
+ * - {@link createEVM}
  */
 export class EVM implements EVMInterface {
   protected static supportedHardforks = [

packages/evm/typedoc.mjs

@@ -2,5 +2,5 @@ export default {
   extends: '../../config/typedoc.mjs',
   entryPoints: ['src'],
   out: 'docs',
-  exclude: ['test/**/*.ts', 'src/evm/**'],
+  exclude: ['test/**/*.ts'],
 }

packages/mpt/src/mpt.ts

@@ -51,6 +51,14 @@ import type { OnFound } from './util/asyncWalk.ts'
 
 /**
  * The basic trie interface, use with `import { MerklePatriciaTrie } from '@ethereumjs/mpt'`.
+ *
+ * A MerklePatriciaTrie object can be created with the constructor method:
+ *
+ * - {@link createMPT}
+ *
+ * A sparse MerklePatriciaTrie object can be created from a merkle proof:
+ *
+ * - {@link createMPTFromProof}
  */
 export class MerklePatriciaTrie {
   protected readonly _opts: MPTOptsWithDefaults = {

packages/verkle/src/verkleTree.ts

@@ -27,6 +27,10 @@ interface Path {
 
 /**
  * The basic verkle tree interface, use with `import { VerkleTree } from '@ethereumjs/verkle'`.
+ *
+ * A VerkleTree object can be created with the constructor method:
+ *
+ * - {@link createVerkleTree}
  */
 export class VerkleTree {
   _opts: VerkleTreeOpts

packages/vm/src/vm.ts

@@ -10,8 +10,12 @@ import type { BigIntLike } from '@ethereumjs/util'
 import type { VMEvent, VMOpts } from './types.ts'
 
 /**
- * Execution engine which can be used to run a blockchain, individual
- * blocks, individual transactions, or snippets of EVM bytecode.
+ * The VM is a state transition machine that executes EVM bytecode and updates the state.
+ * It can be used to execute transactions, blocks, individual transactions, or snippets of EVM bytecode.
+ *
+ * A VM can be created with the constructor method:
+ *
+ * - {@link createVM}
  */
 export class VM {
   /**