The following parameters are required for Gateway operation. Each argument is prefixed with two dashes. Parameters are indicated by chevrons, e.g., “< parameter >”, and defaults are noted when available.
Blockchain protocol of the blockchain node
IP address of the blockchain node. It is required unless using the enode argument
Enode of the blockchain node. It is required unless using the blockchain-ip argument
(Ethereum only) Node ID of your Ethereum node. You can retrieve your node ID using the Ethereum rpc command admin.nodeInfo
Below is a list of optional command line arguments accepted by the bloXroute Gateway. Each argument is prefixed with two dashes and is followed by a parameter where applicable. For example:
The blockchain node port.
Ethereum: 30303, Bitcoin Cash: 8333
Blockchain network of the blockchain node the Gateway will connect to. This is mainly used for users that are using the bloXroute testnet. To use something other than the Mainnet, please contact bloXroute support for instructions.
Public IP address of the Gateway. Please specify your IP address using external-ip if the Gateway cannot access the url “http://checkip.dyndns.org/” to automatically detect its IP address.
External port is the port on which the Gateway can receive external connections from other Gateways in the network. If using the enode parameter, the port specified in the enode overrides this one.
Gateway RPC server host.
Gateway RPC server port.
Location of the public Gateway certificate to allow it to connect to the BDN. Do not change these without instructions from bloXroute Support.
Location of the private Gateway certificate for accounts that registered and obtained private certificates. It can be a local or remote directory. The format is URI
Continent where the Gateway is running. Valid continent values are NA (North America), SA (South and Central America), EU (Europe), OC (Oceania), AS (Asia), AF (Africa), AN (Antarctica).
The country of the Gateway.
The datacenter region of the Gateway. This helps the Gateway connecting to the fastest relay.
Hostname the Gateway is running on. If not specified, the Gateway will query the operating system for hostname
Path to store configuration, status and log files.
~/Library/bloXroute on Mac, ~/bloXroute on Linux
Format of the log output. May be set to JSON or PLAIN
Set the log level of the Gateway. Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, STATS, OFF. Default is INFO
bloXroute Control Plane endpoint to the Mainnet URL. This parameter should only be used by users who connect to the bloXroute testnet. Please contact bloXroute support for instructions.
Maximum size of transactions to keep in memory pool (MB)
Number of threads to use when running tasks on a concurrent thread pool when the extension module is active. The default is determined as the number of CPUs minus 1.
[Number of CPUs] – 1
In order to efficiently iterate the mempool concurrently, the Gateway splits into buckets. This parameter sets the size of each bucket of the transaction mempool.
Optional gateway peer ip/ports that Gateway should always be connected to. Should be in the format ip1:port1,ip2:port2,…
Minimum number of peer Gateways, when connection number falls below this number, the Gateway contacts Control Plane for additional peers.
When true, the Gateway will exit if the connection to the blockchain node is down for more than 30 minutes.
Enable new transaction feed using ipc protocol.
The file that will be used by the new transaction feed with the ipc protocol.
Enable new transaction feed using web socket protocol.
New transaction feed web socket server host.
New transaction feed web socket server port.
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 provided.
Genesis block hash of Ethereum network. Optional, a default is provided.
Ethereum websockets endpoint for syncing transaction content. You need to configure your Ethereum node to enable the Ethereum websockets . For more information see Enable Ethereum Websocket.
Blockchain protocol version is provided to the blockchain node to indicate functionality the Gateway supports as a peer.
Blockchain nonce is a number that is used during the Gateway handshake with a bitcoin node. If none is provided, a random number is used.