Running OPinit Bots

Weave provides a streamlined way to configure and run OPinit Bots (executor and challenger) for your rollup.

Setting up

weave opinit init

This command will guide you through selecting the bot type (executor or challenger), configuring bot keys if needed, and setting up the bot’s configuration.

You can also specify the bot type directly:

Executor

weave opinit init executor

To setup Executor from the config file without going through the interactive setup process, use the --with-config flag together with either --generate-key-file or --key-file flags.

For example, to let Weave generate Executor’s keys for you, use the following command:

weave opinit init executor --with-config <path-to-config-file> --generate-key-file

To provide your own keys, use the following command:

weave opinit init executor --with-config <path-to-config-file> --key-file <path-to-key-file>

Available Flags

--opinit-dir · string · default: "~/.opinit"

The directory to store OPinit bots data and configuration files

--minitia-dir · string · default: "~/.minitia"

Path to the rollup directory that contains the rollup’s artifacts. This is useful when you are setting up OPinit bots for a rollup that you have just launched, as it can use the artifacts from the rollup to setup the bots.

--with-config · string

Path to the rollup config file. Use this flag to setup Executor from a config file without going through the interactive setup process.

--generate-key-file · boolean · default: "false"

Whether to generate Executor’s keys during the setup process. Can only be used when --with-config flag is provided. Conflicts with --key-file flag.

--key-file · string

Path to the Executor’s keys file. Can only be used when --with-config flag is provided. Conflicts with --generate-key-file flag.

Challenger

weave opinit init challenger

To setup Challenger from the config file without going through the interactive setup process, use the --with-config flag together with either --generate-key-file or --key-file flags.

For example, to let Weave generate Challenger’s keys for you, use the following command:

weave opinit init challenger --with-config <path-to-config-file> --generate-key-file

To provide your own OPinit bot keys, use the following command:

weave opinit init challenger --with-config <path-to-config-file> --key-file <path-to-key-file>

Available Flags

--opinit-dir · string · default: "~/.opinit"

The directory to store OPinit bots data and configuration files

--minitia-dir · string · default: "~/.minitia"

Path to the rollup directory that contains the rollup’s artifacts. This is useful when you are setting up OPinit bots for a rollup that you have just launched, as it can use the artifacts from the rollup to setup the bots.

--with-config · string

Path to the rollup config file. Use this flag to setup Challenger from a config file without going through the interactive setup process.

--generate-key-file · boolean · default: "false"

Whether to generate Challenger’s keys during the setup process. Can only be used when --with-config flag is provided. Conflicts with --key-file flag.

--key-file · string

Path to the Challenger’s keys file. Can only be used when --with-config flag is provided. Conflicts with --generate-key-file flag.

Managing Keys

To modify bot keys, use the following command to either generate new keys or restore existing ones:

weave opinit setup-keys

Available Flags

--opinit-dir · string · default: "~/.opinit"

The directory to store OPinit bots data and configuration files

--minitia-dir · string · default: "~/.minitia"

Path to the rollup directory that contains the rollup’s artifacts. This is useful when you are setting up OPinit bots for a rollup that you have just launched, as it can use the artifacts from the rollup to setup the bots.

For Executor bot to work, Bridge Executor, Output Submitter, and Batch Submitter keys must be set up.

For Challenger bot to work, Challenger key must be set up.

For rollups with built-in oracle enabled, Oracle Executor key must be set up.

Resetting OPinit Bots

Executor

Reset Executor’s database. This will clear all the data stored in the Executor’s database (the configuration files are not affected).

weave opinit reset executor

Challenger

Reset Challenger’s database. This will clear all the data stored in the Challenger’s database (the configuration files are not affected).

weave opinit reset challenger

Running OPinit Bots

Executor

Start

weave opinit start executor

Available Flags

--detach, -d · boolean · default: "false"

Whether to run the Executor in the background.

Stop

weave opinit stop executor

Restart

weave opinit restart executor

View logs

weave opinit log executor

Available Flags

-n · number · default: "100"

The number of lines to display from the end of the Executor’s logs.

Challenger

Start

weave opinit start challenger

Available Flags

--detach, -d · boolean · default: "false"

Whether to run the node in the background.

Stop

weave opinit stop challenger

Restart

weave opinit restart challenger

View logs

weave opinit log challenger

Available Flags

-n · number · default: "100"

The number of lines to display from the end of the logs.

Help

To see all the available commands:

weave opinit --help