Skip to content

Commit

Permalink
feat: v0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
charmful0x committed May 4, 2024
1 parent 05778c2 commit 78df0c7
Show file tree
Hide file tree
Showing 23 changed files with 1,063 additions and 5,054 deletions.
1 change: 1 addition & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@
**/build
**/dist
LICENSE
elciao.log
README.md
13 changes: 13 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
JWK=YOUR_ARWEAVE_JWK_OBJECT

PROCESS_ID=LEAVE_IT_BLANK

SETUP_RPC_URL=YOU_NEED_TO_FILL_IT_AFTER_HOSTING_YOUR_NODE_ON_CLOUD

SETUP_CHAIN_ID=0x1

SETUP_NAME=BE_CREATIVE

SETUP_NETWORK=ethereum-mainnet

SETUP_ADMIN=YOUR_ADDRESS
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 WVM

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<p align="center">
<a href="https://wvm.dev">
<img src="https://raw.githubusercontent.com/weaveVM/.github/main/profile/bg.png">
</a>
</p>

## Synopsis

elciao is an EVM light client indexer for [ao](https://ao.arweave.dev). It works by feeding a constant stream of EVM data (Ethereum, for this proof of concept) to an ao process, storing all future EVM block metadata and proofs on Arweave in perpituity and making that available natively to other ao processes by default.

## Build & Setup

Clone the repository and set up the environment:

```bash
git clone https://github.com/weavevm/elciao.git
cd elciao
docker compose up --build
```

After building the repository locally, update the environment variables according to `.env.example`. Once updated, run the following command to deploy the application:

```bash
docker compose up --build
```
After deployment, grab the deployed AO process ID.

For hosting on the cloud (e.g., Heroku), import the `.env` variables, including the `PROCESS_ID`, to your cloud service provider.

## Tech stack
- [AO](https://ao.arweave.dev) : indexing / infra
- [Lodestar](https://github.com/ChainSafe/lodestar) : light client
- [Patronum](https://github.com/commonprefix) : RPC Proxy

## What elciao enables

Pushing EVM data to Arweave creates a permanent record of EVM history and exposes that history to dApps built on ao. Permanence of Ethereum history is an unsolved problem, and current bypasses rely on unincentivized archival nodes for storage.

[EIP-4444](https://eips.ethereum.org/EIPS/eip-4444) proposes a system like what we have built, using a storage-focused chain like Arweave as a guarantee that Ethereum data can always be recalled by client apps that need it, like block explorers and API interfaces for RPCs.

Storage guarantees aside, by exposing EVM data to ao elciao makes it so ao processes can verify transactions and smart contract states from EVM chains in a lightweight way, and ensure that data related to state changes, transaction outcomes and other proofs are always available.

Right now, EVM tooling on ao is in its very early stages of development, but once ao processes can call EVM libraries like ethers.js, ao processes can read from an elciao node to:

- Use a trustless data and assets bridge with Ethereum and other EVMs
- Trustlessly read data from Ethereum, with availability on ao which can facilitate building highly secure and decentralized wallets and infra

Check our live elciao testing node on [ao.link](https://ao.link/entity/zrAYK49KEAXKcB4r3XsfD3ap_ydfqRxElvGU7zEvKqU)

## License
This project is licensed under the [MIT License](./LICENSE)


Empty file added elciao.log
Empty file.
Loading

0 comments on commit 78df0c7

Please sign in to comment.