Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add pagination and auction status optional flags for CLI queries #106

Merged
merged 3 commits into from
Nov 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/cli/liquidfarming.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,9 +272,12 @@ Example
```bash
# The "rewards_auction_duration" param is the duration that is used to create new rewards auction in begin blocker.
# You can adjust the value in config-test.yml file to make it faster or slower.
# By default, the value is set to 12 hours but for local testing purpose it is set to 120 seconds.
# By default, the value is set to 8 hours but for local testing purpose it is set to 120 seconds.
# If you wait 120 seconds (2 minutes) after starting a local network, the module automatically creates new rewards auction.
crescentd query liquidfarming rewards-auctions 1 -o json | jq
crescentd query liquidfarming rewards-auctions 1 --status AUCTION_STATUS_STARTED -o json | jq
crescentd query liquidfarming rewards-auctions 1 --status AUCTION_STATUS_FINISHED -o json | jq
crescentd query liquidfarming rewards-auctions 1 --status AUCTION_STATUS_SKIPPED -o json | jq
```

## RewardsAuction
Expand Down
20 changes: 20 additions & 0 deletions x/liquidfarming/client/cli/flags.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package cli

// DONTCOVER

import (
flag "github.com/spf13/pflag"
)

const (
FlagRewardsAuctionStatus = "status"
)

// flagSetRewardsAuctions returns the FlagSet used for farming plan related opertations.
func flagSetRewardsAuctions() *flag.FlagSet {
fs := flag.NewFlagSet("", flag.ContinueOnError)

fs.String(FlagRewardsAuctionStatus, "", "The rewards auction status; AUCTION_STATUS_STARTED, AUCTION_STATUS_FINISHED, or AUCTION_STATUS_SKIPPED")

return fs
}
28 changes: 24 additions & 4 deletions x/liquidfarming/client/cli/query.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (

"github.com/cosmos/cosmos-sdk/client"
"github.com/cosmos/cosmos-sdk/client/flags"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
"github.com/cosmos/cosmos-sdk/version"

"github.com/crescent-network/crescent/v3/x/liquidfarming/types"
Expand Down Expand Up @@ -111,6 +112,7 @@ $ %s query %s liquidfarms
}

flags.AddQueryFlagsToCmd(cmd)
flags.AddPaginationFlagsToCmd(cmd, "liquidfarms")

return cmd
}
Expand Down Expand Up @@ -182,17 +184,32 @@ $ %s query %s rewards-auctions 1
return fmt.Errorf("failed to parse pool id: %w", err)
}

status, _ := cmd.Flags().GetString(FlagRewardsAuctionStatus)

pageReq, err := client.ReadPageRequest(cmd.Flags())
if err != nil {
return err
}

queryClient := types.NewQueryClient(clientCtx)

res, err := queryClient.RewardsAuctions(cmd.Context(), &types.QueryRewardsAuctionsRequest{
req := &types.QueryRewardsAuctionsRequest{
PoolId: poolId,
Pagination: pageReq,
})
}

if status != "" {
if status == types.AuctionStatusStarted.String() ||
status == types.AuctionStatusFinished.String() ||
status == types.AuctionStatusSkipped.String() {
req.Status = status
} else {
return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest,
"auction status type must be AUCTION_STATUS_STARTED, AUCTION_STATUS_FINISHED, or AUCTION_STATUS_SKIPPED")
}
}

queryClient := types.NewQueryClient(clientCtx)

res, err := queryClient.RewardsAuctions(cmd.Context(), req)
if err != nil {
return err
}
Expand All @@ -201,7 +218,9 @@ $ %s query %s rewards-auctions 1
},
}

cmd.Flags().AddFlagSet(flagSetRewardsAuctions())
flags.AddQueryFlagsToCmd(cmd)
flags.AddPaginationFlagsToCmd(cmd, "auctions")

return cmd
}
Expand Down Expand Up @@ -300,6 +319,7 @@ $ %s query %s bids 1
}

flags.AddQueryFlagsToCmd(cmd)
flags.AddPaginationFlagsToCmd(cmd, "bids")

return cmd
}
Expand Down