Skip to content

Commit

Permalink
fix readme commands
Browse files Browse the repository at this point in the history
  • Loading branch information
jackchuma committed Nov 11, 2024
1 parent ed94874 commit b1a529d
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 40 deletions.
File renamed without changes.
46 changes: 45 additions & 1 deletion services/go-filler/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,45 @@
# An Example Filler App implemented in Go
# An Example Fulfiller App implemented in Go

## Getting Started

Navigate to the `go-filler` directory:

```bash
cd services/go-filler
```

Install dependencies:

```bash
go mod tidy
```

Spin up the docker containers:

```bash
docker-compose up -d
```

Create a `.env` file (the rpc urls must be websocket):

```txt
ARBITRUM_SEPOLIA_RPC=
BASE_SEPOLIA_RPC=
OPTIMISM_SEPOLIA_RPC=
SEPOLIA_RPC=
MONGO_URI=
```

### Log Fetcher

Run the log fetcher:

```bash
go run ./log-fetcher/cmd
```

Run log fetcher unit tests:

```bash
go test ./log-fetcher/internal/...
```
44 changes: 5 additions & 39 deletions services/go-filler/log-fetcher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,12 @@

## Overview

The Log Fetcher serves as the first component in the RIP-7755 Fulfiller architecture. Its main purpose is to monitor events from `RIP7755Outbox` contracts on supported chains. When it ingests an event representing a cross-chain call request, it first parses the log into an ingestible format. It then validates the request by ensuring all routing information matches pre-defined chain configs for the source / destination chains. It then validates that the reward asset / amount represents a reward that would guarantee profit if this request were accepted by the system. If the request passes validation, the log fetcher passes it along to a Redis queue for further processing.
The Log Fetcher is the initial component in the RIP-7755 Fulfiller architecture. Its primary function is to monitor events emitted by `RIP7755Outbox` contracts across supported blockchain networks. Upon detecting an event that signifies a cross-chain call request, the Log Fetcher parses the log into a format suitable for further processing.

## Getting Started

Navigate to the `log-fetcher` directory:

```bash
cd services/go-filler/log-fetcher
```

Install dependencies:

```bash
go mod tidy
```

Spin up the docker containers:
Next, it performs a validation of the request by checking that all routing information aligns with the pre-defined configurations for both the source and destination chains. Additionally, it ensures that the specified reward asset and amount are sufficient to guarantee a profit if the request is processed by the system.

```bash
docker-compose up -d
```
If the request successfully passes all validation checks, the Log Fetcher forwards it to a MongoDB queue for subsequent processing.

Create a `.env` file (the rpc urls must be websocket):

```txt
ARBITRUM_SEPOLIA_RPC=
BASE_SEPOLIA_RPC=
OPTIMISM_SEPOLIA_RPC=
SEPOLIA_RPC=
MONGO_URI=
```

Run the application:

```bash
go run ./cmd
```

Run unit tests:
## Getting Started

```bash
go test ./internal/...
```
To run the log fetcher, see the [README](../README.md) in the `go-filler` directory.

0 comments on commit b1a529d

Please sign in to comment.