Merge pull request #1898 from cosmos/rm-tendermint34

Remove Tendermint 0.34 support

Author: webmaster128

CHANGELOG.md

@@ -46,7 +46,43 @@ and this project adheres to
 
   This change requires users to use TypeScript 5.7 or newer. ([#1883])
 
+- @cosmjs/tendermint-rpc: Remove union type `TendermintClient`. Use
+  `CometClient` or just `Tendermint37Client` instead. ([#1866])
+- @cosmjs/tendermint-rpc: Remove `isTendermint34Client`. Remove
+  `Tendermint34Client` from `CometClient` union type. Remove
+  `Tendermint34Client`. Remove module `tendermint34`. ([#1866])
+- @cosmjs/tendermint-rpc: Remove top-level exports `broadcastTxCommitSuccess`,
+  `broadcastTxSyncSuccess`, `AbciInfoRequest`, `AbciInfoResponse`,
+  `AbciQueryParams`, `AbciQueryRequest`, `AbciQueryResponse`, `Attribute`,
+  `Block`, `BlockchainRequest`, `BlockchainResponse`, `BlockGossipParams`,
+  `BlockId`, `BlockMeta`, `BlockParams`, `BlockRequest`, `BlockResponse`,
+  `BlockResultsRequest`, `BlockResultsResponse`, `BroadcastTxAsyncResponse`,
+  `BroadcastTxCommitResponse`, `BroadcastTxParams`, `BroadcastTxRequest`,
+  `BroadcastTxSyncResponse`, `Commit`, `CommitRequest`, `CommitResponse`,
+  `ConsensusParams`, `Event`, `Evidence`, `EvidenceParams`, `GenesisRequest`,
+  `GenesisResponse`, `Header`, `HealthRequest`, `HealthResponse`, `Method`,
+  `NewBlockEvent`, `NewBlockHeaderEvent`, `NodeInfo`,
+  `NumUnconfirmedTxsRequest`, `NumUnconfirmedTxsResponse`, `ProofOp`,
+  `QueryProof`, `QueryTag`, `Request`, `Response`, `StatusRequest`,
+  `StatusResponse`, `SubscriptionEventType`, `SyncInfo`, `TxData`, `TxEvent`,
+  `TxParams`, `TxProof`, `TxRequest`, `TxResponse`, `TxSearchParams`,
+  `TxSearchRequest`, `TxSearchResponse`, `TxSizeParams`, `Validator`,
+  `ValidatorsParams`, `ValidatorsRequest`, `ValidatorsResponse`, `Version`,
+  `Vote`, `VoteType` which all came from `tendermint34`.
+
+  If you needs any of those you can import them from a version specific module,
+  such as `comet1.Version` or
+
+  ```ts
+  import { comet1, comet38, tendermint37 } from "@cosmjs/tendermint-rpc";
+
+  function convertEvent(e: tendermint37.Event | comet38.Event | comet1.Event);
+  ```
+
+  in case you want to support multiple versions. ([#1866])
+
 [#1883]: https://github.com/cosmos/cosmjs/issues/1883
+[#1866]: https://github.com/cosmos/cosmjs/issues/1866
 
 ## [0.37.0] - 2025-10-29
 

HACKING.md

@@ -115,8 +115,6 @@ order to avoid conflicts. Here is an overview of the ports used:
 | 5555  | httpserver                     | @cosmjs/tendermint-rpc tests    |
 | 9090  | simapp gRPC                    | Manual Stargate debugging       |
 | 11101 | Standalone CometBFT 1.x RPC    | @cosmjs/tendermint-rpc tests    |
-| 11134 | Standalone Tendermint 0.34 RPC | @cosmjs/tendermint-rpc tests    |
-| 11135 | Standalone Tendermint 0.35 RPC | @cosmjs/tendermint-rpc tests    |
 | 11137 | Standalone Tendermint 0.37 RPC | @cosmjs/tendermint-rpc tests    |
 | 11138 | Standalone CometBFT 0.38 RPC   | @cosmjs/tendermint-rpc tests    |
 | 26658 | simapp Tendermint RPC          | Stargate client tests           |

packages/cosmwasm-stargate/src/cosmwasmclient.ts

@@ -92,7 +92,7 @@ export class CosmWasmClient {
   /**
    * Creates an instance by connecting to the given CometBFT RPC endpoint.
    *
-   * This uses auto-detection to decide between a CometBFT 0.38, Tendermint 0.37 and 0.34 client.
+   * This uses auto-detection to decide between a CometBFT 1.x, CometBFT 0.38 and Tendermint 0.37 client.
    * To set the Comet client explicitly, use `create`.
    */
   public static async connect(endpoint: string | HttpEndpoint): Promise<CosmWasmClient> {
@@ -102,7 +102,8 @@ export class CosmWasmClient {
 
   /**
    * Creates an instance from a manually created Comet client.
-   * Use this to use `Comet38Client` or `Tendermint37Client` instead of `Tendermint34Client`.
+   * Use this to use `Comet38Client` or `Tendermint37Client` instead of
+   * auto-detection.
    */
   public static create(cometClient: CometClient): CosmWasmClient {
     return new CosmWasmClient(cometClient);

packages/cosmwasm-stargate/src/signingcosmwasmclient.ts

@@ -208,7 +208,7 @@ export class SigningCosmWasmClient extends CosmWasmClient {
   /**
    * Creates an instance by connecting to the given CometBFT RPC endpoint.
    *
-   * This uses auto-detection to decide between a CometBFT 0.38, Tendermint 0.37 and 0.34 client.
+   * This uses auto-detection to decide between a CometBFT 1.x, CometBFT 0.38 and Tendermint 0.37 client.
    * To set the Comet client explicitly, use `createWithSigner`.
    */
   public static async connectWithSigner(
@@ -222,7 +222,8 @@ export class SigningCosmWasmClient extends CosmWasmClient {
 
   /**
    * Creates an instance from a manually created Comet client.
-   * Use this to use `Comet38Client` or `Tendermint37Client` instead of `Tendermint34Client`.
+   * Use this to use `Comet38Client` or `Tendermint37Client` instead of
+   * auto-detection.
    */
   public static createWithSigner(
     cometClient: CometClient,

packages/stargate/src/events.ts

@@ -1,46 +1,26 @@
-import { fromUtf8 } from "@cosmjs/encoding";
-import { tendermint34, tendermint37 } from "@cosmjs/tendermint-rpc";
+import { comet1, comet38, tendermint37 } from "@cosmjs/tendermint-rpc";
 
-/**
- * An event attribute.
- *
- * This is the same attribute type as tendermint34.Attribute and tendermint35.EventAttribute
- * but `key` and `value` are unified to strings. The conversion
- * from bytes to string in the Tendermint 0.34 case should be done by performing
- * [lossy] UTF-8 decoding.
- *
- * [lossy]: https://doc.rust-lang.org/stable/std/string/struct.String.html#method.from_utf8_lossy
- */
+/** An event attribute */
 export interface Attribute {
   readonly key: string;
   readonly value: string;
 }
 
-/**
- * The same event type as tendermint34.Event and tendermint35.Event
- * but attribute keys and values are unified to strings. The conversion
- * from bytes to string in the Tendermint 0.34 case should be done by performing
- * [lossy] UTF-8 decoding.
- *
- * [lossy]: https://doc.rust-lang.org/stable/std/string/struct.String.html#method.from_utf8_lossy
- */
+/** An event */
 export interface Event {
   readonly type: string;
   readonly attributes: readonly Attribute[];
 }
 
 /**
- * Takes a Tendermint 0.34 or 0.37 event with binary encoded key and value
- * and converts it into an `Event` with string attributes.
+ * Takes a CometBFT event and converts it into an `Event` with string attributes.
+ *
+ * This is not doing much anymore because we always get string events
+ * since CometBFT 0.37+. So maybe this can be refactored away at some point.
  */
-export function fromTendermintEvent(event: tendermint34.Event | tendermint37.Event): Event {
+export function fromTendermintEvent(event: tendermint37.Event | comet38.Event | comet1.Event): Event {
   return {
     type: event.type,
-    attributes: event.attributes.map(
-      (attr): Attribute => ({
-        key: typeof attr.key == "string" ? attr.key : fromUtf8(attr.key, true),
-        value: typeof attr.value == "string" ? attr.value : fromUtf8(attr.value, true),
-      }),
-    ),
+    attributes: event.attributes.map((attr): Attribute => ({ key: attr.key, value: attr.value })),
   };
 }

packages/stargate/src/signingstargateclient.ts

@@ -115,7 +115,7 @@ export class SigningStargateClient extends StargateClient {
   /**
    * Creates an instance by connecting to the given CometBFT RPC endpoint.
    *
-   * This uses auto-detection to decide between a CometBFT 0.38, Tendermint 0.37 and 0.34 client.
+   * This uses auto-detection to decide between a CometBFT 1.x, CometBFT 0.38 and Tendermint 0.37 client.
    * To set the Comet client explicitly, use `createWithSigner`.
    */
   public static async connectWithSigner(
@@ -129,7 +129,8 @@ export class SigningStargateClient extends StargateClient {
 
   /**
    * Creates an instance from a manually created Comet client.
-   * Use this to use `Comet38Client` or `Tendermint37Client` instead of `Tendermint34Client`.
+   * Use this to use `Comet38Client` or `Tendermint37Client` instead of
+   * auto-detection.
    */
   public static createWithSigner(
     cometClient: CometClient,

packages/stargate/src/stargateclient.ts

@@ -213,7 +213,7 @@ export class StargateClient {
   /**
    * Creates an instance by connecting to the given CometBFT RPC endpoint.
    *
-   * This uses auto-detection to decide between a CometBFT 0.38, Tendermint 0.37 and 0.34 client.
+   * This uses auto-detection to decide between a CometBFT 1.x, CometBFT 0.38 and Tendermint 0.37 client.
    * To set the Comet client explicitly, use `create`.
    */
   public static async connect(
@@ -226,7 +226,8 @@ export class StargateClient {
 
   /**
    * Creates an instance from a manually created Comet client.
-   * Use this to use `Comet38Client` or `Tendermint37Client` instead of `Tendermint34Client`.
+   * Use this to use `Comet38Client` or `Tendermint37Client` instead of
+   * auto-detection.
    */
   public static create(cometClient: CometClient, options: StargateClientOptions = {}): StargateClient {
     return new StargateClient(cometClient, options);

packages/tendermint-rpc/src/comet1/comet1client.ts

@@ -99,9 +99,6 @@ export class Comet1Client {
 
   // this should paginate through all blockSearch options to ensure it returns all results.
   // starts with page 1 or whatever was provided (eg. to start on page 7)
-  //
-  // NOTE
-  // This method will error on any node that is running a Tendermint version lower than 0.34.9.
   public async blockSearchAll(params: requests.BlockSearchParams): Promise<responses.BlockSearchResponse> {
     let page = params.page || 1;
     const blocks: responses.BlockResponse[] = [];

packages/tendermint-rpc/src/comet38/comet38client.ts

@@ -85,9 +85,6 @@ export class Comet38Client {
   /**
    * Search for events that are in a block.
    *
-   * NOTE
-   * This method will error on any node that is running a Tendermint version lower than 0.34.9.
-   *
    * @see https://docs.tendermint.com/master/rpc/#/Info/block_search
    */
   public async blockSearch(params: requests.BlockSearchParams): Promise<responses.BlockSearchResponse> {
@@ -102,9 +99,6 @@ export class Comet38Client {
 
   // this should paginate through all blockSearch options to ensure it returns all results.
   // starts with page 1 or whatever was provided (eg. to start on page 7)
-  //
-  // NOTE
-  // This method will error on any node that is running a Tendermint version lower than 0.34.9.
   public async blockSearchAll(params: requests.BlockSearchParams): Promise<responses.BlockSearchResponse> {
     let page = params.page || 1;
     const blocks: responses.BlockResponse[] = [];

packages/tendermint-rpc/src/index.ts

@@ -4,6 +4,10 @@ export {
   rawEd25519PubkeyToRawAddress,
   rawSecp256k1PubkeyToRawAddress,
 } from "./addresses";
+export * as comet1 from "./comet1";
+export { Comet1Client } from "./comet1";
+export * as comet38 from "./comet38";
+export { Comet38Client } from "./comet38";
 export {
   type ReadonlyDateWithNanoseconds,
   DateTime,
@@ -12,99 +16,15 @@ export {
   toRfc3339WithNanoseconds,
   toSeconds,
 } from "./dates";
-// The public Tendermint34Client.create constructor allows manually choosing an RpcClient.
+// The public Comet37Client/Comet38Client/Comet1Client.create constructor allows manually choosing an RpcClient.
 // This is currently the only way to switch to the HttpBatchClient (which may become default at some point).
 // Due to this API, we make RPC client implementations public.
-export * as comet1 from "./comet1";
-export { Comet1Client } from "./comet1";
-export * as comet38 from "./comet38";
-export { Comet38Client } from "./comet38";
 export type { HttpBatchClientOptions, HttpEndpoint, RpcClient } from "./rpcclients";
 export { HttpBatchClient, HttpClient, WebsocketClient } from "./rpcclients";
-export type {
-  AbciInfoRequest,
-  AbciInfoResponse,
-  AbciQueryParams,
-  AbciQueryRequest,
-  AbciQueryResponse,
-  Attribute,
-  Block,
-  BlockchainRequest,
-  BlockchainResponse,
-  BlockGossipParams,
-  BlockId,
-  BlockMeta,
-  BlockParams,
-  BlockRequest,
-  BlockResponse,
-  BlockResultsRequest,
-  BlockResultsResponse,
-  BroadcastTxAsyncResponse,
-  BroadcastTxCommitResponse,
-  BroadcastTxParams,
-  BroadcastTxRequest,
-  BroadcastTxSyncResponse,
-  Commit,
-  CommitRequest,
-  CommitResponse,
-  ConsensusParams,
-  Event,
-  Evidence,
-  EvidenceParams,
-  GenesisRequest,
-  GenesisResponse,
-  Header,
-  HealthRequest,
-  HealthResponse,
-  NewBlockEvent,
-  NewBlockHeaderEvent,
-  NodeInfo,
-  NumUnconfirmedTxsRequest,
-  NumUnconfirmedTxsResponse,
-  ProofOp,
-  QueryProof,
-  QueryTag,
-  Request,
-  Response,
-  StatusRequest,
-  StatusResponse,
-  SyncInfo,
-  TxData,
-  TxEvent,
-  TxParams,
-  TxProof,
-  TxRequest,
-  TxResponse,
-  TxSearchParams,
-  TxSearchRequest,
-  TxSearchResponse,
-  TxSizeParams,
-  Validator,
-  ValidatorsParams,
-  ValidatorsRequest,
-  ValidatorsResponse,
-  Version,
-  Vote,
-} from "./tendermint34";
-export {
-  broadcastTxCommitSuccess,
-  broadcastTxSyncSuccess,
-  Method,
-  SubscriptionEventType,
-  VoteType,
-} from "./tendermint34";
-export * as tendermint34 from "./tendermint34";
-export { Tendermint34Client } from "./tendermint34";
 export * as tendermint37 from "./tendermint37";
 export { Tendermint37Client } from "./tendermint37";
-export type { CometClient, TendermintClient } from "./tendermintclient";
-export {
-  connectComet,
-  isComet1Client,
-  isComet38Client,
-  isTendermint34Client,
-  isTendermint37Client,
-} from "./tendermintclient";
+export type { CometClient } from "./tendermintclient";
+export { connectComet, isComet1Client, isComet38Client, isTendermint37Client } from "./tendermintclient";
 export type {
   CommitSignature,
   ValidatorEd25519Pubkey,