c6315ec1b1
## Description - Use tools methodology to use canonically versioned tools/binaries (e.g. golangci-lint) - This makes it so that all environments and developers use the same versions of tools (no need to rely on hacky docker containers) - Update makefile - Address linting errors --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
115 lines
3.3 KiB
Go
115 lines
3.3 KiB
Go
package client
|
|
|
|
import (
|
|
"encoding/base64"
|
|
|
|
"github.com/spf13/pflag"
|
|
rpchttp "github.com/tendermint/tendermint/rpc/client/http"
|
|
|
|
"github.com/cosmos/cosmos-sdk/client/flags"
|
|
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
|
|
"github.com/cosmos/cosmos-sdk/types/query"
|
|
)
|
|
|
|
// Paginate returns the correct starting and ending index for a paginated query,
|
|
// given that client provides a desired page and limit of objects and the handler
|
|
// provides the total number of objects. The start page is assumed to be 1-indexed.
|
|
// If the start page is invalid, non-positive values are returned signaling the
|
|
// request is invalid; it returns non-positive values if limit is non-positive and
|
|
// defLimit is negative.
|
|
func Paginate(numObjs, page, limit, defLimit int) (start, end int) {
|
|
if page <= 0 {
|
|
// invalid start page
|
|
return -1, -1
|
|
}
|
|
|
|
// fallback to default limit if supplied limit is invalid
|
|
if limit <= 0 {
|
|
if defLimit < 0 {
|
|
// invalid default limit
|
|
return -1, -1
|
|
}
|
|
limit = defLimit
|
|
}
|
|
|
|
start = (page - 1) * limit
|
|
end = limit + start
|
|
|
|
if end >= numObjs {
|
|
end = numObjs
|
|
}
|
|
|
|
if start >= numObjs {
|
|
// page is out of bounds
|
|
return -1, -1
|
|
}
|
|
|
|
return start, end
|
|
}
|
|
|
|
// ReadPageRequest reads and builds the necessary page request flags for pagination.
|
|
func ReadPageRequest(flagSet *pflag.FlagSet) (*query.PageRequest, error) {
|
|
pageKey, _ := flagSet.GetString(flags.FlagPageKey)
|
|
offset, _ := flagSet.GetUint64(flags.FlagOffset)
|
|
limit, _ := flagSet.GetUint64(flags.FlagLimit)
|
|
countTotal, _ := flagSet.GetBool(flags.FlagCountTotal)
|
|
page, _ := flagSet.GetUint64(flags.FlagPage)
|
|
reverse, _ := flagSet.GetBool(flags.FlagReverse)
|
|
|
|
if page > 1 && offset > 0 {
|
|
return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "page and offset cannot be used together")
|
|
}
|
|
|
|
if page > 1 {
|
|
offset = (page - 1) * limit
|
|
}
|
|
|
|
return &query.PageRequest{
|
|
Key: []byte(pageKey),
|
|
Offset: offset,
|
|
Limit: limit,
|
|
CountTotal: countTotal,
|
|
Reverse: reverse,
|
|
}, nil
|
|
}
|
|
|
|
// NewClientFromNode sets up Client implementation that communicates with a Tendermint node over
|
|
// JSON RPC and WebSockets
|
|
func NewClientFromNode(nodeURI string) (*rpchttp.HTTP, error) {
|
|
return rpchttp.New(nodeURI)
|
|
}
|
|
|
|
// FlagSetWithPageKeyDecoded returns the provided flagSet with the page-key value base64 decoded (if it exists).
|
|
// This is for when the page-key is provided as a base64 string (e.g. from the CLI).
|
|
// ReadPageRequest expects it to be the raw bytes.
|
|
//
|
|
// Common usage:
|
|
// fs, err := client.FlagSetWithPageKeyDecoded(cmd.Flags())
|
|
// pageReq, err := client.ReadPageRequest(fs)
|
|
func FlagSetWithPageKeyDecoded(flagSet *pflag.FlagSet) (*pflag.FlagSet, error) {
|
|
encoded, err := flagSet.GetString(flags.FlagPageKey)
|
|
if err != nil {
|
|
return flagSet, err
|
|
}
|
|
if len(encoded) > 0 {
|
|
var raw []byte
|
|
raw, err = base64.StdEncoding.DecodeString(encoded)
|
|
if err != nil {
|
|
return flagSet, err
|
|
}
|
|
_ = flagSet.Set(flags.FlagPageKey, string(raw))
|
|
}
|
|
return flagSet, nil
|
|
}
|
|
|
|
// MustFlagSetWithPageKeyDecoded calls FlagSetWithPageKeyDecoded and panics on error.
|
|
//
|
|
// Common usage: pageReq, err := client.ReadPageRequest(client.MustFlagSetWithPageKeyDecoded(cmd.Flags()))
|
|
func MustFlagSetWithPageKeyDecoded(flagSet *pflag.FlagSet) *pflag.FlagSet {
|
|
rv, err := FlagSetWithPageKeyDecoded(flagSet)
|
|
if err != nil {
|
|
panic(err.Error())
|
|
}
|
|
return rv
|
|
}
|