chore_: move Mailserver to waku/types (#6456)

Author: igor-sirotin

protocol/messenger_config_test.go

@@ -9,6 +9,7 @@ import (
 	"github.com/status-im/status-go/protocol/communities"
 	"github.com/status-im/status-go/services/mailservers"
 	"github.com/status-im/status-go/t/helpers"
+	"github.com/status-im/status-go/waku/types"
 )
 
 func WithTestStoreNode(s *suite.Suite, id string, address multiaddr.Multiaddr, fleet string, collectiblesServiceMock *CollectiblesServiceMock) Option {
@@ -17,7 +18,7 @@ func WithTestStoreNode(s *suite.Suite, id string, address multiaddr.Multiaddr, f
 		s.Require().NoError(err)
 
 		db := mailservers.NewDB(sqldb)
-		err = db.Add(mailservers.Mailserver{
+		err = db.Add(types.Mailserver{
 			ID:    id,
 			Name:  id,
 			Addr:  &address,

protocol/messenger_mailserver_cycle.go

@@ -8,9 +8,10 @@ import (
 	"github.com/status-im/status-go/params"
 	"github.com/status-im/status-go/services/mailservers"
 	"github.com/status-im/status-go/signal"
+	"github.com/status-im/status-go/waku/types"
 )
 
-func (m *Messenger) AllMailservers() ([]mailservers.Mailserver, error) {
+func (m *Messenger) AllMailservers() ([]types.Mailserver, error) {
 	// Get configured fleet
 	fleet, err := m.getFleet()
 	if err != nil {
@@ -149,7 +150,7 @@ func (m *Messenger) checkForStorenodeCycleSignals() {
 		return
 	}
 
-	mailserverMap := make(map[peer.ID]mailservers.Mailserver)
+	mailserverMap := make(map[peer.ID]types.Mailserver)
 	for _, ms := range allMailservers {
 		peerID, err := ms.PeerID()
 		if err != nil {

protocol/messenger_response.go

@@ -6,6 +6,7 @@ import (
 	"golang.org/x/exp/maps"
 
 	ensservice "github.com/status-im/status-go/services/ens"
+	"github.com/status-im/status-go/waku/types"
 
 	"github.com/status-im/status-go/services/browsers"
 	"github.com/status-im/status-go/services/wallet"
@@ -23,7 +24,6 @@ import (
 	"github.com/status-im/status-go/protocol/storenodes"
 	"github.com/status-im/status-go/protocol/verification"
 	localnotifications "github.com/status-im/status-go/services/local-notifications"
-	"github.com/status-im/status-go/services/mailservers"
 )
 
 type RemovedMessage struct {
@@ -49,7 +49,7 @@ type MessengerResponse struct {
 	Invitations                   []*GroupChatInvitation
 	CommunityChanges              []*communities.CommunityChanges
 	AnonymousMetrics              []*appmetrics.AppMetric
-	Mailservers                   []mailservers.Mailserver
+	Mailservers                   []types.Mailserver
 	CommunityStorenodes           []storenodes.Storenode
 	Bookmarks                     []*browsers.Bookmark
 	Settings                      []*settings.SyncSettingField
@@ -109,7 +109,7 @@ func (r *MessengerResponse) MarshalJSON() ([]byte, error) {
 		Invitations             []*GroupChatInvitation              `json:"invitations,omitempty"`
 		CommunityChanges        []*communities.CommunityChanges     `json:"communityChanges,omitempty"`
 		RequestsToJoinCommunity []*communities.RequestToJoin        `json:"requestsToJoinCommunity,omitempty"`
-		Mailservers             []mailservers.Mailserver            `json:"mailservers,omitempty"`
+		Mailservers             []types.Mailserver                  `json:"mailservers,omitempty"`
 		CommunityStorenodes     []storenodes.Storenode              `json:"communityStorenodes,omitempty"`
 		Bookmarks               []*browsers.Bookmark                `json:"bookmarks,omitempty"`
 		ClearedHistories        []*ClearedHistory                   `json:"clearedHistories,omitempty"`

protocol/messenger_storenode_comunity_test.go

@@ -19,6 +19,7 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/ethereum/go-ethereum/crypto"
+
 	"github.com/status-im/status-go/appdatabase"
 	"github.com/status-im/status-go/protocol/protobuf"
 	"github.com/status-im/status-go/protocol/requests"
@@ -123,7 +124,7 @@ func (s *MessengerStoreNodeCommunitySuite) newMessenger(name string, storenodeAd
 	s.Require().NoError(err)
 
 	mailserversDatabase := mailserversDB.NewDB(mailserversSQLDb)
-	err = mailserversDatabase.Add(mailserversDB.Mailserver{
+	err = mailserversDatabase.Add(wakutypes.Mailserver{
 		ID:    localMailserverID,
 		Name:  localMailserverID,
 		Addr:  storenodeAddress,

protocol/messenger_storenode_request_test.go

@@ -1070,7 +1070,7 @@ func (s *MessengerStoreNodeRequestSuite) TestFetchRealCommunity() {
 	// We run a separate request for each node in the fleet.
 	for i, mailserver := range nodesList {
 		wg.Add(1)
-		go func(i int, mailserver mailserversDB.Mailserver) {
+		go func(i int, mailserver wakutypes.Mailserver) {
 			defer wg.Done()
 
 			fmt.Printf("--- starting request [%d] from %s\n", i, mailserver.ID)

protocol/storenodes/models.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/status-im/status-go/eth-node/types"
 	"github.com/status-im/status-go/protocol/protobuf"
-	"github.com/status-im/status-go/services/mailservers"
+	wakutypes "github.com/status-im/status-go/waku/types"
 )
 
 // Storenode is a struct that represents a storenode, it is very closely related to `mailservers.Mailserver`
@@ -63,8 +63,8 @@ func FromProtobuf(storenodes []*protobuf.Storenode, clock uint64) Storenodes {
 	return result
 }
 
-func toMailserver(m Storenode) mailservers.Mailserver {
-	return mailservers.Mailserver{
+func toMailserver(m Storenode) wakutypes.Mailserver {
+	return wakutypes.Mailserver{
 		ID:     m.StorenodeID,
 		Name:   m.Name,
 		Custom: true,

protocol/storenodes/storenodes.go

@@ -11,7 +11,7 @@ import (
 	"github.com/waku-org/go-waku/waku/v2/utils"
 
 	"github.com/status-im/status-go/eth-node/types"
-	"github.com/status-im/status-go/services/mailservers"
+	wakutypes "github.com/status-im/status-go/waku/types"
 )
 
 var (
@@ -44,13 +44,13 @@ type storenodesData struct {
 }
 
 // GetStorenodeByCommunityID returns the active storenode for a community
-func (m *CommunityStorenodes) GetStorenodeByCommunityID(communityID string) (mailservers.Mailserver, error) {
+func (m *CommunityStorenodes) GetStorenodeByCommunityID(communityID string) (wakutypes.Mailserver, error) {
 	m.storenodesByCommunityIDMutex.RLock()
 	defer m.storenodesByCommunityIDMutex.RUnlock()
 
 	msData, ok := m.storenodesByCommunityID[communityID]
 	if !ok || len(msData.storenodes) == 0 {
-		return mailservers.Mailserver{}, ErrNotFound
+		return wakutypes.Mailserver{}, ErrNotFound
 	}
 	return toMailserver(msData.storenodes[0]), nil
 }

protocol/storenodes/storenodes_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/multiformats/go-multiaddr"
 	"github.com/stretchr/testify/require"
 
-	"github.com/status-im/status-go/services/mailservers"
+	"github.com/status-im/status-go/waku/types"
 )
 
 func TestSerialization(t *testing.T) {
@@ -74,7 +74,7 @@ func TestUpdateStorenodesInDB(t *testing.T) {
 	matchStoreNode(t, snodes2[0], ms2)
 }
 
-func matchStoreNode(t *testing.T, sn Storenode, ms mailservers.Mailserver) {
+func matchStoreNode(t *testing.T, sn Storenode, ms types.Mailserver) {
 	require.Equal(t, sn.StorenodeID, ms.ID)
 	require.Equal(t, sn.Name, ms.Name)
 	require.Equal(t, sn.Address.String(), (*ms.Addr).String())

services/mailservers/api.go

@@ -1,6 +1,10 @@
 package mailservers
 
-import "context"
+import (
+	"context"
+
+	"github.com/status-im/status-go/waku/types"
+)
 
 func NewAPI(db *Database) *API {
 	return &API{db}
@@ -11,11 +15,11 @@ type API struct {
 	db *Database
 }
 
-func (a *API) AddMailserver(ctx context.Context, m Mailserver) error {
+func (a *API) AddMailserver(ctx context.Context, m types.Mailserver) error {
 	return a.db.Add(m)
 }
 
-func (a *API) GetMailservers(ctx context.Context) ([]Mailserver, error) {
+func (a *API) GetMailservers(ctx context.Context) ([]types.Mailserver, error) {
 	return a.db.Mailservers()
 }
 

services/mailservers/api_test.go

@@ -26,10 +26,10 @@ func TestAddGetDeleteMailserver(t *testing.T) {
 	db, close := setupTestDB(t)
 	defer close()
 	api := &API{db: db}
-	testMailserver := Mailserver{
+	testMailserver := wakutypes.Mailserver{
 		ID:     "mailserver001",
 		Name:   "My Mailserver",
-		Addr:   MustDecodeMultiaddress("/dns4/node-01.do-ams3.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W"),
+		Addr:   wakutypes.MustDecodeMultiaddress("/dns4/node-01.do-ams3.waku.test.status.im/tcp/30303/p2p/16Uiu2HAkykgaECHswi3YKJ5dMLbq2kPVCo89fcyTd38UcQD6ej5W"),
 		Custom: true,
 		Fleet:  "prod",
 	}
@@ -44,14 +44,14 @@ func TestAddGetDeleteMailserver(t *testing.T) {
 
 	mailservers, err := api.GetMailservers(context.Background())
 	require.NoError(t, err)
-	require.EqualValues(t, []Mailserver{testMailserver, testMailserverWithPassword}, mailservers)
+	require.EqualValues(t, []wakutypes.Mailserver{testMailserver, testMailserverWithPassword}, mailservers)
 
 	err = api.DeleteMailserver(context.Background(), testMailserver.ID)
 	require.NoError(t, err)
 	// Verify they was deleted.
 	mailservers, err = api.GetMailservers(context.Background())
 	require.NoError(t, err)
-	require.EqualValues(t, []Mailserver{testMailserverWithPassword}, mailservers)
+	require.EqualValues(t, []wakutypes.Mailserver{testMailserverWithPassword}, mailservers)
 	// Delete non-existing mailserver.
 	err = api.DeleteMailserver(context.Background(), "other-id")
 	require.NoError(t, err)

services/mailservers/database.go

@@ -9,90 +9,12 @@ import (
 	"strings"
 	"time"
 
-	"github.com/libp2p/go-libp2p/core/peer"
 	"github.com/multiformats/go-multiaddr"
 
-	"github.com/waku-org/go-waku/waku/v2/protocol/enr"
-	"github.com/waku-org/go-waku/waku/v2/utils"
-
-	"github.com/ethereum/go-ethereum/p2p/enode"
-
 	"github.com/status-im/status-go/protocol/transport"
+	"github.com/status-im/status-go/waku/types"
 )
 
-func MustDecodeENR(enrStr string) *enode.Node {
-	node, err := enode.Parse(enode.ValidSchemes, enrStr)
-	if err != nil || node == nil {
-		panic("could not decode enr: " + enrStr)
-	}
-	return node
-}
-
-func MustDecodeMultiaddress(multiaddrsStr string) *multiaddr.Multiaddr {
-	maddr, err := multiaddr.NewMultiaddr(multiaddrsStr)
-	if err != nil || maddr == nil {
-		panic("could not decode multiaddr: " + multiaddrsStr)
-	}
-	return &maddr
-}
-
-type Mailserver struct {
-	ID     string               `json:"id"`
-	Name   string               `json:"name"`
-	Custom bool                 `json:"custom"`
-	ENR    *enode.Node          `json:"enr"`
-	Addr   *multiaddr.Multiaddr `json:"addr"`
-
-	// Deprecated: only used with WakuV1
-	Password       string `json:"password,omitempty"`
-	Fleet          string `json:"fleet"`
-	FailedRequests uint   `json:"-"`
-}
-
-func (m Mailserver) PeerInfo() (peer.AddrInfo, error) {
-	var maddrs []multiaddr.Multiaddr
-
-	if m.ENR != nil {
-		addrInfo, err := enr.EnodeToPeerInfo(m.ENR)
-		if err != nil {
-			return peer.AddrInfo{}, err
-		}
-		addrInfo.Addrs = utils.EncapsulatePeerID(addrInfo.ID, addrInfo.Addrs...)
-		maddrs = append(maddrs, addrInfo.Addrs...)
-	}
-
-	if m.Addr != nil {
-		maddrs = append(maddrs, *m.Addr)
-	}
-
-	p, err := peer.AddrInfosFromP2pAddrs(maddrs...)
-	if err != nil {
-		return peer.AddrInfo{}, err
-	}
-
-	if len(p) != 1 {
-		return peer.AddrInfo{}, errors.New("invalid mailserver setup")
-	}
-
-	return p[0], nil
-}
-
-func (m Mailserver) PeerID() (peer.ID, error) {
-	p, err := m.PeerInfo()
-	if err != nil {
-		return "", err
-	}
-	return p.ID, nil
-}
-
-func (m Mailserver) nullablePassword() (val sql.NullString) {
-	if m.Password != "" {
-		val.String = m.Password
-		val.Valid = true
-	}
-	return
-}
-
 type MailserverRequestGap struct {
 	ID     string `json:"id"`
 	ChatID string `json:"chatId"`
@@ -145,7 +67,7 @@ func NewDB(db *sql.DB) *Database {
 	return &Database{db: db}
 }
 
-func (d *Database) Add(mailserver Mailserver) error {
+func (d *Database) Add(mailserver types.Mailserver) error {
 	// TODO: we are only storing the multiaddress.
 	// In a future PR we must allow storing multiple multiaddresses and ENR
 	_, err := d.db.Exec(`INSERT OR REPLACE INTO mailservers(
@@ -158,13 +80,13 @@ func (d *Database) Add(mailserver Mailserver) error {
 		mailserver.ID,
 		mailserver.Name,
 		(*mailserver.Addr).String(),
-		mailserver.nullablePassword(),
+		mailserver.NullablePassword(),
 		mailserver.Fleet,
 	)
 	return err
 }
 
-func (d *Database) Mailservers() ([]Mailserver, error) {
+func (d *Database) Mailservers() ([]types.Mailserver, error) {
 	rows, err := d.db.Query(`SELECT id, name, address, password, fleet FROM mailservers`)
 	if err != nil {
 		return nil, err
@@ -173,12 +95,12 @@ func (d *Database) Mailservers() ([]Mailserver, error) {
 	return toMailservers(rows)
 }
 
-func toMailservers(rows *sql.Rows) ([]Mailserver, error) {
-	var result []Mailserver
+func toMailservers(rows *sql.Rows) ([]types.Mailserver, error) {
+	var result []types.Mailserver
 
 	for rows.Next() {
 		var (
-			m        Mailserver
+			m        types.Mailserver
 			addrStr  string
 			password sql.NullString
 		)