2020-06-01 05:46:03 -07:00
|
|
|
package client
|
2018-08-06 11:11:30 -07:00
|
|
|
|
|
|
|
import (
|
2020-09-23 06:44:40 -07:00
|
|
|
"context"
|
2018-08-06 11:11:30 -07:00
|
|
|
"fmt"
|
2019-05-28 01:44:04 -07:00
|
|
|
"strings"
|
2018-08-06 11:11:30 -07:00
|
|
|
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
|
2018-08-30 00:52:17 -07:00
|
|
|
abci "github.com/tendermint/tendermint/abci/types"
|
2020-01-16 13:46:51 -08:00
|
|
|
tmbytes "github.com/tendermint/tendermint/libs/bytes"
|
2018-08-06 11:11:30 -07:00
|
|
|
rpcclient "github.com/tendermint/tendermint/rpc/client"
|
2019-02-08 13:45:41 -08:00
|
|
|
|
|
|
|
"github.com/cosmos/cosmos-sdk/store/rootmulti"
|
2019-05-28 01:44:04 -07:00
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
2018-08-06 11:11:30 -07:00
|
|
|
)
|
|
|
|
|
|
|
|
// GetNode returns an RPC client. If the context's client is not defined, an
|
|
|
|
// error is returned.
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) GetNode() (rpcclient.Client, error) {
|
2018-08-06 11:11:30 -07:00
|
|
|
if ctx.Client == nil {
|
2020-03-18 18:49:33 -07:00
|
|
|
return nil, errors.New("no RPC client is defined in offline mode")
|
2018-08-06 11:11:30 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
return ctx.Client, nil
|
|
|
|
}
|
|
|
|
|
2019-06-13 06:54:17 -07:00
|
|
|
// Query performs a query to a Tendermint node with the provided path.
|
2019-06-14 02:52:28 -07:00
|
|
|
// It returns the result and height of the query upon success or an error if
|
|
|
|
// the query fails.
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) Query(path string) ([]byte, int64, error) {
|
2019-06-14 02:52:28 -07:00
|
|
|
return ctx.query(path, nil)
|
2018-08-06 11:11:30 -07:00
|
|
|
}
|
|
|
|
|
2019-06-13 06:54:17 -07:00
|
|
|
// QueryWithData performs a query to a Tendermint node with the provided path
|
|
|
|
// and a data payload. It returns the result and height of the query upon success
|
|
|
|
// or an error if the query fails.
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) QueryWithData(path string, data []byte) ([]byte, int64, error) {
|
2018-08-04 22:56:48 -07:00
|
|
|
return ctx.query(path, data)
|
|
|
|
}
|
|
|
|
|
2019-06-13 06:54:17 -07:00
|
|
|
// QueryStore performs a query to a Tendermint node with the provided key and
|
|
|
|
// store name. It returns the result and height of the query upon success
|
|
|
|
// or an error if the query fails.
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) QueryStore(key tmbytes.HexBytes, storeName string) ([]byte, int64, error) {
|
2018-08-06 11:11:30 -07:00
|
|
|
return ctx.queryStore(key, storeName, "key")
|
|
|
|
}
|
|
|
|
|
2020-01-30 07:13:42 -08:00
|
|
|
// QueryABCI performs a query to a Tendermint node with the provide RequestQuery.
|
|
|
|
// It returns the ResultQuery obtained from the query.
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) QueryABCI(req abci.RequestQuery) (abci.ResponseQuery, error) {
|
2020-01-30 07:13:42 -08:00
|
|
|
return ctx.queryABCI(req)
|
|
|
|
}
|
|
|
|
|
2018-08-06 11:11:30 -07:00
|
|
|
// GetFromAddress returns the from address from the context's name.
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) GetFromAddress() sdk.AccAddress {
|
2019-01-29 11:22:47 -08:00
|
|
|
return ctx.FromAddress
|
2018-09-25 13:48:38 -07:00
|
|
|
}
|
2018-08-06 11:11:30 -07:00
|
|
|
|
Add fee grant module (#8061)
* Add docs
* Add BasicFeeAllowance implementation
* Add expiration structs and complete basic fee
* Add delegation messages, add validation logic
* Add keeper and helper structs
* Add alias and handler to top level
* Add delegation module
* Add basic querier
* Add types tests
* Add types tests
* More internal test coverage
* Solid internal test coverage
* Expose Querier to top level module
* Add FeeAccount to auth/types, like StdTx, SignDoc
* Fix all tests in x/auth
* All tests pass
* Appease the Golang Linter
* Add fee-account command line flag
* Start on DelegatedDeductFeeDecorator
* Cleanup the Decorator
* Wire up delegation module in simapp
* add basic test for decorator (no delegation)
* Table tests for deduct fees
* Table tests over all conditions of delegated fee decorator
* Build full ante handler stack and test it
* Start genesis
* Implement Genesis
* Rename package delegation to subkeys
* Clarify antes test cases, handle empty account w/o fees
* Allow paying delegated fees with no account
* Pull mempool into delegated ante, for control on StdFee
* Use custom DelegatedTx, DelegatedFee for subkeys
* Revert all changes to x/auth.StdTx
* Appease scopelint
* Register DelegatedTx with codec
* Address PR comments
* Remove unnecessary DelegatedMempoolFeeDecorator
* Cleaned up errors in querier
* Clean up message sign bytes
* Minor PR comments
* Replace GetAllFees... with Iterator variants
* PrepareForExport adjusts grant expiration height
* Panic on de/serialization error in keeper
* Move custom ante handler chain to tests, update docs
* More cleanup
* More doc cleanup
* Renamed subkeys module to fee_grant
* Rename subkeys/delegation to fee grant in all strings
* Modify Msg and Keeper methods to use Grant not Delegate
* Add PeriodicFeeAllowance
* Update aliases
* Cover all accept cases for PeriodicFeeAllowance
* Et tu scopelint?
* Update docs as requested
* Remove error return from GetFeeGrant
* Code cleanup as requested by PR
* Updated all errors to use new sdk/errors package
* Use test suite for keeper tests
* Clean up alias.go file
* Define expected interfaces in exported, rather than importing from account
* Remove dependency on auth/ante
* Improve godoc, Logger
* Cleaned up ExpiresAt
* Improve error reporting with UseGrantedFee
* Enforce period limit subset of basic limit
* Add events
* Rename fee_grant to feegrant
* Ensure KeeperTestSuite actually runs
* Move types/tx to types
* Update alias file, include ante
* I do need nolint in alias.go
* Properly emit events in the handler. Use cosmos-sdk in amino types
* Update godoc
* Linting...
* Update errors
* Update pkg doc and fix ante-handler order
* Merge PR #5782: Migrate x/feegrant to proto
* fix errors
* proto changes
* proto changes
* fix errors
* fix errors
* genesis state changed to proto
* fix keeper tests
* fix test
* fixed tests
* fix tests
* updated expected keepers
* updated ante tests
* lint
* deleted alias.go
* tx updated to proto tx
* remove explicit signmode
* tests
* Added `cli/query.go`
* Added tx.go in cli
* updated `module.go`
* resolve errors in tx.go
* Add fee payer gentx func
* updated tx
* fixed error
* WIP: cli tests
* fix query error
* fix tests
* Unused types and funcs
* fix tests
* rename helper func to create tx
* remove unused
* update tx cfg
* fix cli tests
* added simulations
* Add `decoder.go`
* fix build fail
* added init genesis code
* update tx.go
* fixed LGTM alert
* modified cli
* remove gogoproto extensions
* change acc address type to string
* lint
* fix simulations
* Add gen simulations
* remove legacy querier
* remove legacy code
* add grpc queries tests
* fix simulations
* update module.go
* lint
* register feegrant NewSimulationManager
* fix sims
* fix sims
* add genesis test
* add periodic grant
* updated cmd
* changed times
* updated flags
* removed days as period clock
* added condition for period and exp
* add periodic fee cli tests
* udpated tests
* fix lint
* fix tests
* fix sims
* renaming to `fee_grant`
* review changes
* fix test
* add condition for duplicate grants
* fix tests
* add `genTxWithFeeGranter` in tests
* fix simulation
* one of changes & test fixes
* fix test
* fix lint
* changed package name `feegrant` to `fee_grant`
* review comments
* review changes
* review change
* review changes
* added fee-account in flags
* address review changes
* read fee granter from cli
* updated create account with mnemonic
* Address review comments
* move `simapp/ante` file to `feegrant/ante`
* update keeper logic to create account
* update docs
* fix tests
* update `serviceMsgClientConn` from `msgservice`
* review changes
* add test case for using more fees than allowed
* eliminate panic checks from keeper
* fix lint
* change store keys string to bytes
* fix tests
* review changes
* review changes
* udpate docs
* make spend limit optional
* fix tests
* fix tests
* review changes
* add norace tag
* proto-docs
* add docs
Co-authored-by: Ethan Frey <ethanfrey@users.noreply.github.com>
Co-authored-by: Alexander Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: Aleksandr Bezobchuk <aleks.bezobchuk@gmail.com>
Co-authored-by: SaReN <sahithnarahari@gmail.com>
Co-authored-by: aleem1413 <aleem@vitwit.com>
Co-authored-by: MD Aleem <72057206+aleem1314@users.noreply.github.com>
Co-authored-by: Anil Kumar Kammari <anil@vitwit.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-01-29 11:54:51 -08:00
|
|
|
// GetFeeGranterAddress returns the fee granter address from the context
|
|
|
|
func (ctx Context) GetFeeGranterAddress() sdk.AccAddress {
|
|
|
|
return ctx.FeeGranter
|
|
|
|
}
|
|
|
|
|
2018-09-25 13:48:38 -07:00
|
|
|
// GetFromName returns the key name for the current context.
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) GetFromName() string {
|
2019-01-29 11:22:47 -08:00
|
|
|
return ctx.FromName
|
2018-08-06 11:11:30 -07:00
|
|
|
}
|
|
|
|
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) queryABCI(req abci.RequestQuery) (abci.ResponseQuery, error) {
|
2018-08-06 11:11:30 -07:00
|
|
|
node, err := ctx.GetNode()
|
|
|
|
if err != nil {
|
2020-01-30 07:13:42 -08:00
|
|
|
return abci.ResponseQuery{}, err
|
2018-08-06 11:11:30 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
opts := rpcclient.ABCIQueryOptions{
|
2018-11-04 18:28:38 -08:00
|
|
|
Height: ctx.Height,
|
2020-07-22 23:44:18 -07:00
|
|
|
Prove: req.Prove,
|
2018-08-06 11:11:30 -07:00
|
|
|
}
|
|
|
|
|
2020-09-23 06:44:40 -07:00
|
|
|
result, err := node.ABCIQueryWithOptions(context.Background(), req.Path, req.Data, opts)
|
2018-08-06 11:11:30 -07:00
|
|
|
if err != nil {
|
2020-01-30 07:13:42 -08:00
|
|
|
return abci.ResponseQuery{}, err
|
2018-08-06 11:11:30 -07:00
|
|
|
}
|
|
|
|
|
2020-01-30 07:13:42 -08:00
|
|
|
if !result.Response.IsOK() {
|
|
|
|
return abci.ResponseQuery{}, errors.New(result.Response.Log)
|
2018-08-06 11:11:30 -07:00
|
|
|
}
|
|
|
|
|
2018-09-26 06:29:39 -07:00
|
|
|
// data from trusted node or subspace query doesn't need verification
|
2020-06-16 08:11:02 -07:00
|
|
|
if !opts.Prove || !isQueryStoreWithProof(req.Path) {
|
2020-01-30 07:13:42 -08:00
|
|
|
return result.Response, nil
|
2018-08-29 21:50:41 -07:00
|
|
|
}
|
|
|
|
|
2020-01-30 07:13:42 -08:00
|
|
|
return result.Response, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// query performs a query to a Tendermint node with the provided store name
|
|
|
|
// and path. It returns the result and height of the query upon success
|
2020-07-22 23:44:18 -07:00
|
|
|
// or an error if the query fails.
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) query(path string, key tmbytes.HexBytes) ([]byte, int64, error) {
|
2020-01-30 07:13:42 -08:00
|
|
|
resp, err := ctx.queryABCI(abci.RequestQuery{
|
|
|
|
Path: path,
|
|
|
|
Data: key,
|
|
|
|
})
|
2018-08-29 21:50:41 -07:00
|
|
|
if err != nil {
|
2020-01-30 07:13:42 -08:00
|
|
|
return nil, 0, err
|
2018-08-29 21:50:41 -07:00
|
|
|
}
|
|
|
|
|
2019-06-13 06:54:17 -07:00
|
|
|
return resp.Value, resp.Height, nil
|
2018-08-06 11:11:30 -07:00
|
|
|
}
|
|
|
|
|
2019-06-13 06:54:17 -07:00
|
|
|
// queryStore performs a query to a Tendermint node with the provided a store
|
|
|
|
// name and path. It returns the result and height of the query upon success
|
|
|
|
// or an error if the query fails.
|
2020-06-01 05:46:03 -07:00
|
|
|
func (ctx Context) queryStore(key tmbytes.HexBytes, storeName, endPath string) ([]byte, int64, error) {
|
2018-08-06 11:11:30 -07:00
|
|
|
path := fmt.Sprintf("/store/%s/%s", storeName, endPath)
|
|
|
|
return ctx.query(path, key)
|
|
|
|
}
|
2018-08-29 21:50:41 -07:00
|
|
|
|
|
|
|
// isQueryStoreWithProof expects a format like /<queryType>/<storeName>/<subpath>
|
2018-11-04 19:36:35 -08:00
|
|
|
// queryType must be "store" and subpath must be "key" to require a proof.
|
2018-08-30 00:52:17 -07:00
|
|
|
func isQueryStoreWithProof(path string) bool {
|
2018-08-29 21:50:41 -07:00
|
|
|
if !strings.HasPrefix(path, "/") {
|
|
|
|
return false
|
|
|
|
}
|
2018-09-26 06:29:39 -07:00
|
|
|
|
2018-08-29 21:50:41 -07:00
|
|
|
paths := strings.SplitN(path[1:], "/", 3)
|
2020-05-02 12:26:59 -07:00
|
|
|
|
2018-11-04 19:36:35 -08:00
|
|
|
switch {
|
|
|
|
case len(paths) != 3:
|
2018-08-29 21:50:41 -07:00
|
|
|
return false
|
2018-11-04 19:36:35 -08:00
|
|
|
case paths[0] != "store":
|
|
|
|
return false
|
2019-02-01 17:03:09 -08:00
|
|
|
case rootmulti.RequireProof("/" + paths[2]):
|
2018-08-29 21:50:41 -07:00
|
|
|
return true
|
|
|
|
}
|
2018-09-26 06:29:39 -07:00
|
|
|
|
2018-08-29 21:50:41 -07:00
|
|
|
return false
|
|
|
|
}
|