refactor(explorer): update mvp to new aligned architecture (#196)

Co-authored-by: Urix <43704209+uri-99@users.noreply.github.com>
Co-authored-by: Mariano Nicolini <mariano.nicolini.91@gmail.com>
Co-authored-by: Mauro Toscano <12560266+MauroToscano@users.noreply.github.com>
Co-authored-by: MauroFab <maurotoscano2@gmail.com>
Co-authored-by: Nicolas Rampoldi <58613770+NicolasRampoldi@users.noreply.github.com>

Author: 5 people

Makefile

@@ -472,4 +472,16 @@ generate_halo2_ipa_proof:
 	rm params.bin proof.bin pub_input.bin && \
 	RUST_LOG=info cargo run --release && \
 	echo "Generating halo2 plonk proof..." && \
-	echo "Generated halo2 plonk proof!"
+	echo "Generated halo2 plonk proof!"
+	
+__EXPLORER__:
+run_devnet_explorer: 
+	@cd explorer/ && \
+		mix setup && \
+		cp .env.dev .env && \
+		./start.sh
+
+run_explorer:
+	@cd explorer/ && \
+		mix setup && \
+		./start.sh

README.md

@@ -13,15 +13,14 @@
   - [Deploying Aligned Contracts to Holesky or Testnet](#deploying-aligned-contracts-to-holesky-or-testnet)
   - [Metrics](#metrics)
   - [Notes on project creation / devnet deployment](#notes-on-project-creation--devnet-deployment)
+  - [Explorer](#explorer)
   - [Tests](#tests)
   - [FAQ](#faq)
 
 ## The Project
 
 Aligned works with EigenLayer to leverage ethereum consensus mechanism for ZK proof verification. Working outside the EVM, this allows for cheap verification of any proving system. This enables the usage of cutting edge algorithms, that may use new techniques to prove even faster. Even more, proving systems that reduce the proving overhead and add verifier overhead, now become economically feasable to verify thanks to Aligned.
 
-
-
 ## How to use the testnet
 
 ### Requirements
@@ -192,6 +191,8 @@ If you need to start again the operator, and it's already registered, use:
 make operator_start
 ```
 
+If you want to start the explorer for the devnet, see how to run it using it's [documentation](#explorer) below.
+
 ### Send test proofs to batcher for testing
 
 All these proofs are for testing purposes
@@ -727,6 +728,43 @@ The state is backuped on ```contracts/scripts/anvil/state```.
 Eigenlayer contract deployment is almost the same as the EigenLayer contract deployment on mainnet. Changes are described on the file.
 
 
+##  Explorer
+### Requirements
+
+- [Erlang 26](https://github.com/asdf-vm/asdf-erlang)
+- [Elixir 1.16.2](https://elixir-ko.github.io/install.html), compiled with OTP 26
+- [Phoenix 1.7.12](https://hexdocs.pm/phoenix/installation.html)
+- [Ecto 3.11.2](https://hexdocs.pm/ecto/getting-started.html)
+
+### Running for local devnet
+
+```make run_devnet_explorer```
+
+Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
+You can access to a tasks information by visiting `localhost:4000/batches/:merkle_root`.
+
+### Run with custom env / other devnets
+
+Create a `.env` file in the `/explorer` directory of the project. The `.env` file needs to contain the following variables:
+
+| Variable | Description |
+| -------- | ----------- |
+| `RPC_URL` | The RPC URL of the network you want to connect to. |
+| `ENVIRONMENT` | The environment you want to run the application in. It can be `devnet`, `holesky` or `mainnet`. |
+
+```make run_explorer```
+
+
+### Send example data
+
+If you want to have some data to see on it, you can start our infinite task sender, which will constantly send new proofs to the batcher.
+
+```sh
+make batcher_send_burst_groth16
+```
+
+</details>
+
 ## Tests
 
 To run the go tests
@@ -735,7 +773,6 @@ To run the go tests
 make test
 ```
 
-
 ## FAQ
 
 ### What is the objective of Aligned?

explorer/.env.dev

@@ -0,0 +1,2 @@
+RPC_URL=http://localhost:8545
+ENVIRONMENT=devnet