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

Parameters

Parameter
Description
Options/ Additional notes
Default
Example

enodes

Enode of the blockchain node. Example: enode://<node_public_key>@<ip>:<port>

Optional when using Standalone Gateway add-on.

multiaddr

Node address using p2p nodes format . Example: /ip4/54.167.71.57/tcp/13000/p2p/16Uiu2HAkvxQyb62x55RrhxxYHm1ZJFMFFFhCZ67YVmTcS6kJwqQR

Optional when using Standalone Gateway add-on. multiaddr and enr cannot be used at the same time because they represent the same node.

blockchain_network

Blockchain network name.

[Optional]

node_validation

Transaction is sent to the blockchain node for validation, and the Gateway returns any error message received in response.

[Optional]

private-key

Private key for encrypted communication with BSC node

[Optional]

N/A

294549…97dfba3

ws

Enables WebSockets RPC server

[Optional]

false

true

ws-port

WebSockets server port

[Optional]

28333

28334

relay-ip

(alias relays )

Specifies relay IP for the gateway to connect to

Available with Private Regions add-on

N/A

13.213.141.24

log-file-level

The log level of the log file (found in the logs directory). Examples:

TRACE, DEBUG, INFO, WARN/WARNING, ERROR, FATAL, PANIC

[Optional]

INFO

TRACE

log-max-size

Maximum size of a log file (in megabytes) before it is rotated

[Optional]

100

50

log-max-age

Maximum age of an old log file (in days) before it is removed

[Optional]

10

5

log-max-backups

Maximum number of old log files to keep

[Optional]

10

5

port

The external port, which the gateway uses to exchange messages with the relay network

[Optional]

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.

[Optional]. Use http://checkip.dyndns.org/arrow-up-right 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

[Optional]. 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

beacon-api-uri

Beacon APIarrow-up-right uri used to request blocks using consensus clients standard.

It requires additional configuration of a consensus client to expose Beacon API.

registration-cert-dir

File path of the private Gateway certificate - It can be a local or remote directory.

[Optional]

/ssl

/usr/local/ssl

txtrace

Enables TxTrace logging

[Optional]

false

true

txtrace-max-file-size

Maximum file size (in megabytes) for TxTrace log files

[Optional]

100

50

txtrace-max-files

Maximum number of TxTrace log files

[Optional]

10

5

disable-profiling

Disables the pprof http server

[Optional]

false

true

blocks-only

Send only paid blocks and transactions to node

[Optional]

false

true

data-dir

Directory to store configuration, status, SSL certificates, and log files

[Optional]

/datadir

/home/[user]/gateway

grpc

Enables gRPC server

[Optional]

false

true

grpc-host

gRPC server host ip address

[Optional]

127.0.0.1

0.0.0.0

grpc-port

gRPC server port

[Optional]

5001

5002

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).

[Optional]

false

true

enable-blockchain-rpc

Set this flag to enable the gateway to serve as a proxy for your blockchain RPC node.

[Optional]. Find a detailed guide to using this feature herearrow-up-right.

false

true

tx-include-sender-in-feed

Set this flag if you want extract sender of the transaction into Websocket or gRPC feed.

[Optional]. 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

Last updated