Skip to content

Commit

Permalink
small updates
Browse files Browse the repository at this point in the history
  • Loading branch information
adamewozniak committed Sep 4, 2024
1 parent c1f38d2 commit fbee0bc
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions relayer/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,24 @@

Ojo Relayer is a service that anyone can run to periodically push price feeds from the Ojo blockchain to an Ojo contract deployed to an EVM chain. This service is normally run by the Ojo core team, but anyone can run it.

## Quick Start

1. Install the Ojo Relayer
2. Set up your configuration file
3. Run the relayer

For detailed instructions, see the [Installation](#installation), [Configuration](#configuration), and [Usage](#usage) sections.

## Installation

Use the `make install` command to install the Ojo Relayer.
To install the Ojo Relayer:

1. Ensure you have Go 1.21 or later installed.
2. Clone the repository: `git clone https://github.com/ojo-network/ojo-evm.git`
3. Navigate to the project directory: `cd ojo-evm/relayer`
4. Run `make install`

Alternatively, you can see our recent [releases](https://github.com/ojo-network/ojo-evm/releases) to see if there is a binary.
Alternatively, you can download a pre-built binary from our recent [releases](https://github.com/ojo-network/ojo-evm/releases).

## Compatibility

Expand Down Expand Up @@ -112,3 +125,10 @@ default = "1000000"
```

How much each transaction will cost in AXL is different for each chain, and will vary with the usage of each chain (for example, pushing prices to Ethereum is more expensive than Arbitrum).

## Running

To run the relayer, you can use the following commands:

`relayer config.toml`
`relayer version`

0 comments on commit fbee0bc

Please sign in to comment.