chore: apply suggestions from John

Author: 0xstepit

tests/integration/integration.go

@@ -41,7 +41,9 @@ func NewCleanChainAtTime(startTime int64, suiteOpts ...SuiteOpt) *KeeperTestSuit
 	for _, opt := range suiteOpts {
 		opt(&s)
 	}
+
 	s.setupApp(startTime)
+
 	return &s
 }
 

tests/integration/warp_util.go

@@ -13,11 +13,11 @@ import (
 	"github.com/bcp-innovations/hyperlane-cosmos/x/middleware"
 	"github.com/bcp-innovations/hyperlane-cosmos/x/warp"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/gogoproto/proto"
 
 	"github.com/bcp-innovations/hyperlane-cosmos/util"
 	"github.com/bcp-innovations/hyperlane-cosmos/x/warp/keeper"
 	"github.com/bcp-innovations/hyperlane-cosmos/x/warp/types"
-	"github.com/cosmos/gogoproto/proto"
 
 	. "github.com/onsi/gomega"
 )
@@ -32,7 +32,7 @@ func (suite *KeeperTestSuite) postBuildOpts() simapp.PostBuildOpts {
 }
 
 // setupWarpApps returns a post application build configuration handler to
-// register the warp applications on the hyperlane core. If middleware hooks
+// register the Warp applications on the Hyperlane core. If middleware hooks
 // have been specified in the suite, they are used to wrap the warp keeper.
 func (suite *KeeperTestSuite) setupWarpApps() simapp.PostBuildOpt {
 	// If no custom hooks, use default registration

tests/simapp/warp.go

@@ -21,7 +21,7 @@ func RegisterWarpAppsOpt(warpApps ...warp.WarpApp) PostBuildOpt {
 	}
 }
 
-// RegisterWarpApps allows to register warp applications on the hyperlane
+// RegisterWarpApps allows to register Warp applications on the Hyperlane
 // core keeper of the main app.
 func (app *App) RegisterWarpApps(warpApps ...warp.WarpApp) {
 	for _, warpApp := range warpApps {

x/middleware/README.md

@@ -1,20 +1,20 @@
 # Middleware
 
 This package contains a middleware implementation for a generic `HyperlaneApp`.
-The middleware allows to hook
-before and after the execution of the application's `Handle` method.
+Middleware allows integrators to add custom logic
+before and after the execution of an application's `Handle` method.
 
 ## Usage
 
-To wrap n Hyperlane application with a middleware, two components are required:
+To wrap a Hyperlane application with middleware, two components are required:
 
 - The Hyperlane core keeper.
 - A Hyperlane application, like Warp.
 
 Once the Cosmos SDK application has been built,
 it is possible to build and register the middleware.
-Assuming we want to provide hook functionalities
-around the Warp application for the collateral token, we can do as follow.
+Assuming we want to provide hook functionalities around the Warp application for collateral tokens,
+we can do the following.
 
 Import the required types:
 
@@ -31,7 +31,7 @@ import (
 ```
 
 Now we have to create a concrete value implementing the `HandleHook` interface. It is possible to
-use the simple hook type already provided in the package:
+use the simple hook type already provided:
 
 ```go
 hook := middleware.NewHandleHook(
@@ -50,7 +50,7 @@ For more complex applications, a custom type can be created.
 It is also possible to use another Cosmos SDK module as middleware,
 as long as it implements the required methods.
 At this point, it is possible to create the middleware. In the example below,
-we are going to create two wrapped middlewares around the warp application:
+we are going to create two wrapped middlewares around the Warp application:
 
 ```go
 warpKeeper := &warpkeeper.Keeper{}

x/middleware/hook.go

@@ -6,7 +6,7 @@ import (
 	"github.com/bcp-innovations/hyperlane-cosmos/util"
 )
 
-// HandleFn is the signature of the Handle function of an Hyperlane application.
+// HandleFn is the signature of the Handle function of a Hyperlane application.
 type HandleFn = func(ctx context.Context, mailboxId util.HexAddress, message util.HyperlaneMessage) error
 
 type HandleHook interface {
@@ -17,11 +17,11 @@ type HandleHook interface {
 var _ HandleHook = &Hook{}
 
 type Hook struct {
-	// preHandleHook is the behavior expected from a type that hook BEFORE executing
+	// preHandleFn is the function expected from a hook type which is executed BEFORE
 	// the Hyperlane application Handle method.
 	preHandleFn HandleFn
 
-	// postHandleHook is the behavior expected from a type that hook AFTER executing
+	// postHandleFn is the function expected from a hook type which is executed AFTER
 	// the Hyperlane application Handle method.
 	postHandleFn HandleFn
 }

x/middleware/middleware.go

@@ -8,7 +8,7 @@ import (
 	"github.com/bcp-innovations/hyperlane-cosmos/util"
 )
 
-// AppMiddleware defines the behavior required from an Hyperlane application middleware.
+// AppMiddleware defines the behavior required from a Hyperlane application middleware.
 type AppMiddleware interface {
 	util.HyperlaneApp
 }
@@ -23,7 +23,7 @@ type Middleware struct {
 
 func New(inner util.HyperlaneApp, hook HandleHook) (*Middleware, error) {
 	if inner == nil {
-		return nil, errors.New("inner Hyperlane application cannot be nil")
+		return nil, errors.New("underlying Hyperlane application cannot be nil")
 	}
 	if hook == nil {
 		return nil, errors.New("hook cannot be nil")
@@ -35,17 +35,17 @@ func New(inner util.HyperlaneApp, hook HandleHook) (*Middleware, error) {
 	}, nil
 }
 
-// Exists dispatches the request to the underlying wrapped Hyperlane application.
+// Exists dispatches the request to the underlying Hyperlane application.
 func (m *Middleware) Exists(ctx context.Context, recipient util.HexAddress) (bool, error) {
 	return m.HyperlaneApp.Exists(ctx, recipient)
 }
 
-// ReceiverIsmId dispatches the request to the underlying wrapped Hyperlane application.
+// ReceiverIsmId dispatches the request to the underlying Hyperlane application.
 func (m *Middleware) ReceiverIsmId(ctx context.Context, recipient util.HexAddress) (*util.HexAddress, error) {
 	return m.HyperlaneApp.ReceiverIsmId(ctx, recipient)
 }
 
-// Handle allows to execute middleware hooks before and after the underlying wrapped application.
+// Handle allows to execute middleware hooks before and after the underlying application.
 func (m *Middleware) Handle(ctx context.Context, mailboxID util.HexAddress, message util.HyperlaneMessage) error {
 	err := m.hook.PreHandle(ctx, mailboxID, message)
 	if err != nil {