From d1e21711de24d8c083c330f894a10727a4c1315e Mon Sep 17 00:00:00 2001
From: Elias Tazartes <66871571+Eikix@users.noreply.github.com>
Date: Mon, 18 Nov 2024 15:08:09 +0700
Subject: [PATCH] fix: fix mermaid diagram in readme (#1615)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## Pull request type

<!-- Please try to limit your pull request to one type,
submit multiple pull requests if needed. -->

Please check the type of change your PR introduces:

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, renaming)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [x] Documentation content changes
- [ ] Other (please describe):

## What is the current behavior?

<!-- Please describe the current behavior that you are modifying,
or link to a relevant issue. -->

Resolves #<Issue number>

## What is the new behavior?

<!-- Please describe the behavior or changes that are being added by
this PR. -->

- fix mermaid diagram in main readme

error was previously:
```
Unable to render rich display

Parse error on line 26:
...tecode() A ->> K: K ->> I: Inte
----------------------^
Expecting 'NEWLINE', 'AS', ',', 'SOLID_OPEN_ARROW', 'DOTTED_OPEN_ARROW', 'SOLID_ARROW', 'BIDIRECTIONAL_SOLID_ARROW', 'DOTTED_ARROW', 'BIDIRECTIONAL_DOTTED_ARROW', 'SOLID_CROSS', 'DOTTED_CROSS', 'SOLID_POINT', 'DOTTED_POINT', 'TXT', got 'INVALID'

For more information, see https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-mermaid-diagrams
```

<!-- Reviewable:start -->
- - -
This change is [<img src="https://reviewable.io/review_button.svg"
height="34" align="absmiddle"
alt="Reviewable"/>](https://reviewable.io/reviews/kkrt-labs/kakarot/1615)
<!-- Reviewable:end -->
---
 README.md | 18 +++++++-----------
 1 file changed, 7 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 6070511a4..4772f60a7 100644
--- a/README.md
+++ b/README.md
@@ -460,7 +460,7 @@ sequenceDiagram
     note over A: Check EVM tx signature
 
     A ->> RPC: eth_send_raw_unsigned_tx(...)
-    note over RPC: Decode tx<br><br>Check chain ID, nonce, gas params,<br>sender native balance, ...
+    note over RPC: Decode tx<br>Check chain ID, nonce, gas params,<br>sender native balance, ...
 
     RPC ->> RPC: eth_send_transaction(...)
     note over RPC: Verify caller address<br>(via safe_get_evm_address)
@@ -468,31 +468,27 @@ sequenceDiagram
     RPC ->> K: Kakarot.eth_call(...)
 
     K ->> A: get_bytecode()
-    A ->> K:
+    A ->> K: Bytecode returned
 
     K ->> I: Interpreter.execute(...)
 
-    note over I: Init state structs: (Message, EVM, stack, memory, ...)<br>Init called account if needed
+    note over I: Init state structs:<br>Message, EVM, stack, memory, ...<br>Init called account if needed
 
     loop Interpreter loop
-    Note over I: exec_opcode(...) is the function handling individual opcodes
+        note over I: exec_opcode(...) is the function handling individual opcodes
     end
 
-
-    note over I: State finalization<br>(squash memory dict, apply state balance changes, ...)
+    note over I: State finalization:<br>squash memory dict, apply state balance changes, ...
 
     I ->> K: EVM state:<br>result, stack, memory, gas_used, ...
 
     rect rgb(240,240,240)
         K ->> K: Starknet.commit()
-        note over K: Update accounts nonce
-        note over K: Commit accounts storage
-        note over K: Emit events
-        note over K: Perform ERC20 balance transfers
+        note over K: Update accounts nonce<br>Commit accounts storage<br>Emit events<br>Perform ERC20 balance transfers
     end
 
     K ->> A: returndata, success, gas used
-        note over A: Emit transaction_executed event
+    note over A: Emit transaction_executed event
     A ->> U: returndata
 ```