chore: readme - overrides explained (#3823)

Signed-off-by: Mariusz Jasuwienas <[email protected]>

Author: arianejasuwienas

packages/server/tests/acceptance/conformityTests.spec.ts

@@ -348,6 +348,18 @@ const synthesizeTestCases = function (testCases, updateParamIfNeeded) {
   }
 };
 
+/**
+ * To run the Ethereum Execution API tests as defined in the repository ethereum/execution-apis, it’s necessary
+ * to execute them against a specifically configured node. This node must use:
+ *  - Transactions from the blocks in chain.rlp (https://github.com/ethereum/execution-apis/blob/main/tests/chain.rlp),
+ *  - Account balances from genesis.json (https://github.com/ethereum/execution-apis/blob/main/tests/genesis.json).
+ *
+ * We cannot replay all of the chain.rlp transactions directly, as they are already signed with a chain id
+ * that exceeds Java’s Integer.MAX_VALUE (which is also the maximum allowed chain ID in Hedera).
+ * However, we can replicate the test environment by deploying the required smart contracts manually.
+ * While these contracts will receive different addresses than those in the original tests,
+ * their behavior will remain consistent with the expectations.
+ */
 const initGenesisData = async function () {
   for (const data of require('./data/conformity/genesis.json')) {
     const options = { maxPriorityFeePerGas: gasPrice, maxFeePerGas: gasPrice, gasLimit: gasLimit };
@@ -375,11 +387,13 @@ describe('@api-conformity', async function () {
       currentBlockHash = await getLatestBlockHash();
     });
     //Reading the directories within the ethereum execution api repo
+    //Adds tests for custom Hedera methods from override directory to the list, even if they're not in the OpenRPC spec.
     let directories = [...new Set([...fs.readdirSync(directoryPath), ...fs.readdirSync(overwritesDirectoryPath)])];
     const relaySupportedMethodNames = openRpcData.methods.map((method) => method.name);
     //Filtering in order to use only the tests for methods we support in our relay
     directories = directories.filter((directory) => relaySupportedMethodNames.includes(directory));
     for (const directory of directories) {
+      //Lists all files (tests) in a directory (method). Returns an empty array for non-existing directory.
       const ls = (dir: string) => (fs.existsSync(dir) && fs.statSync(dir).isDirectory() ? fs.readdirSync(dir) : []);
       const files = [
         ...new Set([...ls(path.join(directoryPath, directory)), ...ls(path.join(overwritesDirectoryPath, directory))]),