@covalenthq/client-sdk 2.2.6 → 2.3.0

package/dist/esm/src/GoldRushClient.d.ts

@@ -5,8 +5,10 @@ import { BitcoinService } from "./services/BitcoinService";
 import { NftService } from "./services/NftService";
 import { PricingService } from "./services/PricingService";
 import { SecurityService } from "./services/SecurityService";
+import { StreamingService } from "./services/StreamingService";
 import { TransactionService } from "./services/TransactionService";
 import { type GoldRushClientSettings } from "./utils/types/Generic.types";
+import { type StreamingServiceConfig } from "./utils/types/StreamingService.types";
 /**
  * GoldRushClient Class
  */
@@ -19,6 +21,7 @@ export declare class GoldRushClient {
     NftService: NftService;
     PricingService: PricingService;
     SecurityService: SecurityService;
+    StreamingService: StreamingService;
     TransactionService: TransactionService;
-    constructor(apiKey: string, settings?: GoldRushClientSettings);
+    constructor(apiKey: string, settings?: GoldRushClientSettings, streamingConfig?: StreamingServiceConfig);
 }

package/dist/esm/src/services/StreamingService.d.ts

@@ -0,0 +1,151 @@
+import { type NewPairsStreamParams, type NewPairsStreamResponse, type OHLCVPairsStreamParams, type OHLCVPairsStreamResponse, type OHLCVTokensStreamParams, type OHLCVTokensStreamResponse, type StreamingServiceConfig, type StreamSubscriptionOptions, type TokenBalancesStreamParams, type TokenBalancesStreamResponse, type UnsubscribeFunction, type WalletActivityStreamParams, type WalletActivityStreamResponse } from "../utils/types/StreamingService.types";
+import { type Client } from "graphql-ws";
+/**
+ * Streaming API Service
+ *
+ */
+export declare class StreamingService {
+    private defaultConfig;
+    constructor(apiKey: string, config?: StreamingServiceConfig);
+    /**
+     * Initialize the streaming connection
+     */
+    getClient(): Client;
+    /**
+     * Disconnect from the streaming service
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Check if the client is connected
+     */
+    get isConnected(): boolean;
+    /**
+     * Subscribe to a custom GraphQL subscription
+     * This allows for advanced usage and future extensibility
+     *
+     * @param query - GraphQL subscription query
+     * @param variables - Query variables
+     * @param callbacks - Subscription callbacks
+     * @returns Unsubscribe function
+     */
+    rawQuery<T = Array<object>>(query: string, variables: Record<string, unknown>, callbacks: StreamSubscriptionOptions<T>): UnsubscribeFunction;
+    /**
+     * Subscribe to OHLCV data for specific pairs
+     *
+     * @param params - Parameters for the OHLCV pairs stream
+     * @param callbacks - Subscription callbacks
+     * @returns Unsubscribe function
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = streamingService.subscribeToOHLCVPairs(
+     *   {
+     *     chain_name: StreamingChain.BASE_MAINNET,
+     *     pair_addresses: ["0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"],
+     *     interval: StreamingInterval.ONE_MINUTE,
+     *     timeframe: StreamingTimeframe.ONE_HOUR
+     *   },
+     *   {
+     *     next: (data) => console.log("OHLCV Data:", data),
+     *     error: (err) => console.error("Error:", err),
+     *     complete: () => console.log("Stream completed")
+     *   }
+     * );
+     * ```
+     */
+    subscribeToOHLCVPairs(params: OHLCVPairsStreamParams, callbacks: StreamSubscriptionOptions<OHLCVPairsStreamResponse[]>): UnsubscribeFunction;
+    /**
+     * Subscribe to OHLCV data for specific tokens
+     *
+     * @param params - Parameters for the OHLCV tokens stream
+     * @param callbacks - Subscription callbacks
+     * @returns Unsubscribe function
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = streamingService.subscribeToOHLCVTokens(
+     *   {
+     *     chain_name: StreamingChain.BASE_MAINNET,
+     *     token_addresses: ["0x4B6104755AfB5Da4581B81C552DA3A25608c73B8"],
+     *     interval: StreamingInterval.ONE_MINUTE,
+     *     timeframe: StreamingTimeframe.ONE_HOUR
+     *   },
+     *   {
+     *     next: (data) => console.log("OHLCV Token Data:", data),
+     *     error: (err) => console.error("Error:", err),
+     *     complete: () => console.log("Stream completed")
+     *   }
+     * );
+     * ```
+     */
+    subscribeToOHLCVTokens(params: OHLCVTokensStreamParams, callbacks: StreamSubscriptionOptions<OHLCVTokensStreamResponse[]>): UnsubscribeFunction;
+    /**
+     * Subscribe to new DEX pairs created on supported decentralized exchanges
+     *
+     * @param params - Parameters for the new pairs stream
+     * @param callbacks - Subscription callbacks
+     * @returns Unsubscribe function
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = streamingService.subscribeToNewPairs(
+     *   {
+     *     chain_name: StreamingChain.BASE_MAINNET,
+     *     protocols: [StreamingProtocol.UNISWAP_V2, StreamingProtocol.UNISWAP_V3]
+     *   },
+     *   {
+     *     next: (data) => console.log("New Pairs:", data),
+     *     error: (err) => console.error("Error:", err),
+     *     complete: () => console.log("Stream completed")
+     *   }
+     * );
+     * ```
+     */
+    subscribeToNewPairs(params: NewPairsStreamParams, callbacks: StreamSubscriptionOptions<NewPairsStreamResponse[]>): UnsubscribeFunction;
+    /**
+     * Subscribe to real-time token balance updates for a specific wallet address
+     *
+     * @param params - Parameters for the token balances stream
+     * @param callbacks - Subscription callbacks
+     * @returns Unsubscribe function
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = streamingService.subscribeToTokenBalances(
+     *   {
+     *     chain_name: StreamingChain.BASE_MAINNET,
+     *     wallet_address: "0x198ef79f1f515f02dfe9e3115ed9fc07183f02fc"
+     *   },
+     *   {
+     *     next: (data) => console.log("Token Balances:", data),
+     *     error: (err) => console.error("Error:", err),
+     *     complete: () => console.log("Stream completed")
+     *   }
+     * );
+     * ```
+     */
+    subscribeToTokenBalances(params: TokenBalancesStreamParams, callbacks: StreamSubscriptionOptions<TokenBalancesStreamResponse>): UnsubscribeFunction;
+    /**
+     * Subscribe to real-time wallet activity including transactions, token transfers, and smart contract interactions
+     *
+     * @param params - Parameters for the wallet activity stream
+     * @param callbacks - Subscription callbacks
+     * @returns Unsubscribe function
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = streamingService.subscribeToWalletActivity(
+     *   {
+     *     chain_name: StreamingChain.BASE_MAINNET,
+     *     wallet_addresses: ["0x198ef79f1f515f02dfe9e3115ed9fc07183f02fc"]
+     *   },
+     *   {
+     *     next: (data) => console.log("Wallet Activity:", data),
+     *     error: (err) => console.error("Error:", err),
+     *     complete: () => console.log("Stream completed")
+     *   }
+     * );
+     * ```
+     */
+    subscribeToWalletActivity(params: WalletActivityStreamParams, callbacks: StreamSubscriptionOptions<WalletActivityStreamResponse[]>): UnsubscribeFunction;
+}

package/dist/esm/src/utils/types/StreamingService.types.d.ts

@@ -0,0 +1,201 @@
+import type { ContractMetadata } from "./Generic.types";
+/**
+ * Common enums and types for Streaming API
+ */
+export declare enum StreamingChain {
+    BASE_MAINNET = "BASE_MAINNET",
+    ETH_MAINNET = "ETH_MAINNET",
+    BSC_MAINNET = "BSC_MAINNET"
+}
+export declare enum StreamingInterval {
+    FIFTEEN_SECONDS = "FIFTEEN_SECONDS",
+    THIRTY_SECONDS = "THIRTY_SECONDS",
+    ONE_MINUTE = "ONE_MINUTE",
+    FIVE_MINUTES = "FIVE_MINUTES",
+    FIFTEEN_MINUTES = "FIFTEEN_MINUTES",
+    THIRTY_MINUTES = "THIRTY_MINUTES",
+    ONE_HOUR = "ONE_HOUR",
+    FOUR_HOURS = "FOUR_HOURS",
+    ONE_DAY = "ONE_DAY"
+}
+export declare enum StreamingTimeframe {
+    ONE_MINUTE = "ONE_MINUTE",
+    FIVE_MINUTES = "FIVE_MINUTES",
+    FIFTEEN_MINUTES = "FIFTEEN_MINUTES",
+    THIRTY_MINUTES = "THIRTY_MINUTES",
+    ONE_HOUR = "ONE_HOUR",
+    FOUR_HOURS = "FOUR_HOURS",
+    ONE_DAY = "ONE_DAY",
+    ONE_WEEK = "ONE_WEEK",
+    ONE_MONTH = "ONE_MONTH"
+}
+export declare enum StreamingProtocol {
+    UNISWAP_V2 = "UNISWAP_V2",
+    UNISWAP_V3 = "UNISWAP_V3"
+}
+/**
+ * OHLCV Pairs Stream Types
+ */
+export interface OHLCVPairsStreamParams {
+    chain_name: StreamingChain;
+    pair_addresses: string[];
+    interval: StreamingInterval;
+    timeframe: StreamingTimeframe;
+    limit?: number;
+}
+export interface OHLCVPairsStreamResponse {
+    chain_name: StreamingChain;
+    pair_address: string;
+    interval: StreamingInterval;
+    timeframe: StreamingTimeframe;
+    timestamp: string;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume: number;
+    price_usd: number;
+    volume_usd: number;
+    base_token: ContractMetadata;
+    quote_token: ContractMetadata;
+}
+/**
+ * OHLCV Tokens Stream Types
+ */
+export interface OHLCVTokensStreamParams {
+    chain_name: StreamingChain;
+    token_addresses: string[];
+    interval: StreamingInterval;
+    timeframe: StreamingTimeframe;
+    limit?: number;
+}
+export interface OHLCVTokensStreamResponse {
+    chain_name: StreamingChain;
+    pair_address: string;
+    interval: StreamingInterval;
+    timeframe: StreamingTimeframe;
+    timestamp: string;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume: number;
+    volume_usd: number;
+    quote_rate: number;
+    quote_rate_usd: number;
+    base_token: ContractMetadata;
+    quote_token: ContractMetadata;
+}
+/**
+ * New DEX Pairs Stream Types
+ */
+export interface NewPairsStreamParams {
+    chain_name: StreamingChain;
+    protocols: StreamingProtocol[];
+}
+export interface PriceMetrics {
+    last_5m: number;
+    last_1hr: number;
+    last_6hr: number;
+    last_24hr: number;
+}
+export interface SwapMetrics {
+    last_5m: number;
+    last_1hr: number;
+    last_6hr: number;
+    last_24hr: number;
+}
+export interface NewPairsStreamResponse {
+    chain_name: string;
+    protocol: string;
+    protocol_version: string;
+    pair_address: string;
+    deployer_address: string;
+    tx_hash: string;
+    block_signed_at: string;
+    liquidity: number;
+    supply: number;
+    market_cap: number;
+    event_name: string;
+    quote_rate: number;
+    quote_rate_usd: number;
+    base_token_metadata: ContractMetadata;
+    quote_token_metadata: ContractMetadata;
+    pair_metadata: ContractMetadata;
+    prices: PriceMetrics;
+    swaps: SwapMetrics;
+}
+/**
+ * Token Balances Stream Types
+ */
+export interface TokenBalancesStreamParams {
+    chain_name: StreamingChain;
+    wallet_address: string;
+}
+export interface TokenBalanceItem {
+    balance: string;
+    balance_pretty: number;
+    quote_rate_usd: number;
+    quote_usd: number;
+    metadata: ContractMetadata;
+    is_native: boolean;
+}
+export interface TokenBalancesStreamResponse {
+    wallet_address: string;
+    chain_name: string;
+    last_block: number;
+    items: TokenBalanceItem[];
+}
+/**
+ * Wallet Activity Stream Types
+ */
+export interface WalletActivityStreamParams {
+    chain_name: StreamingChain;
+    wallet_addresses: string[];
+}
+export interface WalletActivityLogItem {
+    emitter_address: string;
+    log_offset: number;
+    data: string;
+    topics: string[];
+}
+export interface WalletActivityStreamResponse {
+    tx_hash: string;
+    from_address: string;
+    to_address: string;
+    value: number;
+    chain_name: string;
+    block_signed_at: string;
+    block_height: number;
+    block_hash: string;
+    miner_address: string;
+    gas_used: number;
+    tx_offset: number;
+    successful: boolean;
+    decoded_type: string;
+    decoded_details?: object;
+    logs: WalletActivityLogItem[];
+}
+/**
+ * Streaming service configuration
+ */
+export interface StreamingServiceConfig {
+    shouldRetry?: (retries: number) => boolean;
+    maxReconnectAttempts?: number;
+    onConnecting?: () => void;
+    onOpened?: () => void;
+    onClosed?: () => void;
+    onError?: (error: any) => void;
+}
+/**
+ * Stream subscription options
+ */
+export interface StreamSubscriptionOptions<T = Array<object>> {
+    next: (payload: T) => void;
+    error?: (error: any) => void;
+    complete?: () => void;
+}
+/**
+ * Unsubscribe function type
+ */
+export type UnsubscribeFunction = () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@covalenthq/client-sdk",
-  "version": "2.2.6",
+  "version": "2.3.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -15,7 +15,8 @@
   },
   "homepage": "https://github.com/covalenthq/covalent-api-sdk-ts#readme",
   "dependencies": {
-    "big.js": "^6.2.1"
+    "big.js": "^6.2.1",
+    "graphql-ws": "^6.0.5"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^25.0.4",
@@ -25,6 +26,7 @@
     "@types/big.js": "^6.2.2",
     "@types/jest": "^29.5.5",
     "@types/node": "^20",
+    "@types/ws": "^8.18.1",
     "@typescript-eslint/eslint-plugin": "^7.7.1",
     "@typescript-eslint/parser": "^7.7.1",
     "dotenv": "^16.4.5",
@@ -39,16 +41,8 @@
     "rollup-plugin-typescript2": "^0.35.0",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5"
-  },
-  "scripts": {
-    "test": "jest",
-    "build": "rollup -c rollup.config.js",
-    "clean": "rimraf dist",
-    "start": "rollup -c",
-    "lint": "eslint .",
-    "pretty": "prettier . --write",
-    "prepublishOnly": "npm run clean && npm run build"
+    "typescript": "^5",
+    "ws": "^8.18.2"
   },
   "publishConfig": {
     "access": "public"
@@ -70,5 +64,13 @@
     "./types/esm": "./types/esm/index.d.ts",
     "./package.json": "./package.json"
   },
-  "types": "./dist/esm/index.d.ts"
-}
+  "types": "./dist/esm/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "build": "rollup -c rollup.config.js",
+    "clean": "rimraf dist",
+    "start": "rollup -c",
+    "lint": "eslint .",
+    "pretty": "prettier . --write"
+  }
+}