cleanup

cluster/state/mutation.go

@@ -4,6 +4,7 @@ package state
 
 import "github.com/obolnetwork/charon/cluster"
 
+// MutationType represents the type of a mutation.
 type MutationType string
 
 func (t MutationType) String() string {

cluster/state/mutationlegacylock.go

@@ -55,6 +55,7 @@ func (l lockWrapper) HashTreeRootWith(hw ssz.HashWalker) error {
 	return nil
 }
 
+// verifyLegacyLock verifies that the signed mutation is a valid legacy lock.
 func verifyLegacyLock(signed SignedMutation) error {
 	if signed.Mutation.Type != TypeLegacyLock {
 		return errors.New("invalid mutation type")
@@ -78,6 +79,7 @@ func verifyLegacyLock(signed SignedMutation) error {
 	return wrapper.Lock.VerifySignatures()
 }
 
+// transformLegacyLock transforms the cluster state with the provided legacy lock mutation.
 func transformLegacyLock(_ Cluster, signed SignedMutation) (Cluster, error) {
 	if err := verifyLegacyLock(signed); err != nil {
 		return Cluster{}, errors.Wrap(err, "verify legacy lock")

cluster/state/types.go

@@ -14,6 +14,7 @@ import (
 // RawDAG is a list of mutations that constitute the raw cluster state DAG.
 type RawDAG []Mutation
 
+// rootHasher indicates that a type can be hashed with a ssz.HashWalker.
 type rootHasher interface {
 	HashTreeRootWith(hw ssz.HashWalker) error
 }