Updated comments

Author: hoffmabc

core/net.go

@@ -58,6 +58,7 @@ func (n *OpenBazaarNode) sendMessage(peerID string, k *libp2p.PubKey, message pb
 	return nil
 }
 
+// SendRelayedMessage - send message through web relay manager to recipient
 func (n *OpenBazaarNode) SendRelayedMessage(p peer.ID, k *libp2p.PubKey, m *pb.Message) error {
 	messageBytes, err := n.getMessageBytes(m)
 	if err != nil {

net/web_relay_manager.go

@@ -17,38 +17,44 @@ import (
 	"github.com/gorilla/websocket"
 )
 
+// WebRelayManager - manages connections to web relay servers
 type WebRelayManager struct {
 	webrelays   []string
 	peerID      string
 	connections []*websocket.Conn
 	obService   NetworkService
 }
 
+// EncryptedMessage - message envelope for relay messages
 type EncryptedMessage struct {
 	Message   string `json:"encryptedMessage"`
 	Recipient string `json:"recipient"`
 }
 
+// TypedMessage - generic typed message for transport
 type TypedMessage struct {
 	Type string
 	Data json.RawMessage
 }
 
+// SubscribeMessage - authentication message for web relay server
 type SubscribeMessage struct {
 	UserID          string `json:"userID"`
 	SubscriptionKey string `json:"subscriptionKey"`
 }
 
+// SubscribeResponse - for marshaling authN response from web relay server
 type SubscribeResponse struct {
 	Subscribe string `json:"subscribe"`
 }
 
+// NewWebRelayManager - creates a web relay manager to maintain connections
 func NewWebRelayManager(webrelays []string, sender string) *WebRelayManager {
 	return &WebRelayManager{webrelays, sender, nil, nil}
 }
 
+// ConnectToRelays - initiate websocket connections to the relay servers configured
 func (wrm *WebRelayManager) ConnectToRelays(service NetworkService) {
-
 	// Set WRM service
 	wrm.obService = service
 

schema/configuration.go

@@ -415,6 +415,7 @@ func GetRepublishInterval(cfgBytes []byte) (time.Duration, error) {
 	return d, nil
 }
 
+// GetWebRelays - retrieves web relay server addresses from config file
 func GetWebRelays(cfgBytes []byte) ([]string, error) {
 	var cfgIface interface{}
 	err := json.Unmarshal(cfgBytes, &cfgIface)