Merge branch 'jono/xxdkGoDocs' into 'release'

Fix comments and formatting

See merge request !278

xxdk/backup.go

@@ -8,6 +8,10 @@ package xxdk
 
 import "sync"
 
+// TriggerBackup function is called to start a backup. The reason is used for
+// logging purposes and should describe the event that triggered a backup.
+//
+// For example, the reason can say "contact added" when a new contact is saved.
 type TriggerBackup func(reason string)
 
 // Container contains the trigger to call to initiate a backup.

xxdk/e2e.go

@@ -25,8 +25,8 @@ import (
 	"gitlab.com/xx_network/primitives/id"
 )
 
-// E2e object bundles a ReceptionIdentity with a Cmix
-// and can be used for high level operations such as connections
+// E2e object bundles a ReceptionIdentity with a Cmix object and can be used for
+// high-level operations, such as connections.
 type E2e struct {
 	*Cmix
 	auth        auth.State
@@ -35,8 +35,8 @@ type E2e struct {
 	e2eIdentity ReceptionIdentity
 }
 
-// AuthCallbacks is an adapter for the auth.Callbacks interface
-// that allows for initializing an E2e object without an E2e-dependant auth.Callbacks
+// AuthCallbacks is an adapter for the auth.Callbacks interface that allows for
+// initializing an E2e object without an E2e-dependant auth.Callbacks.
 type AuthCallbacks interface {
 	Request(partner contact.Contact, receptionID receptionID.EphemeralIdentity,
 		round rounds.Round, messenger *E2e)
@@ -46,9 +46,9 @@ type AuthCallbacks interface {
 		round rounds.Round, messenger *E2e)
 }
 
-// Login creates a new E2e backed by the xxdk.Cmix persistent versioned.KV
-// It bundles a Cmix object with a ReceptionIdentity object
-// and initializes the auth.State and e2e.Handler objects
+// Login creates a new E2e backed by the xxdk.Cmix persistent versioned.KV. It
+// bundles a Cmix object with a ReceptionIdentity object and initializes the
+// auth.State and e2e.Handler objects.
 func Login(net *Cmix, callbacks AuthCallbacks,
 	identity ReceptionIdentity, params E2EParams) (m *E2e, err error) {
 
@@ -63,15 +63,15 @@ func Login(net *Cmix, callbacks AuthCallbacks,
 	return login(net, callbacks, identity, net.GetStorage().GetKV(), params)
 }
 
-// LoginEphemeral creates a new E2e backed by a totally ephemeral versioned.KV
+// LoginEphemeral creates a new E2e backed by a totally ephemeral versioned.KV.
 func LoginEphemeral(net *Cmix, callbacks AuthCallbacks,
 	identity ReceptionIdentity, params E2EParams) (m *E2e, err error) {
 	return login(net, callbacks, identity,
 		versioned.NewKV(ekv.MakeMemstore()), params)
 }
 
-// loginLegacy creates a new E2e backed by the xxdk.Cmix persistent versioned.KV
-// Uses the pre-generated transmission ID used by xxdk.Cmix.
+// loginLegacy creates a new E2e backed by the xxdk.Cmix persistent
+// versioned.KV. It uses the pre-generated transmission ID used by xxdk.Cmix.
 // This function is designed to maintain backwards compatibility with previous
 // xx messenger designs and should not be used for other purposes.
 func loginLegacy(net *Cmix, callbacks AuthCallbacks,
@@ -90,8 +90,7 @@ func loginLegacy(net *Cmix, callbacks AuthCallbacks,
 
 	err = net.AddService(m.e2e.StartProcesses)
 	if err != nil {
-		return nil, errors.WithMessage(err, "Failed to add "+
-			"the e2e processies")
+		return nil, errors.WithMessage(err, "Failed to add the e2e processes")
 	}
 
 	m.auth, err = auth.NewState(net.GetStorage().GetKV(), net.GetCmix(),
@@ -111,7 +110,7 @@ func loginLegacy(net *Cmix, callbacks AuthCallbacks,
 	return m, err
 }
 
-// login creates a new xxdk.E2e backed by the given versioned.KV
+// login creates a new xxdk.E2e backed by the given versioned.KV.
 func login(net *Cmix, callbacks AuthCallbacks, identity ReceptionIdentity,
 	kv *versioned.KV, params E2EParams) (m *E2e, err error) {
 
@@ -125,7 +124,8 @@ func login(net *Cmix, callbacks AuthCallbacks, identity ReceptionIdentity,
 		return nil, err
 	}
 	if !generatedId.Cmp(identity.ID) {
-		return nil, errors.Errorf("Given identity %s is invalid, generated ID does not match",
+		return nil, errors.Errorf(
+			"Given identity %s is invalid, generated ID does not match",
 			identity.ID.String())
 	}
 
@@ -139,63 +139,58 @@ func login(net *Cmix, callbacks AuthCallbacks, identity ReceptionIdentity,
 		return nil, err
 	}
 
-	// load or init the new e2e storage
+	// Load or init the new e2e storage
 	e2eGrp := net.GetStorage().GetE2EGroup()
-	m.e2e, err = e2e.Load(kv,
-		net.GetCmix(), identity.ID, e2eGrp, net.GetRng(),
+	m.e2e, err = e2e.Load(kv, net.GetCmix(), identity.ID, e2eGrp, net.GetRng(),
 		net.GetEventReporter())
 	if err != nil {
-		//initialize the e2e storage
-		err = e2e.Init(kv, identity.ID, dhPrivKey, e2eGrp,
-			params.Rekey)
+		// Initialize the e2e storage
+		err = e2e.Init(kv, identity.ID, dhPrivKey, e2eGrp, params.Rekey)
 		if err != nil {
 			return nil, err
 		}
 
-		//load the new e2e storage
-		m.e2e, err = e2e.Load(kv,
-			net.GetCmix(), identity.ID, e2eGrp, net.GetRng(),
-			net.GetEventReporter())
+		// Load the new e2e storage
+		m.e2e, err = e2e.Load(kv, net.GetCmix(), identity.ID, e2eGrp,
+			net.GetRng(), net.GetEventReporter())
 		if err != nil {
-			return nil, errors.WithMessage(err, "Failed to load a "+
-				"newly created e2e store")
+			return nil, errors.WithMessage(
+				err, "Failed to load a newly created e2e store")
 		}
 	}
 
 	err = net.AddService(m.e2e.StartProcesses)
 	if err != nil {
-		return nil, errors.WithMessage(err, "Failed to add "+
-			"the e2e processies")
+		return nil, errors.WithMessage(err, "Failed to add the e2e processes")
 	}
 
-	m.auth, err = auth.NewState(kv, net.GetCmix(),
-		m.e2e, net.GetRng(), net.GetEventReporter(),
-		params.Auth, params.Session,
+	m.auth, err = auth.NewState(kv, net.GetCmix(), m.e2e, net.GetRng(),
+		net.GetEventReporter(), params.Auth, params.Session,
 		MakeAuthCallbacksAdapter(callbacks, m), m.backup.TriggerBackup)
 	if err != nil {
 		return nil, err
 	}
 
 	net.network.AddIdentity(identity.ID, time.Time{}, true)
-	jww.INFO.Printf("Client logged in: \n\tReceptionID: %s",
-		identity.ID)
+	jww.INFO.Printf("Client logged in: \n\tReceptionID: %s", identity.ID)
 	return m, err
 }
 
-// loadOrInitE2eLegacy loads the e2e handler or makes a new one, generating a new
-// e2e private key. It attempts to load via a legacy construction, then tries
-// to load the modern one, creating a new modern ID if neither can be found
+// loadOrInitE2eLegacy loads the e2e.Handler or makes a new one, generating a
+// new E2E private key. It attempts to load via a legacy construction, then
+// tries to load the modern one, creating a new modern ID if neither can be
+// found.
 func loadOrInitE2eLegacy(identity ReceptionIdentity, net *Cmix) (e2e.Handler, error) {
 	e2eGrp := net.GetStorage().GetE2EGroup()
 	kv := net.GetStorage().GetKV()
 
-	//try to load a legacy e2e handler
+	// Try to load a legacy e2e handler
 	e2eHandler, err := e2e.LoadLegacy(kv,
 		net.GetCmix(), identity.ID, e2eGrp, net.GetRng(),
 		net.GetEventReporter(), rekey.GetDefaultParams())
 	if err != nil {
 		jww.DEBUG.Printf("e2e.LoadLegacy error: %v", err)
-		//if no legacy e2e handler exists, try to load a new one
+		// If no legacy e2e handler exists, try to load a new one
 		e2eHandler, err = e2e.Load(kv,
 			net.GetCmix(), identity.ID, e2eGrp, net.GetRng(),
 			net.GetEventReporter())
@@ -203,7 +198,7 @@ func loadOrInitE2eLegacy(identity ReceptionIdentity, net *Cmix) (e2e.Handler, er
 			jww.WARN.Printf("Failed to load e2e instance for %s, "+
 				"creating a new one: %v", identity.ID, err)
 
-			//initialize the e2e storage
+			// Initialize the e2e storage
 			privKey, err := identity.GetDHKeyPrivate()
 			if err != nil {
 				return nil, err
@@ -214,39 +209,38 @@ func loadOrInitE2eLegacy(identity ReceptionIdentity, net *Cmix) (e2e.Handler, er
 				return nil, err
 			}
 
-			//load the new e2e storage
+			// Load the new e2e storage
 			e2eHandler, err = e2e.Load(kv,
 				net.GetCmix(), identity.ID, e2eGrp, net.GetRng(),
 				net.GetEventReporter())
 			if err != nil {
-				return nil, errors.WithMessage(err, "Failed to load a "+
-					"newly created e2e store")
+				return nil, errors.WithMessage(err,
+					"Failed to load a newly created e2e store")
 			}
 		} else {
-			jww.INFO.Printf("Loaded a modern e2e instance for %s",
-				identity.ID)
+			jww.INFO.Printf("Loaded a modern e2e instance for %s", identity.ID)
 		}
 	} else {
-		jww.INFO.Printf("Loaded a legacy e2e instance for %s",
-			identity.ID)
+		jww.INFO.Printf("Loaded a legacy e2e instance for %s", identity.ID)
 	}
+
 	return e2eHandler, nil
 }
 
-// GetReceptionIdentity returns a safe copy of the E2e ReceptionIdentity
+// GetReceptionIdentity returns a safe copy of the E2e ReceptionIdentity.
 func (m *E2e) GetReceptionIdentity() ReceptionIdentity {
 	return m.e2eIdentity.DeepCopy()
 }
 
-// ConstructProtoUserFile is a helper function which is used for proto
-// client testing.  This is used for development testing.
+// ConstructProtoUserFile is a helper function that is used for proto client
+// testing. This is used for development testing.
 func (m *E2e) ConstructProtoUserFile() ([]byte, error) {
 
 	// load the registration code
 	regCode, err := m.GetStorage().GetRegCode()
 	if err != nil {
-		return nil, errors.WithMessage(err, "failed to register with "+
-			"permissioning")
+		return nil, errors.WithMessage(err,
+			"failed to register with permissioning")
 	}
 
 	transIdentity := m.Cmix.GetTransmissionIdentity()
@@ -276,26 +270,29 @@ func (m *E2e) ConstructProtoUserFile() ([]byte, error) {
 
 	jsonBytes, err := json.Marshal(Usr)
 	if err != nil {
-		return nil, errors.WithMessage(err, "failed to register with "+
-			"permissioning")
+		return nil, errors.WithMessage(err,
+			"failed to register with permissioning")
 	}
 
 	return jsonBytes, nil
 }
 
+// GetAuth returns the auth.State.
 func (m *E2e) GetAuth() auth.State {
 	return m.auth
 }
 
+// GetE2E returns the e2e.Handler.
 func (m *E2e) GetE2E() e2e.Handler {
 	return m.e2e
 }
 
+// GetBackupContainer returns the backup Container.
 func (m *E2e) GetBackupContainer() *Container {
 	return m.backup
 }
 
-// DeleteContact is a function which removes a partner from E2e's storage
+// DeleteContact removes a partner from E2e's storage.
 func (m *E2e) DeleteContact(partnerId *id.ID) error {
 	jww.DEBUG.Printf("Deleting contact with ID %s", partnerId)
 
@@ -322,7 +319,7 @@ func (m *E2e) DeleteContact(partnerId *id.ID) error {
 	return nil
 }
 
-// MakeAuthCallbacksAdapter creates an authCallbacksAdapter
+// MakeAuthCallbacksAdapter creates an authCallbacksAdapter.
 func MakeAuthCallbacksAdapter(ac AuthCallbacks, e2e *E2e) *authCallbacksAdapter {
 	return &authCallbacksAdapter{
 		ac:  ac,
@@ -331,12 +328,13 @@ func MakeAuthCallbacksAdapter(ac AuthCallbacks, e2e *E2e) *authCallbacksAdapter
 }
 
 // authCallbacksAdapter is an adapter type to make the AuthCallbacks type
-// compatible with the auth.Callbacks type
+// compatible with the auth.Callbacks type.
 type authCallbacksAdapter struct {
 	ac  AuthCallbacks
 	e2e *E2e
 }
 
+// MakeAuthCB generates a new auth.Callbacks with the given AuthCallbacks.
 func MakeAuthCB(e2e *E2e, cbs AuthCallbacks) auth.Callbacks {
 	return &authCallbacksAdapter{
 		ac:  cbs,
@@ -344,33 +342,36 @@ func MakeAuthCB(e2e *E2e, cbs AuthCallbacks) auth.Callbacks {
 	}
 }
 
+// Request will be called when an auth Request message is processed.
 func (aca *authCallbacksAdapter) Request(partner contact.Contact,
 	receptionID receptionID.EphemeralIdentity, round rounds.Round) {
 	aca.ac.Request(partner, receptionID, round, aca.e2e)
 }
 
+// Confirm will be called when an auth Confirm message is processed.
 func (aca *authCallbacksAdapter) Confirm(partner contact.Contact,
 	receptionID receptionID.EphemeralIdentity, round rounds.Round) {
 	aca.ac.Confirm(partner, receptionID, round, aca.e2e)
 }
 
+// Reset will be called when an auth Reset operation occurs.
 func (aca *authCallbacksAdapter) Reset(partner contact.Contact,
 	receptionID receptionID.EphemeralIdentity, round rounds.Round) {
 	aca.ac.Reset(partner, receptionID, round, aca.e2e)
 }
 
-// DefaultAuthCallbacks is a simple structure for providing a default Callbacks implementation
-// It should generally not be used.
+// DefaultAuthCallbacks is a simple structure for providing a default
+// AuthCallbacks implementation. It should generally not be used.
 type DefaultAuthCallbacks struct{}
 
-// Confirm will be called when an auth Confirm message is processed.
-func (a DefaultAuthCallbacks) Confirm(contact.Contact,
+// Request will be called when an auth Request message is processed.
+func (a DefaultAuthCallbacks) Request(contact.Contact,
 	receptionID.EphemeralIdentity, rounds.Round, *E2e) {
 	jww.ERROR.Printf("No valid auth callback assigned!")
 }
 
-// Request will be called when an auth Request message is processed.
-func (a DefaultAuthCallbacks) Request(contact.Contact,
+// Confirm will be called when an auth Confirm message is processed.
+func (a DefaultAuthCallbacks) Confirm(contact.Contact,
 	receptionID.EphemeralIdentity, rounds.Round, *E2e) {
 	jww.ERROR.Printf("No valid auth callback assigned!")
 }

xxdk/event.go

@@ -5,21 +5,18 @@ import (
 )
 
 // ReportEvent reports an event from the client to api users, providing a
-// priority, category, eventType, and details
+// priority, category, eventType, and details.
 func (c *Cmix) ReportEvent(priority int, category, evtType, details string) {
 	c.events.Report(priority, category, evtType, details)
 }
 
-// RegisterEventCallback records the given function to receive
-// ReportableEvent objects. It returns the internal index
-// of the callback so that it can be deleted later.
-func (c *Cmix) RegisterEventCallback(name string,
-	myFunc event.Callback) error {
+// RegisterEventCallback records the given function to receive ReportableEvent
+// objects.
+func (c *Cmix) RegisterEventCallback(name string, myFunc event.Callback) error {
 	return c.events.RegisterEventCallback(name, myFunc)
 }
 
-// UnregisterEventCallback deletes the callback identified by the
-// index. It returns an error if it fails.
+// UnregisterEventCallback deletes the callback identified by the name.
 func (c *Cmix) UnregisterEventCallback(name string) {
 	c.events.UnregisterEventCallback(name)
 }

xxdk/identity.go

@@ -23,8 +23,8 @@ import (
 
 const idVersion = 0
 
-// ReceptionIdentity is used by the E2e object for managing
-// identities used for message pickup
+// ReceptionIdentity is used by the E2e object for managing identities used for
+// message pickup.
 type ReceptionIdentity struct {
 	ID            *id.ID
 	RSAPrivatePem []byte
@@ -33,9 +33,10 @@ type ReceptionIdentity struct {
 	E2eGrp        []byte
 }
 
-// StoreReceptionIdentity stores the given identity in Cmix storage with the given key
-// This is the ideal way to securely store identities, as the caller of this function
-// is only required to store the given key separately rather than the keying material
+// StoreReceptionIdentity stores the given identity in Cmix storage with the
+// given key. This is the ideal way to securely store identities, as the caller
+// of this function is only required to store the given key separately rather
+// than the keying material.
 func StoreReceptionIdentity(key string, identity ReceptionIdentity, net *Cmix) error {
 	marshalledIdentity, err := identity.Marshal()
 	if err != nil {
@@ -49,7 +50,8 @@ func StoreReceptionIdentity(key string, identity ReceptionIdentity, net *Cmix) e
 	})
 }
 
-// LoadReceptionIdentity loads the given identity in Cmix storage with the given key
+// LoadReceptionIdentity loads the given identity in Cmix storage with the given
+// key.
 func LoadReceptionIdentity(key string, net *Cmix) (ReceptionIdentity, error) {
 	storageObj, err := net.GetStorage().Get(key)
 	if err != nil {
@@ -59,62 +61,58 @@ func LoadReceptionIdentity(key string, net *Cmix) (ReceptionIdentity, error) {
 	return UnmarshalReceptionIdentity(storageObj.Data)
 }
 
-// Marshal returns the JSON representation of a ReceptionIdentity
+// Marshal returns the JSON representation of a ReceptionIdentity.
 func (r ReceptionIdentity) Marshal() ([]byte, error) {
 	return json.Marshal(&r)
 }
 
-// UnmarshalReceptionIdentity takes in a marshalled ReceptionIdentity
-// and converts it to an object
+// UnmarshalReceptionIdentity takes in a marshalled ReceptionIdentity and
+// converts it to an object.
 func UnmarshalReceptionIdentity(marshaled []byte) (ReceptionIdentity, error) {
 	newIdentity := ReceptionIdentity{}
 	return newIdentity, json.Unmarshal(marshaled, &newIdentity)
 }
 
-// GetDHKeyPrivate returns the DHKeyPrivate in go format
+// GetDHKeyPrivate returns the DHKeyPrivate.
 func (r ReceptionIdentity) GetDHKeyPrivate() (*cyclic.Int, error) {
 	dhKeyPriv := &cyclic.Int{}
 	err := dhKeyPriv.UnmarshalJSON(r.DHKeyPrivate)
 	return dhKeyPriv, err
 }
 
-// GetRSAPrivatePem returns the RSAPrivatePem in go format
+// GetRSAPrivatePem returns the RSAPrivatePem.
 func (r ReceptionIdentity) GetRSAPrivatePem() (*rsa.PrivateKey, error) {
 	return rsa.LoadPrivateKeyFromPem(r.RSAPrivatePem)
 }
 
-// GetGroup returns the cyclic.Group in go format
+// GetGroup returns the cyclic.Group.
 func (r ReceptionIdentity) GetGroup() (*cyclic.Group, error) {
 	grp := &cyclic.Group{}
 	return grp, grp.UnmarshalJSON(r.E2eGrp)
 }
 
-// MakeReceptionIdentity generates a new cryptographic identity
-// for receiving messages.
+// MakeReceptionIdentity generates a new cryptographic identity for receiving
+// messages.
 func MakeReceptionIdentity(net *Cmix) (ReceptionIdentity, error) {
 	rng := net.GetRng().GetStream()
 	defer rng.Close()
 	grp := net.GetStorage().GetE2EGroup()
 
-	//make RSA Key
-	rsaKey, err := rsa.GenerateKey(rng,
-		rsa.DefaultRSABitLen)
+	// Make RSA Key
+	rsaKey, err := rsa.GenerateKey(rng, rsa.DefaultRSABitLen)
 	if err != nil {
 		return ReceptionIdentity{}, err
 	}
 
-	//make salt
+	// Make salt
 	salt := make([]byte, 32)
 	_, err = rng.Read(salt)
 
-	//make dh private key
-	privKey := diffieHellman.GeneratePrivateKey(
-		len(grp.GetPBytes()),
-		grp, rng)
+	// Make DH private key
+	privKey := diffieHellman.GeneratePrivateKey(len(grp.GetPBytes()), grp, rng)
 
 	// make the ID
-	newId, err := xx.NewID(rsaKey.GetPublic(),
-		salt, id.User)
+	newId, err := xx.NewID(rsaKey.GetPublic(), salt, id.User)
 	if err != nil {
 		return ReceptionIdentity{}, err
 	}
@@ -129,7 +127,7 @@ func MakeReceptionIdentity(net *Cmix) (ReceptionIdentity, error) {
 		return ReceptionIdentity{}, err
 	}
 
-	//create the identity object
+	// Create the identity object
 	rsaPem := rsa.CreatePrivateKeyPem(rsaKey)
 	I := ReceptionIdentity{
 		ID:            newId,
@@ -142,15 +140,15 @@ func MakeReceptionIdentity(net *Cmix) (ReceptionIdentity, error) {
 	return I, nil
 }
 
-// MakeLegacyReceptionIdentity generates the cryptographic identity
-// for receiving messages based on the extant stored user.Info
+// MakeLegacyReceptionIdentity generates the cryptographic identity for
+// receiving messages based on the extant stored user.Info.
 func MakeLegacyReceptionIdentity(net *Cmix) (ReceptionIdentity, error) {
 	userInfo := net.GetStorage().PortableUserInfo()
 	return buildReceptionIdentity(userInfo.ReceptionID, userInfo.ReceptionSalt,
 		userInfo.ReceptionRSA, net.GetStorage().GetE2EGroup(), userInfo.E2eDhPrivateKey)
 }
 
-// DeepCopy produces a safe copy of a ReceptionIdentity
+// DeepCopy produces a safe copy of the ReceptionIdentity.
 func (r ReceptionIdentity) DeepCopy() ReceptionIdentity {
 	saltCopy := make([]byte, len(r.Salt))
 	copy(saltCopy, r.Salt)
@@ -169,7 +167,7 @@ func (r ReceptionIdentity) DeepCopy() ReceptionIdentity {
 	}
 }
 
-// GetContact accepts a xxdk.ReceptionIdentity object and returns a contact.Contact object
+// GetContact returns a contact.Contact object of the reception identity.
 func (r ReceptionIdentity) GetContact() contact.Contact {
 	grp, _ := r.GetGroup()
 	dhKeyPriv, _ := r.GetDHKeyPrivate()
@@ -183,10 +181,11 @@ func (r ReceptionIdentity) GetContact() contact.Contact {
 	return ct
 }
 
-// buildReceptionIdentity creates a new ReceptionIdentity
-// from the given user.Info
-func buildReceptionIdentity(receptionId *id.ID, receptionSalt []byte, receptionRsa *rsa.PrivateKey,
-	e2eGrp *cyclic.Group, dHPrivkey *cyclic.Int) (ReceptionIdentity, error) {
+// buildReceptionIdentity creates a new ReceptionIdentity from the given
+// user.Info.
+func buildReceptionIdentity(receptionId *id.ID, receptionSalt []byte,
+	receptionRsa *rsa.PrivateKey, e2eGrp *cyclic.Group, dHPrivkey *cyclic.Int) (
+	ReceptionIdentity, error) {
 	saltCopy := make([]byte, len(receptionSalt))
 	copy(saltCopy, receptionSalt)
 
@@ -208,17 +207,18 @@ func buildReceptionIdentity(receptionId *id.ID, receptionSalt []byte, receptionR
 	}, nil
 }
 
-// TransmissionIdentity represents the identity
-// used to transmit over the network via a specific Cmix object
+// TransmissionIdentity represents the identity used to transmit over the
+// network via a specific Cmix object.
 type TransmissionIdentity struct {
 	ID            *id.ID
 	RSAPrivatePem *rsa.PrivateKey
 	Salt          []byte
-	// Timestamp in which user has registered with the network
+
+	// Timestamp of when the user has registered with the network
 	RegistrationTimestamp int64
 }
 
-// DeepCopy produces a safe copy of a TransmissionIdentity
+// DeepCopy produces a safe copy of a TransmissionIdentity.
 func (t TransmissionIdentity) DeepCopy() TransmissionIdentity {
 	saltCopy := make([]byte, len(t.Salt))
 	copy(saltCopy, t.Salt)
@@ -230,8 +230,8 @@ func (t TransmissionIdentity) DeepCopy() TransmissionIdentity {
 	}
 }
 
-// buildTransmissionIdentity creates a new TransmissionIdentity
-// from the given user.Info
+// buildTransmissionIdentity creates a new TransmissionIdentity from the given
+// user.Info.
 func buildTransmissionIdentity(userInfo user.Info) TransmissionIdentity {
 	saltCopy := make([]byte, len(userInfo.TransmissionSalt))
 	copy(saltCopy, userInfo.TransmissionSalt)

xxdk/ndf.go

@@ -10,6 +10,7 @@ package xxdk
 import (
 	"encoding/base64"
 	"github.com/pkg/errors"
+	jww "github.com/spf13/jwalterweatherman"
 	pb "gitlab.com/elixxir/comms/mixmessages"
 	"gitlab.com/xx_network/comms/signature"
 	"gitlab.com/xx_network/crypto/tls"
@@ -19,33 +20,37 @@ import (
 )
 
 // DownloadAndVerifySignedNdfWithUrl retrieves the NDF from a specified URL.
-// The NDF is processed into a protobuf containing a signature which
-// is verified using the cert string passed in. The NDF is returned as marshaled
-// byte data which may be used to start a client.
+// The NDF is processed into a protobuf containing a signature that is verified
+// using the cert string passed in. The NDF is returned as marshaled byte data
+// that may be used to start a client.
 func DownloadAndVerifySignedNdfWithUrl(url, cert string) ([]byte, error) {
 	// Build a request for the file
 	resp, err := http.Get(url)
 	if err != nil {
-		return nil, errors.WithMessagef(err, "Failed to retrieve "+
-			"NDF from %s", url)
+		return nil, errors.WithMessagef(
+			err, "Failed to retrieve NDF from %s", url)
 	}
-	defer resp.Body.Close()
+	defer func() {
+		if err = resp.Body.Close(); err != nil {
+			jww.ERROR.Printf("Failed to close http response body: %+v", err)
+		}
+	}()
 
 	// Download contents of the file
 	signedNdfEncoded, err := ioutil.ReadAll(resp.Body)
 	if err != nil {
-		return nil, errors.WithMessage(err, "Failed to read signed "+
-			"NDF response request")
+		return nil, errors.WithMessage(
+			err, "Failed to read signed NDF response request")
 	}
 
 	// Process the download NDF and return the marshaled NDF
 	return processAndVerifySignedNdf(signedNdfEncoded, cert)
 }
 
-// processAndVerifySignedNdf is a helper function which parses the downloaded NDF
+// processAndVerifySignedNdf is a helper function that parses the downloaded NDF
 // into a protobuf containing a signature. The signature is verified using the
-// passed in cert. Upon successful parsing and verification, the NDF is
-// returned as byte data.
+// passed in cert. Upon successful parsing and verification, the NDF is returned
+// as byte data.
 func processAndVerifySignedNdf(signedNdfEncoded []byte, cert string) ([]byte, error) {
 	// Base64 decode the signed NDF
 	signedNdfMarshaled, err := base64.StdEncoding.DecodeString(
@@ -58,26 +63,29 @@ func processAndVerifySignedNdf(signedNdfEncoded []byte, cert string) ([]byte, er
 	signedNdfMsg := &pb.NDF{}
 	err = proto.Unmarshal(signedNdfMarshaled, signedNdfMsg)
 	if err != nil {
-		return nil, errors.WithMessage(err, "Failed to unmarshal "+
-			"signed NDF into protobuf")
+		return nil, errors.WithMessage(err,
+			"Failed to unmarshal signed NDF into protobuf")
 	}
 
 	// Load the certificate from it's PEM contents
 	schedulingCert, err := tls.LoadCertificate(cert)
 	if err != nil {
-		return nil, errors.WithMessagef(err, "Failed to parse scheduling cert (%s)", cert)
+		return nil, errors.WithMessagef(err,
+			"Failed to parse scheduling cert (%s)", cert)
 	}
 
 	// Extract the public key from the cert
 	schedulingPubKey, err := tls.ExtractPublicKey(schedulingCert)
 	if err != nil {
-		return nil, errors.WithMessage(err, "Failed to extract public key from cert")
+		return nil, errors.WithMessage(err,
+			"Failed to extract public key from cert")
 	}
 
 	// Verify signed NDF message
 	err = signature.VerifyRsa(signedNdfMsg, schedulingPubKey)
 	if err != nil {
-		return nil, errors.WithMessage(err, "Failed to verify signed NDF message")
+		return nil, errors.WithMessage(err,
+			"Failed to verify signed NDF message")
 	}
 
 	return signedNdfMsg.Ndf, nil

xxdk/notifications.go

@@ -16,18 +16,17 @@ import (
 	"gitlab.com/xx_network/primitives/id/ephemeral"
 )
 
-// RegisterForNotifications allows a client to register for push
-// notifications.
-// Note that clients are not required to register for push notifications
-// especially as these rely on third parties (i.e., Firebase *cough*
-// *cough* google's palantir *cough*) that may represent a security
-// risk to the user.
+// RegisterForNotifications allows a client to register for push notifications.
+// Note that clients are not required to register for push notifications,
+// especially as these rely on third parties (i.e., Firebase *cough* *cough*
+// Google's palantir *cough*) that may represent a security risk to the user.
 func (m *E2e) RegisterForNotifications(token string) error {
 	jww.INFO.Printf("RegisterForNotifications(%s)", token)
 	// Pull the host from the manage
 	notificationBotHost, ok := m.GetComms().GetHost(&id.NotificationBot)
 	if !ok {
-		return errors.New("RegisterForNotifications: Failed to retrieve host for notification bot")
+		return errors.New("RegisterForNotifications: " +
+			"Failed to retrieve host for notification bot")
 	}
 	intermediaryReceptionID, sig, err := m.getIidAndSig()
 	if err != nil {
@@ -59,7 +58,7 @@ func (m *E2e) RegisterForNotifications(token string) error {
 	return nil
 }
 
-// UnregisterForNotifications turns of notifications for this client
+// UnregisterForNotifications turns off notifications for this client.
 func (m *E2e) UnregisterForNotifications() error {
 	jww.INFO.Printf("UnregisterForNotifications()")
 	// Pull the host from the manage
@@ -71,8 +70,9 @@ func (m *E2e) UnregisterForNotifications() error {
 	if err != nil {
 		return err
 	}
-	// Send the unregister message
-	_, err = m.GetComms().UnregisterForNotifications(notificationBotHost, &mixmessages.NotificationUnregisterRequest{
+	// Sends the unregister message
+	_, err = m.GetComms().UnregisterForNotifications(notificationBotHost,
+		&mixmessages.NotificationUnregisterRequest{
 			IntermediaryId:        intermediaryReceptionID,
 			IIDTransmissionRsaSig: sig,
 		})
@@ -86,17 +86,21 @@ func (m *E2e) UnregisterForNotifications() error {
 }
 
 func (m *E2e) getIidAndSig() ([]byte, []byte, error) {
-	intermediaryReceptionID, err := ephemeral.GetIntermediaryId(m.GetStorage().GetReceptionID())
+	intermediaryReceptionID, err := ephemeral.GetIntermediaryId(
+		m.GetStorage().GetReceptionID())
 	if err != nil {
-		return nil, nil, errors.WithMessage(err, "RegisterForNotifications: Failed to form intermediary ID")
+		return nil, nil, errors.WithMessage(err,
+			"RegisterForNotifications: Failed to form intermediary ID")
 	}
 	h, err := hash.NewCMixHash()
 	if err != nil {
-		return nil, nil, errors.WithMessage(err, "RegisterForNotifications: Failed to create cmix hash")
+		return nil, nil, errors.WithMessage(err,
+			"RegisterForNotifications: Failed to create cMix hash")
 	}
 	_, err = h.Write(intermediaryReceptionID)
 	if err != nil {
-		return nil, nil, errors.WithMessage(err, "RegisterForNotifications: Failed to write intermediary ID to hash")
+		return nil, nil, errors.WithMessage(err,
+			"RegisterForNotifications: Failed to write intermediary ID to hash")
 	}
 
 	stream := m.GetRng().GetStream()
@@ -104,7 +108,8 @@ func (m *E2e) getIidAndSig() ([]byte, []byte, error) {
 		m.GetStorage().GetTransmissionRSA(),
 		hash.CMixHash, h.Sum(nil), nil)
 	if err != nil {
-		return nil, nil, errors.WithMessage(err, "RegisterForNotifications: Failed to sign intermediary ID")
+		return nil, nil, errors.WithMessage(err,
+			"RegisterForNotifications: Failed to sign intermediary ID")
 	}
 	stream.Close()
 	return intermediaryReceptionID, sig, nil

xxdk/params.go

@@ -20,8 +20,8 @@ import (
 	"gitlab.com/elixxir/client/e2e/rekey"
 )
 
-// CMIXParams contains the parameters for Network tracking and for
-// specific CMIX messaging settings.
+// CMIXParams contains the parameters for Network tracking and for specific CMIX
+// messaging settings.
 //
 // FIXME: this breakdown could be cleaner and is an unfortunate side effect of
 //        several refactors of the codebase.
@@ -32,8 +32,8 @@ type CMIXParams struct {
 
 // E2EParams holds all the settings for e2e and it's various submodules.
 //
-// NOTE: "Base" wraps cmix.CMIXParams to control message send params,
-//       so xxdk library users should copy the desired settings to both.
+// Note that Base wraps cmix.CMIXParams to control message send params, so that
+// xxdk library users should copy the desired settings to both.
 // FIXME: this should not wrap a copy of cmix.CMIXParams.
 type E2EParams struct {
 	Session        session.Params
@@ -43,10 +43,11 @@ type E2EParams struct {
 	Auth           auth.Params
 }
 
-////////////////////////////////////////
-// -- CMix Params Helper Functions -- //
-////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+// CMix Params Helper Functions                                               //
+////////////////////////////////////////////////////////////////////////////////
 
+// GetDefaultCMixParams returns a new CMIXParams with the default parameters.
 func GetDefaultCMixParams() CMIXParams {
 	return CMIXParams{
 		Network: cmix.GetDefaultParams(),
@@ -54,20 +55,22 @@ func GetDefaultCMixParams() CMIXParams {
 	}
 }
 
-// Unmarshal fills an empty object with the deserialized contents of jsonData
+// Unmarshal fills an empty object with the deserialized contents of the JSON
+// data.
 func (p *CMIXParams) Unmarshal(jsonData []byte) error {
 	return json.Unmarshal(jsonData, p)
 }
 
-// Marshal creates json data of the object
+// Marshal creates JSON data of the object.
 func (p *CMIXParams) Marshal() ([]byte, error) {
 	return json.Marshal(p)
 }
 
-////////////////////////////////////////
-// -- E2E Params Helper Functions --  //
-////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////
+// E2E Params Helper Functions                                                //
+////////////////////////////////////////////////////////////////////////////////
 
+// GetDefaultE2EParams returns a new E2EParams with the default parameters.
 func GetDefaultE2EParams() E2EParams {
 	return E2EParams{
 		Session:        session.GetDefaultParams(),
@@ -78,12 +81,13 @@ func GetDefaultE2EParams() E2EParams {
 	}
 }
 
-// Unmarshal fills an empty object with the deserialized contents of jsonData
+// Unmarshal fills an empty object with the deserialized contents of the JSON
+// data.
 func (p *E2EParams) Unmarshal(jsonData []byte) error {
 	return json.Unmarshal(jsonData, p)
 }
 
-// Marshal creates json data of the object
+// Marshal creates JSON data of the object.
 func (p *E2EParams) Marshal() ([]byte, error) {
 	return json.Marshal(p)
 }

xxdk/params_test.go

@@ -13,8 +13,8 @@ import (
 	"testing"
 )
 
-// Tests that no data is lost when marshaling and
-// unmarshaling the Params object.
+// Tests that no data is lost when marshaling and unmarshalling the CMIXParams
+// object.
 func TestParams_MarshalUnmarshal(t *testing.T) {
 	// Construct a set of params
 	p := GetDefaultCMixParams()
@@ -42,9 +42,8 @@ func TestParams_MarshalUnmarshal(t *testing.T) {
 
 	t.Logf("%s", string(data2))
 
-	// Check that they match (it is done this way to avoid
-	// false failures with the reflect.DeepEqual function and
-	// pointers)
+	// Check that they match (it is done this way to avoid false failures when
+	// using the reflect.DeepEqual function and pointers)
 	if !bytes.Equal(data, data2) {
 		t.Fatalf("Data was lost in marshal/unmarshal.")
 	}

xxdk/permissioning.go

@@ -14,26 +14,24 @@ import (
 	"gitlab.com/elixxir/client/storage/user"
 )
 
-// Returns an error if registration fails.
+// registerWithPermissioning returns an error if registration fails.
 func (c *Cmix) registerWithPermissioning() error {
-	//get the users public key
+	// Get the users public key
 	transmissionPubKey := c.storage.GetTransmissionRSA().GetPublic()
 	receptionPubKey := c.storage.GetReceptionRSA().GetPublic()
 
-	//load the registration code
+	// Load the registration code
 	regCode, err := c.storage.GetRegCode()
 	if err != nil {
-		return errors.WithMessage(err, "failed to register with "+
-			"permissioning")
+		return errors.WithMessage(err, "failed to register with permissioning")
 	}
 
-	//register with registration
+	// Register with registration
 	transmissionRegValidationSignature, receptionRegValidationSignature,
 		registrationTimestamp, err := c.permissioning.Register(
 		transmissionPubKey, receptionPubKey, regCode)
 	if err != nil {
-		return errors.WithMessage(err, "failed to register with "+
-			"permissioning")
+		return errors.WithMessage(err, "failed to register with permissioning")
 	}
 
 	// store the signature
@@ -43,7 +41,7 @@ func (c *Cmix) registerWithPermissioning() error {
 		receptionRegValidationSignature)
 	c.storage.SetRegistrationTimestamp(registrationTimestamp)
 
-	//update the registration state
+	// Update the registration state
 	err = c.storage.ForwardRegistrationStatus(storage.PermissioningComplete)
 	if err != nil {
 		return errors.WithMessage(err, "failed to update local state "+
@@ -52,15 +50,14 @@ func (c *Cmix) registerWithPermissioning() error {
 	return nil
 }
 
-// ConstructProtoUserFile is a helper function which is used for proto
-// client testing.  This is used for development testing.
+// ConstructProtoUserFile is a helper function that is used for proto client
+// testing. This is used for development testing.
 func (c *Cmix) ConstructProtoUserFile() ([]byte, error) {
 
-	//load the registration code
+	// Load the registration code
 	regCode, err := c.storage.GetRegCode()
 	if err != nil {
-		return nil, errors.WithMessage(err, "failed to register with "+
-			"permissioning")
+		return nil, errors.WithMessage(err, "failed to get registration code")
 	}
 
 	userInfo := c.GetStorage().PortableUserInfo()
@@ -82,8 +79,7 @@ func (c *Cmix) ConstructProtoUserFile() ([]byte, error) {
 
 	jsonBytes, err := json.Marshal(Usr)
 	if err != nil {
-		return nil, errors.WithMessage(err, "failed to register with "+
-			"permissioning")
+		return nil, errors.WithMessage(err, "failed to JSON marshal user.Proto")
 	}
 
 	return jsonBytes, nil

xxdk/precan.go

@@ -22,11 +22,11 @@ import (
 	"gitlab.com/xx_network/crypto/csprng"
 )
 
-// NewPrecannedClient creates an insecure user with predetermined keys
-// with nodes It creates client storage, generates keys, connects, and
-// registers with the network. Note that this does not register a
-// username/identity, but merely creates a new cryptographic identity
-// for adding such information at a later date.
+// NewPrecannedClient creates an insecure user with predetermined keys with
+// nodes. It creates client storage, generates keys, connects, and registers
+// with the network. Note that this does not register a username/identity, but
+// merely creates a new cryptographic identity for adding such information at a
+// later date.
 func NewPrecannedClient(precannedID uint, defJSON, storageDir string,
 	password []byte) error {
 	jww.INFO.Printf("NewPrecannedClient()")
@@ -57,7 +57,8 @@ func NewPrecannedClient(precannedID uint, defJSON, storageDir string,
 	return err
 }
 
-// MakePrecannedAuthenticatedChannel creates an insecure e2e relationship with a precanned user
+// MakePrecannedAuthenticatedChannel creates an insecure E2E relationship with a
+// precanned user.
 func (m *E2e) MakePrecannedAuthenticatedChannel(precannedID uint) (
 	contact.Contact, error) {
 
@@ -98,14 +99,14 @@ func (m *E2e) MakePrecannedAuthenticatedChannel(precannedID uint) (
 	}
 	mySIDHPrivKey.GeneratePublicKey(mySIDHPubKey)
 
-	// add the precanned user as a e2e contact
+	// Add the precanned user as a e2e contact
 	// FIXME: these params need to be threaded through...
 	sesParam := session.GetDefaultParams()
 	_, err = m.e2e.AddPartner(precanContact.ID, precanContact.DhPubKey,
 		m.e2e.GetHistoricalDHPrivkey(), theirSIDHPubKey,
 		mySIDHPrivKey, sesParam, sesParam)
 
-	// check garbled messages in case any messages arrived before creating
+	// Check garbled messages in case any messages arrived before creating
 	// the channel
 	m.GetCmix().CheckInProgressMessages()
 

xxdk/services.go

@@ -7,8 +7,8 @@ import (
 	"time"
 )
 
-// a service process starts itself in a new thread, returning from the
-// originator a stopable to control it
+// Service is a service process that starts itself in a new thread, returning
+// from the originator a stoppable to control it.
 type Service func() (stoppable.Stoppable, error)
 
 type services struct {
@@ -18,8 +18,8 @@ type services struct {
 	mux       sync.Mutex
 }
 
-// newServiceProcessiesList creates a new services list which will add its
-// services to the passed mux
+// newServices creates a new services list that will add its services to the
+// passed mux.
 func newServices() *services {
 	return &services{
 		services:  make([]Service, 0),
@@ -28,8 +28,8 @@ func newServices() *services {
 	}
 }
 
-// Add adds the service process to the list and adds it to the multi-stopable.
-// Start running it if services are running
+// add appends the service process to the list and adds it to the multi-
+// stoppable. Start running it if services are running.
 func (s *services) add(sp Service) error {
 	s.mux.Lock()
 	defer s.mux.Unlock()
@@ -48,9 +48,9 @@ func (s *services) add(sp Service) error {
 	return nil
 }
 
-// Runs all services. If they are in the process of stopping,
-// it will wait for the stop to complete or the timeout to ellapse
-// Will error if already running
+// start runs all services. If they are in the process of stopping, it will wait
+// for the stop to complete or the timeout to elapse. Will error if already
+// running.
 func (s *services) start(timeout time.Duration) error {
 	s.mux.Lock()
 	defer s.mux.Unlock()
@@ -69,10 +69,10 @@ func (s *services) start(timeout time.Duration) error {
 		}
 	}
 
-	//create a new stopable
+	// Create a new stoppable
 	s.stoppable = stoppable.NewMulti(followerStoppableName)
 
-	//start all services and register with the stoppable
+	// Start all services and register with the stoppable
 	for _, sp := range s.services {
 		stop, err := sp()
 		if err != nil {
@@ -86,8 +86,8 @@ func (s *services) start(timeout time.Duration) error {
 	return nil
 }
 
-// Stops all currently running services. Will return an
-// error if the state is not "running"
+// stop closes all currently running services. It returns an error if the stat
+// is not Running.
 func (s *services) stop() error {
 	s.mux.Lock()
 	defer s.mux.Unlock()
@@ -108,7 +108,7 @@ func (s *services) stop() error {
 	return nil
 }
 
-// returns the current state of services
+// status returns the current state of services.
 func (s *services) status() Status {
 	s.mux.Lock()
 	defer s.mux.Unlock()

xxdk/services_test.go

@@ -8,15 +8,15 @@
 package xxdk
 
 import (
-	"errors"
+	"github.com/pkg/errors"
 	"gitlab.com/elixxir/client/stoppable"
 	"reflect"
 	"testing"
 	"time"
 )
 
-// Unit test
-func TestNewServices(t *testing.T) {
+// Unit test of newServices.
+func Test_newServices(t *testing.T) {
 	expected := &services{
 		services:  make([]Service, 0),
 		stoppable: stoppable.NewMulti("services"),
@@ -32,8 +32,8 @@ func TestNewServices(t *testing.T) {
 	}
 }
 
-// Unit test
-func TestServices_Add(t *testing.T) {
+// Unit test of services.add.
+func Test_services_add(t *testing.T) {
 	mockService := func() (stoppable.Stoppable, error) {
 		return nil, nil
 	}
@@ -42,7 +42,7 @@ func TestServices_Add(t *testing.T) {
 
 	err := mockServices.add(mockService)
 	if err != nil {
-		t.Fatalf("Failed to add mock service to services: %v", err)
+		t.Fatalf("Failed to add mock service to the services list: %v", err)
 	}
 
 	err = mockServices.start(500 * time.Millisecond)
@@ -62,7 +62,8 @@ func TestServices_Add(t *testing.T) {
 	}
 }
 
-func TestServices_Start(t *testing.T) {
+// Unit test of services.start.
+func Test_services_start(t *testing.T) {
 	mockService := func() (stoppable.Stoppable, error) {
 		return nil, nil
 	}
@@ -71,7 +72,7 @@ func TestServices_Start(t *testing.T) {
 
 	err := mockServices.add(mockService)
 	if err != nil {
-		t.Fatalf("Failed to add mock service to services: %v", err)
+		t.Fatalf("Failed to add mock service to the services list: %v", err)
 	}
 
 	err = mockServices.start(500)
@@ -86,7 +87,8 @@ func TestServices_Start(t *testing.T) {
 	}
 }
 
-func TestServices_Stop(t *testing.T) {
+// Unit test of services.stop.
+func Test_services_stop(t *testing.T) {
 	mockService := func() (stoppable.Stoppable, error) {
 		return stoppable.NewSingle("test"), nil
 	}
@@ -95,7 +97,7 @@ func TestServices_Stop(t *testing.T) {
 
 	err := mockServices.add(mockService)
 	if err != nil {
-		t.Fatalf("Failed to add mock service to services: %v", err)
+		t.Fatalf("Failed to add mock service to the services list: %v", err)
 	}
 
 	err = mockServices.stop()

xxdk/status.go

@@ -11,14 +11,25 @@ import (
 	"fmt"
 )
 
+// Status holds the status of the network.
 type Status int
 
 const (
+	// Stopped signifies that the network follower is stopped; none of its
+	// processes are running.
 	Stopped Status = 0
+
+	// Running signifies that the network follower and its processes are active
+	// and running.
 	Running Status = 2000
+
+	// Stopping signifies that the network follower has been signalled to stop
+	// and is in the processes of stopping the processes.
 	Stopping Status = 3000
 )
 
+// String returns a human-readable string version of the status. This function
+// adheres to the fmt.Stringer interface.
 func (s Status) String() string {
 	switch s {
 	case Stopped:
@@ -28,6 +39,6 @@ func (s Status) String() string {
 	case Stopping:
 		return "Stopping"
 	default:
-		return fmt.Sprintf("Unknown state %d", s)
+		return fmt.Sprintf("Unknown status %d", s)
 	}
 }

xxdk/user.go

@@ -28,11 +28,11 @@ import (
 )
 
 const (
-	// SaltSize size of user salts
+	// SaltSize is the length of user salts, in bytes.
 	SaltSize = 32
 )
 
-// createNewUser generates an identity for cMix
+// createNewUser generates an identity for cMix.
 func createNewUser(rng *fastRNG.StreamGenerator, e2eGroup *cyclic.Group) user.Info {
 	// CMIX Keygen
 	var transmissionRsaKey, receptionRsaKey *rsa.PrivateKey
@@ -67,9 +67,8 @@ func createNewUser(rng *fastRNG.StreamGenerator, e2eGroup *cyclic.Group) user.In
 	}
 }
 
-func createKeys(rng *fastRNG.StreamGenerator,
-	e2e *cyclic.Group) (e2eKeyBytes,
-	transmissionSalt, receptionSalt []byte,
+func createKeys(rng *fastRNG.StreamGenerator, e2e *cyclic.Group) (
+	e2eKeyBytes, transmissionSalt, receptionSalt []byte,
 	transmissionRsaKey, receptionRsaKey *rsa.PrivateKey) {
 	wg := sync.WaitGroup{}
 
@@ -81,7 +80,7 @@ func createKeys(rng *fastRNG.StreamGenerator,
 		// DH Keygen
 		// FIXME: Why 256 bits? -- this is spec but not explained, it has
 		//  to do with optimizing operations on one side and still preserves
-		// decent security -- cite this. Why valid for BOTH e2e and cmix?
+		//  decent security -- cite this. Why valid for BOTH e2e and cMix?
 		stream := rng.GetStream()
 		e2eKeyBytes, err = csprng.GenerateInGroup(e2e.GetPBytes(), 256, stream)
 		stream.Close()
@@ -128,8 +127,8 @@ func createKeys(rng *fastRNG.StreamGenerator,
 
 }
 
-// createNewVanityUser generates an identity for cMix
-// The identity's ReceptionID is not random but starts with the supplied prefix
+// createNewVanityUser generates an identity for cMix. The identity's
+// ReceptionID is not random but starts with the supplied prefix.
 func createNewVanityUser(rng csprng.Source,
 	e2e *cyclic.Group, prefix string) user.Info {
 	// DH Keygen
@@ -164,8 +163,8 @@ func createNewVanityUser(rng csprng.Source,
 		jww.FATAL.Panicf(err.Error())
 	}
 
-	// just in case more than one go routine tries to access
-	// receptionSalt and receptionID
+	// Just in case more than one go routine tries to access receptionSalt and
+	// receptionID
 	var mu sync.Mutex
 	done := make(chan struct{})
 	found := make(chan bool)
@@ -177,11 +176,13 @@ func createNewVanityUser(rng csprng.Source,
 
 	pref := prefix
 	ignoreCase := false
-	// check if case-insensitivity is enabled
+
+	// Check if case-insensitivity is enabled
 	if strings.HasPrefix(prefix, "(?i)") {
 		pref = strings.ToLower(pref[4:])
 		ignoreCase = true
 	}
+
 	// Check if prefix contains valid Base64 characters
 	match, _ := regexp.MatchString("^[A-Za-z0-9+/]+$", pref)
 	if match == false {
@@ -233,11 +234,13 @@ func createNewVanityUser(rng csprng.Source,
 			}
 		}()
 	}
-	// wait for a solution then close the done channel to signal
-	// the workers to exit
+
+	// Wait for a solution then close the done channel to signal the workers to
+	// exit
 	<-found
 	close(done)
 	wg.Wait()
+
 	return user.Info{
 		TransmissionID:   transmissionID.DeepCopy(),
 		TransmissionSalt: transmissionSalt,
@@ -251,7 +254,6 @@ func createNewVanityUser(rng csprng.Source,
 	}
 }
 
-// createPrecannedUser
 func createPrecannedUser(precannedID uint, rng csprng.Source, grp *cyclic.Group) user.Info {
 	// Salt, UID, etc gen
 	salt := make([]byte, SaltSize)

xxdk/utils.go

@@ -25,8 +25,8 @@ const (
 	desiredPreviewSize = 32 * 24
 )
 
-// CompressJpeg takes a JPEG image in byte format
-// and compresses it based on desired output size
+// CompressJpeg takes a JPEG image in byte format and compresses it based on
+// desired output size.
 func CompressJpeg(imgBytes []byte) ([]byte, error) {
 	// Convert bytes to a reader
 	imgBuf := bytes.NewReader(imgBytes)
@@ -76,8 +76,8 @@ func CompressJpeg(imgBytes []byte) ([]byte, error) {
 	return newImgBuf.Bytes(), nil
 }
 
-// CompressJpeg takes a JPEG image in byte format
-// and compresses it based on desired output size
+// CompressJpegForPreview takes a JPEG image in byte format and compresses it
+// based on desired output size.
 func CompressJpegForPreview(imgBytes []byte) ([]byte, error) {
 	// Convert bytes to a reader
 	imgBuf := bytes.NewReader(imgBytes)

xxdk/utils_test.go

@@ -58,8 +58,11 @@ func newTestingClient(face interface{}) (*Cmix, error) {
 		jww.FATAL.Panicf("Failed to create new test instance: %v", err)
 	}
 
-	commsManager.AddHost(&id.Permissioning, "", cert,
-		connect.GetDefaultHostParams())
+	_, err = commsManager.AddHost(
+		&id.Permissioning, "", cert, connect.GetDefaultHostParams())
+	if err != nil {
+		return nil, err
+	}
 	instanceComms := &connect.ProtoComms{
 		Manager: commsManager,
 	}
@@ -82,7 +85,7 @@ func newTestingClient(face interface{}) (*Cmix, error) {
 	return c, nil
 }
 
-// Helper function which generates an ndf for testing
+// Helper function that generates an NDF for testing.
 func getNDF(face interface{}) *ndf.NetworkDefinition {
 	switch face.(type) {
 	case *testing.T, *testing.M, *testing.B, *testing.PB:
@@ -152,8 +155,8 @@ func getNDF(face interface{}) *ndf.NetworkDefinition {
 	}
 }
 
-// Signs a passed round info with the key tied to the test nodes cert
-// used throughout utils and other tests
+// signRoundInfo signs a passed round info with the key tied to the test node's
+// cert used throughout utils and other tests.
 func signRoundInfo(ri *pb.RoundInfo) error {
 	privKeyFromFile := testkeys.LoadFromPath(testkeys.GetNodeKeyPath())