-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme build instructions (#96)
- Loading branch information
Showing
1 changed file
with
16 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,18 @@ | ||
# jito-relayer | ||
Jito Relayer acts as a transaction processing unit (TPU) proxy. | ||
It filters and verifies transactions for multiple authenticated validators on a separate server to ensure validators can devote resources to executing transactions. | ||
# Jito Relayer | ||
Jito Relayer acts as a transaction processing unit (TPU) proxy for Solana validators. | ||
|
||
# Building | ||
```shell | ||
# pull submodules to get protobuffers required to connect to Block Engine and validator | ||
$ git submodule update -i -r | ||
# build from source | ||
$ cargo b --release | ||
``` | ||
|
||
# Releases | ||
There are two options for running the relayer from releases: | ||
- Download the most recent release on the [releases](https://github.com/jito-foundation/jito-relayer/releases) page. | ||
- (Not recommended for production): One can download and run Docker containers from the Docker [registry](https://hub.docker.com/r/jitolabs/jito-transaction-relayer). | ||
|
||
# Running a Relayer | ||
See https://jito-foundation.gitbook.io/mev/jito-relayer/running-a-relayer for setup and usage instructions. |