feat: inspect query warns on failing addresses (#2341)

* feat: inspect query warns on failing addresses * changelog * fix lint * field comment --------- Co-authored-by: Robert Zaremba <[email protected]>
umee-network · Dec 1, 2023 · 0579b5e · 0579b5e
1 parent 1507d63
commit 0579b5e
Show file tree

Hide file tree

Showing 5 changed files with 189 additions and 119 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -54,6 +54,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 - [2299](https://github.com/umee-network/umee/pull/2299) Upgrade Cosmos SDK to v0.47.
 - [2301](https://github.com/umee-network/umee/pull/2301) use gov/v1 MinInitialDepositRatio and set it to 0.1.
+- [2341](https://github.com/umee-network/umee/pull/2341) inspect query also returns a list of accounts whose positions could not be calculated
 
 ### Breaking Changes
 

diff --git a/proto/umee/leverage/v1/query.proto b/proto/umee/leverage/v1/query.proto
@@ -402,6 +402,8 @@ message QueryInspectResponse {
   repeated InspectAccount borrowers = 1 [
     (gogoproto.nullable) = false
   ];
+  // Failures is a list of addresses for which the position calculation failed.
+  repeated string failures = 2;
 }
 
 // QueryInspectAccountResponse defines the response structure for the InspectAccount gRPC service handler.

diff --git a/swagger/swagger.yaml b/swagger/swagger.yaml
@@ -408,6 +408,13 @@ paths:
                   description: >-
                     InspectAccount contains risk and balance info for a single
                     account for the inspector query.
+              failures:
+                type: array
+                items:
+                  type: string
+                description: >-
+                  Failures is a list of addresses for which the position
+                  calculation failed.
             description: >-
               QueryInspectResponse defines the response structure for the
               Inspect gRPC service handler.
@@ -5079,6 +5086,13 @@ definitions:
           description: >-
             InspectAccount contains risk and balance info for a single account
             for the inspector query.
+      failures:
+        type: array
+        items:
+          type: string
+        description: >-
+          Failures is a list of addresses for which the position calculation
+          failed.
     description: >-
       QueryInspectResponse defines the response structure for the Inspect gRPC
       service handler.

diff --git a/x/leverage/keeper/inspector.go b/x/leverage/keeper/inspector.go
@@ -29,6 +29,7 @@ func (q Querier) Inspect(
 	if req == nil {
 		return nil, status.Error(codes.InvalidArgument, "empty request")
 	}
+	failures := []string{}
 
 	// This query is also disabled by default as a safety measure. Enable with liquidator queries.
 	if !q.Keeper.liquidatorQueryEnabled {
@@ -73,6 +74,8 @@ func (q Querier) Inspect(
 			borrowedValue = position.BorrowedValue()
 			collateralValue = position.CollateralValue()
 			liquidationThreshold = position.Limit()
+		} else {
+			failures = append(failures, addr.String())
 		}
 
 		borrowed := k.GetBorrowerBorrows(ctx, addr)
@@ -120,7 +123,7 @@ func (q Querier) Inspect(
 	for _, b := range borrowers {
 		sortedBorrowers = append(sortedBorrowers, *b)
 	}
-	return &types.QueryInspectResponse{Borrowers: sortedBorrowers}, nil
+	return &types.QueryInspectResponse{Borrowers: sortedBorrowers, Failures: failures}, nil
 }
 
 // Separated from grpc_query.go