package
0.0.2
Repository: https://github.com/incubus-network/fury.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

DefaultGenesisState returns a default genesis state.
DefaultParams returns default params for earn module.
DepositorVaultSharesKey returns a key from a depositor address.
NewAllowedVault returns a new AllowedVault with the given values.
NewCommunityPoolDepositProposal creates a new community pool deposit proposal.
NewCommunityPoolWithdrawProposal creates a new community pool deposit proposal.
NewGenesisState creates a new genesis state.
No description provided by the author
NewMsgDeposit returns a new MsgDeposit.
NewMsgWithdraw returns a new MsgWithdraw.
NewParams returns a new params object.
No description provided by the author
NewQueryDepositsRequest returns a new QueryDepositsRequest.
NewQueryParamsRequest returns a new QueryParamsRequest.
NewQueryVaultRequest returns a new QueryVaultRequest.
NewQueryVaultsRequest returns a new QueryVaultsRequest.
NewStrategyTypeFromString converts string to StrategyType type.
NewVaultRecord returns a new VaultRecord with 0 supply.
NewVaultShare returns a new VaultShare.
NewVaultShareRecord returns a new VaultShareRecord with the provided supplied coins.
NewVaultShares returns new VaultShares.
ParamKeyTable for earn module.
RegisterInterfaces registers proto messages under their interfaces for unmarshalling, in addition to registerting the msg service for handling tx msgs.
RegisterLegacyAminoCodec registers all the necessary types and interfaces for the earn module.
No description provided by the author
RegisterQueryHandler registers the http handlers for service Query to "mux".
RegisterQueryHandlerClient registers the http handlers for service Query to "mux".
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterQueryHandlerServer registers the http handlers for service Query to "mux".
No description provided by the author
VaultKey returns a key generated from a vault denom.

# Constants

Event types for earn module.
Event types for earn module.
Event types for earn module.
Event types for earn module.
Event types for earn module.
DefaultParamspace default name for parameter store.
Event types for earn module.
Event types for earn module.
ModuleAccountName name of module account used to hold liquidity.
ModuleName name that will be used throughout the module.
ProposalTypeCommunityPoolDeposit defines the type for a CommunityPoolDepositProposal.
ProposalTypeCommunityPoolWithdraw defines the type for a CommunityPoolDepositProposal.
QuerierRoute Top level query string.
RouterKey Top level router key.
StoreKey Top level store key where all module items will be stored.
STRATEGY_TYPE_HARD represents the strategy that deposits assets in the Hard module.
STRATEGY_TYPE_SAVINGS represents the strategy that deposits assets in the Savings module.
STRATEGY_TYPE_UNSPECIFIED represents an unspecified or invalid strategy type.
legacy message types.
legacy message types.

# Variables

Parameter keys and default values.
earn module errors.
earn module errors.
earn module errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
earn module errors.
earn module errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
earn module errors.
earn module errors.
Parameter keys and default values.
ModuleCdc represents the legacy amino codec for the module.
No description provided by the author
No description provided by the author
denom -> vault.
depositor address -> vault shares.

# Structs

AllowedVault is a vault that is allowed to be created.
CommunityPoolDepositProposal deposits from the community pool into an earn vault.
CommunityPoolDepositProposalJSON defines a CommunityPoolDepositProposal with a deposit.
CommunityPoolWithdrawProposal withdraws from an earn vault back to community pool.
CommunityPoolWithdrawProposalJSON defines a CommunityPoolWithdrawProposal with a deposit.
DepositResponse defines a deposit query response type.
GenesisState defines the earn module's genesis state.
MsgDeposit represents a message for depositing assedts into a vault.
MsgDepositResponse defines the Msg/Deposit response type.
MsgWithdraw represents a message for withdrawing liquidity from a vault.
MsgWithdrawResponse defines the Msg/Withdraw response type.
Params defines the parameters of the earn module.
QueryDepositsRequest is the request type for the Query/Deposits RPC method.
QueryDepositsResponse is the response type for the Query/Deposits RPC method.
QueryParamsRequest defines the request type for querying x/earn parameters.
QueryParamsResponse defines the response type for querying x/earn parameters.
QueryTotalSupplyRequest defines the request type for Query/TotalSupply method.
TotalSupplyResponse defines the response type for the Query/TotalSupply method.
QueryVaultRequest is the request type for the Query/Vault RPC method.
QueryVaultResponse is the response type for the Query/Vault RPC method.
QueryVaultsRequest is the request type for the Query/Vaults RPC method.
QueryVaultsResponse is the response type for the Query/Vaults RPC method.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.
VaultRecord is the state of a vault.
VaultResponse is the response type for a vault.
VaultShare defines shares of a vault owned by a depositor.
VaultShareRecord defines the vault shares owned by a depositor.

# Interfaces

AccountKeeper defines the expected account keeper.
BankKeeper defines the expected interface needed to retrieve account balances.
DistributionKeeper defines the expected interface needed for community-pool deposits to earn vaults.
EarnHooks are event hooks called when a user's deposit to a earn vault changes.
HardKeeper defines the expected interface needed for the hard strategy.
LiquidKeeper defines the expected interface needed for derivative to staked token conversions.
MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.
SavingsKeeper defines the expected interface needed for the savings strategy.

# Type aliases

AllowedVaults is a slice of AllowedVault.
StrategyType is the type of strategy that a vault uses to optimize yields.
StrategyTypes defines a slice of StrategyType.
VaultRecords is a slice of VaultRecord.
VaultShareRecords is a slice of VaultShareRecord.
VaultShares is a slice of VaultShare.