Skip to content

Commit

Permalink
docs: Add basic README.md (#6)
Browse files Browse the repository at this point in the history
# 🤖 Linear

Closes GRT-35

## Description
Adds a basic README file.
  • Loading branch information
0xyaco authored Jul 18, 2024
1 parent 1fd4fdb commit 851f98c
Showing 1 changed file with 57 additions and 1 deletion.
58 changes: 57 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,57 @@
# ebo-agent
# ebo-agent

The Epoch Block Oracle (EBO) introduces the use of an optimistic oracle ([Prophet](https://docs.prophet.tech/)), enabling any off-chain agent to interact with it by creating requests, proposing responses, or disputing responses in a permissionless manner. This document outlines a comprehensive implementation strategy for the agent responsible for automating all workflows associated with EBO. Within this document, you will find a detailed presentation of the high-level architecture, code design, process flows, technology stack, and project estimations.

## Table of contents

* Background
* Install
* Usage
* Contributing

## Background

The EBO agent is an open-source tool designed to poll events from the relevant on-chain smart contracts on the Protocol chain (Arbitrum) and respond to these events with specific actions tailored to the flow requirements. Additionally, the agent will interface with blockchains supported by The Graph and perform block computations for each epoch as necessary. These computations are required for various scenarios, such as responding to a request, validating a proposal, and revalidating a proposal during a dispute.


```mermaid
flowchart LR;
A[EBO Agent] --> B[Arbitrum RPC];
B --> Oracle & EBORequestCreator & DataEdge;
subgraph block-beta:Chains [Indexed Chains]
C[Chain 1]
D[Chain ...]
E[Chain N]
end
subgraph block-beta:RPC [Data Providers]
F[RPC Nodes]
H[Substreams]
end
A --> block-beta:RPC
block-beta:RPC --> block-beta:Chains
```

## Install
```
$ pnpm install
```

## Usage

```
$ pnpm start
```

## Test

```
$ pnpm test
```

## Contributing

Prophet was built with ❤️ by [Wonderland](https://defi.sucks).

Wonderland is a team of top Web3 researchers, developers, and operators who believe that the future needs to be open-source, permissionless, and decentralized.

[DeFi sucks](https://defi.sucks), but Wonderland is here to make it better.

0 comments on commit 851f98c

Please sign in to comment.