Skip to content
You are reading Web3Signer development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.

Start Web3Signer

Note

This documentation has been updated in line with the name changes recommended by the Ethereum Foundation. The execution layer is formerly “Ethereum 1.0.” The consensus layer is formerly “Ethereum 2.0.”

Prerequisites:

Web3Signer supports execution layer clients, consensus layer clients, and Filecoin platforms, so you must specify the signing mode, and the location of the signing key configuration files when starting Web3Signer.

web3signer --key-store-path=/Users/me/keyFiles/ eth1
web3signer --key-store-path=/Users/me/keyFiles/ eth2 --slashing-protection-db-url="jdbc:postgresql://localhost/web3signer" --slashing-protection-db-username=postgres --slashing-protection-db-password=password
web3signer --key-store-path=/Users/me/keyFiles/ filecoin

In the command line:

  • Use the --key-store-path option to specify the location of the signing key configuration files.
  • Specify the subcommand to indicate which signing mode to use. Valid subcommands are eth1, eth2, and filecoin. You can only specify one signing mode when starting Web3Signer.

Consensus layer considerations

Consensus layer slashing protection is enabled by default, and you must specify the details the slashing protection database, or disable slashing protection using the --slashing-protection-db-enabled command line option.

Note

Web3Signer also allows you to bulk load consensus layer signing keys stored in Azure Key Vault.

Start the client, for example Teku by specifying the Web3Signer details.

Important

If Teku connects to a network other than mainnet, then the --network option must be specified, and it must match the network used by the Teku client.

Confirm Web3Signer is running

Use the upcheck endpoint to confirm Web3Signer is connected and running.

Example

curl -X GET http://localhost:9000/upcheck
200 OK
Questions or feedback? You can discuss issues and obtain free support on Web3Signer Discord channel.
For paid professional support by Consensys, contact us at [email protected].