package crescent.farming.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service Msg
tx.proto:13Msg defines the farming Msg service.
rpc AdvanceEpoch (, )
tx.proto:35AdvanceEpoch defines a method for advancing epoch by one, just for testing purpose and shouldn't be used in real world
message
tx.proto:180MsgAdvanceEpoch defines a message to advance epoch by one.
string requester = 1
requester defines the bech32-encoded address of the requester
message
tx.proto:188MsgAdvanceEpochResponse defines the Msg/AdvanceEpoch response type.
(message has no fields)
rpc CreateFixedAmountPlan (, )
tx.proto:16CreateFixedAmountPlan defines a method for creating a new fixed amount farming plan
message
tx.proto:40MsgCreateFixedAmountPlan defines a SDK message for creating a new fixed amount farming plan.
string name = 1
name specifies the name for the plan
string creator = 2
creator defines the bech32-encoded address of the creator for the private plan, termination address is also set to this creator.
repeated staking_coin_weights = 3
staking_coin_weights specifies coins weight for the plan
optional start_time = 4
start_time specifies the start time of the plan
optional end_time = 5
end_time specifies the end time of the plan
repeated epoch_amount = 6
epoch_amount specifies the distributing amount for each epoch
message
tx.proto:74MsgCreateFixedAmountPlanResponse defines the MsgCreateFixedAmountPlanResponse response type.
(message has no fields)
rpc CreateRatioPlan (, )
tx.proto:19CreateRatioPlan defines a method for creating a new ratio farming plan
message
tx.proto:78MsgCreateRatioPlan defines a SDK message for creating a new ratio farming plan.
string name = 1
name specifies the name for the plan
string creator = 2
creator defines the bech32-encoded address of the creator for the private plan, termination address is also set to this creator.
repeated staking_coin_weights = 3
staking_coin_weights specifies coins weight for the plan
optional start_time = 4
start_time specifies the start time of the plan
optional end_time = 5
end_time specifies the end time of the plan
string epoch_ratio = 6
epoch_ratio specifies the distributing amount by ratio
message
tx.proto:113MsgCreateRatioPlanResponse defines the Msg/MsgCreateRatioPlanResponse response type.
(message has no fields)
rpc Harvest (, )
tx.proto:28Harvest defines a method for claiming farming rewards
message
tx.proto:153MsgHarvest defines a SDK message for claiming rewards from the farming plan.
string farmer = 1
farmer defines the bech32-encoded address of the farmer
repeated string staking_coin_denoms = 2
staking_coin_denoms is the set of denoms of staked coins as a source of the reward for harvesting
message
tx.proto:165MsgHarvestResponse defines the Msg/MsgHarvestResponse response type.
(message has no fields)
rpc RemovePlan (, )
tx.proto:31RemovePlan defines a method for removing a terminated plan.
message
tx.proto:168MsgRemovePlan defines a message for removing a terminated plan.
string creator = 1
uint64 plan_id = 2
message
tx.proto:177MsgRemovePlanResponse defines the Msg/RemovePlan response type.
(message has no fields)
rpc Stake (, )
tx.proto:22Stake defines a method for staking coins into the farming plan
message
tx.proto:116MsgStake defines a SDK message for staking coins into the farming plan.
string farmer = 1
farmer defines the bech32-encoded address of the farmer
repeated staking_coins = 2
staking_coins specifies coins to stake
message
tx.proto:131MsgStakeResponse defines the Msg/MsgStakeResponse response type.
(message has no fields)
rpc Unstake (, )
tx.proto:25Unstake defines a method for unstaking coins from the farming plan
message
tx.proto:135MsgUnstake defines a SDK message for performing unstaking of coins from the farming plan.
string farmer = 1
farmer defines the bech32-encoded address of the farmer
repeated unstaking_coins = 2
unstaking_coins specifies coins to stake
message
tx.proto:150MsgUnstakeResponse defines the Msg/MsgUnstakeResponse response type.
(message has no fields)
service Query
query.proto:18Query defines the gRPC query service for the farming module.
rpc CurrentEpochDays (, )
query.proto:247CurrentEpochDays returns current epoch days.
message
query.proto:407QueryCurrentEpochDaysRequest is the request type for the Query/CurrentEpochDays RPC method.
(message has no fields)
message
query.proto:410QueryCurrentEpochDaysResponse is the response type for the Query/CurrentEpochDays RPC method.
uint32 current_epoch_days = 1
rpc HistoricalRewards (, )
query.proto:269HistoricalRewards returns HistoricalRewards records for a staking coin denom.
message
query.proto:415QueryHistoricalRewardsRequest is the request type for the Query/HistoricalRewards RPC method.
string staking_coin_denom = 1
optional pagination = 2
message
query.proto:421QueryHistoricalRewardsResponse is the response type for the Query/HistoricalRewards RPC method.
repeated historical_rewards = 1
optional pagination = 2
rpc Params (, )
query.proto:20Params returns parameters of the farming module.
message
query.proto:292QueryParamsRequest is the request type for the Query/Params RPC method.
(message has no fields)
message
query.proto:295QueryParamsResponse is the response type for the Query/Params RPC method.
optional params = 1
rpc Plan (, )
query.proto:74Plan returns a specific plan.
message
query.proto:319QueryPlanRequest is the request type for the Query/Plan RPC method.
uint64 plan_id = 1
message
query.proto:324QueryPlanResponse is the response type for the Query/Plan RPC method.
optional plan = 1
rpc Plans (, )
query.proto:32Plans returns all plans.
message
query.proto:300QueryPlansRequest is the request type for the Query/Plans RPC method.
string type = 1
string farming_pool_address = 2
string termination_address = 3
string staking_coin_denom = 4
string terminated = 5
optional pagination = 6
message
query.proto:310QueryPlansResponse is the response type for the Query/Plans RPC method.
repeated plans = 1
plans are the existing plans
optional pagination = 2
pagination defines the pagination in the response.
rpc Position (, )
query.proto:115message
query.proto:329QueryPositionRequest is the request type for the Query/Position RPC method.
string farmer = 1
string staking_coin_denom = 2
message
query.proto:335QueryPositionResponse is the response type for the Query/Position RPC method.
repeated staked_coins = 1
repeated queued_coins = 2
repeated rewards = 3
rpc QueuedStakings (, )
query.proto:159QueryStakings returns all queued stakings by a farmer.
message
query.proto:358QueryQueuedStakingsRequest is the request type for the Query/QueuedStakings RPC method.
string farmer = 1
string staking_coin_denom = 2
optional pagination = 3
message
query.proto:365QueryQueuedStakingsResponse is the response type for the Query/QueuedStakings RPC method.
repeated queued_stakings = 1
optional pagination = 2
rpc Rewards (, )
query.proto:203Rewards returns rewards for a farmer
message
query.proto:381QueryRewardsRequest is the request type for the Query/Rewards RPC method.
string farmer = 1
string staking_coin_denom = 2
optional pagination = 3
message
query.proto:388QueryRewardsResponse is the response type for the Query/Rewards RPC method.
repeated rewards = 1
optional pagination = 2
rpc Stakings (, )
query.proto:137Stakings returns all stakings by a farmer.
message
query.proto:345QueryStakingsRequest is the request type for the Query/Stakings RPC method.
string farmer = 1
string staking_coin_denom = 2
optional pagination = 3
message
query.proto:352QueryStakingsResponse is the response type for the Query/Stakings RPC method.
repeated stakings = 1
optional pagination = 2
rpc TotalStakings (, )
query.proto:181TotalStakings returns total staking amount for a staking coin denom
message
query.proto:371QueryTotalStakingsRequest is the request type for the Query/TotalStakings RPC method.
string staking_coin_denom = 1
message
query.proto:376QueryTotalStakingsResponse is the response type for the Query/TotalStakings RPC method.
string amount = 1
rpc UnharvestedRewards (, )
query.proto:225UnharvestedRewards returns unharvested rewards for a farmer
message
query.proto:394QueryUnharvestedRewardsRequest is the request type for the Query/UnharvestedRewards RPC method.
string farmer = 1
string staking_coin_denom = 2
optional pagination = 3
message
query.proto:401QueryUnharvestedRewardsResponse is the response type for the Query/UnharvestedRewards RPC method.
repeated unharvested_rewards = 1
optional pagination = 2
message
proposal.proto:41AddPlanRequest details a proposal for creating a public plan.
Used in:
string name = 1
name specifies the plan name for display
string farming_pool_address = 2
farming_pool_address defines the bech32-encoded address of the farming pool
string termination_address = 3
termination_address defines the bech32-encoded address that terminates plan when the plan ends after the end time, the balance of farming pool address is transferred to the termination address
repeated staking_coin_weights = 4
staking_coin_weights specifies coin weights for the plan
optional start_time = 5
start_time specifies the start time of the plan
optional end_time = 6
end_time specifies the end time of the plan
repeated epoch_amount = 7
epoch_amount specifies the distributing amount for each epoch
string epoch_ratio = 8
epoch_ratio specifies the distributing amount by ratio
AddressType enumerates the available types of a address.
ADDRESS_TYPE_32_BYTES = 0
the 32 bytes length address type of ADR 028.
ADDRESS_TYPE_20_BYTES = 1
the default 20 bytes length address type.
message
farming.proto:48BasePlan defines a base plan type and contains the required fields for basic farming plan functionality. Any custom farming plan type must extend this type for additional functionality (for example, fixed amount plan, ratio plan).
Used in: ,
uint64 id = 1
id specifies index of the farming plan
string name = 2
name specifies the name for the plan
PlanType type = 3
type specifies the plan type; type 0 is public and 1 is private public plan must be created through governance proposal and private plan is created by account
string farming_pool_address = 4
farming_pool_address defines the bech32-encoded address of the farming pool
string termination_address = 5
termination_address defines the Bech32-encoded address that terminates the plan when the plan ends after the end time, the balance of the farming pool address is transferred to the termination address
repeated staking_coin_weights = 6
staking_coin_weights specifies the coin weights for the plan
optional start_time = 7
start_time specifies the start time of the plan
optional end_time = 8
end_time specifies the end time of the plan
bool terminated = 9
terminated indicates whether the plan has been terminated or not
optional last_distribution_time = 10
last_distribution_time specifies the last time a distribution occurred
repeated distributed_coins = 11
distributed_coins specifies the total coins distributed by this plan
message
genesis.proto:165CurrentEpochRecord is used for import/export via genesis json.
Used in:
string staking_coin_denom = 1
uint64 current_epoch = 2
message
proposal.proto:130DeletePlanRequest details a proposal for deleting an existing public plan.
Used in:
uint64 plan_id = 1
plan_id specifies index of the farming plan
message
farming.proto:104FixedAmountPlan defines a fixed amount plan that distributes a fixed amount of coins for every epoch.
optional base_plan = 1
repeated epoch_amount = 2
epoch_amount specifies the distributing amount for each epoch
message
genesis.proto:16GenesisState defines the farming module's genesis state.
optional params = 1
params defines all the parameters for the farming module
uint64 global_plan_id = 2
repeated plan_records = 3
plan_records defines the plan records used for genesis state
repeated staking_records = 4
repeated queued_staking_records = 5
repeated historical_rewards_records = 6
repeated outstanding_rewards_records = 7
repeated unharvested_rewards_records = 8
repeated current_epoch_records = 9
repeated total_stakings_records = 10
repeated reward_pool_coins = 11
reward_pool_coins specifies balance of the reward pool to be distributed in the plans this param is needed for import/export validation
optional last_epoch_time = 12
last_epoch_time specifies the last executed epoch time of the plans
uint32 current_epoch_days = 13
current_epoch_days specifies the epoch used when allocating farming rewards in end blocker
message
farming.proto:168HistoricalRewards defines the cumulative unit rewards for a given staking coin denom and an epoch number.
Used in:
repeated cumulative_unit_rewards = 1
message
genesis.proto:129HistoricalRewardsRecord is used for import/export via genesis json.
Used in:
string staking_coin_denom = 1
uint64 epoch = 2
optional historical_rewards = 3
message
query.proto:456Used in:
uint64 epoch = 1
repeated cumulative_unit_rewards = 2
message
proposal.proto:84ModifyPlanRequest details a proposal for modifying the existing public plan.
Used in:
uint64 plan_id = 1
plan_id specifies index of the farming plan
string name = 2
name specifies the plan name for display
string farming_pool_address = 3
farming_pool_address defines the bech32-encoded address of the farming pool
string termination_address = 4
termination_address defines the bech32-encoded address that terminates plan when the plan ends after the end time, the balance of farming pool address is transferred to the termination address
repeated staking_coin_weights = 5
staking_coin_weights specifies coin weights for the plan
optional start_time = 6
start_time specifies the start time of the plan
optional end_time = 7
end_time specifies the end time of the plan
repeated epoch_amount = 8
epoch_amount specifies the distributing amount for each epoch
string epoch_ratio = 9
epoch_ratio specifies the distributing amount by ratio
message
farming.proto:180OutstandingRewards represents outstanding (un-withdrawn) rewards for a staking coin denom.
Used in:
repeated rewards = 1
message
genesis.proto:142OutstandingRewardsRecord is used for import/export via genesis json.
Used in:
string staking_coin_denom = 1
optional outstanding_rewards = 2
message
farming.proto:13Params defines the set of params for the farming module.
Used in: ,
repeated private_plan_creation_fee = 1
private_plan_creation_fee specifies the fee for plan creation this fee prevents from spamming and is collected in the community pool
uint32 next_epoch_days = 2
next_epoch_days is the epoch length in number of days it updates internal state called CurrentEpochDays that is used to process staking and reward distribution in end blocker
string farming_fee_collector = 3
farming_fee_collector is the module account address to collect fees within the farming module
uint64 delayed_staking_gas_fee = 4
delayed_staking_gas_fee is used to impose gas fee for the delayed staking
uint32 max_num_private_plans = 5
max_num_private_plans is the maximum number of active private plans
message
genesis.proto:66PlanRecord is used for import/export via genesis json.
Used in:
optional plan = 1
plan specifies the plan interface; it can be FixedAmountPlan or RatioPlan
repeated farming_pool_coins = 2
farming_pool_coins specifies balance of the farming pool for the plan this param is needed for import/export validation
PlanType enumerates the valid types of a plan.
Used in:
PLAN_TYPE_UNSPECIFIED = 0
PLAN_TYPE_UNSPECIFIED defines the default plan type.
PLAN_TYPE_PUBLIC = 1
PLAN_TYPE_PUBLIC defines the public plan type.
PLAN_TYPE_PRIVATE = 2
PLAN_TYPE_PRIVATE defines the private plan type.
message
proposal.proto:17PublicPlanProposal defines a public farming plan governance proposal that receives one of the following requests: A request that creates a public farming plan, a request that updates the plan, and a request that deletes the plan. For public plan creation, depending on which field is passed, either epoch amount or epoch ratio, it creates a fixed amount plan or ratio plan.
string title = 1
title specifies the title of the plan
string description = 2
description specifies the description of the plan
repeated add_plan_requests = 3
add_plan_requests specifies AddPlanRequest object
repeated modify_plan_requests = 4
modify_plan_requests specifies ModifyPlanRequest object
repeated delete_plan_requests = 5
delete_plan_requests specifies DeletePlanRequest object
message
farming.proto:154QueuedStaking defines staking that is waiting in a queue.
Used in:
string amount = 1
message
genesis.proto:95QueuedStakingRecord is used for import/export via genesis json.
Used in:
optional end_time = 1
string staking_coin_denom = 2
string farmer = 3
optional queued_staking = 4
message
query.proto:434Used in:
string staking_coin_denom = 1
string amount = 2
optional end_time = 3
message
farming.proto:119RatioPlan defines a plan that distributes to farmers by ratio distribution for every epoch day.
optional base_plan = 1
string epoch_ratio = 2
epoch_ratio specifies the distributing amount by ratio
message
query.proto:442Used in:
string staking_coin_denom = 1
repeated rewards = 2
message
farming.proto:145Staking defines a farmer's staking information.
Used in:
string amount = 1
uint64 starting_epoch = 2
message
genesis.proto:83StakingRecord is used for import/export via genesis json.
Used in:
string staking_coin_denom = 1
string farmer = 2
optional staking = 3
message
query.proto:426Used in:
string staking_coin_denom = 1
string amount = 2
uint64 starting_epoch = 3
message
farming.proto:161TotalStakings defines the total staking amount for a staking coin denom.
string amount = 1
message
genesis.proto:110TotalStakingsRecord is used for import/export via genesis json.
Used in:
string staking_coin_denom = 1
string amount = 2
amount specifies total amount of the staking for the staking coin denom except queued staking
repeated staking_reserve_coins = 9
staking_reserve_coins specifies balance of the staking reserve account where staking and queued staking for the staking coin denom is stored this param is needed for import/export validation
message
farming.proto:190UnharvestedRewards represents unharvested rewards of a farmer for a staking coin denom, which increases when there was an automatic withdrawal of rewards due to changes in staked coin amount.
Used in:
repeated rewards = 1
message
genesis.proto:152Used in:
string farmer = 1
string staking_coin_denom = 2
optional unharvested_rewards = 3
message
query.proto:449Used in:
string staking_coin_denom = 1
repeated rewards = 2