Initial implementation of app-specific actions

cmd/start.go

@@ -3,9 +3,10 @@ package cmd
 import (
 	"context"
 	"fmt"
-	"github.com/keep-network/keep-core/pkg/diagnostics"
 	"time"
 
+	"github.com/keep-network/keep-core/pkg/diagnostics"
+
 	"github.com/keep-network/keep-core/pkg/chain"
 	"github.com/keep-network/keep-core/pkg/metrics"
 	"github.com/keep-network/keep-core/pkg/net"
@@ -19,11 +20,12 @@ import (
 	"github.com/keep-network/keep-core/pkg/net/libp2p"
 	"github.com/keep-network/keep-core/pkg/net/retransmission"
 	"github.com/keep-network/keep-core/pkg/operator"
-	"github.com/keep-network/keep-ecdsa/pkg/firewall"
 
 	"github.com/keep-network/keep-ecdsa/internal/config"
 	"github.com/keep-network/keep-ecdsa/pkg/chain/ethereum"
 	"github.com/keep-network/keep-ecdsa/pkg/client"
+	"github.com/keep-network/keep-ecdsa/pkg/extensions/tbtc"
+	"github.com/keep-network/keep-ecdsa/pkg/firewall"
 
 	"github.com/urfave/cli"
 )
@@ -168,6 +170,8 @@ func Start(c *cli.Context) error {
 	)
 	logger.Debugf("initialized operator with address: [%s]", ethereumKey.Address.String())
 
+	initializeExtensions(ctx, config.Extensions, ethereumChain)
+
 	initializeMetrics(ctx, config, networkProvider, stakeMonitor, ethereumKey.Address.Hex())
 	initializeDiagnostics(config, networkProvider)
 
@@ -183,6 +187,35 @@ func Start(c *cli.Context) error {
 	}
 }
 
+func initializeExtensions(
+	ctx context.Context,
+	config config.Extensions,
+	ethereumChain *ethereum.EthereumChain,
+) {
+	if len(config.TBTC.TBTCSystem) > 0 {
+		tbtcEthereumChain, err := ethereum.WithTBTCExtensions(
+			ethereumChain,
+			config.TBTC.TBTCSystem,
+		)
+		if err != nil {
+			logger.Errorf(
+				"could not initialize tbtc chain extensions: [%v]",
+				err,
+			)
+			return
+		}
+
+		err = tbtc.InitializeExtensions(ctx, tbtcEthereumChain)
+		if err != nil {
+			logger.Errorf(
+				"could not initialize tbtc extensions: [%v]",
+				err,
+			)
+			return
+		}
+	}
+}
+
 func initializeMetrics(
 	ctx context.Context,
 	config *config.Config,

configs/config.toml.SAMPLE

@@ -108,4 +108,9 @@
 # The port on which the `/diagnostics` endpoint will be available can be
 # customized below.
 # [Diagnostics]
-	# Port = 8081
+	# Port = 8081
+
+# Uncomment to enable application-specific extensions.
+# [Extensions.TBTC]
+	# TBTCSystem = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
+

go.mod

@@ -18,8 +18,9 @@ require (
 	github.com/gogo/protobuf v1.3.1
 	github.com/google/gofuzz v1.1.0
 	github.com/ipfs/go-log v1.0.4
-	github.com/keep-network/keep-common v1.2.1-0.20201002105641-e04cc579ff66
+	github.com/keep-network/keep-common v1.2.1-0.20201015091820-496b0c87d6f5
 	github.com/keep-network/keep-core v1.3.0
+	github.com/keep-network/tbtc v1.1.1-0.20201019112958-4337c22f085f
 	github.com/pkg/errors v0.9.1
 	github.com/urfave/cli v1.22.1
 )

go.sum

@@ -333,10 +333,12 @@ github.com/keep-network/go-libp2p-bootstrap v0.0.0-20200423153828-ed815bc50aec h
 github.com/keep-network/go-libp2p-bootstrap v0.0.0-20200423153828-ed815bc50aec/go.mod h1:xR8jf3/VJAjh3nWu5tFe8Yxnt2HvWsqZHfGef1P5oDk=
 github.com/keep-network/keep-common v1.2.0 h1:hVd2tTd7vL+9CQP5Ntk5kjs+GYvkgrRNBcNvTuhHhVk=
 github.com/keep-network/keep-common v1.2.0/go.mod h1:emxogTbBdey7M3jOzfxZOdfn139kN2mI2b2wA6AHKKo=
-github.com/keep-network/keep-common v1.2.1-0.20201002105641-e04cc579ff66 h1:x/9fra2wLrBDhS8LOQztFajoM2q13FgBN5jFiqBGBog=
-github.com/keep-network/keep-common v1.2.1-0.20201002105641-e04cc579ff66/go.mod h1:emxogTbBdey7M3jOzfxZOdfn139kN2mI2b2wA6AHKKo=
+github.com/keep-network/keep-common v1.2.1-0.20201015091820-496b0c87d6f5 h1:HCQv0+3IhaH1zvRQ2cAinKK+HJCASI41EpZuUMKD278=
+github.com/keep-network/keep-common v1.2.1-0.20201015091820-496b0c87d6f5/go.mod h1:emxogTbBdey7M3jOzfxZOdfn139kN2mI2b2wA6AHKKo=
 github.com/keep-network/keep-core v1.3.0 h1:7Tb33EmO/ntHOEbOiYciRlBhqu5Ln6KemWCaYK0Z6LA=
 github.com/keep-network/keep-core v1.3.0/go.mod h1:1KsSSTQoN754TrFLW7kLy50pOG2CQ4BOfnJqdvEG7FA=
+github.com/keep-network/tbtc v1.1.1-0.20201019112958-4337c22f085f h1:oRSWqLvA1CU2Eb/9t8Nr8Ab13pQj0HbhNlfXPUGIPR0=
+github.com/keep-network/tbtc v1.1.1-0.20201019112958-4337c22f085f/go.mod h1:qokmMoT1zPzGN5rZaew40JJyedXORnO4jz6LoVJsgrU=
 github.com/keep-network/toml v0.3.0 h1:G+NJwWR/ZiORqeLBsDXDchYoL29PXHdxOPcCueA7ctE=
 github.com/keep-network/toml v0.3.0/go.mod h1:Zeyd3lxbIlMYLREho3UK1dMP2xjqt2gLkQ5E5vM6K38=
 github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q=

internal/config/config.go

@@ -27,6 +27,7 @@ type Config struct {
 	TSS                    tss.Config
 	Metrics                Metrics
 	Diagnostics            Diagnostics
+	Extensions             Extensions
 }
 
 // SanctionedApplications contains addresses of applications approved by the
@@ -70,6 +71,16 @@ type Diagnostics struct {
 	Port int
 }
 
+// Extensions stores app-specific extensions configuration.
+type Extensions struct {
+	TBTC TBTC
+}
+
+// TBTC stores configuration related with TBTC-specific extensions.
+type TBTC struct {
+	TBTCSystem string
+}
+
 // ReadConfig reads in the configuration file in .toml format. Ethereum key file
 // password is expected to be provided as environment variable.
 func ReadConfig(filePath string) (*Config, error) {

pkg/chain/ethereum/connect.go

@@ -14,7 +14,6 @@ import (
 	"github.com/keep-network/keep-common/pkg/chain/ethereum"
 	"github.com/keep-network/keep-common/pkg/chain/ethereum/blockcounter"
 	"github.com/keep-network/keep-common/pkg/chain/ethereum/ethutil"
-	eth "github.com/keep-network/keep-ecdsa/pkg/chain"
 	"github.com/keep-network/keep-ecdsa/pkg/chain/gen/contract"
 )
 
@@ -60,7 +59,7 @@ type EthereumChain struct {
 
 // Connect performs initialization for communication with Ethereum blockchain
 // based on provided config.
-func Connect(accountKey *keystore.Key, config *ethereum.Config) (eth.Handle, error) {
+func Connect(accountKey *keystore.Key, config *ethereum.Config) (*EthereumChain, error) {
 	client, err := ethclient.Dial(config.URL)
 	if err != nil {
 		return nil, err

pkg/chain/ethereum/tbtc.go

@@ -0,0 +1,153 @@
+package ethereum
+
+import (
+	"fmt"
+	"math/big"
+
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/keep-network/keep-common/pkg/subscription"
+	"github.com/keep-network/tbtc/pkg/chain/ethereum/gen/contract"
+)
+
+// TBTCEthereumChain represents an Ethereum chain handle with
+// TBTC-specific capabilities.
+type TBTCEthereumChain struct {
+	*EthereumChain
+
+	tbtcSystemContract *contract.TBTCSystem
+}
+
+// WithTBTCExtensions extends the Ethereum chain handle with
+// TBTC-specific capabilities.
+func WithTBTCExtensions(
+	ethereumChain *EthereumChain,
+	tbtcSystemContractAddress string,
+) (*TBTCEthereumChain, error) {
+	if !common.IsHexAddress(tbtcSystemContractAddress) {
+		return nil, fmt.Errorf("incorrect tbtc system contract address")
+	}
+
+	tbtcSystemContract, err := contract.NewTBTCSystem(
+		common.HexToAddress(tbtcSystemContractAddress),
+		ethereumChain.accountKey,
+		ethereumChain.client,
+		ethereumChain.nonceManager,
+		ethereumChain.miningWaiter,
+		ethereumChain.transactionMutex,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	return &TBTCEthereumChain{
+		EthereumChain:      ethereumChain,
+		tbtcSystemContract: tbtcSystemContract,
+	}, nil
+}
+
+// OnDepositCreated installs a callback that is invoked when an
+// on-chain notification of a new deposit creation is seen.
+func (tec *TBTCEthereumChain) OnDepositCreated(
+	handler func(depositAddress string),
+) (subscription.EventSubscription, error) {
+	return tec.tbtcSystemContract.WatchCreated(
+		func(
+			DepositContractAddress common.Address,
+			KeepAddress common.Address,
+			Timestamp *big.Int,
+			blockNumber uint64,
+		) {
+			handler(DepositContractAddress.Hex())
+		},
+		func(err error) error {
+			return fmt.Errorf("watch deposit created failed: [%v]", err)
+		},
+		nil,
+		nil,
+	)
+}
+
+// OnDepositRegisteredPubkey installs a callback that is invoked when an
+// on-chain notification of a deposit's pubkey registration is seen.
+func (tec *TBTCEthereumChain) OnDepositRegisteredPubkey(
+	handler func(depositAddress string),
+) (subscription.EventSubscription, error) {
+	return tec.tbtcSystemContract.WatchRegisteredPubkey(
+		func(
+			DepositContractAddress common.Address,
+			SigningGroupPubkeyX [32]uint8,
+			SigningGroupPubkeyY [32]uint8,
+			Timestamp *big.Int,
+			blockNumber uint64,
+		) {
+			handler(DepositContractAddress.Hex())
+		},
+		func(err error) error {
+			return fmt.Errorf("watch deposit created failed: [%v]", err)
+		},
+		nil,
+	)
+}
+
+// KeepAddress returns the underlying keep address for the
+// provided deposit.
+func (tec *TBTCEthereumChain) KeepAddress(
+	depositAddress string,
+) (string, error) {
+	deposit, err := tec.getDepositContract(depositAddress)
+	if err != nil {
+		return "", err
+	}
+
+	keepAddress, err := deposit.KeepAddress()
+	if err != nil {
+		return "", err
+	}
+
+	return keepAddress.Hex(), nil
+}
+
+// RetrieveSignerPubkey retrieves the signer public key for the
+// provided deposit.
+func (tec *TBTCEthereumChain) RetrieveSignerPubkey(
+	depositAddress string,
+) error {
+	deposit, err := tec.getDepositContract(depositAddress)
+	if err != nil {
+		return err
+	}
+
+	transaction, err := deposit.RetrieveSignerPubkey()
+	if err != nil {
+		return err
+	}
+
+	logger.Debugf(
+		"submitted RetrieveSignerPubkey transaction with hash: [%x]",
+		transaction.Hash(),
+	)
+
+	return nil
+}
+
+func (tec *TBTCEthereumChain) getDepositContract(
+	address string,
+) (*contract.Deposit, error) {
+	if !common.IsHexAddress(address) {
+		return nil, fmt.Errorf("incorrect deposit contract address")
+	}
+
+	depositContract, err := contract.NewDeposit(
+		common.HexToAddress(address),
+		tec.accountKey,
+		tec.client,
+		tec.nonceManager,
+		tec.miningWaiter,
+		tec.transactionMutex,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	return depositContract, nil
+}

pkg/extensions/tbtc/chain.go

@@ -0,0 +1,42 @@
+package tbtc
+
+import (
+	"github.com/keep-network/keep-common/pkg/subscription"
+	eth "github.com/keep-network/keep-ecdsa/pkg/chain"
+)
+
+// Handle represents a chain handle extended with TBTC-specific capabilities.
+type Handle interface {
+	eth.Handle
+
+	Deposit
+	TBTCSystem
+}
+
+// Deposit is an interface that provides ability to interact
+// with Deposit contracts.
+type Deposit interface {
+	// KeepAddress returns the underlying keep address for the
+	// provided deposit.
+	KeepAddress(depositAddress string) (string, error)
+
+	// RetrieveSignerPubkey retrieves the signer public key for the
+	// provided deposit.
+	RetrieveSignerPubkey(depositAddress string) error
+}
+
+// TBTCSystem is an interface that provides ability to interact
+// with TBTCSystem contract.
+type TBTCSystem interface {
+	// OnDepositCreated installs a callback that is invoked when an
+	// on-chain notification of a new deposit creation is seen.
+	OnDepositCreated(
+		handler func(depositAddress string),
+	) (subscription.EventSubscription, error)
+
+	// OnDepositRegisteredPubkey installs a callback that is invoked when an
+	// on-chain notification of a deposit's pubkey registration is seen.
+	OnDepositRegisteredPubkey(
+		handler func(depositAddress string),
+	) (subscription.EventSubscription, error)
+}