abci: Restore Client::set_option as deprecated

informalsystems · Sep 28, 2022 · 2a89abe · 2a89abe
1 parent 35e3fe5
commit 2a89abe
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/.changelog/unreleased/enhancements/1203-deprecate-abci-client-set-option.md b/.changelog/unreleased/enhancements/1203-deprecate-abci-client-set-option.md
@@ -0,0 +1,2 @@
+- `[tendermint-abci]` Deprecate `Client::set_option`.
+  ([#1203](https://github.com/informalsystems/tendermint-rs/pull/1203))
diff --git a/abci/src/client.rs b/abci/src/client.rs
@@ -6,10 +6,10 @@ use tendermint_proto::abci::{
     request, response, Request, RequestApplySnapshotChunk, RequestBeginBlock, RequestCheckTx,
     RequestCommit, RequestDeliverTx, RequestEcho, RequestEndBlock, RequestFlush, RequestInfo,
     RequestInitChain, RequestListSnapshots, RequestLoadSnapshotChunk, RequestOfferSnapshot,
-    RequestQuery, ResponseApplySnapshotChunk, ResponseBeginBlock, ResponseCheckTx, ResponseCommit,
-    ResponseDeliverTx, ResponseEcho, ResponseEndBlock, ResponseFlush, ResponseInfo,
-    ResponseInitChain, ResponseListSnapshots, ResponseLoadSnapshotChunk, ResponseOfferSnapshot,
-    ResponseQuery,
+    RequestQuery, RequestSetOption, ResponseApplySnapshotChunk, ResponseBeginBlock,
+    ResponseCheckTx, ResponseCommit, ResponseDeliverTx, ResponseEcho, ResponseEndBlock,
+    ResponseFlush, ResponseInfo, ResponseInitChain, ResponseListSnapshots,
+    ResponseLoadSnapshotChunk, ResponseOfferSnapshot, ResponseQuery, ResponseSetOption,
 };
 
 use crate::{codec::ClientCodec, Error};
@@ -113,6 +113,15 @@ impl Client {
         perform!(self, Commit, RequestCommit {})
     }
 
+    /// Request that the application set an option to a particular value.
+    ///
+    /// This request lacks specification and should not be used.
+    /// It will be removed in ABCI 0.37.
+    #[deprecated]
+    pub fn set_option(&mut self, req: RequestSetOption) -> Result<ResponseSetOption, Error> {
+        perform!(self, SetOption, req)
+    }
+
     /// Used during state sync to discover available snapshots on peers.
     pub fn list_snapshots(&mut self) -> Result<ResponseListSnapshots, Error> {
         perform!(self, ListSnapshots, RequestListSnapshots {})