feat: update tests running for ci and add docs

Makefile

@@ -30,8 +30,14 @@ vet:
 	go vet ./...
 
 .PHONY: test
+# Find all directories containing go.mod, and run go test for each module, excluding auction-audit
 test:
-	go test -v ./...
+	find . -name "go.mod" -not -path "*/vendor/*" -not -path "*/auction-audit/*" -exec dirname {} \; | \
+	while read dir; do \
+		echo "Running tests in $$dir..."; \
+		(cd $$dir && go test ./... -v) || exit 1; \
+	done
+
 
 .PHONY: test-integration
 test-integration:

alerts/README.md

@@ -51,3 +51,7 @@ make install
 
 AWS_PROFILE=development $GOPATH/bin/alerts usdx run
 ```
+
+## Alerts
+
+There is a separate auction alerts service run that is described in the [doc](./auctions/README.md).

alerts/auctions/README.md

@@ -0,0 +1,7 @@
+## Description
+
+Auction alerts tracks ongoing auctions on the Kava Chain and alerts for:
+
+- Total value of auctions above configured value
+- Percentage price deviation of auction clearing price above configured value
+- Price deviation of USDX below configured value

alerts/auctions/data.go

@@ -48,7 +48,7 @@ func getAuctionDataAtHeight(client AuctionClient, height int64) (*AuctionData, e
 		return nil, err
 	}
 
-	cdpMarkets, err := client.GetMarkets(height)
+	cdpMarkets, err := client.GetCollateralParams(height)
 	if err != nil {
 		return nil, err
 	}

alerts/auctions/grpc_client.go

@@ -12,7 +12,6 @@ import (
 	cdptypes "github.com/kava-labs/kava/x/cdp/types"
 	hardtypes "github.com/kava-labs/kava/x/hard/types"
 	pricefeedtypes "github.com/kava-labs/kava/x/pricefeed/types"
-	"google.golang.org/grpc"
 )
 
 const (
@@ -30,13 +29,12 @@ type AuctionClient interface {
 	GetInfo() (*InfoResponse, error)
 	GetPrices(height int64) (pricefeedtypes.CurrentPriceResponses, error)
 	GetAuctions(height int64) ([]auctiontypes.Auction, error)
-	GetMarkets(height int64) (cdptypes.CollateralParams, error)
+	GetCollateralParams(height int64) (cdptypes.CollateralParams, error)
 	GetMoneyMarkets(height int64) (hardtypes.MoneyMarkets, error)
 }
 
 // GrpcAuctionClient defines a client for interacting with auctions via rpc
 type GrpcAuctionClient struct {
-	conn       *grpc.ClientConn
 	grpcClient *kavagrpc.KavaGrpcClient
 	util       *kavagrpcutil.Util
 	cdc        codec.Codec
@@ -90,8 +88,8 @@ func (c *GrpcAuctionClient) GetPrices(height int64) (pricefeedtypes.CurrentPrice
 	return prices.Prices, nil
 }
 
-// GetMarkets gets an array of collateral params for each collateral type for provided height
-func (c *GrpcAuctionClient) GetMarkets(height int64) (cdptypes.CollateralParams, error) {
+// GetCollateralParams gets an array of collateral params for each collateral type for provided height
+func (c *GrpcAuctionClient) GetCollateralParams(height int64) (cdptypes.CollateralParams, error) {
 	heightCtx := c.util.CtxAtHeight(height)
 	params, err := c.grpcClient.Query.Cdp.Params(heightCtx, &cdptypes.QueryParamsRequest{})
 	if err != nil {

alerts/auctions/grpc_client_test.go

@@ -88,7 +88,7 @@ func TestGrpcGetMarkets(t *testing.T) {
 		t.Skip("skipping test in short mode")
 	}
 
-	markets, err := dataQueryClient.GetMarkets(11000000)
+	markets, err := dataQueryClient.GetCollateralParams(11000000)
 	require.NoError(t, err)
 	require.Len(t, markets, 10)
 }
@@ -100,5 +100,5 @@ func TestGrpcGetMoneyMarkets(t *testing.T) {
 
 	moneyMarkets, err := dataQueryClient.GetMoneyMarkets(11000000)
 	require.NoError(t, err)
-	require.Len(t, moneyMarkets, 29)
+	require.Len(t, moneyMarkets, 16)
 }