v1.16: kafka: rename to tools (backport of #203) (#209)

(cherry picked from commit f5f0c3c)

Co-authored-by: Kirill Fomichev <[email protected]>

.github/workflows/release.yml

@@ -10,7 +10,7 @@ on:
       - 'v1.16'
     tags:
       - 'v*'
-      - 'kafka-v*'
+      - 'tools-v*'
   workflow_dispatch:
 
 env:

.github/workflows/test.yml

@@ -74,10 +74,10 @@ jobs:
         run: cargo check -p yellowstone-grpc-client-simple --all-targets --tests
       - name: check features in `geyser`
         run: cargo check -p yellowstone-grpc-geyser --all-targets --tests
-      - name: check features in `kafka`
-        run: cargo check -p yellowstone-grpc-kafka --all-targets --tests
       - name: check features in `proto`
         run: cargo check -p yellowstone-grpc-proto --all-targets --tests
+      - name: check features in `tools`
+        run: cargo check -p yellowstone-grpc-tools --all-targets --tests
 
       - name: Build
         run: ./ci/cargo-build-test.sh

CHANGELOG.md

@@ -16,6 +16,8 @@ The minor version will be incremented upon a breaking change and the patch versi
 
 ### Breaking
 
+- kafka: rename to tools ([#209](https://github.com/rpcpool/yellowstone-grpc/pull/209)).
+
 ## 2023-10-14
 
 - yellowstone-grpc-client-1.11.1+solana.1.16.17

Cargo.toml

@@ -1,10 +1,10 @@
 [workspace]
 members = [
     "examples/rust", # 1.10.0+solana.1.16.17
-    "yellowstone-grpc-client", # 1.11.1+solana.1.16.17
-    "yellowstone-grpc-geyser", # 1.10.0+solana.1.16.17
-    "yellowstone-grpc-kafka", # 1.0.0-rc.3+solana.1.16.17
+    "yellowstone-grpc-client", # 1.11.1+solana.1.6.17
+    "yellowstone-grpc-geyser", # 1.10.0+solana.1.6.17
     "yellowstone-grpc-proto", # 1.10.0+solana.1.16.17
+    "yellowstone-grpc-tools", # 1.0.0-rc.4+solana.1.16.17
 ]
 
 [profile.release]

README.md

@@ -104,7 +104,9 @@ It's possible to add limits for filters in config. If `filters` field is omitted
    - [Rust](examples/rust)
    - [TypeScript](examples/typescript)
 
-### Kafka producer / consumer
+### gRPC Tools
+
+#### Kafka
 
 In addition to gRPC Geyser Plugin we provide Kafka tool. This tool can works in 3 modes:
 
@@ -114,7 +116,7 @@ In addition to gRPC Geyser Plugin we provide Kafka tool. This tool can works in
 
 ```bash
 $ cargo run --bin grpc-kafka -- --help
-Yellowstone gRPC Kafka Producer/Dedup/Consumer
+Yellowstone gRPC Kafka Tool
 
 Usage: grpc-kafka [OPTIONS] --config <CONFIG> <COMMAND>
 
@@ -126,7 +128,6 @@ Commands:
 
 Options:
   -c, --config <CONFIG>          Path to config file
-      --prometheus <PROMETHEUS>  Prometheus listen address
   -h, --help                     Print help
   -V, --version                  Print version
 ```
@@ -135,11 +136,11 @@ Options:
 
 ```bash
 # run kafka locally
-docker-compose -f ./yellowstone-grpc-kafka/docker-kafka.yml up
+docker-compose -f ./yellowstone-grpc-tools/docker-kafka.yml up
 # create topic
 kafka_2.13-3.5.0/bin/kafka-topics.sh --bootstrap-server localhost:29092 --create --topic grpc1
 # send messages from gRPC to Kafka
-cargo run --bin grpc-kafka -- --config yellowstone-grpc-kafka/config.json --prometheus 127.0.0.1:8873 grpc2kafka
+cargo run --bin grpc-kafka -- --config yellowstone-grpc-tools/config-kafka.json grpc2kafka
 # read messages from Kafka
 kafka_2.13-3.5.0/bin/kafka-console-consumer.sh --bootstrap-server localhost:29092 --topic grpc1
 ```

yellowstone-grpc-kafka/Cargo.toml → yellowstone-grpc-tools/Cargo.toml

@@ -1,9 +1,9 @@
 [package]
-name = "yellowstone-grpc-kafka"
-version = "1.0.0-rc.3+solana.1.16.17"
+name = "yellowstone-grpc-tools"
+version = "1.0.0-rc.4+solana.1.16.17"
 authors = ["Triton One"]
 edition = "2021"
-description = "Yellowstone gRPC Kafka Producer/Dedup/Consumer"
+description = "Yellowstone gRPC Tools"
 publish = false
 
 [dependencies]