metoken(proto): update docs

proto/umee/metoken/v1/metoken.proto

@@ -19,10 +19,10 @@ message Params {
   // leverage module
   int64 claiming_frequency = 2;
 
-  // Rewards Auction Factor determines the portion of interest accrued on
-  // borrows that is sent to the auction module for the rewards auction.
+  // Rewards Auction Factor determines the portion of swap and redeem fee that is sent to the
+  // auction module for the rewards auction.
   // Valid values: 0-10000 (in basis points, 2000 = 20%).
-  uint32 rewards_auction_factor= 3 [
+  uint32 rewards_auction_factor = 3 [
     (gogoproto.customtype) = "github.com/umee-network/umee/v6/util/bpmath.FixedBP",
     (gogoproto.nullable)   = false
   ];
@@ -48,7 +48,8 @@ message Index {
   uint32 exponent = 3;
 
   // Fee contains fee parameters used for swap and redemption fee calculations for all underlying
-  // assets in this index.
+  // assets in this index. `Params.rewards_auction_factor` of the fee will go for the burn
+  // auction.
   Fee fee = 4 [(gogoproto.nullable) = false];
 
   // Accepted Assets is the list of underlying Tokens that can be swapped and redeemed for the Index's meToken,

swagger/swagger.yaml

@@ -5709,7 +5709,10 @@ paths:
                         Fee contains fee parameters used for swap and redemption
                         fee calculations for all underlying
 
-                        assets in this index.
+                        assets in this index. `Params.rewards_auction_factor` of
+                        the fee will go for the burn
+
+                        auction.
                       type: object
                       properties:
                         min_fee:
@@ -5867,6 +5870,16 @@ paths:
                       often metoken module will claim accrued interest from
 
                       leverage module
+                  rewards_auction_factor:
+                    type: integer
+                    format: int64
+                    description: >-
+                      Rewards Auction Factor determines the portion of swap and
+                      redeem fee that is sent to the
+
+                      auction module for the rewards auction.
+
+                      Valid values: 0-10000 (in basis points, 2000 = 20%).
                 description: Params defines the parameters for the metoken module.
             description: >-
               QueryParamsResponse defines the response structure for the Params
@@ -10333,7 +10346,10 @@ definitions:
           Fee contains fee parameters used for swap and redemption fee
           calculations for all underlying
 
-          assets in this index.
+          assets in this index. `Params.rewards_auction_factor` of the fee will
+          go for the burn
+
+          auction.
         type: object
         properties:
           min_fee:
@@ -10532,6 +10548,16 @@ definitions:
           module will claim accrued interest from
 
           leverage module
+      rewards_auction_factor:
+        type: integer
+        format: int64
+        description: >-
+          Rewards Auction Factor determines the portion of swap and redeem fee
+          that is sent to the
+
+          auction module for the rewards auction.
+
+          Valid values: 0-10000 (in basis points, 2000 = 20%).
     description: Params defines the parameters for the metoken module.
   umee.metoken.v1.QueryIndexBalancesResponse:
     type: object
@@ -10752,7 +10778,10 @@ definitions:
                 Fee contains fee parameters used for swap and redemption fee
                 calculations for all underlying
 
-                assets in this index.
+                assets in this index. `Params.rewards_auction_factor` of the fee
+                will go for the burn
+
+                auction.
               type: object
               properties:
                 min_fee:
@@ -10866,6 +10895,16 @@ definitions:
               metoken module will claim accrued interest from
 
               leverage module
+          rewards_auction_factor:
+            type: integer
+            format: int64
+            description: >-
+              Rewards Auction Factor determines the portion of swap and redeem
+              fee that is sent to the
+
+              auction module for the rewards auction.
+
+              Valid values: 0-10000 (in basis points, 2000 = 20%).
         description: Params defines the parameters for the metoken module.
     description: |-
       QueryParamsResponse defines the response structure for the Params gRPC