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.

Sign up for GitHub

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

ProtoRev: Adding Txs to CLI #4567

Merged
merged 4 commits into from
Mar 24, 2023
Merged

ProtoRev: Adding Txs to CLI #4567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb45b32
init set hot routes cli command
davidterpay Mar 9, 2023
100102a
adding remaining txs
davidterpay Mar 10, 2023
a887fd9
few more tests
davidterpay Mar 10, 2023
1f0877c
comments
davidterpay Mar 10, 2023
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
11 changes: 10 additions & 1 deletion x/protorev/client/cli/query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ func NewCmdQuery() *cobra.Command {
osmocli.AddQueryCmd(cmd, types.NewQueryClient, NewQueryMaxPoolPointsPerBlockCmd)
osmocli.AddQueryCmd(cmd, types.NewQueryClient, NewQueryBaseDenomsCmd)
osmocli.AddQueryCmd(cmd, types.NewQueryClient, NewQueryEnabledCmd)
osmocli.AddQueryCmd(cmd, types.NewQueryClient, NewQueryPoolWeightsCmd)

return cmd
}
Expand Down Expand Up @@ -86,7 +87,7 @@ func NewQueryAllRouteStatisticsCmd() (*osmocli.QueryDescriptor, *types.QueryGetP
// NewQueryTokenPairArbRoutesCmd returns the command to query the token pair arb routes
func NewQueryTokenPairArbRoutesCmd() (*osmocli.QueryDescriptor, *types.QueryGetProtoRevTokenPairArbRoutesRequest) {
return &osmocli.QueryDescriptor{
Use: "token-pair-arb-routes",
Use: "hot-routes",
Short: "Query the ProtoRev hot routes currently being used",
}, &types.QueryGetProtoRevTokenPairArbRoutesRequest{}
}
Expand Down Expand Up @@ -139,6 +140,14 @@ func NewQueryEnabledCmd() (*osmocli.QueryDescriptor, *types.QueryGetProtoRevEnab
}, &types.QueryGetProtoRevEnabledRequest{}
}

// NewQueryPoolWeightsCmd returns the command to query the pool weights of protorev
func NewQueryPoolWeightsCmd() (*osmocli.QueryDescriptor, *types.QueryGetProtoRevPoolWeightsRequest) {
return &osmocli.QueryDescriptor{
Use: "pool-weights",
Short: "Query the pool weights used to determine how computationally expensive a route is",
}, &types.QueryGetProtoRevPoolWeightsRequest{}
}

// convert a string array "[1,2,3]" to []uint64
func parseRoute(arg string, _ *pflag.FlagSet) (any, osmocli.FieldReadLocation, error) {
var route []uint64
Expand Down
163 changes: 161 additions & 2 deletions x/protorev/client/cli/tx.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ import (
"strconv"

"github.com/cosmos/cosmos-sdk/client"

"github.com/cosmos/cosmos-sdk/client/flags"
"github.com/cosmos/cosmos-sdk/client/tx"
"github.com/cosmos/cosmos-sdk/version"
"github.com/cosmos/cosmos-sdk/x/gov/client/cli"
"github.com/spf13/cobra"
"github.com/spf13/pflag"

govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"

Expand All @@ -22,17 +24,174 @@ import (
// NewCmdTx returns the cli transaction commands for this module
func NewCmdTx() *cobra.Command {
txCmd := osmocli.TxIndexCmd(types.ModuleName)
osmocli.AddTxCmd(txCmd, CmdSetDeveloperAccount)
osmocli.AddTxCmd(txCmd, CmdSetMaxPoolPointsPerTx)
osmocli.AddTxCmd(txCmd, CmdSetMaxPoolPointsPerBlock)
txCmd.AddCommand(
CmdSetDeveloperHotRoutes().BuildCommandCustomFn(),
CmdSetPoolWeights().BuildCommandCustomFn(),
CmdSetBaseDenoms().BuildCommandCustomFn(),
CmdSetProtoRevAdminAccountProposal(),
CmdSetProtoRevEnabledProposal(),
)
return txCmd
}

// CmdSetDeveloperHotRoutes implements the command to set the protorev hot routes
func CmdSetDeveloperHotRoutes() *osmocli.TxCliDesc {
desc := osmocli.TxCliDesc{
Use: "set-hot-routes [path/to/routes.json]",
Short: "set the protorev hot routes",
Long: `Must provide a json file with all of the hot routes that will be set.
Sample json file:
[
{
"token_in": "uosmo",
"token_out": "ibc/123...",
"arb_routes" : [
{
"trades": [
{
"pool": 1,
"token_in": "uosmo",
"token_out": "uatom"
},
{
"pool": 2,
"token_in": "uatom",
"token_out": "ibc/123..."
},
{
"pool": 0,
"token_in": "ibc/123...",
"token_out": "uosmo"
}
],
"step_size": 1000000
}
]
}
]
`,
Example: fmt.Sprintf(`$ %s tx protorev set-hot-routes routes.json --from mykey`, version.AppName),
NumArgs: 1,
ParseAndBuildMsg: BuildSetHotRoutesMsg,
}

return &desc
}

// CmdSetDeveloperAccount implements the command to set the protorev developer account
func CmdSetDeveloperAccount() (*osmocli.TxCliDesc, *types.MsgSetDeveloperAccount) {
return &osmocli.TxCliDesc{
Use: "set-developer-account [sdk.AccAddress]",
Short: "set the protorev developer account",
NumArgs: 1,
ParseAndBuildMsg: func(clientCtx client.Context, args []string, flags *pflag.FlagSet) (sdk.Msg, error) {
developer, err := sdk.AccAddressFromBech32(args[0])
if err != nil {
return nil, err
}

return &types.MsgSetDeveloperAccount{
DeveloperAccount: developer.String(),
Admin: clientCtx.GetFromAddress().String(),
}, nil
},
}, &types.MsgSetDeveloperAccount{}
}

// CmdSetMaxPoolPointsPerTx implements the command to set the max pool points per tx
func CmdSetMaxPoolPointsPerTx() (*osmocli.TxCliDesc, *types.MsgSetMaxPoolPointsPerTx) {
return &osmocli.TxCliDesc{
Use: "set-max-pool-points-per-tx [uint64]",
Short: "set the max pool points that can be consumed per tx",
NumArgs: 1,
ParseAndBuildMsg: func(clientCtx client.Context, args []string, flags *pflag.FlagSet) (sdk.Msg, error) {
maxPoolPointsPerTx, err := strconv.ParseUint(args[0], 10, 64)
if err != nil {
return nil, err
}

return &types.MsgSetMaxPoolPointsPerTx{
MaxPoolPointsPerTx: maxPoolPointsPerTx,
Admin: clientCtx.GetFromAddress().String(),
}, nil
},
}, &types.MsgSetMaxPoolPointsPerTx{}
}

// CmdSetMaxPoolPointsPerBlock implements the command to set the max pool points per block
func CmdSetMaxPoolPointsPerBlock() (*osmocli.TxCliDesc, *types.MsgSetMaxPoolPointsPerBlock) {
return &osmocli.TxCliDesc{
Use: "set-max-pool-points-per-block [uint64]",
Short: "set the max pool points that can be consumed per block",
NumArgs: 1,
ParseAndBuildMsg: func(clientCtx client.Context, args []string, flags *pflag.FlagSet) (sdk.Msg, error) {
maxPoolPointsPerBlock, err := strconv.ParseUint(args[0], 10, 64)
if err != nil {
return nil, err
}

return &types.MsgSetMaxPoolPointsPerBlock{
MaxPoolPointsPerBlock: maxPoolPointsPerBlock,
Admin: clientCtx.GetFromAddress().String(),
}, nil
},
}, &types.MsgSetMaxPoolPointsPerBlock{}
}

// CmdSetPoolWeights implements the command to set the pool weights used to estimate execution costs
func CmdSetPoolWeights() *osmocli.TxCliDesc {
desc := osmocli.TxCliDesc{
Use: "set-pool-weights [path/to/routes.json]",
Short: "set the protorev pool weights",
Long: `Must provide a json file with all the pool weights that will be set.
Sample json file:
{
"stable_weight" : 1,
"balancer_weight" : 1,
"concentrated_weight" : 1
}
`,
Example: fmt.Sprintf(`$ %s tx protorev set-pool-weights weights.json --from mykey`, version.AppName),
NumArgs: 1,
ParseAndBuildMsg: BuildSetPoolWeightsMsg,
}

return &desc
}

// CmdSetBaseDenoms implements the command to set the base denoms used in the highest liquidity method
func CmdSetBaseDenoms() *osmocli.TxCliDesc {
desc := osmocli.TxCliDesc{
Use: "set-base-denoms [path/to/denoms.json]",
Short: "set the protorev base denoms",
Long: `Must provide a json file with all the base denoms that will be set.
Sample json file:
[
{
"step_size" : 10000,
"denom" : "uosmo"
},
{
"step_size" : 10000,
"denom" : "atom"
}
]
`,
Example: fmt.Sprintf(`$ %s tx protorev set-base-denoms denoms.json --from mykey`, version.AppName),
NumArgs: 1,
ParseAndBuildMsg: BuildSetBaseDenomsMsg,
}

return &desc
}

// CmdSetProtoRevAdminAccountProposal implements the command to submit a SetProtoRevAdminAccountProposal
func CmdSetProtoRevAdminAccountProposal() *cobra.Command {
cmd := &cobra.Command{
Use: "set-protorev-admin-account-proposal [sdk.AccAddress]",
Use: "set-admin-account-proposal [sdk.AccAddress]",
Args: cobra.ExactArgs(1),
Short: "submit a set protorev admin account proposal to set the admin account for x/protorev",
Example: fmt.Sprintf(`$ %s tx protorev set-protorev-admin-account osmo123... --from mykey`, version.AppName),
Expand All @@ -58,7 +217,7 @@ func CmdSetProtoRevAdminAccountProposal() *cobra.Command {
// CmdSetProtoRevEnabledProposal implements the command to submit a SetProtoRevEnabledProposal
func CmdSetProtoRevEnabledProposal() *cobra.Command {
cmd := &cobra.Command{
Use: "set-protorev-enabled-proposal [boolean]",
Use: "set-enabled-proposal [boolean]",
Args: cobra.ExactArgs(1),
Short: "submit a set protorev enabled proposal to enable or disable the protocol",
Example: fmt.Sprintf(`$ %s tx protorev set-protorev-enabled true --from mykey`, version.AppName),
Expand Down
Loading