refactor: create store node facade

osmaczko · osmaczko · commit f176cbac8603 · 2025-08-20T08:33:47.000+02:00
iterates: #6629
diff --git a/internal/enr/enr.go b/internal/enr/enr.go
@@ -0,0 +1,13 @@
+package enr
+
+import (
+	"github.com/ethereum/go-ethereum/p2p/enode"
+)
+
+func MustDecode(enrStr string) *enode.Node {
+	node, err := enode.Parse(enode.ValidSchemes, enrStr)
+	if err != nil || node == nil {
+		panic("could not decode enr: " + enrStr)
+	}
+	return node
+}
diff --git a/internal/multiaddr/multiaddr.go b/internal/multiaddr/multiaddr.go
@@ -0,0 +1,11 @@
+package multiaddr
+
+import "github.com/multiformats/go-multiaddr"
+
+func MustDecode(multiaddrsStr string) *multiaddr.Multiaddr {
+	maddr, err := multiaddr.NewMultiaddr(multiaddrsStr)
+	if err != nil || maddr == nil {
+		panic("could not decode multiaddr: " + multiaddrsStr)
+	}
+	return &maddr
+}
diff --git a/messaging/types/store_node.go b/messaging/types/store_node.go
@@ -0,0 +1,80 @@
+package types
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/libp2p/go-libp2p/core/peer"
+	"github.com/multiformats/go-multiaddr"
+
+	"github.com/ethereum/go-ethereum/p2p/enode"
+
+	wakutypes "github.com/status-im/status-go/waku/types"
+)
+
+type StoreNode struct {
+	ID     string               `json:"id"`
+	Name   string               `json:"name"`
+	Custom bool                 `json:"custom"`
+	ENR    *enode.Node          `json:"enr"`
+	Addr   *multiaddr.Multiaddr `json:"addr"`
+}
+
+func (m StoreNode) PeerID() (peer.ID, error) {
+	return wakutypes.Mailserver{
+		ID:     m.ID,
+		Name:   m.Name,
+		Custom: m.Custom,
+		ENR:    m.ENR,
+		Addr:   m.Addr,
+	}.PeerID()
+}
+
+func (m StoreNode) PeerInfo() (peer.AddrInfo, error) {
+	return wakutypes.Mailserver{
+		ID:     m.ID,
+		Name:   m.Name,
+		Custom: m.Custom,
+		ENR:    m.ENR,
+		Addr:   m.Addr,
+	}.PeerInfo()
+}
+
+// UnmarshalJSON implements the custom JSON unmarshaling logic for Mailserver.
+// It supports ENR and Addr being saved as strings.
+func (m *StoreNode) UnmarshalJSON(data []byte) error {
+	type Alias StoreNode // Create an alias type to avoid infinite recursion
+	aux := struct {
+		Alias
+		ENR  string `json:"enr"`  // Temporary field to handle ENR as a string
+		Addr string `json:"addr"` // Temporary field to handle Addr as a string
+	}{}
+
+	// Unmarshal the data into the temporary struct
+	if err := json.Unmarshal(data, &aux); err != nil {
+		return err
+	}
+
+	// Set the basic fields
+	*m = StoreNode(aux.Alias)
+
+	// Decode the ENR if present
+	if aux.ENR != "" {
+		decodedENR, err := enode.Parse(enode.ValidSchemes, aux.ENR)
+		if err != nil {
+			return fmt.Errorf("invalid ENR: %w", err)
+		}
+		m.ENR = decodedENR
+	}
+
+	// Decode the Multiaddr if present
+	if aux.Addr != "" {
+		decodedAddr, err := multiaddr.NewMultiaddr(aux.Addr)
+		if err != nil {
+			return fmt.Errorf("invalid Addr: %w", err)
+		}
+		m.Addr = &decodedAddr
+	}
+
+	return nil
+}
diff --git a/params/cluster.go b/params/cluster.go
diff --git a/params/storenode_test.go b/params/storenode_test.go
@@ -0,0 +1,28 @@
+package params_test
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	messagingtypes "github.com/status-im/status-go/messaging/types"
+	"github.com/status-im/status-go/params"
+)
+
+func TestStoreNode_UnmarshalJSON(t *testing.T) {
+	fleets := params.GetSupportedFleets()
+
+	for _, fleet := range fleets {
+		for _, storeNode := range fleet.StoreNodes {
+			jsonData, err := json.Marshal(storeNode)
+			require.NoError(t, err)
+
+			var unmarshalled messagingtypes.StoreNode
+			err = json.Unmarshal(jsonData, &unmarshalled)
+			require.NoError(t, err)
+
+			require.Equal(t, storeNode, unmarshalled)
+		}
+	}
+}
diff --git a/protocol/messenger.go b/protocol/messenger.go
@@ -631,7 +631,7 @@ func (m *Messenger) Start() (*MessengerResponse, error) {
 	}
 	response := &MessengerResponse{}
 
-	response.Mailservers, err = m.AllMailservers()
+	response.StoreNodes, err = m.AllMailservers()
 	if err != nil {
 		return nil, err
 	}
diff --git a/protocol/messenger_mailserver_cycle.go b/protocol/messenger_mailserver_cycle.go
@@ -5,12 +5,12 @@ import (
 	"go.uber.org/zap"
 
 	gocommon "github.com/status-im/status-go/common"
+	messagingtypes "github.com/status-im/status-go/messaging/types"
 	"github.com/status-im/status-go/params"
 	"github.com/status-im/status-go/signal"
-	wakutypes "github.com/status-im/status-go/waku/types"
 )
 
-func (m *Messenger) AllMailservers() ([]wakutypes.Mailserver, error) {
+func (m *Messenger) AllMailservers() ([]messagingtypes.StoreNode, error) {
 	// Get configured fleet
 	fleet, err := m.getFleet()
 	if err != nil {
@@ -20,7 +20,7 @@ func (m *Messenger) AllMailservers() ([]wakutypes.Mailserver, error) {
 	return m.allMailserversByFleet(fleet)
 }
 
-func (m *Messenger) allMailserversByFleet(fleet string) ([]wakutypes.Mailserver, error) {
+func (m *Messenger) allMailserversByFleet(fleet string) ([]messagingtypes.StoreNode, error) {
 	// Get default mailservers for given fleet
 	allMailservers := params.DefaultStoreNodes(fleet)
 	return allMailservers, nil
@@ -124,7 +124,7 @@ func (m *Messenger) checkForStorenodeCycleSignals() {
 		return
 	}
 
-	mailserverMap := make(map[peer.ID]wakutypes.Mailserver)
+	mailserverMap := make(map[peer.ID]messagingtypes.StoreNode)
 	for _, ms := range allMailservers {
 		peerID, err := ms.PeerID()
 		if err != nil {
@@ -139,22 +139,22 @@ func (m *Messenger) checkForStorenodeCycleSignals() {
 		case <-m.ctx.Done():
 			return
 		case <-notWorking:
-			signal.SendMailserverNotWorking()
+			signal.SendStoreNodeNotWorking()
 
 		case activeMailserver := <-changed:
 			if activeMailserver != "" {
 				ms, ok := mailserverMap[activeMailserver]
 				if ok {
-					signal.SendMailserverChanged(&ms)
+					signal.SendStoreNodeChanged(&ms)
 				}
 			} else {
-				signal.SendMailserverChanged(nil)
+				signal.SendStoreNodeChanged(nil)
 			}
 		case activeMailserver := <-available:
 			if activeMailserver != "" {
 				ms, ok := mailserverMap[activeMailserver]
 				if ok {
-					signal.SendMailserverAvailable(&ms)
+					signal.SendStoreNodeAvailable(&ms)
 				}
 				m.asyncRequestAllHistoricMessages()
 			}
diff --git a/protocol/messenger_response.go b/protocol/messenger_response.go
@@ -6,7 +6,6 @@ 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"
@@ -46,7 +45,7 @@ type MessengerResponse struct {
 	Contacts                      []*Contact
 	Invitations                   []*GroupChatInvitation
 	CommunityChanges              []*communities.CommunityChanges
-	Mailservers                   []types.Mailserver
+	StoreNodes                    []messagingtypes.StoreNode
 	Bookmarks                     []*browsers.Bookmark
 	Settings                      []*settings.SyncSettingField
 	IdentityImages                []images.IdentityImage
@@ -105,7 +104,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             []types.Mailserver                  `json:"mailservers,omitempty"`
+		StoreNodes              []messagingtypes.StoreNode          `json:"mailservers,omitempty"`
 		Bookmarks               []*browsers.Bookmark                `json:"bookmarks,omitempty"`
 		ClearedHistories        []*ClearedHistory                   `json:"clearedHistories,omitempty"`
 		VerificationRequests    []*verification.Request             `json:"verificationRequests,omitempty"`
@@ -142,7 +141,7 @@ func (r *MessengerResponse) MarshalJSON() ([]byte, error) {
 		Invitations:             r.Invitations,
 		CommunityChanges:        r.CommunityChanges,
 		RequestsToJoinCommunity: r.RequestsToJoinCommunity(),
-		Mailservers:             r.Mailservers,
+		StoreNodes:              r.StoreNodes,
 		Bookmarks:               r.Bookmarks,
 		CurrentStatus:           r.currentStatus,
 		Settings:                r.Settings,
@@ -311,7 +310,7 @@ func (r *MessengerResponse) IsEmpty() bool {
 		len(r.removedChats)+
 		len(r.removedMessages)+
 		len(r.deletedMessages)+
-		len(r.Mailservers)+
+		len(r.StoreNodes)+
 		len(r.IdentityImages)+
 		len(r.WatchOnlyAccounts)+
 		len(r.Keypairs)+
@@ -337,7 +336,7 @@ func (r *MessengerResponse) IsEmpty() bool {
 // the existing Messages & Chats if they have the same ID
 func (r *MessengerResponse) Merge(response *MessengerResponse) error {
 	if len(response.Invitations)+
-		len(response.Mailservers)+
+		len(response.StoreNodes)+
 		len(response.clearedHistories)+
 		len(response.DiscordChannels)+
 		len(response.DiscordCategories) != 0 {
diff --git a/signal/events_shhext.go b/signal/events_shhext.go
@@ -11,7 +11,6 @@ import (
 
 	"github.com/status-im/status-go/crypto/types"
 	messagingtypes "github.com/status-im/status-go/messaging/types"
-	wakutypes "github.com/status-im/status-go/waku/types"
 )
 
 const (
@@ -105,7 +104,7 @@ type BundleAddedSignal struct {
 	InstallationID string `json:"installationID"`
 }
 
-type MailserverSignal struct {
+type StoreNodeSignal struct {
 	Address *multiaddr.Multiaddr `json:"address"`
 	ID      string               `json:"id"`
 }
@@ -222,23 +221,23 @@ func SendNewMessages(obj json.Marshaler) {
 	send(EventNewMessages, obj)
 }
 
-func sendMailserverSignal(ms *wakutypes.Mailserver, event string) {
-	msSignal := MailserverSignal{}
+func sendStoreNodeSignal(ms *messagingtypes.StoreNode, event string) {
+	msSignal := StoreNodeSignal{}
 	if ms != nil {
 		msSignal.Address = ms.Addr
 		msSignal.ID = ms.ID
 	}
 	send(event, msSignal)
 }
 
-func SendMailserverAvailable(ms *wakutypes.Mailserver) {
-	sendMailserverSignal(ms, EventMailserverAvailable)
+func SendStoreNodeAvailable(ms *messagingtypes.StoreNode) {
+	sendStoreNodeSignal(ms, EventMailserverAvailable)
 }
 
-func SendMailserverChanged(ms *wakutypes.Mailserver) {
-	sendMailserverSignal(ms, EventMailserverChanged)
+func SendStoreNodeChanged(ms *messagingtypes.StoreNode) {
+	sendStoreNodeSignal(ms, EventMailserverChanged)
 }
 
-func SendMailserverNotWorking() {
-	sendMailserverSignal(nil, EventMailserverNotWorking)
+func SendStoreNodeNotWorking() {
+	sendStoreNodeSignal(nil, EventMailserverNotWorking)
 }
diff --git a/waku/types/mailserver.go b/waku/types/mailserver.go
@@ -2,9 +2,7 @@ package types
 
 import (
 	"database/sql"
-	"encoding/json"
 	"errors"
-	"fmt"
 
 	"github.com/ethereum/go-ethereum/p2p/enode"
 
@@ -47,22 +45,6 @@ type SyncEventResponse struct {
 	Error  string
 }
 
-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"`
@@ -119,42 +101,3 @@ func (m Mailserver) NullablePassword() (val sql.NullString) {
 	}
 	return
 }
-
-// UnmarshalJSON implements the custom JSON unmarshaling logic for Mailserver.
-// It supports ENR and Addr being saved as strings.
-func (m *Mailserver) UnmarshalJSON(data []byte) error {
-	type Alias Mailserver // Create an alias type to avoid infinite recursion
-	aux := struct {
-		Alias
-		ENR  string `json:"enr"`  // Temporary field to handle ENR as a string
-		Addr string `json:"addr"` // Temporary field to handle Addr as a string
-	}{}
-
-	// Unmarshal the data into the temporary struct
-	if err := json.Unmarshal(data, &aux); err != nil {
-		return err
-	}
-
-	// Set the basic fields
-	*m = Mailserver(aux.Alias)
-
-	// Decode the ENR if present
-	if aux.ENR != "" {
-		decodedENR, err := enode.Parse(enode.ValidSchemes, aux.ENR)
-		if err != nil {
-			return fmt.Errorf("invalid ENR: %w", err)
-		}
-		m.ENR = decodedENR
-	}
-
-	// Decode the Multiaddr if present
-	if aux.Addr != "" {
-		decodedAddr, err := multiaddr.NewMultiaddr(aux.Addr)
-		if err != nil {
-			return fmt.Errorf("invalid Addr: %w", err)
-		}
-		m.Addr = &decodedAddr
-	}
-
-	return nil
-}
diff --git a/waku/types/mailserver_test.go b/waku/types/mailserver_test.go

Original file line number	Diff line number	Diff line change
`@@ -631,7 +631,7 @@ func (m Messenger) Start() (MessengerResponse, error) {`
`631`	`631`	`}`
`632`	`632`	`response := &MessengerResponse{}`
`633`	`633`
`634`		`- response.Mailservers, err = m.AllMailservers()`
	`634`	`+ response.StoreNodes, err = m.AllMailservers()`
`635`	`635`	`if err != nil {`
`636`	`636`	`return nil, err`
`637`	`637`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@ import (`
`11`	`11`
`12`	`12`	`"github.com/status-im/status-go/crypto/types"`
`13`	`13`	`messagingtypes "github.com/status-im/status-go/messaging/types"`
`14`		`- wakutypes "github.com/status-im/status-go/waku/types"`
`15`	`14`	`)`
`16`	`15`
`17`	`16`	`const (`
`@@ -105,7 +104,7 @@ type BundleAddedSignal struct {`
`105`	`104`	InstallationID string `json:"installationID"`
`106`	`105`	`}`
`107`	`106`
`108`		`-type MailserverSignal struct {`
	`107`	`+type StoreNodeSignal struct {`
`109`	`108`	Address *multiaddr.Multiaddr `json:"address"`
`110`	`109`	ID string `json:"id"`
`111`	`110`	`}`
`@@ -222,23 +221,23 @@ func SendNewMessages(obj json.Marshaler) {`
`222`	`221`	`send(EventNewMessages, obj)`
`223`	`222`	`}`
`224`	`223`
`225`		`-func sendMailserverSignal(ms *wakutypes.Mailserver, event string) {`
`226`		`- msSignal := MailserverSignal{}`
	`224`	`+func sendStoreNodeSignal(ms *messagingtypes.StoreNode, event string) {`
	`225`	`+ msSignal := StoreNodeSignal{}`
`227`	`226`	`if ms != nil {`
`228`	`227`	`msSignal.Address = ms.Addr`
`229`	`228`	`msSignal.ID = ms.ID`
`230`	`229`	`}`
`231`	`230`	`send(event, msSignal)`
`232`	`231`	`}`
`233`	`232`
`234`		`-func SendMailserverAvailable(ms *wakutypes.Mailserver) {`
`235`		`- sendMailserverSignal(ms, EventMailserverAvailable)`
	`233`	`+func SendStoreNodeAvailable(ms *messagingtypes.StoreNode) {`
	`234`	`+ sendStoreNodeSignal(ms, EventMailserverAvailable)`
`236`	`235`	`}`
`237`	`236`
`238`		`-func SendMailserverChanged(ms *wakutypes.Mailserver) {`
`239`		`- sendMailserverSignal(ms, EventMailserverChanged)`
	`237`	`+func SendStoreNodeChanged(ms *messagingtypes.StoreNode) {`
	`238`	`+ sendStoreNodeSignal(ms, EventMailserverChanged)`
`240`	`239`	`}`
`241`	`240`
`242`		`-func SendMailserverNotWorking() {`
`243`		`- sendMailserverSignal(nil, EventMailserverNotWorking)`
	`241`	`+func SendStoreNodeNotWorking() {`
	`242`	`+ sendStoreNodeSignal(nil, EventMailserverNotWorking)`
`244`	`243`	`}`