Fix comments (#398)

Co-authored-by: Raul Jordan <[email protected]>

Author: terencechain

chain-abstraction/sol-implementation/assertion_chain_test.go

@@ -353,7 +353,7 @@ func TestLatestCreatedAssertion(t *testing.T) {
 	var latestAssertionID [32]byte
 	copy(latestAssertionID[:], expected.Id().Bytes())
 	var fakeAssertionID [32]byte
-	copy(fakeAssertionID[:], []byte("fake assertion id as parent"))
+	copy(fakeAssertionID[:], "fake assertion id as parent")
 
 	evtID := abiEvt.ID
 	validTopics := []common.Hash{evtID, latestAssertionID, fakeAssertionID}

chain-abstraction/sol-implementation/edge_challenge_manager.go

@@ -419,7 +419,7 @@ func (cm *specChallengeManager) LevelZeroBlockEdgeHeight(ctx context.Context) (u
 	return h.Uint64(), nil
 }
 
-// Duration of the challenge period in blocks.
+// ChallengePeriodBlocks is the duration of the challenge period in blocks.
 func (cm *specChallengeManager) ChallengePeriodBlocks(
 	ctx context.Context,
 ) (uint64, error) {
@@ -433,7 +433,7 @@ func (cm *specChallengeManager) ChallengePeriodBlocks(
 	return res.Uint64(), nil
 }
 
-// Gets an edge by its hash.
+// GetEdge gets an edge by its hash.
 func (cm *specChallengeManager) GetEdge(
 	ctx context.Context,
 	edgeId protocol.EdgeId,
@@ -474,7 +474,7 @@ func (cm *specChallengeManager) GetEdge(
 	})), nil
 }
 
-// Calculates an edge hash given its challenge id, start history, and end history.
+// CalculateEdgeId calculates an edge hash given its challenge id, start history, and end history.
 func (cm *specChallengeManager) CalculateEdgeId(
 	ctx context.Context,
 	edgeType protocol.EdgeType,

challenge-manager/challenge-tree/mock/edge.go

@@ -17,7 +17,7 @@ type EdgeId string
 type Commit string
 type OriginId string
 
-// Mock Edge for challenge tree specific tests, making it easier for test ergonomics.
+// Edge for challenge tree specific tests, making it easier for test ergonomics.
 type Edge struct {
 	ID            EdgeId
 	EdgeType      protocol.EdgeType
@@ -71,23 +71,23 @@ func (e *Edge) ComputeMutualId() string {
 	)
 }
 
-// The claim id of the edge, if any
+// ClaimId of the edge, if any
 func (e *Edge) ClaimId() option.Option[protocol.ClaimId] {
 	if e.ClaimID == "" {
 		return option.None[protocol.ClaimId]()
 	}
 	return option.Some(protocol.ClaimId(common.BytesToHash([]byte(e.ClaimID))))
 }
 
-// The lower child of the edge, if any.
+// LowerChild of the edge, if any.
 func (e *Edge) LowerChild(_ context.Context) (option.Option[protocol.EdgeId], error) {
 	if e.LowerChildID == "" {
 		return option.None[protocol.EdgeId](), nil
 	}
 	return option.Some(protocol.EdgeId{Hash: common.BytesToHash([]byte(e.LowerChildID))}), nil
 }
 
-// The upper child of the edge, if any.
+// UpperChild of the edge, if any.
 func (e *Edge) UpperChild(_ context.Context) (option.Option[protocol.EdgeId], error) {
 	if e.UpperChildID == "" {
 		return option.None[protocol.EdgeId](), nil
@@ -99,38 +99,38 @@ func (e *Edge) HasChildren(ctx context.Context) (bool, error) {
 	return e.LowerChildID != "" && e.UpperChildID != "", nil
 }
 
-// The ministaker of an edge. Only existing for level zero edges.
+// MiniStaker of an edge. Only existing for level zero edges.
 func (*Edge) MiniStaker() option.Option[common.Address] {
 	return option.None[common.Address]()
 }
 
-// The assertion hash of the parent assertion that originated the challenge
+// AssertionHash of the parent assertion that originated the challenge
 // at the top-level.
 func (*Edge) AssertionHash(_ context.Context) (protocol.AssertionHash, error) {
 	return protocol.AssertionHash{}, nil
 }
 
-// The time in seconds an edge has been unrivaled.
+// TimeUnrivaled in seconds an edge has been unrivaled.
 func (*Edge) TimeUnrivaled(_ context.Context) (uint64, error) {
 	return 0, nil
 }
 
-// The status of an edge.
+// Status of an edge.
 func (*Edge) Status(_ context.Context) (protocol.EdgeStatus, error) {
 	return 0, nil
 }
 
-// Whether or not an edge has rivals.
+// HasRival if an edge has rivals.
 func (*Edge) HasRival(_ context.Context) (bool, error) {
 	return false, nil
 }
 
-// Checks if an edge has a length one rival.
+// HasLengthOneRival checks if an edge has a length one rival.
 func (*Edge) HasLengthOneRival(_ context.Context) (bool, error) {
 	return false, nil
 }
 
-// The history commitment for the top-level edge the current edge's challenge is made upon.
+// TopLevelClaimHeight for the top-level edge the current edge's challenge is made upon.
 // This is used at subchallenge creation boundaries.
 func (*Edge) TopLevelClaimHeight(_ context.Context) (protocol.OriginHeights, error) {
 	return protocol.OriginHeights{}, nil