Gateway Startup Arguments

Available regions:

Use these for ofr-host argument. Select the one which is the closest to your region.

Region
Address
Cloud Provider

Frankfurt

frankfurt.solana-v2.blxrbdn.com

Latitude

New York

ny.solana-v2.blxrbdn.com

Latitude

Tokyo

tokyo.solana-v2.blxrbdn.com

Latitude

Amsterdam

amsterdam.solana-v2.blxrbdn.com

servers.com

Please see below for full lists of startup arguments you may use to configure the Gateway.

Required Gateway Arguments

Parameter

Description

Default

Example

auth-header

Must be provided (Authorization required)

ZDE0ZTVmZTYtNjBhOC00NTUzLTliZjQtNTU0ODE3MjNlMDRlOmRlYTJiM3F3cWJnNHJ2ZWc0MjQydmJlM2EzcnUyanQ2

tvu-port

Port of your Solana TVU port. Run solana-validator contact-info (or agave-validator contact-info depending on the client) to find it.

8001

8001

ofr-host

Manually specifies the closest relay of the OFR via hostname. See the list of available relays above and select the one geographically closest to your node to minimize latency.

N/A

ny.solana-v2.blxrbdn.com

network-interface

The outbound network interface used for communication. Run ifconfig (Linux/macOS) or ipconfig (Windows) to find the correct interface. Select the one with an inet value that matches your machine’s public IP.

N/A

eno1

port

The gateway receives shreds through OFR by communicating with bloXroute's OFR Relay, which uses port 18888 by default. Please make sure the port is open Inbound/Outbound.

18888

18888

Optional Gateway Arguments

Parameter

Description

Default

Example

log-level

Sets the log level of the Gateway stdout.​Users should change log-file-level only if a detailed log is required. [Options: TRACE, DEBUG, INFO, WARN, ERROR].

INFO

DEBUG

log-file-level

The log level of the log file (found in the logs directory). Users should change log-file-level only if a detailed log is required. [Options: TRACE, DEBUG, INFO, WARN, ERROR].

DEBUG

DEBUG (can be set to TRACE, INFO, WARN, or ERROR depending on verbosity needs)

broadcast-addresses

list of ip:port of addresses to send shreds to

Empty (must be manually specified if needed)

92.168.0.254:1234,

122.168.0.254:1235

broadcast-from-ofr-only

true for sending only shreds from ofr to addresses provided in broadcast-addresses, false to send all shreds

false

true/false

no-validator

Specifies if gateway should run without node. This flag is available to users with Enterprise Elite plan or above.

false

true/false

run-http-server

run http server to submit txs to trader api

false

true/false

http-port

http port for submitting txs to trader api

8080

8080

log-max-size

Max log file size in MB

100

100

log-max-backups

Max log file backups

10

10

log-max-age

Max days to keep log file

10

10

dynamic-port-range

Range to use for dynamically assigned ports for shreds propagation over UDP, should not conflict with solana/agave dynamic port range

18889-19888

18889-19888

staked-node

If this flag is enabled while running a staked node, the gateway will not send shreds that have already been received from the staked node

false

true/false

tx-submission-only

If enabled, the gateway will neither send nor receive any shreds from the OFR network. It may be set to utilize transaction submission directly to OFR via the http API

false

true/false

Note: The --network=host tag is a required startup parameter for the Docker command. It gives the container access to all network interfaces on the host machine.

Last updated