package crescent.liquidfarming.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the Msg service.

• rpc AdvanceAuction (MsgAdvanceAuction, MsgAdvanceAuctionResponse)

  tx.proto:29

  AdvanceAuction defines a method for advancing rewards auction by one. This Msg is defined just for testing purpose and it shouldn't be used in production.

  message MsgAdvanceAuction

  tx.proto:109

  MsgAdvanceAuction defines a message to advance rewards auction by one.

  • string requester = 1

    requester defines the bech32-encoded address of the requester

  message MsgAdvanceAuctionResponse

  tx.proto:117

  MsgAdvanceAuctionResponse defines the Msg/AdvanceAuction response type.

  (message has no fields)

• rpc LiquidFarm (MsgLiquidFarm, MsgLiquidFarmResponse)

  tx.proto:13

  LiquidFarm defines a method for farming pool coin for a liquid farm

  message MsgLiquidFarm

  tx.proto:33

  MsgLiquidFarm defines a SDK message for farming pool coin for a liquid farm.

  • uint64 pool_id = 1

  • string farmer = 2

  • optional cosmos.base.v1beta1.Coin farming_coin = 3

  message MsgLiquidFarmResponse

  tx.proto:45

  MsgLiquidFarmResponse defines the MsgLiquidFarmResponse response type.

  (message has no fields)

• rpc LiquidUnfarm (MsgLiquidUnfarm, MsgLiquidUnfarmResponse)

  tx.proto:16

  LiquidUnfarm defines a method for unfarming amount of LFCoin

  message MsgLiquidUnfarm

  tx.proto:48

  MsgLiquidUnfarm defines a SDK message for unfarming LFCoin.

  • uint64 pool_id = 1

  • string farmer = 2

  • optional cosmos.base.v1beta1.Coin unfarming_coin = 3

  message MsgLiquidUnfarmResponse

  tx.proto:60

  MsgLiquidUnfarmResponse defines the MsgLiquidUnfarmResponse response type.

  (message has no fields)

• rpc LiquidUnfarmAndWithdraw (MsgLiquidUnfarmAndWithdraw, MsgLiquidUnfarmAndWithdrawResponse)

  tx.proto:19

  LiquidUnfarmAndWithdraw defines a method for unfarming amount of LFCoin and withdraw pool coin from the pool

  message MsgLiquidUnfarmAndWithdraw

  tx.proto:63

  MsgLiquidUnfarmAndWithdraw defines a SDK message for unfarming LFCoin.

  • uint64 pool_id = 1

  • string farmer = 2

  • optional cosmos.base.v1beta1.Coin unfarming_coin = 3

  message MsgLiquidUnfarmAndWithdrawResponse

  tx.proto:75

  MsgLiquidUnfarmAndWithdrawResponse defines the MsgLiquidUnfarmAndWithdrawResponse response type.

  (message has no fields)

• rpc PlaceBid (MsgPlaceBid, MsgPlaceBidResponse)

  tx.proto:22

  PlaceBid defines a method for placing a bid for a rewards auction

  message MsgPlaceBid

  tx.proto:78

  MsgPlaceBid defines a SDK message for placing a bid for a rewards auction.

  • uint64 auction_id = 1

  • uint64 pool_id = 2

  • string bidder = 3

  • optional cosmos.base.v1beta1.Coin bidding_coin = 4

  message MsgPlaceBidResponse

  tx.proto:92

  MsgPlaceBidResponse defines the MsgPlaceBidResponse response type.

  (message has no fields)

• rpc RefundBid (MsgRefundBid, MsgRefundBidResponse)

  tx.proto:25

  RefundBid defines a method for refunding the bid that is not winning for the auction

  message MsgRefundBid

  tx.proto:95

  MsgRefundBid defines a SDK message for refunding the bid that is not winning for the auction.

  • uint64 auction_id = 1

  • uint64 pool_id = 2

  • string bidder = 3

  message MsgRefundBidResponse

  tx.proto:106

  MsgRefundBidResponse defines the MsgRefundBidResponse response type.

  (message has no fields)

Query defines the gRPC querier service.

• rpc Bids (QueryBidsRequest, QueryBidsResponse)

  query.proto:42

  Bids returns all bids for the liquid farm

  message QueryBidsRequest

  query.proto:110

  QueryBidsRequest is request type for the Query/Bids RPC method.

  • uint64 pool_id = 1

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 2

  message QueryBidsResponse

  query.proto:116

  QueryBidsResponse is response type for the Query/Bids RPC method.

  • repeated Bid bids = 1

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 2

• rpc ExchangeRate (QueryExchangeRateRequest, QueryExchangeRateResponse)

  query.proto:52

  ExchangeRate returns exchange rates (mint rate and burn rate) for the liquid farm

  message QueryExchangeRateRequest

  query.proto:133

  QueryExchangeRateRequest is request type for the Query/ExchangeRate RPC method.

  • uint64 pool_id = 1

  message QueryExchangeRateResponse

  query.proto:138

  QueryExchangeRateResponse is response type for the Query/ExchangeRate RPC method.

  • optional ExchangeRateResponse exchange_rate = 1

• rpc LiquidFarm (QueryLiquidFarmRequest, QueryLiquidFarmResponse)

  query.proto:26

  LiquidFarm returns the specific liquid farm

  message QueryLiquidFarmRequest

  query.proto:68

  QueryLiquidFarmRequest is the request type for the Query/LiquidFarm RPC method.

  • uint64 pool_id = 1

  message QueryLiquidFarmResponse

  query.proto:73

  QueryLiquidFarmResponse is response type for the Query/LiquidFarm RPC method.

  • optional LiquidFarmResponse liquid_farm = 1

• rpc LiquidFarms (QueryLiquidFarmsRequest, QueryLiquidFarmsResponse)

  query.proto:21

  LiquidFarms returns all liquid farms registered in params

  message QueryLiquidFarmsRequest

  query.proto:58

  QueryLiquidFarmsRequest is the request type for the Query/LiquidFarms RPC method.

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 1

  message QueryLiquidFarmsResponse

  query.proto:63

  QueryLiquidFarmsResponse is response type for the Query/LiquidFarms RPC method.

  • repeated LiquidFarmResponse liquid_farms = 1

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:16

  Params returns parameters of the module

  message QueryParamsRequest

  query.proto:78

  QueryParamsRequest is request type for the Query/Params RPC method.

  (message has no fields)

  message QueryParamsResponse

  query.proto:81

  QueryParamsResponse is response type for the Query/Params RPC method.

  • optional Params params = 1

• rpc Rewards (QueryRewardsRequest, QueryRewardsResponse)

  query.proto:47

  Rewards returns all accumulated farming rewards for the liquid farm

  message QueryRewardsRequest

  query.proto:122

  QueryRewardsRequest is request type for the Query/Rewards RPC method.

  • uint64 pool_id = 1

  message QueryRewardsResponse

  query.proto:127

  QueryRewardsResponse is response type for the Query/Rewards RPC method.

  • repeated cosmos.base.v1beta1.Coin rewards = 1

• rpc RewardsAuction (QueryRewardsAuctionRequest, QueryRewardsAuctionResponse)

  query.proto:36

  RewardsAuction returns the specific rewards auction

  message QueryRewardsAuctionRequest

  query.proto:99

  QueryRewardsAuctionRequest is request type for the Query/RewardsAuction RPC method.

  • uint64 auction_id = 1

  • uint64 pool_id = 2

  message QueryRewardsAuctionResponse

  query.proto:105

  QueryRewardsAuctionResponse is response type for the Query/RewardsAuction RPC method.

  • optional RewardsAuction rewards_auction = 1

• rpc RewardsAuctions (QueryRewardsAuctionsRequest, QueryRewardsAuctionsResponse)

  query.proto:31

  RewardsAuctions returns all rewards auctions that correspond to the given pool id

  message QueryRewardsAuctionsRequest

  query.proto:86

  QueryRewardsAuctionsRequest is request type for the Query/RewardsAuctions RPC method.

  • uint64 pool_id = 1

  • string status = 2

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 3

  message QueryRewardsAuctionsResponse

  query.proto:93

  QueryRewardsAuctionsResponse is response type for the Query/RewardsAuctions RPC method.

  • repeated RewardsAuction rewards_auctions = 1

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 2

AuctionStatus enumerates the valid status of an auction.

Used in: RewardsAuction

• AUCTION_STATUS_UNSPECIFIED = 0

  AUCTION_STATUS_UNSPECIFIED defines the default auction status

• AUCTION_STATUS_STARTED = 1

  AUCTION_STATUS_STARTED defines the started auction status

• AUCTION_STATUS_FINISHED = 2

  AUCTION_STATUS_FINISHED defines the finished auction status

• AUCTION_STATUS_SKIPPED = 3

  AUCTION_STATUS_SKIPPED defines the skipped auction status

Bid defines standard bid for a rewards auction.

Used in: GenesisState, QueryBidsResponse, WinningBidRecord

• uint64 pool_id = 1

  pool_id specifies the pool id

• string bidder = 2

  bidder specifies the bech32-encoded address that places a bid for the auction

• optional cosmos.base.v1beta1.Coin amount = 3

  amount specifies the amount to place a bid

CompoundingRewards records the amount of pool coin that is used for a bidder to place a bid for an auction. It is used internally to calculate unfarm amount.

• string amount = 1

Used in: QueryExchangeRateResponse

• string mint_rate = 1

• string burn_rate = 2

GenesisState defines the liquidfarming module's genesis state.

• optional Params params = 1

• repeated LastRewardsAuctionIdRecord last_rewards_auction_id_record = 2

• repeated LiquidFarm liquid_farms = 3

• repeated RewardsAuction rewards_auctions = 4

• repeated Bid bids = 5

• repeated WinningBidRecord winning_bid_records = 6

• optional google.protobuf.Timestamp last_rewards_auction_end_time = 7

Used in: GenesisState

• uint64 pool_id = 1

• uint64 auction_id = 2

LiquidFarm defines liquid farm object that provides auto compounding functionality for the liquidity pool and undergoes farming rewards auction process. See the technical spec for more detailed information.

Used in: GenesisState, Params

• uint64 pool_id = 1

• string min_farm_amount = 2

• string min_bid_amount = 3

• string fee_rate = 4

LiquidFarmResponse is response type for the Query/LiquidFarm RPC method.

Used in: QueryLiquidFarmResponse, QueryLiquidFarmsResponse

• uint64 pool_id = 1

• string liquid_farm_reserve_address = 2

• string lf_coin_denom = 3

• string lf_coin_supply = 4

• string pool_coin_denom = 5

• string pool_coin_farming_amount = 6

• string min_farm_amount = 7

• string min_bid_amount = 8

Params defines the parameters for the module.

Used in: GenesisState, QueryParamsResponse

• string fee_collector = 1

• optional google.protobuf.Duration rewards_auction_duration = 2

• repeated LiquidFarm liquid_farms = 3

RewardsAuction defines rewards auction that is created by the module for every rewards_auction_duration in params.

Used in: GenesisState, QueryRewardsAuctionResponse, QueryRewardsAuctionsResponse

• uint64 id = 1

  id specifies the unique auction id

• uint64 pool_id = 2

  pool_id specifies the liquidity pool id

• string bidding_coin_denom = 3

  bidding_coin_denom specifies the bidding coin denomination

• string paying_reserve_address = 4

  paying_reserve_address specfies the account that reserves bidding amounts placed by bidders

• optional google.protobuf.Timestamp start_time = 5

  start_time specifies the start time of an auction

• optional google.protobuf.Timestamp end_time = 6

  end_time specifies the end time of an auction

• AuctionStatus status = 7

  status specifies the status of an auction

• string winner = 8

  winner specifies the bidder who won the auction the value is determined when an auction is finished

• optional cosmos.base.v1beta1.Coin winning_amount = 9

  winning_amount specifies the winning amount for the uaction

• repeated cosmos.base.v1beta1.Coin rewards = 10

  rewards specifies the farming rewards for are accumulated in the farm module the value is determined when an auction is finished

• repeated cosmos.base.v1beta1.Coin fees = 11

• string fee_rate = 12

WinningBidRecord defines a custom winning bid record that is required to be recorded in genesis state.

Used in: GenesisState

• uint64 auction_id = 1

• optional Bid winning_bid = 2