Tbtc Maintainer: Added the maintainer command

[tomaszslabon]

This PR adds a command for launching the maintainer for Bitcoin difficulty.
The relay maintainer can be launched using the command:

KEEP_ETHEREUM_PASSWORD="password" ./keep-client maintainer  --bitcoinDifficulty  --config /Users/tslabon/projekt/keep-core/configs/maintainer.toml --developer

In the future we can add other maintainer tasks and launch the maintainer, e.g.:

KEEP_ETHEREUM_PASSWORD="password" ./keep-client maintainer  --bitcoinDifficulty --spv  --config /Users/tslabon/projekt/keep-core/configs/maintainer.toml --developer

Maintainer uses 3 groups of configuration flags:

• ethereum (url, keyFile, etc.)
• electrum (url)
• maintainer (bitcoinDifficulty, spv, etc.)

All the options can be provided on the command line or using a configuration file or a mix of them.
Here is an example configuration toml file:

[ethereum]
  URL = "ws://127.0.0.1:8546"
  KeyFile = "/path/to/ethereum/data/keystore/UTC--2022-10-03T10-45-23.667111000Z--7ca4c3c109851221b6560c7d4f3917db6d056977"

[bitcoin.electrum]
  URL = "https://blockstream.info/api/"

[tbtc.maintainer]
 BitcoinDifficulty = true

Tested locally.

[lukasz-zimnoch]

I'll open a PR with the bitcoin groundwork soon. Please hold off with the merge of this PR until so.

[lukasz-zimnoch]

The PR with the Bitcoin toys is ready: #3384

[pdyraga]

I tried to test it starting the maintainer with KEEP_ETHEREUM_PASSWORD="password" ./keep-client --config configs/config.1.toml maintainer but nothing is printed to the console and it looks like if the process hanged. What am I doing wrong?

[tomaszslabon]

I tried to test it starting the maintainer with KEEP_ETHEREUM_PASSWORD="password" ./keep-client --config configs/config.1.toml maintainer but nothing is printed to the console and it looks like if the process hanged. What am I doing wrong?

You need to provide the --bitcoinDifficulty flag:

KEEP_ETHEREUM_PASSWORD="password" ./keep-client maintainer  --bitcoinDifficulty  --config /Users/tslabon/projekt/keep-core/configs/maintainer.toml 

Alternatively, you can add:

[tbtc.maintainer]
 BitcoinDifficulty = true

to your config file.

[pdyraga]

I was under the impression that we start all maintainers by default?

[tomaszslabon]

I was under the impression that we start all maintainers by default?

I wanted to leave a TODO for that (once we have more than one maintainer). But now I added launching all maintainer if not option specified in c87ccff.

[pdyraga]

What about naming it just Config? We would have electrum.Config living in pkg/bitcoin/electrum referenced from [bitcoin.electrum] section. I think it all makes sense.

[tomaszslabon]

There is already such a structure in the electrum package and it contains config for electrum (it was added by Kuba and I copied it). It's the structure used by BitcoinConfig. So I cannot rename BitcoinConfig to Config unless I change the name of that structure as well.

[pdyraga]

Right, I think we should have just one config (cc @nkuba) structure named Config:

package electrum

// Config defines the configuration for the Electrum Bitcoin client.
type Config struct {
  // URL to the Electrum server in format: `hostname:port`.
  URL string
}

Based on this conversation, we agreed that we are not configuring Bitcoin but we are configuring Electrum Bitcoin client. The configuration is in [bitcon.electrum] in the config and the structure is in pkg/bitcoin/electrum/config.go.

[tomaszslabon]

If we want to use a nested structure in the config file:

[bitcoin.electrum]
URL = "url.to.electrum:1111"

then the corresponding structure in Golang should also be nested:

type BitcoinConfig struct {
 Electrum Config
}

type Config struct {
 	URL string
}

If we don't use a nested structure, but just a simple non-nested Config structure, then the Viper package that we use for mapping config file to the Golang structure will be unable to read the configuration properly.

[nkuba]

I proposed an update in 40ff528