Startup Arguments

The full lists of startup arguments you may use to configure your Local Gateway.

The following arguments can be used to configure your Local Gateway, regardless of the installation method chosen

Required Gateway Arguments

Parameter	Description	Example	Additional notes
enodes	Enode of the blockchain node	enode://<node_public_key>@<ip>:<port>	Optional for Enterprise-Elite users or above
multiaddr	Node address using p2p nodes format	/ip4/54.167.71.57/tcp/13000/p2p/16Uiu2HAkvxQyb62x55RrhxxYHm1ZJFMFFFhCZ67YVmTcS6kJwqQR	Optional for non-Ethereum network or gateway working without blockchain node

multiaddr has replaced enr as the argument to indicate the node address because it is human-readable. It has the following format: /ip4/<IPv4_NETWORK_ADDRESS>/tcp/<LISTENING_PORT>/p2p/<NODE_ID>

multiaddr and enr cannot be used at the same time because they represent the same node.

Optional Gateway Arguments

Parameter	Description	Options/ Additional notes	Default	Example
blockchain-network	Blockchain network the gateway will connect to	Mainnet, BSC-Mainnet, Polygon-Mainnet	Mainnet	BSC-Mainnet
private-key	Private key for encrypted communication with Ethereum node	This argument is optional, and the Gateway will generate a random private key if one is not provide.	N/A	294549…97dfba3
ws	Enables WebSockets RPC server		false	true
ws-port	WebSockets server port		28333	28334
relay-ip (alias relays )	Specifies relay IP for the gateway to connect to	Ultra users can provide a list of relays in order to connect to backbone and edge relays from a singular gateway	N/A	13.213.141.24
log-file-level	The log level of the log file (found in the logs directory)	TRACE, DEBUG, INFO, WARN/WARNING, ERROR, FATAL, PANIC	INFO	TRACE
log-max-size	Maximum size of a log file (in megabytes) before it is rotated		100	50
log-max-age	Maximum age of an old log file (in days) before it is removed		10	5
log-max-backups	Maximum number of old log files to keep		10	5
port	The external port, which the gateway uses to exchange messages with the relay network		1809	1801
external-ip	The public IP address of the gateway - Please specify your IP address using external-ip if the gateway cannot access the url.	Use http://checkip.dyndns.org/ to automatically detect IP address.	Automatically tries to find the IP address of the machine	24.8.18.29
eth-ws-uri	Ethereum WebSockets endpoint for syncing block and transaction content	You need to configure your Ethereum node to enable the Ethereum WebSockets. For more information see Enable Ethereum Websocket.	N/A	ws://127.0.0.1:8546
prysm-grpc-uri	Ethereum Mainnet Prysm gRPC uri for getting blocks faster		N/A	IP:Port
beacon-api-uri	Beacon API uri used to request blocks using consensus clients standard.	It requires additional configuration of a consensus client to expose Beacon API.	N/A	IP:Port
registration-cert-dir	File path of the private Gateway certificate - It can be a local or remote directory.		/ssl	/usr/local/ssl
txtrace	Enables TxTrace logging		false	true
txtrace-max-file-size	Maximum file size (in megabytes) for TxTrace log files		100	50
txtrace-max-files	Maximum number of TxTrace log files		10	5
disable-profiling	Disables the pprof http server		false	true
blocks-only	Send only paid blocks and transactions to node		false	true
data-dir	Directory to store configuration, status, SSL certificates, and log files		/datadir	/home/[user]/gateway
grpc	Enables gRPC server		false	true
grpc-host	gRPC server host ip address		127.0.0.1	0.0.0.0
grpc-port	gRPC server port		5001	5002
mode	Set the gateway mode.	Refer to Gateway Modes for explanation	bdn	flashbots
all-txs	Set this flag to propagate all transactions from the BDN to the connected node (warning: may result in worse performance and propagation times).		false	true
enable-blockchain-rpc	Set this flag to enable the gateway to serve as a proxy for your blockchain RPC node.	Find a detailed guide to using this feature here.	false	true
polygon-heimdall-endpoints	Set this flag to pass TCP endpoints to run the Polygon Heimdall server.	This argument supports multiple endpoints: "http://host1:port1,http://host2:port2". Please note that WS connection to Polygon bor node is also required when Heimdall node connection is active.	N/A	http://host:port
tx-include-sender-in-feed	Set this flag if you want extract sender of the transaction into Websocket or gRPC feed.	From field is deprecated and will be removed in the future. This made to improve performance and shift responsibility to feed client. In versions up to v2.128.14.1 it is true by default, after it will be false, which means you need to set it explicitly if you want to get from.	true	--tx-include-sender-in-feed=false