mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-12-29 01:35:18 +00:00
4beaf0de54
* add swap claim type * add store methods for swap claims * add swap claims to genesis state * tidy up cdp and hard hook doc comments * add uncalled hooks to the swap keeper * add swap rewards sync method * add swap rewards init method * connect swap rewards via swap hooks * Update querier and client for swap claims (#951) * refactor querier to dedupe code * add swap claims querier endpoint * add swap claim querying to rest * add swap claim querying to cli * add keeper method to iterate swap reward indexes * simplify reward-factors query endpoint, add swap * update swap hook to match latest swap branch * rename func to not collide with latest swap branch * Squash merge swap-acceptance branch (#956) * add failing acceptance test for a user depositing into a pool * implement GetAccount test helper * implement swap.MsgDeposit for creating and adding liquidity to a pool * update aliases, add event types, and fix typo/compiler errors in handler test * use only aliases names in handler test (don't use swap types -- ensures we have run aliasgen), add assertion for even type message * implement account and module account balance checks in handler test * fill out handler assertions for testing keeper state and events * update signed json representation and register swap/MsgDeposit for proper encoding * fill out boilerplate to get handler test to compile * alias gen for pool * add handling of message type; fill in deposit keeper method for succesful compile; noop but test assertions now run up to module acc not nil check * add module account permissions for swap module -- fixes module account creation; pass account keeper and supply keeper into swap keeper to allow the ability to work with user and module accounts * implement create pool logic for msg deposit; allows creation of a of new pool, checking params to see if it is allowed. Initi shares are set, and senders number of shares are stored * Swap migrations scaffolding (#925) * swap module scaffolding * global swap fee * can't think of a reason for begin blocker; removing for abci.go for now; * test pair types; refactor pair name logic; simplify pairs validation and fix stack overflow error * check comparison * use test package * init swap module genesis * add basic marshall tests * remove reward apy from pairs * fix integration helpers * use max swap fee constant; fix validation of swap fee; add tests to cover param validation and param set setup * use noerror over nil * start genesis tests * test param set validation mirrors param validation * add genesis tests * remove print statement * add subtests for genesis test cases; add extra querier test for unknown route; add keeper params testing * add spec * update swagger * find replace hard -> swap in comments * remove unused method * rename pairs to allowed pools; pool is more commonly used, and allowedPool makes it more clear what swap parameter is for. In addition, we won't conflict with Pool data structure for storing a created pool in the store. * remove generated link * missed spec rename * validate token order for allowed pools * fix swagger * json should be snakecase; change allowedPools to allowed_pools * add legacy types * add swap genesis to v0_15 migration * add legacy types * add swap genesis to v0_15 migration * migration revisions Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com> * keeper todos * update keeper tests * type todos * update types tests * tx deposit cli cmd * tx deposit rest * Swap module simulation scaffolding (#924) * sims scaffolding * add noop operation * genesis revisions * add param changes * mvoe persistance methods to main keeper file, consolidate tests * make helper methods private. they are tested via deposit method, and unit testing them would make test suite brittle and refactoring difficult * use more clear coin variables * code 1 is reserved, use code 2 and sequence all errors * remove todo * Implement deadline for swap module module message. This is implemented in handler with a interface to easily apply to it to all messages, and separate msg validation concerns from the keeper * move allowed pools to params -- let pool and pool_test focus on pool domain logic, not parameter & governance concerns * update alias * add unitless implementatin of constant product liquidity pool to isolate and enapsulate liquidity logic. Swap methods interfaces are added, but implementation not yet added * nits and todos * add ErrInvalidPool * add tests for edge cases around pool depletion; add explicit panic for edge case that results in a pool reserve being zero; handle pool reinitialization if it is empty * touch up comments and flush out the rest of assertions * add data structures for keeper state storage separate from pool domain objects, and improve structure for easier querying * rename pool name to pool key for events * add support for a denominated pool that uses sdk.Coins and sdk.Coin arguments, keeping tracking of the units in the base pool. This gives nice separation between pool logic, and coin/denom logic * refactor keeper to use new records for storage, and implement pool deposit using the denominated pool * address previous PR comment - reminder for migration if changing account permissions * msg deposit should validate that denoms are not equal * add godoc comments * golint and some poolName -> poolID cleanup * implement adding liquidity to an existing pool * hardcode pools in sims * touch up comment * withdraw keeper logic * withdraw type updates * add withdraw msg tx handler * initial withdraw test * fix panic * use new denominated pool with existing shares * fix: check args on deposit cmd * add slippage limit check for depositing to an existing pool * send coins just before event emission * check liquidity returned is greater than zero for both coins; ensure returned number of shares are greater than zero * add deadline to msgwithdraw * register msgwithdraw * scaffold msgwithdraw types test * register the correct msg * modify swap functions to also return the amount paid for the pool swap fee. This will be used to calculate slippage and for event tracking * add slippage types * add expected withdrawal coins * calculate slippage against expected coins * update withdraw keeper tests * spelling, improve comments on add liquidity math * typo * typo * grammer * typo / grammer * remove pool_id from withdraw msg * add slippage to tx cmd * TestWithdraw_Partial * nit * add withdraw no pool, no deposit record tests * drop event check on partial withdraw test * fix broken link * fix broken link * resolve merge conflicts * ensure swap fee can not be equal to 1; add full implementation of swap pool methods; these implementation ensure that the pool invariant is always greater or equal to the previous invariant * refactor duplicated code into private swap methods * add runtime assertion to always ensure invariant is greater or equal to the previous invariant sub fee on swaps * improve comments for base pool swap functions * add swap exact input and output methods to denominated pool that wrap the base pool interface for swapping * comment touch ups * more comment touchups * fix msg deposit struct tag (#943) * use better name for swap calculation private methods * nits: golint * fix misspelling in method name * Add HARD token governance committee for Hard module (#941) * add hard gov token committee * revisions: update migration * revisions: update test/data file * initial revisions * add TokenCommittee JSONMarshal test * fix SetPermissions method * remove BaseCommittee Type field * add incentive params to allowed params * Add SWP token governance committee for Swap module (#946) * add swp token commitee to migration * update test, add gen export utility method * final revisions: add TODO * remove slippage from withdraw to use min values for coins; add additional validation test cases * update alias for swap module * add withdraw tests to handler for increased coverage; note: first pass, improvements still yet to be made here * refact withdraw keeper to use min amounts; panic for cases that do not happen in normal situations * lint fixes * use total shares to track if pool should be deleted; add more in depth withdraw comment * add exact args for withdraw cmd * extract record update methods * update depositor share record if it exists -- do not overwrite an existing record; ensures no loss of shares if the same address deposits more than once * Swap queries: deposit, pool, pools (#949) * query deposits types * implement deposit querier keeper methods * query deposits CLI * query deposits REST * query types for pool/pools * pool/pools querier keeper methods * pool/pools CLI * pool/pools REST * basic pool/pools query tests * basic deposit querier test * iterate share records via owner bytes * nit: add example for querying deposits by owner only Co-authored-by: karzak <kjydavis3@gmail.com> * feat: add REST tx handler for swap LP withdrawals Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com> Co-authored-by: Denali Marsh <denali@kava.io> Co-authored-by: denalimarsh <denalimarsh@gmail.com> Co-authored-by: karzak <kjydavis3@gmail.com> * expand incentive cli query docs Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com> Co-authored-by: Denali Marsh <denali@kava.io> Co-authored-by: denalimarsh <denalimarsh@gmail.com> Co-authored-by: karzak <kjydavis3@gmail.com> * minor update to godoc comment Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com> Co-authored-by: Denali Marsh <denali@kava.io> Co-authored-by: denalimarsh <denalimarsh@gmail.com> Co-authored-by: karzak <kjydavis3@gmail.com>
301 lines
9.4 KiB
Go
301 lines
9.4 KiB
Go
package cli
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/viper"
|
|
|
|
"github.com/cosmos/cosmos-sdk/client/context"
|
|
"github.com/cosmos/cosmos-sdk/client/flags"
|
|
"github.com/cosmos/cosmos-sdk/codec"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
"github.com/cosmos/cosmos-sdk/version"
|
|
|
|
"github.com/kava-labs/kava/x/incentive/types"
|
|
)
|
|
|
|
const (
|
|
flagOwner = "owner"
|
|
flagType = "type"
|
|
flagUnsynced = "unsynced"
|
|
flagDenom = "denom"
|
|
|
|
typeDelegator = "delegator"
|
|
typeHard = "hard"
|
|
typeUSDXMinting = "usdx-minting"
|
|
typeSwap = "swap"
|
|
)
|
|
|
|
var rewardTypes = []string{typeDelegator, typeHard, typeUSDXMinting, typeSwap}
|
|
|
|
// GetQueryCmd returns the cli query commands for the incentive module
|
|
func GetQueryCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
|
|
incentiveQueryCmd := &cobra.Command{
|
|
Use: types.ModuleName,
|
|
Short: "Querying commands for the incentive module",
|
|
}
|
|
|
|
incentiveQueryCmd.AddCommand(flags.GetCommands(
|
|
queryParamsCmd(queryRoute, cdc),
|
|
queryRewardsCmd(queryRoute, cdc),
|
|
queryRewardFactorsCmd(queryRoute, cdc),
|
|
)...)
|
|
|
|
return incentiveQueryCmd
|
|
}
|
|
|
|
func queryRewardsCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "rewards",
|
|
Short: "query claimable rewards",
|
|
Long: strings.TrimSpace(
|
|
fmt.Sprintf(`Query rewards with optional flags for owner and type
|
|
|
|
Example:
|
|
$ %s query %s rewards
|
|
$ %s query %s rewards --owner kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw
|
|
$ %s query %s rewards --type hard
|
|
$ %s query %s rewards --type usdx-minting
|
|
$ %s query %s rewards --type delegator
|
|
$ %s query %s rewards --type swap
|
|
$ %s query %s rewards --type hard --owner kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw
|
|
$ %s query %s rewards --type hard --unsynced
|
|
`,
|
|
version.ClientName, types.ModuleName, version.ClientName, types.ModuleName,
|
|
version.ClientName, types.ModuleName, version.ClientName, types.ModuleName,
|
|
version.ClientName, types.ModuleName, version.ClientName, types.ModuleName,
|
|
version.ClientName, types.ModuleName, version.ClientName, types.ModuleName)),
|
|
Args: cobra.NoArgs,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
cliCtx := context.NewCLIContext().WithCodec(cdc)
|
|
|
|
page := viper.GetInt(flags.FlagPage)
|
|
limit := viper.GetInt(flags.FlagLimit)
|
|
strOwner := viper.GetString(flagOwner)
|
|
strType := viper.GetString(flagType)
|
|
boolUnsynced := viper.GetBool(flagUnsynced)
|
|
|
|
// Prepare params for querier
|
|
owner, err := sdk.AccAddressFromBech32(strOwner)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
switch strings.ToLower(strType) {
|
|
case typeHard:
|
|
params := types.NewQueryRewardsParams(page, limit, owner, boolUnsynced)
|
|
claims, err := executeHardRewardsQuery(queryRoute, cdc, cliCtx, params)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return cliCtx.PrintOutput(claims)
|
|
case typeUSDXMinting:
|
|
params := types.NewQueryRewardsParams(page, limit, owner, boolUnsynced)
|
|
claims, err := executeUSDXMintingRewardsQuery(queryRoute, cdc, cliCtx, params)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return cliCtx.PrintOutput(claims)
|
|
case typeDelegator:
|
|
params := types.NewQueryRewardsParams(page, limit, owner, boolUnsynced)
|
|
claims, err := executeDelegatorRewardsQuery(queryRoute, cdc, cliCtx, params)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return cliCtx.PrintOutput(claims)
|
|
case typeSwap:
|
|
params := types.NewQueryRewardsParams(page, limit, owner, boolUnsynced)
|
|
claims, err := executeSwapRewardsQuery(queryRoute, cdc, cliCtx, params)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return cliCtx.PrintOutput(claims)
|
|
default:
|
|
params := types.NewQueryRewardsParams(page, limit, owner, boolUnsynced)
|
|
|
|
hardClaims, err := executeHardRewardsQuery(queryRoute, cdc, cliCtx, params)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
usdxMintingClaims, err := executeUSDXMintingRewardsQuery(queryRoute, cdc, cliCtx, params)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
delegatorClaims, err := executeDelegatorRewardsQuery(queryRoute, cdc, cliCtx, params)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
swapClaims, err := executeSwapRewardsQuery(queryRoute, cdc, cliCtx, params)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if len(hardClaims) > 0 {
|
|
cliCtx.PrintOutput(hardClaims)
|
|
}
|
|
if len(usdxMintingClaims) > 0 {
|
|
cliCtx.PrintOutput(usdxMintingClaims)
|
|
}
|
|
if len(delegatorClaims) > 0 {
|
|
cliCtx.PrintOutput(delegatorClaims)
|
|
}
|
|
if len(swapClaims) > 0 {
|
|
cliCtx.PrintOutput(swapClaims)
|
|
}
|
|
}
|
|
return nil
|
|
},
|
|
}
|
|
cmd.Flags().String(flagOwner, "", "(optional) filter by owner address")
|
|
cmd.Flags().String(flagType, "", fmt.Sprintf("(optional) filter by a reward type: %s", strings.Join(rewardTypes, "|")))
|
|
cmd.Flags().Bool(flagUnsynced, false, "(optional) get unsynced claims")
|
|
cmd.Flags().Int(flags.FlagPage, 1, "pagination page rewards of to to query for")
|
|
cmd.Flags().Int(flags.FlagLimit, 100, "pagination limit of rewards to query for")
|
|
return cmd
|
|
}
|
|
|
|
func queryParamsCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
|
|
return &cobra.Command{
|
|
Use: "params",
|
|
Short: "get the incentive module parameters",
|
|
Long: "Get the current global incentive module parameters.",
|
|
Args: cobra.NoArgs,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
cliCtx := context.NewCLIContext().WithCodec(cdc)
|
|
|
|
// Query
|
|
route := fmt.Sprintf("custom/%s/%s", queryRoute, types.QueryGetParams)
|
|
res, height, err := cliCtx.QueryWithData(route, nil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
cliCtx = cliCtx.WithHeight(height)
|
|
|
|
// Decode and print results
|
|
var params types.Params
|
|
if err := cdc.UnmarshalJSON(res, ¶ms); err != nil {
|
|
return fmt.Errorf("failed to unmarshal params: %w", err)
|
|
}
|
|
return cliCtx.PrintOutput(params)
|
|
},
|
|
}
|
|
}
|
|
|
|
func queryRewardFactorsCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "reward-factors",
|
|
Short: "get current global reward factors",
|
|
Long: `Get current global reward factors for all reward types.`,
|
|
Args: cobra.NoArgs,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
cliCtx := context.NewCLIContext().WithCodec(cdc)
|
|
|
|
// Execute query
|
|
route := fmt.Sprintf("custom/%s/%s", queryRoute, types.QueryGetRewardFactors)
|
|
res, height, err := cliCtx.QueryWithData(route, nil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
cliCtx = cliCtx.WithHeight(height)
|
|
|
|
// Decode and print results
|
|
var response types.QueryGetRewardFactorsResponse
|
|
if err := cdc.UnmarshalJSON(res, &response); err != nil {
|
|
return fmt.Errorf("failed to unmarshal reward factors: %w", err)
|
|
}
|
|
return cliCtx.PrintOutput(response)
|
|
},
|
|
}
|
|
cmd.Flags().String(flagDenom, "", "(optional) filter reward factors by denom")
|
|
return cmd
|
|
}
|
|
|
|
func executeHardRewardsQuery(queryRoute string, cdc *codec.Codec, cliCtx context.CLIContext, params types.QueryRewardsParams) (types.HardLiquidityProviderClaims, error) {
|
|
bz, err := cdc.MarshalJSON(params)
|
|
if err != nil {
|
|
return types.HardLiquidityProviderClaims{}, err
|
|
}
|
|
|
|
route := fmt.Sprintf("custom/%s/%s", queryRoute, types.QueryGetHardRewards)
|
|
res, height, err := cliCtx.QueryWithData(route, bz)
|
|
if err != nil {
|
|
return types.HardLiquidityProviderClaims{}, err
|
|
}
|
|
|
|
cliCtx = cliCtx.WithHeight(height)
|
|
|
|
var claims types.HardLiquidityProviderClaims
|
|
if err := cdc.UnmarshalJSON(res, &claims); err != nil {
|
|
return types.HardLiquidityProviderClaims{}, fmt.Errorf("failed to unmarshal claims: %w", err)
|
|
}
|
|
|
|
return claims, nil
|
|
}
|
|
|
|
func executeUSDXMintingRewardsQuery(queryRoute string, cdc *codec.Codec, cliCtx context.CLIContext, params types.QueryRewardsParams) (types.USDXMintingClaims, error) {
|
|
bz, err := cdc.MarshalJSON(params)
|
|
if err != nil {
|
|
return types.USDXMintingClaims{}, err
|
|
}
|
|
|
|
route := fmt.Sprintf("custom/%s/%s", queryRoute, types.QueryGetUSDXMintingRewards)
|
|
res, height, err := cliCtx.QueryWithData(route, bz)
|
|
if err != nil {
|
|
return types.USDXMintingClaims{}, err
|
|
}
|
|
|
|
cliCtx = cliCtx.WithHeight(height)
|
|
|
|
var claims types.USDXMintingClaims
|
|
if err := cdc.UnmarshalJSON(res, &claims); err != nil {
|
|
return types.USDXMintingClaims{}, fmt.Errorf("failed to unmarshal claims: %w", err)
|
|
}
|
|
|
|
return claims, nil
|
|
}
|
|
|
|
func executeDelegatorRewardsQuery(queryRoute string, cdc *codec.Codec, cliCtx context.CLIContext, params types.QueryRewardsParams) (types.DelegatorClaims, error) {
|
|
bz, err := cdc.MarshalJSON(params)
|
|
if err != nil {
|
|
return types.DelegatorClaims{}, err
|
|
}
|
|
|
|
route := fmt.Sprintf("custom/%s/%s", queryRoute, types.QueryGetDelegatorRewards)
|
|
res, height, err := cliCtx.QueryWithData(route, bz)
|
|
if err != nil {
|
|
return types.DelegatorClaims{}, err
|
|
}
|
|
|
|
cliCtx = cliCtx.WithHeight(height)
|
|
|
|
var claims types.DelegatorClaims
|
|
if err := cdc.UnmarshalJSON(res, &claims); err != nil {
|
|
return types.DelegatorClaims{}, fmt.Errorf("failed to unmarshal claims: %w", err)
|
|
}
|
|
|
|
return claims, nil
|
|
}
|
|
|
|
func executeSwapRewardsQuery(queryRoute string, cdc *codec.Codec, cliCtx context.CLIContext, params types.QueryRewardsParams) (types.SwapClaims, error) {
|
|
bz, err := cdc.MarshalJSON(params)
|
|
if err != nil {
|
|
return types.SwapClaims{}, err
|
|
}
|
|
|
|
route := fmt.Sprintf("custom/%s/%s", queryRoute, types.QueryGetSwapRewards)
|
|
res, height, err := cliCtx.QueryWithData(route, bz)
|
|
if err != nil {
|
|
return types.SwapClaims{}, err
|
|
}
|
|
|
|
cliCtx = cliCtx.WithHeight(height)
|
|
|
|
var claims types.SwapClaims
|
|
if err := cdc.UnmarshalJSON(res, &claims); err != nil {
|
|
return types.SwapClaims{}, fmt.Errorf("failed to unmarshal claims: %w", err)
|
|
}
|
|
|
|
return claims, nil
|
|
}
|