From 7dcec75430d3d4dffec65c99ce3bd7754be85f11 Mon Sep 17 00:00:00 2001 From: buffalu <85544055+buffalu@users.noreply.github.com> Date: Tue, 16 Jan 2024 20:37:55 -0600 Subject: [PATCH] Update readme build instructions (#96) --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c474e0ec..f0bb5400 100644 --- a/README.md +++ b/README.md @@ -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.