Initial implementation of app-specific actions

cmd/start.go

@@ -3,9 +3,11 @@ 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-ecdsa/pkg/actions"
+
 	"github.com/keep-network/keep-core/pkg/chain"
 	"github.com/keep-network/keep-core/pkg/metrics"
 	"github.com/keep-network/keep-core/pkg/net"
@@ -168,6 +170,8 @@ func Start(c *cli.Context) error {
 	)
 	logger.Debugf("initialized operator with address: [%s]", ethereumKey.Address.String())
 
+	initializeApplicationSpecificActions(config.Actions, ethereumChain)
+
 	initializeMetrics(ctx, config, networkProvider, stakeMonitor, ethereumKey.Address.Hex())
 	initializeDiagnostics(config, networkProvider)
 
@@ -183,6 +187,23 @@ func Start(c *cli.Context) error {
 	}
 }
 
+func initializeApplicationSpecificActions(
+	actionsConfig config.Actions,
+	ethereumChain *ethereum.EthereumChain,
+) {
+	if len(actionsConfig.TBTC.DepositLog) > 0 {
+		tbtcEthereumChain, err := ethereum.WithTBTCExtensions(
+			ethereumChain,
+			actionsConfig.TBTC.DepositLog,
+		)
+		if err != nil {
+
+		}
+
+		actions.InitializeTBTCActions(tbtcEthereumChain)
+	}
+}
+
 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
+
+[Actions]
+	[TBTC]
+		DepositLog = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
+

go.mod

@@ -20,6 +20,7 @@ require (
 	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-core v1.3.0
+	github.com/keep-network/tbtc/bindings/go v0.0.0-20201014164341-29eeaf8dfc0f
 	github.com/pkg/errors v0.9.1
 	github.com/urfave/cli v1.22.1
 )

go.sum

@@ -337,6 +337,10 @@ github.com/keep-network/keep-common v1.2.1-0.20201002105641-e04cc579ff66 h1:x/9f
 github.com/keep-network/keep-common v1.2.1-0.20201002105641-e04cc579ff66/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.0 h1:9ZCuBsrJYN1L1V7bAC98ZAtxv+ZIHcMhz6RJLAizLvY=
+github.com/keep-network/tbtc v1.1.1-0.20201014164341-29eeaf8dfc0f h1:d5kn2pPyT/XWKepB9/g1fRTF+AN1EnPXZcX1Q8hJjpw=
+github.com/keep-network/tbtc/bindings/go v0.0.0-20201014164341-29eeaf8dfc0f h1:DxZXCteXGQGR8B/45AWJU2Xvpei4diP+xc3R0kYVTkQ=
+github.com/keep-network/tbtc/bindings/go v0.0.0-20201014164341-29eeaf8dfc0f/go.mod h1:uEeNDO/K1AjOPE19rRo39sa76tZgTCYSOdJNSJrLG1o=
 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
+	Actions                Actions
 }
 
 // SanctionedApplications contains addresses of applications approved by the
@@ -70,6 +71,16 @@ type Diagnostics struct {
 	Port int
 }
 
+// Actions stores app-specific actions configuration.
+type Actions struct {
+	TBTC TBTCActions
+}
+
+// TBTCActions stores configuration related with TBTC-specific actions.
+type TBTCActions struct {
+	DepositLog 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/actions/tbtc_actions.go

@@ -0,0 +1,49 @@
+package actions
+
+import (
+	"math/big"
+
+	"github.com/ipfs/go-log"
+	"github.com/keep-network/keep-common/pkg/subscription"
+	eth "github.com/keep-network/keep-ecdsa/pkg/chain"
+)
+
+var logger = log.Logger("keep-actions")
+
+// TBTCHandle represents a chain handle extended with TBTC-specific capabilities.
+type TBTCHandle interface {
+	eth.Handle
+
+	Deposit
+	DepositLog
+}
+
+// Deposit is an interface that provides ability to interact
+// with Deposit contracts.
+type Deposit interface {
+}
+
+// DepositLog is an interface that provides ability to interact
+// with DepositLog contract.
+type DepositLog interface {
+	// OnDepositCreated installs a callback that is invoked when an
+	// on-chain notification of a new deposit creation is seen.
+	OnDepositCreated(
+		handler func(depositAddress, keepAddress string, timestamp *big.Int),
+	) subscription.EventSubscription
+}
+
+// InitializeTBTCActions initializes actions specific for the TBTC application.
+func InitializeTBTCActions(tbtcHandle TBTCHandle) {
+	logger.Infof("initializing tbtc-specific actions")
+
+	tbtcHandle.OnDepositCreated(func(
+		depositAddress,
+		keepAddress string,
+		timestamp *big.Int,
+	) {
+		// TODO: Implementation
+	})
+
+	logger.Infof("tbtc-specific actions have been initialized")
+}

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_extensions.go

@@ -0,0 +1,73 @@
+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/bindings/go/contract"
+)
+
+// TBTCEthereumChain represents an Ethereum chain handle with
+// TBTC-specific capabilities.
+type TBTCEthereumChain struct {
+	*EthereumChain
+
+	depositLogContract *contract.DepositLog
+}
+
+// WithTBTCExtensions extends the Ethereum chain handle with
+// TBTC-specific capabilities.
+func WithTBTCExtensions(
+	ethereumChain *EthereumChain,
+	depositLogContractAddress string,
+) (*TBTCEthereumChain, error) {
+	if !common.IsHexAddress(depositLogContractAddress) {
+		return nil, fmt.Errorf("incorrect deposit log contract address")
+	}
+
+	depositLogContract, err := contract.NewDepositLog(
+		common.HexToAddress(depositLogContractAddress),
+		ethereumChain.accountKey,
+		ethereumChain.client,
+		ethereumChain.nonceManager,
+		ethereumChain.miningWaiter,
+		ethereumChain.transactionMutex,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	return &TBTCEthereumChain{
+		EthereumChain:      ethereumChain,
+		depositLogContract: depositLogContract,
+	}, 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, keepAddress string, timestamp *big.Int),
+) subscription.EventSubscription {
+	subscription, err := tec.depositLogContract.WatchCreated(
+		func(
+			DepositContractAddress common.Address,
+			KeepAddress common.Address,
+			Timestamp *big.Int,
+			blockNumber uint64,
+		) {
+			handler(DepositContractAddress.Hex(), KeepAddress.Hex(), Timestamp)
+		},
+		func(err error) error {
+			return fmt.Errorf("watch deposit created failed: [%v]", err)
+		},
+		nil,
+		nil,
+	)
+	if err != nil {
+		logger.Errorf("could not watch Created event: [%v]", err)
+	}
+
+	return subscription
+}