Merge pull request #3305 from keep-network/print-addresses

Print addresses of operators selected to a signing group

To make the debugging of problems easier, we now print the addresses of
operators selected to ECDSA and Beacon signing groups.

pkg/beacon/chain/chain.go

@@ -53,7 +53,7 @@ type GroupSelectionInterface interface {
 	// SelectGroup returns the group members for the group generated by
 	// the given seed. This function can return an error if the beacon chain's
 	// state does not allow for group selection at the moment.
-	SelectGroup(seed *big.Int) ([]chain.Address, error)
+	SelectGroup(seed *big.Int) (chain.Addresses, error)
 }
 
 // GroupRegistrationInterface defines the subset of the beacon chain interface

pkg/beacon/node.go

@@ -75,6 +75,8 @@ func (n *node) JoinDKGIfEligible(
 		return
 	}
 
+	logger.Infof("selected group members = %s", selectedOperators)
+
 	if len(selectedOperators) > n.beaconChain.GetConfig().GroupSize {
 		logger.Errorf(
 			"group size larger than supported: [%v]",

pkg/chain/address.go

@@ -1,5 +1,10 @@
 package chain
 
+import (
+	"fmt"
+	"strings"
+)
+
 // Address is a chain-agnostic representation of a chain address.
 type Address string
 
@@ -20,3 +25,27 @@ func (a Addresses) Set() map[Address]bool {
 
 	return set
 }
+
+// String converts Addresses into a string with elements indexed from 1.
+// This allows to print the list of addresses as a group members with member
+// indexes starting from 1.
+func (a Addresses) String() string {
+	if len(a) == 0 {
+		return "[]"
+	}
+
+	if len(a) == 1 {
+		return fmt.Sprintf("[1: %s]", a[0])
+	}
+
+	var sb strings.Builder
+	var i = 0
+
+	sb.WriteString("[")
+	for i = 0; i < len(a)-1; i++ {
+		fmt.Fprintf(&sb, "%d: %s, ", i+1, a[i].String())
+	}
+	fmt.Fprintf(&sb, "%d: %s]", i+1, a[i].String())
+
+	return sb.String()
+}

pkg/chain/address_test.go

@@ -0,0 +1,43 @@
+package chain
+
+import (
+	"testing"
+
+	"github.com/keep-network/keep-core/pkg/internal/testutils"
+)
+
+func TestAddressesToString(t *testing.T) {
+	var tests = map[string]struct {
+		addresses      Addresses
+		expectedString string
+	}{
+		"empty addresses": {
+			addresses:      Addresses{},
+			expectedString: "[]",
+		},
+		"one address": {
+			addresses:      Addresses{"0x123"},
+			expectedString: "[1: 0x123]",
+		},
+		"two addresses": {
+			addresses:      Addresses{"0x123", "0x234"},
+			expectedString: "[1: 0x123, 2: 0x234]",
+		},
+		"three addresses": {
+			addresses:      Addresses{"0x123", "0x234", "0x345"},
+			expectedString: "[1: 0x123, 2: 0x234, 3: 0x345]",
+		},
+	}
+
+	for testName, test := range tests {
+		t.Run(testName, func(t *testing.T) {
+			actualString := test.addresses.String()
+			testutils.AssertStringsEqual(
+				t,
+				"ToString() result",
+				test.expectedString,
+				actualString,
+			)
+		})
+	}
+}

pkg/chain/ethereum/beacon.go

@@ -233,7 +233,7 @@ func (bc *BeaconChain) RestoreRewardEligibility() error {
 // SelectGroup returns the group members for the group generated by
 // the given seed. This function can return an error if the beacon chain's
 // state does not allow for group selection at the moment.
-func (bc *BeaconChain) SelectGroup(seed *big.Int) ([]chain.Address, error) {
+func (bc *BeaconChain) SelectGroup(seed *big.Int) (chain.Addresses, error) {
 	groupSize := big.NewInt(int64(bc.GetConfig().GroupSize))
 	seedBytes := [32]byte{}
 	seed.FillBytes(seedBytes[:])

pkg/chain/ethereum/tbtc.go

@@ -287,7 +287,7 @@ func (tc *TbtcChain) RestoreRewardEligibility() error {
 // SelectGroup returns the group members for the group generated by
 // the given seed. This function can return an error if the beacon chain's
 // state does not allow for group selection at the moment.
-func (tc *TbtcChain) SelectGroup(seed *big.Int) ([]chain.Address, error) {
+func (tc *TbtcChain) SelectGroup(seed *big.Int) (chain.Addresses, error) {
 	groupSize := big.NewInt(int64(tc.GetConfig().GroupSize))
 	seedBytes := [32]byte{}
 	seed.FillBytes(seedBytes[:])
@@ -385,7 +385,7 @@ func (tc *TbtcChain) OnSignatureRequested(
 }
 
 // TODO: Temporary mock that simulates the behavior of the WalletRegistry
-//	     contract. Should be removed eventually.
+//       contract. Should be removed eventually.
 type mockWalletRegistry struct {
 	blockCounter chain.BlockCounter
 

pkg/chain/local_v1/local.go

@@ -131,7 +131,7 @@ func (c *localChain) OnRelayEntryRequested(
 	})
 }
 
-func (c *localChain) SelectGroup(seed *big.Int) ([]chain.Address, error) {
+func (c *localChain) SelectGroup(seed *big.Int) (chain.Addresses, error) {
 	panic("not implemented")
 }
 

pkg/tbtc/chain.go

@@ -26,7 +26,7 @@ type GroupSelectionChain interface {
 	// SelectGroup returns the group members for the group generated by
 	// the given seed. This function can return an error if the TBTC chain's
 	// state does not allow for group selection at the moment.
-	SelectGroup(seed *big.Int) ([]chain.Address, error)
+	SelectGroup(seed *big.Int) (chain.Addresses, error)
 }
 
 // DistributedKeyGenerationChain defines the subset of the TBTC chain
@@ -101,7 +101,7 @@ type BridgeChain interface {
 // SignatureRequestedEvent represents a Bridge signature request event.
 //
 // TODO: This is a temporary structure that should be removed once the client
-//	     is integrated with real on-chain contracts.
+//       is integrated with real on-chain contracts.
 type SignatureRequestedEvent struct {
 	WalletPublicKey []byte
 	Message         *big.Int

pkg/tbtc/node.go

@@ -80,6 +80,8 @@ func (n *node) joinDKGIfEligible(seed *big.Int, startBlockNumber uint64) {
 		return
 	}
 
+	logger.Infof("selected group members = %s", selectedSigningGroupOperators)
+
 	chainConfig := n.chain.GetConfig()
 
 	if len(selectedSigningGroupOperators) > chainConfig.GroupSize {