Mermaid EOA name (#86)

* Add name to EAO nodes in mermaid diagram
Ref L2B-2385

* Add changesets

* Update changelog

* Bumped package.json version

.gitignore

@@ -1,3 +1,5 @@
 node_modules
 .vscode
 dist
+
+**/.DS_Store

packages/discovery/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @l2beat/discovery
 
+## 0.19.1
+
+### Patch Changes
+
+- b34f1df: Use config.json names entry in naming EOAs in the mermaid diagram
+
 ## 0.19.0
 
 ### Minor Changes

packages/discovery/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@l2beat/discovery",
   "description": "L2Beat discovery - engine & tooling utilized for keeping an eye on L2s",
-  "version": "0.19.0",
+  "version": "0.19.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {

packages/discovery/src/discovery/config/DiscoveryConfig.ts

@@ -23,6 +23,10 @@ export class DiscoveryConfig {
     return this.config.name
   }
 
+  get names(): Record<string, string> {
+    return this.config.names ?? {}
+  }
+
   get chainId(): ChainId {
     return this.config.chain
   }

packages/discovery/src/inversion/runInversion.ts

@@ -6,6 +6,7 @@ import { mkdir, writeFile } from 'fs/promises'
 import { isObject } from 'lodash'
 
 import { ConfigReader } from '../discovery/config/ConfigReader'
+import { DiscoveryConfig } from '../discovery/config/DiscoveryConfig'
 import { ChainId } from '../utils/ChainId'
 import { EthereumAddress } from '../utils/EthereumAddress'
 
@@ -30,7 +31,8 @@ export async function runInversion(
   chain: ChainId,
 ): Promise<void> {
   const discovery = await configReader.readDiscovery(project, chain)
-  const addresses = calculateInversion(discovery)
+  const config = await configReader.readConfig(project, chain)
+  const addresses = calculateInversion(discovery, config)
 
   if (useMermaidMarkup) {
     const mermaid = createMermaid(addresses)
@@ -60,6 +62,7 @@ export async function runInversion(
 
 export function calculateInversion(
   discovery: DiscoveryOutput,
+  config: DiscoveryConfig,
 ): InvertedAddresses {
   const addresses = new Map<string, AddressDetails>()
 
@@ -74,8 +77,9 @@ export function calculateInversion(
     let details = addresses.get(address)
     if (!details) {
       details = {
-        name: discovery.contracts.find((x) => x.address.toString() === address)
-          ?.name,
+        name:
+          discovery.contracts.find((x) => x.address.toString() === address)
+            ?.name ?? config.names[address],
         address,
         roles: [],
       }