chore: documentation (#84)

Author: sstraatemans

devnet/README.md

@@ -1,8 +1,25 @@
 # Devnet EVM
 
+## INIT
+
+Make sure that the following is installed, before continueing.
+
+```sh
+# The Girhub CLI
+brew install gh
+
+# This tool is required to locate and configure dependencies during the build process
+brew install pkg-config
+
+# Fast Python package and project manager
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+uv add secp256k1
+```
+
 ## Github Container Registry
 
-Create a `GITHUB_TOKEN` env var with token with `packages:read` permission to
+Create a `GITHUB_TOKEN` (Github > Profile > Settings > Developer Settings) env var with token with `packages:read` permission to
 access the docker images. Then run:
 
 ```sh

devnet/config/default/bootnode/nginx.conf

@@ -40,12 +40,13 @@ http {
             add_header Access-Control-Allow-Origin *;
         }
 
-        location = /mining-trigger {
+location = /mining-trigger {
             internal;
             proxy_pass http://bootnode-mining-trigger:11848/trigger;
             proxy_set_header X-Original-URI $request_uri;
         }
 
+
         location /chainweb/0.0/evm-development/chain/20/evm/rpc {
             mirror /mining-trigger;
             add_header Access-Control-Allow-Origin *;

tests/e2e/discontinued-node.test.ts

@@ -1,4 +1,4 @@
-import { describe, test, expect, afterAll, beforeAll, it } from 'bun:test';
+import { describe, test, expect, afterAll, beforeAll } from 'bun:test';
 import {
   $devnet,
   CONFIG,
@@ -18,7 +18,7 @@ $.verbose = CONFIG.VERBOSE;
 const log = createLogger({ context: 'discontinued-node.test.ts' });
 
 describe(`e2e: verify ${DOCKER_COMPOSE_FILE} generation`, () => {
-  it(`e2e: generate ${DOCKER_COMPOSE_FILE}`, async () => {
+  test(`e2e: generate ${DOCKER_COMPOSE_FILE}`, async () => {
     await createDockerComposeFile();
     const fileExists = fs.existsSync(DOCKER_COMPOSE_FILE);
     expect(fileExists).toBe(true);
@@ -67,9 +67,7 @@ describe('e2e: start network, stop node, restart node', () => {
     if (!evm20) {
       throw new Error('evm-20 not found in devnet status');
     }
-    const lowestHeight = devnetStatus.chains.sort(
-      (a, b) => a.height - b.height
-    )[0];
+    const lowestHeight = devnetStatus.chains.sort((a, b) => a.height - b.height)[0];
 
     console.log(`expecting lowest height to be evm-20: ${evm20.height}`);
     expect(lowestHeight).toEqual(evm20);
@@ -85,9 +83,7 @@ describe('e2e: start network, stop node, restart node', () => {
       );
     } catch (e) {
       console.log('cut-height not increasing');
-      const newEvm20 = (await getDevnetStatus()).chains.find(
-        (chain) => chain.chainId === 20
-      )!;
+      const newEvm20 = (await getDevnetStatus()).chains.find((chain) => chain.chainId === 20)!;
       if (newEvm20.height === evm20.height) {
         expect(
           newEvm20.height,