package kava.earn.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the earn Msg service.

• rpc Deposit (MsgDeposit, MsgDepositResponse)

  tx.proto:15

  Deposit defines a method for depositing assets into a vault

  message MsgDeposit

  tx.proto:21

  MsgDeposit represents a message for depositing assedts into a vault

  • string depositor = 1

    depositor represents the address to deposit funds from

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

    Amount represents the token to deposit. The vault corresponds to the denom of the amount coin.

  • StrategyType strategy = 3

    Strategy is the vault strategy to use.

  message MsgDepositResponse

  tx.proto:35

  MsgDepositResponse defines the Msg/Deposit response type.

  • optional VaultShare shares = 1

• rpc Withdraw (MsgWithdraw, MsgWithdrawResponse)

  tx.proto:17

  Withdraw defines a method for withdrawing assets into a vault

  message MsgWithdraw

  tx.proto:40

  MsgWithdraw represents a message for withdrawing liquidity from a vault

  • string from = 1

    from represents the address we are withdrawing for

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

    Amount represents the token to withdraw. The vault corresponds to the denom of the amount coin.

  • StrategyType strategy = 3

    Strategy is the vault strategy to use.

  message MsgWithdrawResponse

  tx.proto:55

  MsgWithdrawResponse defines the Msg/Withdraw response type.

  • optional VaultShare shares = 1

Query defines the gRPC querier service for earn module

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:19

  Params queries all parameters of the earn module.

  message QueryParamsRequest

  query.proto:45

  QueryParamsRequest defines the request type for querying x/earn parameters.

  (message has no fields)

  message QueryParamsResponse

  query.proto:48

  QueryParamsResponse defines the response type for querying x/earn parameters.

  • optional Params params = 1

    params represents the earn module parameters

• rpc Vaults (QueryVaultsRequest, QueryVaultsResponse)

  query.proto:24

  Vaults queries all vaults

  message QueryVaultsRequest

  query.proto:54

  QueryVaultsRequest is the request type for the Query/Vaults RPC method.

  (message has no fields)

  message QueryVaultsResponse

  query.proto:57

  QueryVaultsResponse is the response type for the Query/Vaults RPC method.

  • repeated VaultResponse vaults = 1

    vaults represents the earn module vaults

• rpc Vault (QueryVaultRequest, QueryVaultResponse)

  query.proto:29

  Vault queries a single vault based on the vault denom

  message QueryVaultRequest

  query.proto:63

  QueryVaultRequest is the request type for the Query/Vault RPC method.

  • string denom = 1

    vault filters vault by denom

  message QueryVaultResponse

  query.proto:69

  QueryVaultResponse is the response type for the Query/Vault RPC method.

  • optional VaultResponse vault = 1

    vault represents the queried earn module vault

• rpc Deposits (QueryDepositsRequest, QueryDepositsResponse)

  query.proto:34

  Deposits queries deposit details based on depositor address and vault

  message QueryDepositsRequest

  query.proto:105

  QueryDepositsRequest is the request type for the Query/Deposits RPC method.

  • string depositor = 1

    depositor optionally filters deposits by depositor

  • string denom = 2

    denom optionally filters deposits by vault denom

  • bool value_in_staked_tokens = 3

    respond with vault value in ukava for bkava vaults

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

    pagination defines an optional pagination for the request.

  message QueryDepositsResponse

  query.proto:120

  QueryDepositsResponse is the response type for the Query/Deposits RPC method.

  • repeated DepositResponse deposits = 1

    deposits returns the deposits matching the requested parameters

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

    pagination defines the pagination in the response.

• rpc TotalSupply (QueryTotalSupplyRequest, QueryTotalSupplyResponse)

  query.proto:39

  TotalSupply returns the total sum of all coins currently locked into the earn module.

  message QueryTotalSupplyRequest

  query.proto:149

  QueryTotalSupplyRequest defines the request type for Query/TotalSupply method.

  (message has no fields)

  message QueryTotalSupplyResponse

  query.proto:152

  TotalSupplyResponse defines the response type for the Query/TotalSupply method.

  • int64 height = 1

    Height is the block height at which these totals apply

  • repeated cosmos.base.v1beta1.Coin result = 2

    Result is a list of coins supplied to earn

AllowedVault is a vault that is allowed to be created. These can be modified via parameter governance.

Used in: Params

• string denom = 1

  Denom is the only supported denomination of the vault for deposits and withdrawals.

• repeated StrategyType strategies = 2

  VaultStrategy is the strategy used for this vault.

• bool is_private_vault = 3

  IsPrivateVault is true if the vault only allows depositors contained in AllowedDepositors.

• repeated bytes allowed_depositors = 4

  AllowedDepositors is a list of addresses that are allowed to deposit to this vault if IsPrivateVault is true. Addresses not contained in this list are not allowed to deposit into this vault. If IsPrivateVault is false, this should be empty and ignored.

CommunityPoolDepositProposal deposits from the community pool into an earn vault

• string title = 1

• string description = 2

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

CommunityPoolDepositProposalJSON defines a CommunityPoolDepositProposal with a deposit

• string title = 1

• string description = 2

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

• repeated cosmos.base.v1beta1.Coin deposit = 4

CommunityPoolWithdrawProposal withdraws from an earn vault back to community pool

• string title = 1

• string description = 2

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

CommunityPoolWithdrawProposalJSON defines a CommunityPoolWithdrawProposal with a deposit

• string title = 1

• string description = 2

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

• repeated cosmos.base.v1beta1.Coin deposit = 4

DepositResponse defines a deposit query response type.

Used in: QueryDepositsResponse

• string depositor = 1

  depositor represents the owner of the deposit.

• repeated VaultShare shares = 2

  Shares represent the issued shares from their corresponding vaults.

• repeated cosmos.base.v1beta1.Coin value = 3

  Value represents the total accumulated value of denom coins supplied to vaults. This may be greater than or equal to amount_supplied depending on the strategy.

GenesisState defines the earn module's genesis state.

• optional Params params = 1

  params defines all the parameters related to earn

• repeated VaultRecord vault_records = 2

  vault_records defines the available vaults

• repeated VaultShareRecord vault_share_records = 3

  share_records defines the owned shares of each vault

Params defines the parameters of the earn module.

Used in: GenesisState, QueryParamsResponse

• repeated AllowedVault allowed_vaults = 1

StrategyType is the type of strategy that a vault uses to optimize yields.

Used in: AllowedVault, MsgDeposit, MsgWithdraw, VaultResponse

• STRATEGY_TYPE_UNSPECIFIED = 0

  STRATEGY_TYPE_UNSPECIFIED represents an unspecified or invalid strategy type.

• STRATEGY_TYPE_HARD = 1

  STRATEGY_TYPE_HARD represents the strategy that deposits assets in the Hard module.

• STRATEGY_TYPE_SAVINGS = 2

  STRATEGY_TYPE_SAVINGS represents the strategy that deposits assets in the Savings module.

VaultRecord is the state of a vault.

Used in: GenesisState

• optional VaultShare total_shares = 1

  TotalShares is the total distributed number of shares in the vault.

VaultResponse is the response type for a vault.

Used in: QueryVaultResponse, QueryVaultsResponse

• string denom = 1

  denom represents the denom of the vault

• repeated StrategyType strategies = 2

  VaultStrategy is the strategy used for this vault.

• bool is_private_vault = 3

  IsPrivateVault is true if the vault only allows depositors contained in AllowedDepositors.

• repeated string allowed_depositors = 4

  AllowedDepositors is a list of addresses that are allowed to deposit to this vault if IsPrivateVault is true. Addresses not contained in this list are not allowed to deposit into this vault. If IsPrivateVault is false, this should be empty and ignored.

• string total_shares = 5

  TotalShares is the total amount of shares issued to depositors.

• string total_value = 6

  TotalValue is the total value of denom coins supplied to the vault if the vault were to be liquidated.

VaultShare defines shares of a vault owned by a depositor.

Used in: DepositResponse, MsgDepositResponse, MsgWithdrawResponse, VaultRecord, VaultShareRecord

• string denom = 1

• string amount = 2

VaultShareRecord defines the vault shares owned by a depositor.

Used in: GenesisState

• bytes depositor = 1

  Depositor represents the owner of the shares

• repeated VaultShare shares = 2

  Shares represent the vault shares owned by the depositor.