Configuration

Learn how to configure and run your plasma node.

Sections in this article

Configuration Files

plasma can be configured using command-line flags or a configuration YAML file. Since you’ll need to specify most of the global options with every invocation of the plasma command, we strongly recommend using a configuration file. Below, see an example config for a root node:

db: "./database"
node-url: "http://localhost:9545"
contract-addr: "0xf25186b5081ff5ce73482ad761db0eb0d25abfbf"
private-key: "c87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3"

If you used one of our pre-built binaries to install Plasma, an example configuration file is placed in /etc/plasma/config.yaml.

To use a configuration file, pass it in using the --config flag like this:

$ plasma --config ./local-config.yaml start

Available Options

Here’s a description of what each configuration option does:

  • db
    • Sets the location for plasma’s database. Default to ~/.plasma.
  • node-url
    • Sets the URL to a running Ethereum client, like Geth or Parity. If you set use-geth to false, this can be an Infura URL.
  • rest-port
  • contract-addr
    • The address of the Plasma smart contract. plasma will infer the active Ethereum network by querying the Ethereum client located at node-url.
  • private-key
    • Your Ethereum private key. Used to sign transactions.

Some Plasma commands also accept additional configuration parameters via command-line flags. To view documentation on each of those, add --help to the end of your command to view the manual in your terminal.