package cosmos.farming.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the farming Msg service.

• rpc AdvanceEpoch (MsgAdvanceEpoch, MsgAdvanceEpochResponse)

  tx.proto:35

  AdvanceEpoch defines a method for advancing epoch by one, just for testing purpose and shouldn't be used in real world

  message MsgAdvanceEpoch

  tx.proto:180

  MsgAdvanceEpoch defines a message to advance epoch by one.

  • string requester = 1

    requester defines the bech32-encoded address of the requester

  message MsgAdvanceEpochResponse

  tx.proto:188

  MsgAdvanceEpochResponse defines the Msg/AdvanceEpoch response type.

  (message has no fields)

• rpc CreateFixedAmountPlan (MsgCreateFixedAmountPlan, MsgCreateFixedAmountPlanResponse)

  tx.proto:16

  CreateFixedAmountPlan defines a method for creating a new fixed amount farming plan

  message MsgCreateFixedAmountPlan

  tx.proto:40

  MsgCreateFixedAmountPlan 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 base.v1beta1.DecCoin staking_coin_weights = 3

    staking_coin_weights specifies coins weight for the plan

  • optional google.protobuf.Timestamp start_time = 4

    start_time specifies the start time of the plan

  • optional google.protobuf.Timestamp end_time = 5

    end_time specifies the end time of the plan

  • repeated base.v1beta1.Coin epoch_amount = 6

    epoch_amount specifies the distributing amount for each epoch

  message MsgCreateFixedAmountPlanResponse

  tx.proto:74

  MsgCreateFixedAmountPlanResponse defines the MsgCreateFixedAmountPlanResponse response type.

  (message has no fields)

• rpc CreateRatioPlan (MsgCreateRatioPlan, MsgCreateRatioPlanResponse)

  tx.proto:19

  CreateRatioPlan defines a method for creating a new ratio farming plan

  message MsgCreateRatioPlan

  tx.proto:78

  MsgCreateRatioPlan 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 base.v1beta1.DecCoin staking_coin_weights = 3

    staking_coin_weights specifies coins weight for the plan

  • optional google.protobuf.Timestamp start_time = 4

    start_time specifies the start time of the plan

  • optional google.protobuf.Timestamp 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 MsgCreateRatioPlanResponse

  tx.proto:113

  MsgCreateRatioPlanResponse defines the Msg/MsgCreateRatioPlanResponse response type.

  (message has no fields)

• rpc Harvest (MsgHarvest, MsgHarvestResponse)

  tx.proto:28

  Harvest defines a method for claiming farming rewards

  message MsgHarvest

  tx.proto:153

  MsgHarvest 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 MsgHarvestResponse

  tx.proto:165

  MsgHarvestResponse defines the Msg/MsgHarvestResponse response type.

  (message has no fields)

• rpc RemovePlan (MsgRemovePlan, MsgRemovePlanResponse)

  tx.proto:31

  RemovePlan defines a method for removing a terminated plan.

  message MsgRemovePlan

  tx.proto:168

  MsgRemovePlan defines a message for removing a terminated plan.

  • string creator = 1

  • uint64 plan_id = 2

  message MsgRemovePlanResponse

  tx.proto:177

  MsgRemovePlanResponse defines the Msg/RemovePlan response type.

  (message has no fields)

• rpc Stake (MsgStake, MsgStakeResponse)

  tx.proto:22

  Stake defines a method for staking coins into the farming plan

  message MsgStake

  tx.proto:116

  MsgStake defines a SDK message for staking coins into the farming plan.

  • string farmer = 1

    farmer defines the bech32-encoded address of the farmer

  • repeated base.v1beta1.Coin staking_coins = 2

    staking_coins specifies coins to stake

  message MsgStakeResponse

  tx.proto:131

  MsgStakeResponse defines the Msg/MsgStakeResponse response type.

  (message has no fields)

• rpc Unstake (MsgUnstake, MsgUnstakeResponse)

  tx.proto:25

  Unstake defines a method for unstaking coins from the farming plan

  message MsgUnstake

  tx.proto:135

  MsgUnstake 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 base.v1beta1.Coin unstaking_coins = 2

    unstaking_coins specifies coins to stake

  message MsgUnstakeResponse

  tx.proto:150

  MsgUnstakeResponse defines the Msg/MsgUnstakeResponse response type.

  (message has no fields)

Query defines the gRPC query service for the farming module.

• rpc CurrentEpochDays (QueryCurrentEpochDaysRequest, QueryCurrentEpochDaysResponse)

  query.proto:200

  CurrentEpochDays returns current epoch days.

  message QueryCurrentEpochDaysRequest

  query.proto:299

  QueryCurrentEpochDaysRequest is the request type for the Query/CurrentEpochDays RPC method.

  (message has no fields)

  message QueryCurrentEpochDaysResponse

  query.proto:302

  QuerCurrentEpochDaysResponse is the response type for the Query/CurrentEpochDays RPC method.

  • uint32 current_epoch_days = 1

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:19

  Params returns parameters of the farming module.

  message QueryParamsRequest

  query.proto:226

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

  (message has no fields)

  message QueryParamsResponse

  query.proto:229

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

  • optional Params params = 1

• rpc Plan (QueryPlanRequest, QueryPlanResponse)

  query.proto:79

  Plan returns a specific plan.

  message QueryPlanRequest

  query.proto:253

  QueryPlanRequest is the request type for the Query/Plan RPC method.

  • uint64 plan_id = 1

  message QueryPlanResponse

  query.proto:258

  QueryPlanResponse is the response type for the Query/Plan RPC method.

  • optional google.protobuf.Any plan = 1

• rpc Plans (QueryPlansRequest, QueryPlansResponse)

  query.proto:33

  Plans returns all plans.

  message QueryPlansRequest

  query.proto:234

  QueryPlansRequest 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 base.query.v1beta1.PageRequest pagination = 6

  message QueryPlansResponse

  query.proto:244

  QueryPlansResponse is the response type for the Query/Plans RPC method.

  • repeated google.protobuf.Any plans = 1

    plans are the existing plans

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

    pagination defines the pagination in the response.

• rpc Rewards (QueryRewardsRequest, QueryRewardsResponse)

  query.proto:175

  Rewards returns rewards for a farmer

  message QueryRewardsRequest

  query.proto:287

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

  • string farmer = 1

  • string staking_coin_denom = 2

  message QueryRewardsResponse

  query.proto:293

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

  • repeated base.v1beta1.Coin rewards = 1

• rpc Stakings (QueryStakingsRequest, QueryStakingsResponse)

  query.proto:125

  Stakings returns all stakings by a farmer.

  message QueryStakingsRequest

  query.proto:263

  QueryStakingsRequest is the request type for the Query/Stakings RPC method.

  • string farmer = 1

  • string staking_coin_denom = 2

  message QueryStakingsResponse

  query.proto:269

  QueryStakingsResponse is the response type for the Query/Stakings RPC method.

  • repeated base.v1beta1.Coin staked_coins = 1

  • repeated base.v1beta1.Coin queued_coins = 2

• rpc TotalStakings (QueryTotalStakingsRequest, QueryTotalStakingsResponse)

  query.proto:150

  TotalStakings returns total staking amount for a staking coin denom

  message QueryTotalStakingsRequest

  query.proto:277

  QueryTotalStakingsRequest is the request type for the Query/TotalStakings RPC method.

  • string staking_coin_denom = 1

  message QueryTotalStakingsResponse

  query.proto:282

  QueryTotalStakingsResponse is the response type for the Query/TotalStakings RPC method.

  • string amount = 1

AddPlanRequest details a proposal for creating a public plan.

Used in: PublicPlanProposal

• 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 base.v1beta1.DecCoin staking_coin_weights = 4

  staking_coin_weights specifies coin weights for the plan

• optional google.protobuf.Timestamp start_time = 5

  start_time specifies the start time of the plan

• optional google.protobuf.Timestamp end_time = 6

  end_time specifies the end time of the plan

• repeated base.v1beta1.Coin 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.

BasePlan 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: FixedAmountPlan, RatioPlan

• 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 base.v1beta1.DecCoin staking_coin_weights = 6

  staking_coin_weights specifies the coin weights for the plan

• optional google.protobuf.Timestamp start_time = 7

  start_time specifies the start time of the plan

• optional google.protobuf.Timestamp 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 google.protobuf.Timestamp last_distribution_time = 10

  last_distribution_time specifies the last time a distribution occurred

• repeated base.v1beta1.Coin distributed_coins = 11

  distributed_coins specifies the total coins distributed by this plan

CurrentEpochRecord is used for import/export via genesis json.

Used in: GenesisState

• string staking_coin_denom = 1

• uint64 current_epoch = 2

DeletePlanRequest details a proposal for deleting an existing public plan.

Used in: PublicPlanProposal

• uint64 plan_id = 1

  plan_id specifies index of the farming plan

FixedAmountPlan defines a fixed amount plan that distributes a fixed amount of coins for every epoch.

• optional BasePlan base_plan = 1

• repeated base.v1beta1.Coin epoch_amount = 2

  epoch_amount specifies the distributing amount for each epoch

GenesisState defines the farming module's genesis state.

• optional Params params = 1

  params defines all the parameters for the farming module

• uint64 global_plan_id = 2

• repeated PlanRecord plan_records = 3

  plan_records defines the plan records used for genesis state

• repeated StakingRecord staking_records = 4

• repeated QueuedStakingRecord queued_staking_records = 5

• repeated HistoricalRewardsRecord historical_rewards_records = 6

• repeated OutstandingRewardsRecord outstanding_rewards_records = 7

• repeated CurrentEpochRecord current_epoch_records = 8

• repeated TotalStakingsRecord total_stakings_records = 9

• repeated base.v1beta1.Coin reward_pool_coins = 10

  reward_pool_coins specifies balance of the reward pool to be distributed in the plans this param is needed for import/export validation

• optional google.protobuf.Timestamp last_epoch_time = 11

  last_epoch_time specifies the last executed epoch time of the plans

• uint32 current_epoch_days = 12

  current_epoch_days specifies the epoch used when allocating farming rewards in end blocker

HistoricalRewards defines the cumulative unit rewards for a given staking coin denom and an epoch number.

Used in: HistoricalRewardsRecord

• repeated base.v1beta1.DecCoin cumulative_unit_rewards = 1

HistoricalRewardsRecord is used for import/export via genesis json.

Used in: GenesisState

• string staking_coin_denom = 1

• uint64 epoch = 2

• optional HistoricalRewards historical_rewards = 3

ModifyPlanRequest details a proposal for modifying the existing public plan.

Used in: PublicPlanProposal

• 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 base.v1beta1.DecCoin staking_coin_weights = 5

  staking_coin_weights specifies coin weights for the plan

• optional google.protobuf.Timestamp start_time = 6

  start_time specifies the start time of the plan

• optional google.protobuf.Timestamp end_time = 7

  end_time specifies the end time of the plan

• repeated base.v1beta1.Coin epoch_amount = 8

  epoch_amount specifies the distributing amount for each epoch

• string epoch_ratio = 9

  epoch_ratio specifies the distributing amount by ratio

OutstandingRewards represents outstanding (un-withdrawn) rewards for a staking coin denom.

Used in: OutstandingRewardsRecord

• repeated base.v1beta1.DecCoin rewards = 1

OutstandingRewardsRecord is used for import/export via genesis json.

Used in: GenesisState

• string staking_coin_denom = 1

• optional OutstandingRewards outstanding_rewards = 2

Params defines the set of params for the farming module.

Used in: GenesisState, QueryParamsResponse

• repeated base.v1beta1.Coin 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

PlanRecord is used for import/export via genesis json.

Used in: GenesisState

• optional google.protobuf.Any plan = 1

  plan specifies the plan interface; it can be FixedAmountPlan or RatioPlan

• repeated base.v1beta1.Coin 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: BasePlan

• 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.

PublicPlanProposal 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 AddPlanRequest add_plan_requests = 3

  add_plan_requests specifies AddPlanRequest object

• repeated ModifyPlanRequest modify_plan_requests = 4

  modify_plan_requests specifies ModifyPlanRequest object

• repeated DeletePlanRequest delete_plan_requests = 5

  delete_plan_requests specifies DeletePlanRequest object

QueuedStaking defines staking that is waiting in a queue.

Used in: QueuedStakingRecord

• string amount = 1

QueuedStakingRecord is used for import/export via genesis json.

Used in: GenesisState

• string staking_coin_denom = 1

• string farmer = 2

• optional QueuedStaking queued_staking = 3

RatioPlan defines a plan that distributes to farmers by ratio distribution for every epoch day.

• optional BasePlan base_plan = 1

• string epoch_ratio = 2

  epoch_ratio specifies the distributing amount by ratio

Staking defines a farmer's staking information.

Used in: StakingRecord

• string amount = 1

• uint64 starting_epoch = 2

StakingRecord is used for import/export via genesis json.

Used in: GenesisState

• string staking_coin_denom = 1

• string farmer = 2

• optional Staking staking = 3

TotalStakings defines the total staking amount for a staking coin denom.

• string amount = 1

TotalStakingsRecord is used for import/export via genesis json.

Used in: GenesisState

• string staking_coin_denom = 1

• string amount = 2

  amount specifies total amount of the staking for the staking coin denom except queued staking

• repeated base.v1beta1.Coin 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