@validators-dao/solana-stream-sdk 0.8.0 → 0.10.0

package/README.md

@@ -210,94 +210,56 @@ Here's how to use the SDK to subscribe to Solana Shreds and decode entries:
 
 ```typescript
 import {
-  ShredstreamProxyClient,
-  credentials,
-  ShredsCommitmentLevel,
-  ShredsSubscribeEntriesRequestFns,
-  decodeSolanaEntries,
-  bs58,
+  ShredsClient,
+  ShredsClientCommitmentLevel,
+  // decodeSolanaEntries,
 } from '@validators-dao/solana-stream-sdk'
 import 'dotenv/config'
+// import { logDecodedEntries } from '@/utils/logDecodedEntries'
 
-const endpoint = process.env.SHREDS_ENDPOINT!.replace(/^https?:\/\//, '')
+import { receivedSlots, startLatencyCheck } from '@/utils/checkLatency'
 
-const client = new ShredstreamProxyClient(endpoint, credentials.createSsl())
+const endpoint = process.env.SHREDS_ENDPOINT!
 
-const request = ShredsSubscribeEntriesRequestFns.create({
-  accounts: {
-    pumpfun: {
-      account: [],
-      owner: [],
-      filters: [],
-    },
-  },
+const client = new ShredsClient(endpoint)
+
+// The filter is experimental
+const request = {
+  accounts: {},
   transactions: {},
   slots: {},
-  commitment: ShredsCommitmentLevel.PROCESSED,
-})
+  commitment: ShredsClientCommitmentLevel.Processed,
+}
 
-const connect = async () => {
+const connect = () => {
   console.log('Connecting to:', endpoint)
 
-  const stream = client.subscribeEntries(request)
-
-  stream.on('data', (data) => {
-    console.log(`\n🟢 Received slot: ${data.slot}`)
-
-    const decodedEntries = decodeSolanaEntries(data.entries)
-
-    if (!Array.isArray(decodedEntries)) {
-      console.warn('⚠️ decodedEntries is not an array:', decodedEntries)
-      return
-    }
-
-    decodedEntries.forEach((entry, entryIdx) => {
-      console.log(`\n✅ Entry #${entryIdx + 1}`)
-      console.log(
-        `  - Hash: ${entry.hash ? bs58.encode(Buffer.from(entry.hash)) : 'N/A'}`,
-      )
-      console.log(`  - Num Hashes: ${entry.num_hashes ?? 'N/A'}`)
-
-      entry.transactions.forEach((tx, txIdx) => {
-        console.log(`\n📄 Transaction #${txIdx + 1}`)
-        const signaturesBase58 = tx.signatures
-          .slice(1)
-          .map((sig) => bs58.encode(Buffer.from(sig)))
-        console.log(`  - Signatures:`, signaturesBase58)
-
-        const message = tx.message[0]
-        if (message) {
-          message.accountKeys.forEach((key, idx) => {
-            console.log(`    [${idx}] ${bs58.encode(Buffer.from(key))}`)
-          })
-
-          message.instructions.forEach((inst, instIdx) => {
-            console.log(`    [${instIdx}]`)
-            console.log(`      - Program ID Index: ${inst.programIdIndex}`)
-            console.log(`      - Accounts: ${inst.accounts.join(', ')}`)
-            console.log(`      - Data: ${bs58.encode(Buffer.from(inst.data))}`)
-          })
-
-          console.log(
-            `  📌 Recent Blockhash: ${bs58.encode(Buffer.from(message.recentBlockhash))}`,
-          )
+  client.subscribeEntries(
+    JSON.stringify(request),
+    (_error: any, buffer: any) => {
+      const receivedAt = new Date()
+      if (buffer) {
+        const {
+          slot,
+          // entries
+        } = JSON.parse(buffer)
+
+        // You can decode entries as needed
+        // const decodedEntries = decodeSolanaEntries(new Uint8Array(entries))
+        // logDecodedEntries(decodedEntries)
+
+        if (!receivedSlots.has(slot)) {
+          receivedSlots.set(slot, [{ receivedAt }])
+        } else {
+          receivedSlots.get(slot)!.push({ receivedAt })
         }
-      })
-    })
-  })
-
-  stream.on('error', (err) => {
-    console.error('🚨 Stream error:', err)
-    setTimeout(connect, 5000)
-  })
-
-  stream.on('end', () => {
-    console.log('🔚 Stream ended, reconnecting...')
-    setTimeout(connect, 5000)
-  })
+      }
+    },
+  )
 }
 
 connect()
+startLatencyCheck()
 ```
 
 Ensure the environment variable `SHREDS_ENDPOINT` is set correctly.
@@ -325,33 +287,21 @@ Ensure the environment variable `SHREDS_ENDPOINT` is set correctly.
 - `SubscribeRequestAccountsDataSlice`: Data slice configuration for account subscriptions.
 - `bs58`: Base58 encoding/decoding utilities for Solana addresses and data.
 
-### Shredstream Client Types
-
-- `ShredstreamProxyClient`: Client for streaming Solana shreds through proxy endpoints.
-- `ShredstreamClient`: Direct client for streaming Solana shreds.
-- `ShredsCommitmentLevel`: Commitment levels specifically for Shredstream data.
-- `ShredsSubscribeEntriesRequestFns`: Functions to construct entry subscription requests.
-- `ShredsEntryFns`: Utilities and functions for handling shred entries.
-
-### Shredstream Exported Type Definitions
+### Shredstream Client
 
-- `ShredsSubscribeEntriesRequest`: Request type definition for subscribing to entries.
-- `ShredsSubscribeRequestFilterAccounts`: Account filter type for shred subscriptions.
-- `ShredsSubscribeRequestFilterTransactions`: Transaction filter type for shred subscriptions.
-- `ShredsSubscribeRequestFilterSlots`: Slot filter type for shred subscriptions.
-- `ShredsEntry`: Entry type definition representing Solana shred entries.
+- `ShredsClient`: Client for streaming Solana shreds through shreds endpoints.
+- `ShredsClientCommitmentLevel`: Solana commitment levels (e.g., processed, confirmed, finalized).
 
 ### Utility Exports
 
 - `decodeSolanaEntries`: Function to decode raw Solana shred entry data into structured, human-readable formats.
-- `credentials`, `Metadata`: gRPC credentials and metadata utilities.
 
 ## Dependencies
 
 - `@triton-one/yellowstone-grpc`: For gRPC streaming capabilities
 - `bs58`: For base58 encoding/decoding
-- `@grpc/grpc-js`
 - `@validators-dao/solana-entry-decoder`: Utility for decoding Solana shred entries.
+- `@validators-dao/solana-shreds-client`: Solana Shreds Client for Scale. (NAPI-RS)
 
 ## ⚠️ Experimental Filtering Feature Notice
 

package/dist/index.d.ts

@@ -1,179 +1,5 @@
 export { CommitmentLevel, default as GeyserClient, SubscribeRequestAccountsDataSlice, SubscribeRequestFilterAccounts, SubscribeRequestFilterBlocks, SubscribeRequestFilterBlocksMeta, SubscribeRequestFilterEntry, SubscribeRequestFilterSlots, SubscribeRequestFilterTransactions } from '@triton-one/yellowstone-grpc';
 export { default as bs58 } from 'bs58';
-import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
-import { Client, CallOptions, ClientReadableStream, Metadata, ChannelCredentials, ClientOptions, ServiceError, ClientUnaryCall } from '@grpc/grpc-js';
-export { Metadata, credentials } from '@grpc/grpc-js';
-
-interface Socket {
-    ip: string;
-    port: number;
-}
-declare const Socket: MessageFns$1<Socket>;
-type Builtin$1 = Date | Function | Uint8Array | string | number | boolean | undefined;
-type DeepPartial$1<T> = T extends Builtin$1 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$1<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$1<U>> : T extends {} ? {
-    [K in keyof T]?: DeepPartial$1<T[K]>;
-} : Partial<T>;
-type KeysOfUnion$1<T> = T extends T ? keyof T : never;
-type Exact$1<P, I extends P> = P extends Builtin$1 ? P : P & {
-    [K in keyof P]: Exact$1<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion$1<P>>]: never;
-};
-interface MessageFns$1<T> {
-    encode(message: T, writer?: BinaryWriter): BinaryWriter;
-    decode(input: BinaryReader | Uint8Array, length?: number): T;
-    fromJSON(object: any): T;
-    toJSON(message: T): unknown;
-    create<I extends Exact$1<DeepPartial$1<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact$1<DeepPartial$1<T>, I>>(object: I): T;
-}
-
-declare enum CommitmentLevel {
-    PROCESSED = 0,
-    CONFIRMED = 1,
-    FINALIZED = 2,
-    UNRECOGNIZED = -1
-}
-interface Heartbeat {
-    /**
-     * don't trust IP:PORT from tcp header since it can be tampered over the wire
-     * `socket.ip` must match incoming packet's ip. this prevents spamming an unwitting destination
-     */
-    socket: Socket | undefined;
-    /**
-     * regions for shredstream proxy to receive shreds from
-     * list of valid regions: https://docs.jito.wtf/lowlatencytxnsend/#api
-     */
-    regions: string[];
-}
-declare const Heartbeat: MessageFns<Heartbeat>;
-interface HeartbeatResponse {
-    /** client must respond within `ttl_ms` to keep stream alive */
-    ttlMs: number;
-}
-declare const HeartbeatResponse: MessageFns<HeartbeatResponse>;
-interface SubscribeEntriesRequest {
-    accounts: {
-        [key: string]: SubscribeRequestFilterAccounts;
-    };
-    transactions: {
-        [key: string]: SubscribeRequestFilterTransactions;
-    };
-    slots: {
-        [key: string]: SubscribeRequestFilterSlots;
-    };
-    commitment?: CommitmentLevel | undefined;
-}
-declare const SubscribeEntriesRequest: MessageFns<SubscribeEntriesRequest>;
-interface SubscribeRequestFilterAccounts {
-    account: string[];
-    owner: string[];
-    filters: SubscribeRequestFilterAccountsFilter[];
-    nonemptyTxnSignature?: boolean | undefined;
-}
-declare const SubscribeRequestFilterAccounts: MessageFns<SubscribeRequestFilterAccounts>;
-interface SubscribeRequestFilterAccountsFilter {
-    memcmp?: SubscribeRequestFilterAccountsFilterMemcmp | undefined;
-    datasize?: number | undefined;
-    tokenAccountState?: boolean | undefined;
-    lamports?: SubscribeRequestFilterAccountsFilterLamports | undefined;
-}
-declare const SubscribeRequestFilterAccountsFilter: MessageFns<SubscribeRequestFilterAccountsFilter>;
-interface SubscribeRequestFilterAccountsFilterMemcmp {
-    offset: number;
-    bytes?: Uint8Array | undefined;
-    base58?: string | undefined;
-    base64?: string | undefined;
-}
-declare const SubscribeRequestFilterAccountsFilterMemcmp: MessageFns<SubscribeRequestFilterAccountsFilterMemcmp>;
-interface SubscribeRequestFilterAccountsFilterLamports {
-    eq?: number | undefined;
-    ne?: number | undefined;
-    lt?: number | undefined;
-    gt?: number | undefined;
-}
-declare const SubscribeRequestFilterAccountsFilterLamports: MessageFns<SubscribeRequestFilterAccountsFilterLamports>;
-interface SubscribeRequestFilterSlots {
-    filterByCommitment?: boolean | undefined;
-    interslotUpdates?: boolean | undefined;
-}
-declare const SubscribeRequestFilterSlots: MessageFns<SubscribeRequestFilterSlots>;
-interface SubscribeRequestFilterTransactions {
-    accountInclude: string[];
-    accountExclude: string[];
-    accountRequired: string[];
-}
-declare const SubscribeRequestFilterTransactions: MessageFns<SubscribeRequestFilterTransactions>;
-interface Entry {
-    /** the slot that the entry is from */
-    slot: number;
-    /** Serialized bytes of Vec<Entry>: https://docs.rs/solana-entry/latest/solana_entry/entry/struct.Entry.html */
-    entries: Uint8Array;
-}
-declare const Entry: MessageFns<Entry>;
-type ShredstreamService = typeof ShredstreamService;
-declare const ShredstreamService: {
-    /** RPC endpoint to send heartbeats to keep shreds flowing */
-    readonly sendHeartbeat: {
-        readonly path: "/shredstream.Shredstream/SendHeartbeat";
-        readonly requestStream: false;
-        readonly responseStream: false;
-        readonly requestSerialize: (value: Heartbeat) => Buffer<ArrayBuffer>;
-        readonly requestDeserialize: (value: Buffer) => Heartbeat;
-        readonly responseSerialize: (value: HeartbeatResponse) => Buffer<ArrayBuffer>;
-        readonly responseDeserialize: (value: Buffer) => HeartbeatResponse;
-    };
-};
-interface ShredstreamClient extends Client {
-    /** RPC endpoint to send heartbeats to keep shreds flowing */
-    sendHeartbeat(request: Heartbeat, callback: (error: ServiceError | null, response: HeartbeatResponse) => void): ClientUnaryCall;
-    sendHeartbeat(request: Heartbeat, metadata: Metadata, callback: (error: ServiceError | null, response: HeartbeatResponse) => void): ClientUnaryCall;
-    sendHeartbeat(request: Heartbeat, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: HeartbeatResponse) => void): ClientUnaryCall;
-}
-declare const ShredstreamClient: {
-    new (address: string, credentials: ChannelCredentials, options?: Partial<ClientOptions>): ShredstreamClient;
-    service: typeof ShredstreamService;
-    serviceName: string;
-};
-type ShredstreamProxyService = typeof ShredstreamProxyService;
-declare const ShredstreamProxyService: {
-    readonly subscribeEntries: {
-        readonly path: "/shredstream.ShredstreamProxy/SubscribeEntries";
-        readonly requestStream: false;
-        readonly responseStream: true;
-        readonly requestSerialize: (value: SubscribeEntriesRequest) => Buffer<ArrayBuffer>;
-        readonly requestDeserialize: (value: Buffer) => SubscribeEntriesRequest;
-        readonly responseSerialize: (value: Entry) => Buffer<ArrayBuffer>;
-        readonly responseDeserialize: (value: Buffer) => Entry;
-    };
-};
-interface ShredstreamProxyClient extends Client {
-    subscribeEntries(request: SubscribeEntriesRequest, options?: Partial<CallOptions>): ClientReadableStream<Entry>;
-    subscribeEntries(request: SubscribeEntriesRequest, metadata?: Metadata, options?: Partial<CallOptions>): ClientReadableStream<Entry>;
-}
-declare const ShredstreamProxyClient: {
-    new (address: string, credentials: ChannelCredentials, options?: Partial<ClientOptions>): ShredstreamProxyClient;
-    service: typeof ShredstreamProxyService;
-    serviceName: string;
-};
-type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
-    [K in keyof T]?: DeepPartial<T[K]>;
-} : Partial<T>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-type Exact<P, I extends P> = P extends Builtin ? P : P & {
-    [K in keyof P]: Exact<P[K], I[K]>;
-} & {
-    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
-};
-interface MessageFns<T> {
-    encode(message: T, writer?: BinaryWriter): BinaryWriter;
-    decode(input: BinaryReader | Uint8Array, length?: number): T;
-    fromJSON(object: any): T;
-    toJSON(message: T): unknown;
-    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
-    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
-}
 
 declare const decodeSolanaEntries: any;
 declare const ShredsClient: any;
@@ -183,4 +9,4 @@ declare enum ShredsClientCommitmentLevel {
     Confirmed = "Confirmed"
 }
 
-export { ShredsClient, ShredsClientCommitmentLevel, CommitmentLevel as ShredsCommitmentLevel, Entry as ShredsEntry, Entry as ShredsEntryFns, SubscribeEntriesRequest as ShredsSubscribeEntriesRequest, SubscribeEntriesRequest as ShredsSubscribeEntriesRequestFns, SubscribeRequestFilterAccounts as ShredsSubscribeRequestFilterAccounts, SubscribeRequestFilterSlots as ShredsSubscribeRequestFilterSlots, SubscribeRequestFilterTransactions as ShredsSubscribeRequestFilterTransactions, ShredstreamClient, ShredstreamProxyClient, decodeSolanaEntries };
+export { ShredsClient, ShredsClientCommitmentLevel, decodeSolanaEntries };