Command reference

The Beamer software currently supports two commands:

beamer agent

The agent command will run a Beamer agent and provide liquidity for the bridge.

Command-line option

Description

--account-path PATH

Path to the account keyfile.

--account-password PASSWORD

The password needed to unlock the account.

--deployment-dir DIR

The directory containing contract deployment files.

--fill-wait-time TIME

Time in seconds to wait for a fill event before challenging a false claim. Default: 120.

--confirmation-blocks BLOCKS

Number of confirmation blocks to consider the block ready for processing. Default: 0.

--unsafe-fill-time TIME

Time in seconds before request expiry, during which the agent will consider it unsafe to fill and ignore the request. Default: 600. For more info: Unsafe Fill Time

--log-level LEVEL

Logging level, one of debug, info, warning, error, critical. Default: info.

--metrics-prometheus-port PORT

Provide Prometheus metrics on the specified port.

--source-chain NAME

Name of the source chain. Deprecated and will be removed. No longer needed because the agent supports multiple chain pairs.

--target-chain NAME

Name of the target chain. Deprecated and will be removed. No longer needed because the agent supports multiple chain pairs.

--chain NAME=URL

Associate a JSON-RPC endpoint URL with chain NAME. May be given multiple times. Example:

--chain foo=http://foo.bar:8545

--poll-period

Time in seconds which is waited before new events are fetched from the chains after the last fetch. If a value for a specific chain is provided in the config file, it takes precedence for this chain. Default: 5.0.

beamer health-check

The health-check command scans the contracts for the emitted events and analyzes whether there is a missed fill, unclaimed transaction or a challenge game going on. In addition to this, if an agent-address is provided in the config file, the final notification will also include the liquidity on all chains for all the tokens specified inside the configuration file for the provided agent address. The command will notify the user by sending everything either to Telegram or RocketChat.

Command-line option

Description

--config PATH

Path to the config file with chains configuration. See Health Check configuration for available options.

--log-level LEVEL

Logging level, one of debug, info, warning, error, critical. Default: error.