@validators-dao/solana-stream-sdk 0.12.0 → 1.0.1

package/README.md

@@ -27,6 +27,32 @@ Solana Stream SDK by Validators DAO - A TypeScript SDK for streaming Solana bloc
   <img src="https://storage.slv.dev/PoweredBySolana.svg" alt="Powered By Solana" width="200px" height="95px">
 </a>
 
+## What's New in v1.0.1
+
+- Yellowstone Geyser gRPC connection upgraded to an NAPI-RS-powered client for better backpressure
+- NAPI-powered Shreds client/decoder so TypeScript can tap Rust-grade throughput
+- Improved backpressure handling and up to 4x streaming efficiency (400% improvement)
+- Faster real-time Geyser streams for TypeScript clients with lower overhead
+
+## Production-Ready Geyser Client (TypeScript Best Practices)
+
+- Ping/Pong handling to keep Yellowstone gRPC streams alive
+- Exponential reconnect backoff plus `fromSlot` gap recovery
+- Bounded in-memory queue with drop logging for backpressure safety
+- Hot-swappable subscriptions via a JSON file (no reconnect)
+- Optional runtime metrics logging (rates, queue size, drops)
+- Default filters drop vote/failed transactions to reduce traffic
+
+Tip: start with slots, then add filters as needed. When resuming from `fromSlot`,
+duplicates are expected.
+
+## Performance Highlights
+
+- NAPI-powered Geyser gRPC and Shreds client/decoder for high-throughput streaming
+- TypeScript ergonomics with Rust-grade performance under the hood
+- For the absolute fastest signal path, see Rust UDP Shreds in the repo:
+  https://github.com/ValidatorsDAO/solana-stream#shreds-udp-pumpfun-watcher-rust
+
 ## Installation
 
 ```bash
@@ -117,16 +143,15 @@ const geyser = async () => {
   const maxRetries = 2000000
 
   const createClient = () => {
-    const token = process.env.X_TOKEN || ''
-    console.log('X_TOKEN:', token)
-    if (token === '') {
-      throw new Error('X_TOKEN environment variable is not set')
+    const token = process.env.X_TOKEN?.trim()
+    if (!token) {
+      console.warn('X_TOKEN not set. Connecting without auth.')
     }
     const endpoint = `https://grpc-ams-3.erpc.global`
     console.log('Connecting to', endpoint)
 
     // @ts-ignore ignore
-    return new GeyserClient(endpoint, token, undefined)
+    return new GeyserClient(endpoint, token || undefined, undefined)
   }
 
   const connect = async (retries: number = 0): Promise<void> => {
@@ -136,6 +161,7 @@ const geyser = async () => {
 
     try {
       const client = createClient()
+      await client.connect()
       const version = await client.getVersion()
       console.log('version: ', version)
       const stream = await client.subscribe()
@@ -200,7 +226,7 @@ const main = async () => {
 main()
 ```
 
-Please ensure you have the `X_TOKEN` environment variable set with your gRPC token for authentication.
+If your endpoint requires authentication, set the `X_TOKEN` environment variable with your gRPC token.
 
 Please note that the url endpoint in the example is for demonstration purposes. You should replace it with the actual endpoint you are using.
 
@@ -266,7 +292,7 @@ Ensure the environment variable `SHREDS_ENDPOINT` is set correctly.
 
 ## Features
 
-- **Geyser Client**: Direct access to Triton's Yellowstone gRPC client for real-time Solana data streaming
+- **Geyser Client**: Direct access to the Yellowstone gRPC client for real-time Solana data streaming
 - **Shredstream Client**: Real-time entry streaming and decoding from Solana Shreds
 - **TypeScript Types**: Comprehensive TypeScript types for all filter and subscription interfaces
 - **Utilities**: Includes bs58 for Solana address and data encoding/decoding, gRPC utilities, and entry decoding functions
@@ -298,7 +324,7 @@ Ensure the environment variable `SHREDS_ENDPOINT` is set correctly.
 
 ## Dependencies
 
-- `@triton-one/yellowstone-grpc`: For gRPC streaming capabilities
+- Yellowstone gRPC client: For gRPC streaming capabilities
 - `bs58`: For base58 encoding/decoding
 - `@validators-dao/solana-entry-decoder`: Utility for decoding Solana shred entries.
 - `@validators-dao/solana-shreds-client`: Solana Shreds Client for Scale. (NAPI-RS)
@@ -316,6 +342,18 @@ Other reports and suggestions are also highly appreciated.
 You can also join discussions or share feedback on Validators DAO's Discord community:
 https://discord.gg/C7ZQSrCkYR
 
+## Shreds UDP configuration (Rust client)
+
+- Load base config via `SHREDS_UDP_CONFIG=/path/to/config.{json,toml}`; env vars then override it.
+- Core envs:  
+  - `SOLANA_RPC_ENDPOINT`  
+  - Logs: `SHREDS_UDP_LOG_RAW`, `SHREDS_UDP_LOG_SHREDS`, `SHREDS_UDP_LOG_ENTRIES`, `SHREDS_UDP_LOG_WATCH_HITS`, `SHREDS_UDP_LOG_DEFER`  
+  - Watch lists: `SHREDS_UDP_WATCH_PROGRAM_IDS`, `SHREDS_UDP_WATCH_AUTHORITIES` (defaults to pump.fun program/authority)  
+  - Hardening: `SHREDS_UDP_REQUIRE_CODE_MATCH`, `SHREDS_UDP_STRICT_FEC`, `SHREDS_UDP_STRICT_NUM_DATA`, `SHREDS_UDP_STRICT_NUM_CODING`  
+  - Slot window: `SHREDS_UDP_ROOT_SLOT`, `SHREDS_UDP_MAX_FUTURE` (default 512)  
+  - TTLs: `SHREDS_UDP_COMPLETED_TTL_MS` (default 30s), `SHREDS_UDP_EVICT_COOLDOWN_MS` (default 300ms), `SHREDS_UDP_WARN_ONCE` (default true)  
+- Pump.fun: program and mint-authority pubkeys are fixed; token mint addresses are discovered per transaction at runtime (not hardcoded).
+
 ## Repository
 
 This package is part of the [Solana Stream](https://github.com/ValidatorsDAO/solana-stream) monorepo.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@validators-dao/solana-stream-sdk",
   "description": "Solana Stream SDK by Validators DAO",
-  "version": "0.12.0",
+  "version": "1.0.1",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,7 +24,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@triton-one/yellowstone-grpc": "4.0.2",
+    "@triton-one/yellowstone-grpc": "5.0.1",
     "bs58": "6.0.0",
     "@validators-dao/solana-entry-decoder": "2.3.0",
     "@validators-dao/solana-shreds-client": "1.2.0"