@validators-dao/solana-stream-sdk 0.1.0 → 0.2.0

package/README.md

@@ -16,18 +16,188 @@ pnpm add @validators-dao/solana-stream-sdk
 
 ## Usage
 
-```typescript
-import { gRPC, bs58 } from '@validators-dao/solana-stream-sdk'
+Example of using the GeyserClient to subscribe to Solana Pump Fun transactions and accounts:
 
-// Use the gRPC client for Yellowstone streams
-// Use bs58 for base58 encoding/decoding
+```typescript
+import {
+  GeyserClient,
+  bs58,
+  CommitmentLevel,
+  SubscribeRequestAccountsDataSlice,
+  SubscribeRequestFilterAccounts,
+  SubscribeRequestFilterBlocks,
+  SubscribeRequestFilterBlocksMeta,
+  SubscribeRequestFilterEntry,
+  SubscribeRequestFilterSlots,
+  SubscribeRequestFilterTransactions,
+} from '@validators-dao/solana-stream-sdk'
+import 'dotenv/config'
+
+interface SubscribeRequest {
+  accounts: {
+    [key: string]: SubscribeRequestFilterAccounts
+  }
+  slots: {
+    [key: string]: SubscribeRequestFilterSlots
+  }
+  transactions: {
+    [key: string]: SubscribeRequestFilterTransactions
+  }
+  transactionsStatus: {
+    [key: string]: SubscribeRequestFilterTransactions
+  }
+  blocks: {
+    [key: string]: SubscribeRequestFilterBlocks
+  }
+  blocksMeta: {
+    [key: string]: SubscribeRequestFilterBlocksMeta
+  }
+  entry: {
+    [key: string]: SubscribeRequestFilterEntry
+  }
+  commitment?: CommitmentLevel | undefined
+  accountsDataSlice: SubscribeRequestAccountsDataSlice[]
+  ping?: any
+}
+
+// const PUMP_FUN_MINT_AUTHORITY = 'TSLvdd1pWpHVjahSpsvCXUbgwsL3JAcvokwaKt1eokM'
+const PUMP_FUN_PROGRAM_ID = '6EF8rrecthR5Dkzon8Nwu78hRvfCKubJ14M5uBEwF6P'
+
+const tran: SubscribeRequestFilterTransactions = {
+  accountInclude: [PUMP_FUN_PROGRAM_ID],
+  accountExclude: [],
+  accountRequired: [],
+}
+
+const request: SubscribeRequest = {
+  accounts: {
+    pumpfun: {
+      account: [],
+      owner: [],
+      filters: [],
+    },
+  },
+  slots: {},
+  transactions: { elsol: tran },
+  transactionsStatus: {},
+  blocks: {},
+  blocksMeta: {},
+  entry: {},
+  accountsDataSlice: [],
+  commitment: CommitmentLevel.PROCESSED,
+}
+
+const geyser = async () => {
+  console.log('Starting geyser client...')
+  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 endpoint = `https://grpc-ams-3.erpc.global`
+    console.log('Connecting to', endpoint)
+
+    // @ts-ignore ignore
+    return new GeyserClient(endpoint, token, undefined)
+  }
+
+  const connect = async (retries: number = 0): Promise<void> => {
+    if (retries > maxRetries) {
+      throw new Error('Max retries reached')
+    }
+
+    try {
+      const client = createClient()
+      const version = await client.getVersion()
+      console.log('version: ', version)
+      const stream = await client.subscribe()
+      stream.on('data', async (data: any) => {
+        if (data.transaction !== undefined) {
+          const transaction = data.transaction
+          const txnSignature = transaction.transaction.signature
+          const tx = bs58.encode(new Uint8Array(txnSignature))
+          console.log('tx:', tx)
+          return
+        }
+        if (data.account === undefined) {
+          return
+        }
+        // console.log('data:', JSON.stringify(data, null, 2))
+
+        const accounts = data.account
+        const rawPubkey = accounts.account.pubkey
+        const rawTxnSignature = accounts.account.txnSignature
+        const pubkey = bs58.encode(new Uint8Array(rawPubkey))
+        const txnSignature = bs58.encode(new Uint8Array(rawTxnSignature))
+        console.log('pubkey:', pubkey)
+        console.log('txnSignature:', txnSignature)
+      })
+
+      stream.on('error', async (e: any) => {
+        console.error('Stream error:', e)
+        console.log(`Reconnecting ...`)
+        await connect(retries + 1)
+      })
+
+      await new Promise<void>((resolve, reject) => {
+        stream.write(request, (err: any) => {
+          if (!err) {
+            resolve()
+          } else {
+            console.error('Request error:', err)
+            reject(err)
+          }
+        })
+      }).catch((reason) => {
+        console.error(reason)
+        throw reason
+      })
+    } catch (error) {
+      console.error(`Connection failed. Retrying ...`, error)
+      await connect(retries + 1)
+    }
+  }
+
+  await connect()
+}
+
+const main = async () => {
+  try {
+    await geyser()
+  } catch (error) {
+    console.log(error)
+  }
+}
+
+main()
 ```
 
+Please ensure you have the `X_TOKEN` environment variable set with your gRPC token for authentication.
+
+Please note that the url endpoint in the example is for demonstration purposes. You should replace it with the actual endpoint you are using.
+
 ## Features
 
-- **gRPC Streaming**: Built on Triton's Yellowstone gRPC for real-time Solana data streaming
+- **Geyser Client**: Direct access to Triton's Yellowstone gRPC client for real-time Solana data streaming
+- **TypeScript Types**: Comprehensive TypeScript types for all filter and subscription interfaces
 - **Base58 Utilities**: Includes bs58 for Solana address and data encoding/decoding
-- **TypeScript Support**: Full TypeScript support with type definitions
+- **Full Type Safety**: Complete TypeScript support with detailed type definitions
+
+## Exported Types
+
+- `GeyserClient`: Main client for connecting to Yellowstone gRPC streams
+- `CommitmentLevel`: Solana commitment level types
+- `SubscribeRequestFilterAccounts`: Account filter types
+- `SubscribeRequestFilterTransactions`: Transaction filter types
+- `SubscribeRequestFilterBlocks`: Block filter types
+- `SubscribeRequestFilterBlocksMeta`: Block metadata filter types
+- `SubscribeRequestFilterSlots`: Slot filter types
+- `SubscribeRequestFilterEntry`: Entry filter types
+- `SubscribeRequestAccountsDataSlice`: Account data slice types
+- `bs58`: Base58 encoding/decoding utilities
 
 ## Dependencies
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as gRPC from '@triton-one/yellowstone-grpc';
+import Client, { CommitmentLevel, SubscribeRequestAccountsDataSlice, SubscribeRequestFilterAccounts, SubscribeRequestFilterBlocks, SubscribeRequestFilterBlocksMeta, SubscribeRequestFilterEntry, SubscribeRequestFilterSlots, SubscribeRequestFilterTransactions } from '@triton-one/yellowstone-grpc';
 import bs58 from 'bs58';
-export { gRPC, bs58 };
+export { bs58, Client as GeyserClient, CommitmentLevel, SubscribeRequestAccountsDataSlice, SubscribeRequestFilterAccounts, SubscribeRequestFilterBlocks, SubscribeRequestFilterBlocksMeta, SubscribeRequestFilterEntry, SubscribeRequestFilterSlots, SubscribeRequestFilterTransactions, };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,8BAA8B,CAAA;AACpD,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,EAAE,EACb,eAAe,EACf,iCAAiC,EACjC,8BAA8B,EAC9B,4BAA4B,EAC5B,gCAAgC,EAChC,2BAA2B,EAC3B,2BAA2B,EAC3B,kCAAkC,EACnC,MAAM,8BAA8B,CAAA;AACrC,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EACL,IAAI,EACJ,MAAM,IAAI,YAAY,EACtB,eAAe,EACf,iCAAiC,EACjC,8BAA8B,EAC9B,4BAA4B,EAC5B,gCAAgC,EAChC,2BAA2B,EAC3B,2BAA2B,EAC3B,kCAAkC,GACnC,CAAA"}

package/dist/index.js

@@ -1,4 +1,4 @@
-import * as gRPC from '@triton-one/yellowstone-grpc';
+import Client, { CommitmentLevel, SubscribeRequestAccountsDataSlice, SubscribeRequestFilterAccounts, SubscribeRequestFilterBlocks, SubscribeRequestFilterBlocksMeta, SubscribeRequestFilterEntry, SubscribeRequestFilterSlots, SubscribeRequestFilterTransactions, } from '@triton-one/yellowstone-grpc';
 import bs58 from 'bs58';
-export { gRPC, bs58 };
+export { bs58, Client as GeyserClient, CommitmentLevel, SubscribeRequestAccountsDataSlice, SubscribeRequestFilterAccounts, SubscribeRequestFilterBlocks, SubscribeRequestFilterBlocksMeta, SubscribeRequestFilterEntry, SubscribeRequestFilterSlots, SubscribeRequestFilterTransactions, };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,8BAA8B,CAAA;AACpD,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,EAAE,EACb,eAAe,EACf,iCAAiC,EACjC,8BAA8B,EAC9B,4BAA4B,EAC5B,gCAAgC,EAChC,2BAA2B,EAC3B,2BAA2B,EAC3B,kCAAkC,GACnC,MAAM,8BAA8B,CAAA;AACrC,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EACL,IAAI,EACJ,MAAM,IAAI,YAAY,EACtB,eAAe,EACf,iCAAiC,EACjC,8BAA8B,EAC9B,4BAA4B,EAC5B,gCAAgC,EAChC,2BAA2B,EAC3B,2BAA2B,EAC3B,kCAAkC,GACnC,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@validators-dao/solana-stream-sdk",
   "description": "Solana Stream SDK by Validators DAO",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,8 +9,7 @@
   "engines": {
     "pnpm": ">=10",
     "npm": "please_use_pnpm_instead",
-    "node": "22",
-    "version": "0.0.1"
+    "node": "22"
   },
   "repository": {
     "type": "git",
@@ -32,8 +31,8 @@
     "format": "prettier --write ."
   },
   "dependencies": {
-    "@triton-one/yellowstone-grpc": "^4.0.2",
-    "bs58": "^6.0.0"
+    "@triton-one/yellowstone-grpc": "4.0.2",
+    "bs58": "6.0.0"
   },
   "devDependencies": {
     "prettier": "3.5.3",