Merge pull request #1679 from cosmos/run-Comet38Client-against-cometbft1

Test Comet38Client against 0.38 and 1.x backends

Author: webmaster128

CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to
 
 ## [Unreleased]
 
+### Added
+
+- @cosmjs/tendermint-rpc: `Comet38Client` is now used to connect to CometBFT
+  0.38 and 1.x backends ([#1679])
+
+[#1679]: https://github.com/cosmos/cosmjs/pull/1679
+
 ### Changed
 
 - Replaxe axios with cross-fetch ([#1645])

HACKING.md

@@ -114,9 +114,11 @@ order to avoid conflicts. Here is an overview of the ports used:
 | 4445  | socketserver slow              | @cosmjs/sockets tests           |
 | 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           |
 | 26659 | wasmd Tendermint RPC           | @cosmjs/cosmwasm-stargate tests |
 | 26660 | simapp slow Tendermint RPC     | Stargate client tests           |

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

@@ -493,7 +493,7 @@ function defaultTestSuite(rpcFactory: () => RpcClient, expected: ExpectedValues)
       const client = await Comet38Client.create(rpcFactory());
 
       const result = await client.txSearch({ query: `tx.hash='${toHex(broadcast1.hash)}'` });
-      expect(result.totalCount).toEqual(1);
+      expect(result.txs.length).toEqual(1);
       expect(result.txs[0]).toEqual({
         hash: broadcast1.hash,
         height: broadcast1.height,
@@ -502,6 +502,10 @@ function defaultTestSuite(rpcFactory: () => RpcClient, expected: ExpectedValues)
         result: broadcast1.deliverTx!,
         proof: undefined,
       });
+      if (!expected.bug5219) {
+        // This is broken in CometBFT 1.x (see https://github.com/cometbft/cometbft/issues/5219)
+        expect(result.totalCount).toEqual(1);
+      }
 
       client.disconnect();
     });
@@ -878,7 +882,7 @@ function websocketTestSuite(rpcFactory: () => RpcClient, expected: ExpectedValue
   });
 }
 
-describe("Comet38Client", () => {
+describe("Comet38Client with CometBFT 0.38 backend", () => {
   const { url, expected } = tendermintInstances[38];
 
   it("can connect to a given url", async () => {
@@ -913,3 +917,39 @@ describe("Comet38Client", () => {
     websocketTestSuite(factory, expected);
   });
 });
+
+describe("Comet38Client with CometBFT 1 backend", () => {
+  const { url, expected } = tendermintInstances[1];
+
+  it("can connect to a given url", async () => {
+    pendingWithoutTendermint();
+
+    // http connection
+    {
+      const client = await Comet38Client.connect("http://" + url);
+      const info = await client.abciInfo();
+      expect(info).toBeTruthy();
+      client.disconnect();
+    }
+
+    // ws connection
+    {
+      const client = await Comet38Client.connect("ws://" + url);
+      const info = await client.abciInfo();
+      expect(info).toBeTruthy();
+      client.disconnect();
+    }
+  });
+
+  describe("With HttpClient", () => {
+    defaultTestSuite(() => new HttpClient("http://" + url), expected);
+  });
+
+  describe("With WebsocketClient", () => {
+    // don't print out WebSocket errors if marked pending
+    const onError = process.env.TENDERMINT_ENABLED ? console.error : () => 0;
+    const factory = (): WebsocketClient => new WebsocketClient("ws://" + url, onError);
+    defaultTestSuite(factory, expected);
+    websocketTestSuite(factory, expected);
+  });
+});

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

@@ -20,6 +20,9 @@ type Encoder<T extends requests.Request> = (req: T) => JsonRpcRequest;
 // Decoder is a generic that matches all methods of Responses
 type Decoder<T extends responses.Response> = (res: JsonRpcSuccessResponse) => T;
 
+/**
+ * A client for the CometBFT 0.38 and 1.x RPC API
+ */
 export class Comet38Client {
   /**
    * Creates a new Tendermint client for the given endpoint.

packages/tendermint-rpc/src/tendermintclient.ts

@@ -36,7 +36,7 @@ export async function connectComet(endpoint: string | HttpEndpoint): Promise<Com
   const version = (await tm37Client.status()).nodeInfo.version;
   if (version.startsWith("0.37.")) {
     out = tm37Client;
-  } else if (version.startsWith("0.38.")) {
+  } else if (version.startsWith("0.38.") || version.startsWith("1.0.")) {
     tm37Client.disconnect();
     out = await Comet38Client.connect(endpoint);
   } else {

packages/tendermint-rpc/src/testutil.spec.ts

@@ -12,6 +12,8 @@ export interface ExpectedValues {
   readonly p2pVersion: number;
   readonly blockVersion: number;
   readonly appVersion: number;
+  /** Affected by https://github.com/cometbft/cometbft/issues/5219 */
+  readonly bug5219: boolean;
 }
 
 export interface TendermintInstance {
@@ -36,7 +38,7 @@ export interface TendermintInstance {
  *   docker container ls | grep tendermint/tendermint
  *   docker container kill <container id from 1st column>
  */
-export const tendermintInstances = {
+export const tendermintInstances: Record<number, TendermintInstance> = {
   34: {
     url: "localhost:11134",
     version: "0.34.x",
@@ -48,6 +50,7 @@ export const tendermintInstances = {
       p2pVersion: 8,
       blockVersion: 11,
       appVersion: 1,
+      bug5219: false,
     },
   },
   37: {
@@ -61,6 +64,7 @@ export const tendermintInstances = {
       p2pVersion: 8,
       blockVersion: 11,
       appVersion: 1,
+      bug5219: false,
     },
   },
   38: {
@@ -74,6 +78,21 @@ export const tendermintInstances = {
       p2pVersion: 8,
       blockVersion: 11,
       appVersion: 1,
+      bug5219: false,
+    },
+  },
+  1: {
+    url: "localhost:11101",
+    version: "1.x.y",
+    blockTime: 500,
+    expected: {
+      chainId: /^dockerchain$/,
+      version: /^1\.\d+\.\d+$/,
+      appCreator: "Cosmoshi Netowoko",
+      p2pVersion: 9,
+      blockVersion: 11,
+      appVersion: 1,
+      bug5219: true,
     },
   },
 };

scripts/tendermint/all_start.sh

@@ -9,18 +9,21 @@ declare -a TM_IMAGES
 TM_IMAGES[34]="tendermint/tendermint:v0.34.19"
 TM_IMAGES[37]="cometbft/cometbft:v0.37.0-rc3"
 TM_IMAGES[38]="cometbft/cometbft:v0.38.0"
+TM_IMAGES[1]="cometbft/cometbft:v1.x"
 
 declare -a TM_ROOTS
 TM_ROOTS[34]="/tendermint"
 TM_ROOTS[37]="/cometbft"
 TM_ROOTS[38]="/cometbft"
+TM_ROOTS[1]="/cometbft"
 
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
 for KEY in "${!TM_IMAGES[@]}"; do
+  PORT=$(printf "111%02g" "$KEY") # e.g. 11101 or 11138
   export TENDERMINT_IMAGE="${TM_IMAGES[$KEY]}"
   export TENDERMINT_ROOT="${TM_ROOTS[$KEY]}"
-  export TENDERMINT_PORT="111$KEY"
+  export TENDERMINT_PORT="$PORT"
   export TENDERMINT_NAME="tendermint-$KEY"
 
   echo "Starting $TENDERMINT_NAME ($TENDERMINT_IMAGE) on port $TENDERMINT_PORT ..."

scripts/tendermint/all_stop.sh

@@ -4,7 +4,7 @@ command -v shellcheck >/dev/null && shellcheck "$0"
 
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
-for KEY in 34 37 38; do
+for KEY in 34 37 38 1; do
   export TENDERMINT_NAME="tendermint-$KEY"
 
   echo "Stopping $TENDERMINT_NAME ..."