chore: fix verification of README code snippets (#7471)

Replacement for #6868 which
got a bit stale and had workarounds in it which are no longer required.

Closes #6300

Author: nflaig

package.json

@@ -71,7 +71,7 @@
     "supertest": "^6.3.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.2",
-    "typescript-docs-verifier": "^2.5.0",
+    "typescript-docs-verifier": "^2.5.3",
     "vite": "^5.3.4",
     "vite-plugin-dts": "^3.9.1",
     "vite-plugin-node-polyfills": "^0.22.0",

packages/prover/README.md

@@ -14,7 +14,7 @@ A set of tools allowing to verify EL client JSON-RPC calls.
 You can use the `@lodestar/prover` in two ways, as a Web3 Provider and as proxy. For prover use case see below example.
 
 ```ts
-import Web3 from "web3";
+import {Web3} from "web3";
 import {createVerifiedExecutionProvider, LCTransport} from "@lodestar/prover";
 
 const httpProvider = new Web3.providers.HttpProvider("https://lodestar-sepoliarpc.chainsafe.io");
@@ -38,7 +38,7 @@ In this scenario the actual provider is mutated to handle the RPC requests and v
 For some scenarios when you don't want to mutate the provider you can pass an option `mutateProvider` as `false`. In this scenario the object `httpProvider` is not mutated and you get a new object `provider`. This is useful when your provider object does not allow mutation, e.g. Metamask provider accessible through `window.ethereum`. If not provided `mutateProvider` is considered as `true` by default. In coming releases we will switch its default behavior to `false`.
 
 ```ts
-import Web3 from "web3";
+import {Web3} from "web3";
 import {createVerifiedExecutionProvider, LCTransport} from "@lodestar/prover";
 
 const httpProvider = new Web3.providers.HttpProvider("https://lodestar-sepoliarpc.chainsafe.io");
@@ -51,7 +51,7 @@ const {provider, proofProvider} = createVerifiedExecutionProvider(httpProvider,
   mutateProvider: false,
 });
 
-const web3 = new Web3(provider);
+const web3 = new Web3(httpProvider);
 
 const address = "0xf97e180c050e5Ab072211Ad2C213Eb5AEE4DF134";
 const balance = await web3.eth.getBalance(address, "latest");

packages/types/README.md

@@ -67,13 +67,15 @@ import {Epoch, ssz} from "@lodestar/types";
 const epoch: Epoch = ssz.Epoch.defaultValue();
 ```
 
-In some cases, we need interfaces that accept types across all forks, like when the fork is not known ahead of time. SSZ Types typed to these interfaces are also provided under an `allForks` namespace, but keyed by `ForkName`.
+In some cases, we need interfaces that accept types across all forks, like when the fork is not known ahead of time. Those are directly available without a namespace and SSZ Types typed to these interfaces can be retrieved by calling `sszTypesFor` with the `ForkName`.
 
 ```typescript
-import {ForkName} from "@lodestar/params";
-import {ssz, BeaconState} from "@lodestar/types";
+import {ForkName, ForkPostAltair} from "@lodestar/params";
+import {sszTypesFor, BeaconState} from "@lodestar/types";
 
-const state: BeaconState<ForkName.phase0> = ssz.allForks[ForkName.phase0].BeaconState.defaultValue();
+const fork = ForkName.altair;
+
+const state: BeaconState<ForkPostAltair> = sszTypesFor(fork).BeaconState.defaultValue();
 ```
 
 ## License

yarn.lock

@@ -12410,10 +12410,10 @@ typedarray@^0.0.6:
   resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
   integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==
 
-typescript-docs-verifier@^2.5.0:
-  version "2.5.0"
-  resolved "https://registry.yarnpkg.com/typescript-docs-verifier/-/typescript-docs-verifier-2.5.0.tgz#5a39c89b492aca31100b20affd477913daa82f7d"
-  integrity sha512-h+1fW9LEJi5Q8fMZxdpVoXjGQohx7CAYTylF5JWmmj6IM0J21HgII1vpLAX/Q5B+jlIg8V7v7sGfwBI7LIG4oA==
+typescript-docs-verifier@^2.5.3:
+  version "2.5.3"
+  resolved "https://registry.yarnpkg.com/typescript-docs-verifier/-/typescript-docs-verifier-2.5.3.tgz#2fcb393cdae955a2c86bf272008cf6f7fb3d1fbf"
+  integrity sha512-fATV69QQZzIQWDGfUzo2USUcUTK0hPqTm7XZuyHf4QOkZUshnkwDk8TEk2IxaIlHxKjbM+5RtyDgxCtKYycjXA==
   dependencies:
     chalk "^4.1.2"
     fs-extra "^10.0.0"