abci: Remove SetOption #5447 #9091 (#9266)

* Remove set option for abci

CHANGELOG_PENDING.md

@@ -15,6 +15,7 @@ Friendly reminder, we have a [bug bounty program](https://hackerone.com/tendermi
  - [abci/counter] \#6684 Delete counter example app
  - [txResults] \#9175 Remove `gas_used` & `gas_wanted` from being merkelized in the lastresulthash in the header
  - [abci] \#5783 Make length delimiter encoding consistent (`uint64`) between ABCI and P2P wire-level protocols
+ - [abci] \##9145 Removes Response/Request `SetOption` from ABCI
 
 - P2P Protocol
 

abci/client/client.go

@@ -30,7 +30,6 @@ type Client interface {
  FlushAsync() *ReqRes
  EchoAsync(msg string) *ReqRes
  InfoAsync(types.RequestInfo) *ReqRes
- SetOptionAsync(types.RequestSetOption) *ReqRes
  DeliverTxAsync(types.RequestDeliverTx) *ReqRes
  CheckTxAsync(types.RequestCheckTx) *ReqRes
  QueryAsync(types.RequestQuery) *ReqRes
@@ -48,7 +47,6 @@ type Client interface {
  FlushSync() error
  EchoSync(msg string) (*types.ResponseEcho, error)
  InfoSync(types.RequestInfo) (*types.ResponseInfo, error)
- SetOptionSync(types.RequestSetOption) (*types.ResponseSetOption, error)
  DeliverTxSync(types.RequestDeliverTx) (*types.ResponseDeliverTx, error)
  CheckTxSync(types.RequestCheckTx) (*types.ResponseCheckTx, error)
  QuerySync(types.RequestQuery) (*types.ResponseQuery, error)

abci/client/grpc_client.go

@@ -192,15 +192,6 @@ func (cli *grpcClient) InfoAsync(params types.RequestInfo) *ReqRes {
  return cli.finishAsyncCall(req, &types.Response{Value: &types.Response_Info{Info: res}})
 }
 
-func (cli *grpcClient) SetOptionAsync(params types.RequestSetOption) *ReqRes {
- req := types.ToRequestSetOption(params)
- res, err := cli.client.SetOption(context.Background(), req.GetSetOption(), grpc.WaitForReady(true))
- if err != nil {
- cli.StopForError(err)
- }
- return cli.finishAsyncCall(req, &types.Response{Value: &types.Response_SetOption{SetOption: res}})
-}
-
 func (cli *grpcClient) DeliverTxAsync(params types.RequestDeliverTx) *ReqRes {
  req := types.ToRequestDeliverTx(params)
  res, err := cli.client.DeliverTx(context.Background(), req.GetDeliverTx(), grpc.WaitForReady(true))
@@ -375,11 +366,6 @@ func (cli *grpcClient) InfoSync(req types.RequestInfo) (*types.ResponseInfo, err
  return cli.finishSyncCall(reqres).GetInfo(), cli.Error()
 }
 
-func (cli *grpcClient) SetOptionSync(req types.RequestSetOption) (*types.ResponseSetOption, error) {
- reqres := cli.SetOptionAsync(req)
- return reqres.Response.GetSetOption(), cli.Error()
-}
-
 func (cli *grpcClient) DeliverTxSync(params types.RequestDeliverTx) (*types.ResponseDeliverTx, error) {
  reqres := cli.DeliverTxAsync(params)
  return cli.finishSyncCall(reqres).GetDeliverTx(), cli.Error()

abci/client/local_client.go

@@ -75,17 +75,6 @@ func (app *localClient) InfoAsync(req types.RequestInfo) *ReqRes {
  )
 }
 
-func (app *localClient) SetOptionAsync(req types.RequestSetOption) *ReqRes {
- app.mtx.Lock()
- defer app.mtx.Unlock()
-
- res := app.Application.SetOption(req)
- return app.callback(
- types.ToRequestSetOption(req),
- types.ToResponseSetOption(res),
- )
-}
-
 func (app *localClient) DeliverTxAsync(params types.RequestDeliverTx) *ReqRes {
  app.mtx.Lock()
  defer app.mtx.Unlock()
@@ -247,14 +236,6 @@ func (app *localClient) InfoSync(req types.RequestInfo) (*types.ResponseInfo, er
  return &res, nil
 }
 
-func (app *localClient) SetOptionSync(req types.RequestSetOption) (*types.ResponseSetOption, error) {
- app.mtx.Lock()
- defer app.mtx.Unlock()
-
- res := app.Application.SetOption(req)
- return &res, nil
-}
-
 func (app *localClient) DeliverTxSync(req types.RequestDeliverTx) (*types.ResponseDeliverTx, error) {
  app.mtx.Lock()
  defer app.mtx.Unlock()

abci/client/socket_client.go

@@ -231,10 +231,6 @@ func (cli *socketClient) InfoAsync(req types.RequestInfo) *ReqRes {
  return cli.queueRequest(types.ToRequestInfo(req))
 }
 
-func (cli *socketClient) SetOptionAsync(req types.RequestSetOption) *ReqRes {
- return cli.queueRequest(types.ToRequestSetOption(req))
-}
-
 func (cli *socketClient) DeliverTxAsync(req types.RequestDeliverTx) *ReqRes {
  return cli.queueRequest(types.ToRequestDeliverTx(req))
 }
@@ -316,15 +312,6 @@ func (cli *socketClient) InfoSync(req types.RequestInfo) (*types.ResponseInfo, e
  return reqres.Response.GetInfo(), cli.Error()
 }
 
-func (cli *socketClient) SetOptionSync(req types.RequestSetOption) (*types.ResponseSetOption, error) {
- reqres := cli.queueRequest(types.ToRequestSetOption(req))
- if err := cli.FlushSync(); err != nil {
- return nil, err
- }
-
- return reqres.Response.GetSetOption(), cli.Error()
-}
-
 func (cli *socketClient) DeliverTxSync(req types.RequestDeliverTx) (*types.ResponseDeliverTx, error) {
  reqres := cli.queueRequest(types.ToRequestDeliverTx(req))
  if err := cli.FlushSync(); err != nil {
@@ -494,8 +481,6 @@ func resMatchesReq(req *types.Request, res *types.Response) (ok bool) {
  _, ok = res.Value.(*types.Response_Flush)
  case *types.Request_Info:
  _, ok = res.Value.(*types.Response_Info)
- case *types.Request_SetOption:
- _, ok = res.Value.(*types.Response_SetOption)
  case *types.Request_DeliverTx:
  _, ok = res.Value.(*types.Response_DeliverTx)
  case *types.Request_CheckTx:

abci/cmd/abci-cli/abci-cli.go

@@ -138,7 +138,6 @@ func addCommands() {
  RootCmd.AddCommand(consoleCmd)
  RootCmd.AddCommand(echoCmd)
  RootCmd.AddCommand(infoCmd)
- RootCmd.AddCommand(setOptionCmd)
  RootCmd.AddCommand(deliverTxCmd)
  RootCmd.AddCommand(checkTxCmd)
  RootCmd.AddCommand(commitCmd)
@@ -164,7 +163,6 @@ you'd like to run:
 
 where example.file looks something like:
 
- set_option serial on
  check_tx 0x00
  check_tx 0xff
  deliver_tx 0x00
@@ -186,7 +184,7 @@ This command opens an interactive console for running any of the other commands
 without opening a new connection each time
 `,
  Args: cobra.ExactArgs(0),
- ValidArgs: []string{"echo", "info", "set_option", "deliver_tx", "check_tx", "commit", "query"},
+ ValidArgs: []string{"echo", "info", "deliver_tx", "check_tx", "commit", "query"},
  RunE: cmdConsole,
 }
 
@@ -204,13 +202,6 @@ var infoCmd = &cobra.Command{
  Args: cobra.ExactArgs(0),
  RunE: cmdInfo,
 }
-var setOptionCmd = &cobra.Command{
- Use: "set_option",
- Short: "set an option on the application",
- Long: "set an option on the application",
- Args: cobra.ExactArgs(2),
- RunE: cmdSetOption,
-}
 
 var deliverTxCmd = &cobra.Command{
  Use: "deliver_tx",
@@ -304,7 +295,6 @@ func cmdTest(cmd *cobra.Command, args []string) error {
  return compose(
  []func() error{
  func() error { return servertest.InitChain(client) },
- func() error { return servertest.SetOption(client, "serial", "on") },
  func() error { return servertest.Commit(client, nil) },
  func() error { return servertest.DeliverTx(client, []byte("abc"), code.CodeTypeBadNonce, nil) },
  func() error { return servertest.Commit(client, nil) },
@@ -419,8 +409,6 @@ func muxOnCommands(cmd *cobra.Command, pArgs []string) error {
  return cmdInfo(cmd, actualArgs)
  case "query":
  return cmdQuery(cmd, actualArgs)
- case "set_option":
- return cmdSetOption(cmd, actualArgs)
  default:
  return cmdUnimplemented(cmd, pArgs)
  }
@@ -444,7 +432,6 @@ func cmdUnimplemented(cmd *cobra.Command, args []string) error {
  fmt.Printf("%s: %s\n", deliverTxCmd.Use, deliverTxCmd.Short)
  fmt.Printf("%s: %s\n", queryCmd.Use, queryCmd.Short)
  fmt.Printf("%s: %s\n", commitCmd.Use, commitCmd.Short)
- fmt.Printf("%s: %s\n", setOptionCmd.Use, setOptionCmd.Short)
  fmt.Println("Use \"[command] --help\" for more information about a command.")
 
  return nil
@@ -484,25 +471,6 @@ func cmdInfo(cmd *cobra.Command, args []string) error {
 
 const codeBad uint32 = 10
 
-// Set an option on the application
-func cmdSetOption(cmd *cobra.Command, args []string) error {
- if len(args) < 2 {
- printResponse(cmd, args, response{
- Code: codeBad,
- Log: "want at least arguments of the form: <key> <value>",
- })
- return nil
- }
-
- key, val := args[0], args[1]
- _, err := client.SetOptionSync(types.RequestSetOption{Key: key, Value: val})
- if err != nil {
- return err
- }
- printResponse(cmd, args, response{Log: "OK (SetOption doesn't return anything.)"}) // NOTE: Nothing to show...
- return nil
-}
-
 // Append a new tx to application
 func cmdDeliverTx(cmd *cobra.Command, args []string) error {
  if len(args) == 0 {

abci/example/kvstore/persistent_kvstore.go

@@ -62,10 +62,6 @@ func (app *PersistentKVStoreApplication) Info(req types.RequestInfo) types.Respo
  return res
 }
 
-func (app *PersistentKVStoreApplication) SetOption(req types.RequestSetOption) types.ResponseSetOption {
- return app.app.SetOption(req)
-}
-
 // tx is either "val:pubkey!power" or "key=value" or just arbitrary bytes
 func (app *PersistentKVStoreApplication) DeliverTx(req types.RequestDeliverTx) types.ResponseDeliverTx {
  // if it starts with "val:", update the validator set

abci/server/socket_server.go

@@ -200,9 +200,6 @@ func (s *SocketServer) handleRequest(req *types.Request, responses chan<- *types
  case *types.Request_Info:
  res := s.app.Info(*r.Info)
  responses <- types.ToResponseInfo(res)
- case *types.Request_SetOption:
- res := s.app.SetOption(*r.SetOption)
- responses <- types.ToResponseSetOption(res)
  case *types.Request_DeliverTx:
  res := s.app.DeliverTx(*r.DeliverTx)
  responses <- types.ToResponseDeliverTx(res)

abci/tests/server/client.go

@@ -29,17 +29,6 @@ func InitChain(client abcicli.Client) error {
  return nil
 }
 
-func SetOption(client abcicli.Client, key, value string) error {
- _, err := client.SetOptionSync(types.RequestSetOption{Key: key, Value: value})
- if err != nil {
- fmt.Println("Failed test: SetOption")
- fmt.Printf("error while setting %v=%v: \nerror: %v\n", key, value, err)
- return err
- }
- fmt.Println("Passed test: SetOption")
- return nil
-}
-
 func Commit(client abcicli.Client, hashExp []byte) error {
  res, err := client.CommitSync()
  data := res.Data

abci/tests/test_cli/ex2.abci.out

@@ -1,6 +1,4 @@
 > set_option serial on
--> code: OK
--> log: OK (SetOption doesn't return anything.)
 
 > check_tx 0x00
 -> code: OK

abci/types/application.go

@@ -12,9 +12,8 @@ import (
 // except CheckTx/DeliverTx, which take `tx []byte`, and `Commit`, which takes nothing.
 type Application interface {
  // Info/Query Connection
- Info(RequestInfo) ResponseInfo // Return application info
- SetOption(RequestSetOption) ResponseSetOption // Set application option
- Query(RequestQuery) ResponseQuery // Query for state
+ Info(RequestInfo) ResponseInfo // Return application info
+ Query(RequestQuery) ResponseQuery // Query for state
 
  // Mempool Connection
  CheckTx(RequestCheckTx) ResponseCheckTx // Validate a tx for the mempool
@@ -51,10 +50,6 @@ func (BaseApplication) Info(req RequestInfo) ResponseInfo {
  return ResponseInfo{}
 }
 
-func (BaseApplication) SetOption(req RequestSetOption) ResponseSetOption {
- return ResponseSetOption{}
-}
-
 func (BaseApplication) DeliverTx(req RequestDeliverTx) ResponseDeliverTx {
  return ResponseDeliverTx{Code: CodeTypeOK}
 }
@@ -144,11 +139,6 @@ func (app *GRPCApplication) Info(ctx context.Context, req *RequestInfo) (*Respon
  return &res, nil
 }
 
-func (app *GRPCApplication) SetOption(ctx context.Context, req *RequestSetOption) (*ResponseSetOption, error) {
- res := app.app.SetOption(*req)
- return &res, nil
-}
-
 func (app *GRPCApplication) DeliverTx(ctx context.Context, req *RequestDeliverTx) (*ResponseDeliverTx, error) {
  res := app.app.DeliverTx(*req)
  return &res, nil

abci/types/messages.go

@@ -48,12 +48,6 @@ func ToRequestInfo(req RequestInfo) *Request {
  }
 }
 
-func ToRequestSetOption(req RequestSetOption) *Request {
- return &Request{
- Value: &Request_SetOption{&req},
- }
-}
-
 func ToRequestDeliverTx(req RequestDeliverTx) *Request {
  return &Request{
  Value: &Request_DeliverTx{&req},
@@ -158,12 +152,6 @@ func ToResponseInfo(res ResponseInfo) *Response {
  }
 }
 
-func ToResponseSetOption(res ResponseSetOption) *Response {
- return &Response{
- Value: &Response_SetOption{&res},
- }
-}
-
 func ToResponseDeliverTx(res ResponseDeliverTx) *Response {
  return &Response{
  Value: &Response_DeliverTx{&res},