Merge pull request #1504 from cosmos/deprecate-sendIbcTokens

Deprecate SigningStargateClient.sendIbcTokens
cosmos · Nov 8, 2023 · bb34b58 · bb34b58
2 parents c7b6bd3 + 9c55a85
commit bb34b58
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -62,6 +62,10 @@ and this project adheres to
 
 - @cosmjs/tendermint-rpc: `CometClient` should be used instead of
   `TendermintClient`.
+- @cosmjs/stargate: Deprecate `SigningStargateClient.sendIbcTokens`. Please use
+  `signAndBroadcast` + `MsgTransferEncodeObject` instead. ([#1493])
+
+[#1493]: https://github.com/cosmos/cosmjs/issues/1493
 
 ## [0.31.3] - 2023-10-25
 

diff --git a/packages/stargate/src/signingstargateclient.ts b/packages/stargate/src/signingstargateclient.ts
@@ -261,6 +261,12 @@ export class SigningStargateClient extends StargateClient {
     return this.signAndBroadcast(delegatorAddress, [withdrawMsg], fee, memo);
   }
 
+  /**
+   * @deprecated This API does not support setting the memo field of `MsgTransfer` (only the transaction memo).
+   * We'll remove this method at some point because trying to wrap the various message types is a losing strategy.
+   * Please migrate to `signAndBroadcast` with an `MsgTransferEncodeObject` created in the caller code instead.
+   * @see https://github.com/cosmos/cosmjs/issues/1493
+   */
   public async sendIbcTokens(
     senderAddress: string,
     recipientAddress: string,