From ee58615fabcfb94f310cb7628f5b6d683f1d9039 Mon Sep 17 00:00:00 2001 From: Robert Zaremba Date: Tue, 30 Apr 2024 18:02:26 +0200 Subject: [PATCH] metoken(proto): update docs --- proto/umee/metoken/v1/metoken.proto | 9 +++--- swagger/swagger.yaml | 45 +++++++++++++++++++++++++++-- x/metoken/metoken.pb.go | 7 +++-- 3 files changed, 51 insertions(+), 10 deletions(-) diff --git a/proto/umee/metoken/v1/metoken.proto b/proto/umee/metoken/v1/metoken.proto index 161846c2e9..e96ebde122 100644 --- a/proto/umee/metoken/v1/metoken.proto +++ b/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, diff --git a/swagger/swagger.yaml b/swagger/swagger.yaml index 5264e5fb3d..f2461760e1 100644 --- a/swagger/swagger.yaml +++ b/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 diff --git a/x/metoken/metoken.pb.go b/x/metoken/metoken.pb.go index cce3482b0b..b8daf5a481 100644 --- a/x/metoken/metoken.pb.go +++ b/x/metoken/metoken.pb.go @@ -34,8 +34,8 @@ type Params struct { // Interest claiming frequency in seconds, determines how often metoken module will claim accrued interest from // leverage module ClaimingFrequency int64 `protobuf:"varint,2,opt,name=claiming_frequency,json=claimingFrequency,proto3" json:"claiming_frequency,omitempty"` - // 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%). RewardsAuctionFactor github_com_umee_network_umee_v6_util_bpmath.FixedBP `protobuf:"varint,3,opt,name=rewards_auction_factor,json=rewardsAuctionFactor,proto3,customtype=github.com/umee-network/umee/v6/util/bpmath.FixedBP" json:"rewards_auction_factor"` } @@ -88,7 +88,8 @@ type Index struct { // Valid value: must be the same as the oracle.Denom.exponent. Exponent uint32 `protobuf:"varint,3,opt,name=exponent,proto3" json:"exponent,omitempty"` // 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 `protobuf:"bytes,4,opt,name=fee,proto3" json:"fee"` // Accepted Assets is the list of underlying Tokens that can be swapped and redeemed for the Index's meToken, // along with their token-specific parameters.