Helius SDK - v3.4.0
    Preparing search index...

    Interface WsAsync

    WebSocket RPC subscription client. Provides promisified access to Solana's WebSocket subscriptions (logs, slots, signatures, programs, accounts) and Helius Enhanced WebSocket subscriptions (transactions, accounts).

    All standard subscription methods return a Promise that resolves to a subscription object with an async iterator.

    Enhanced methods (transactionSubscribe, accountSubscribe) use Helius Enhanced WebSockets for 1.5-2x faster streaming with advanced filtering. These require a Business+ plan.

    interface WsAsync {
        accountNotifications(
            ...args: [address: Address, config?: Readonly<{}>],
        ): Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>;
        accountSubscribe(
            account: string,
            config?: EnhancedAccountSubscribeConfig,
        ): Promise<EnhancedSubscription<EnhancedAccountNotificationResult>>;
        accountUnsubscribe(subscriptionId: number): Promise<boolean>;
        close(): void;
        logsNotifications(
            filter: LogsFilter,
            config?: Readonly<{ commitment?: Commitment }>,
        ): Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>;
        programNotifications(
            ...args: [programId: Address, config?: Readonly<{}>],
        ): Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>;
        signatureNotifications(
            signature: string | Signature,
            config?: Readonly<{ commitment?: Commitment }>,
        ): Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>;
        slotNotifications(): Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>;
        transactionSubscribe(
            filter: TransactionSubscribeFilter,
            config?: TransactionSubscribeConfig,
        ): Promise<EnhancedSubscription<TransactionNotificationResult>>;
        transactionUnsubscribe(subscriptionId: number): Promise<boolean>;
    }
    Index

    Methods

    • Subscribe to account updates.

      Parameters

      • ...args: [address: Address, config?: Readonly<{}>]

      Returns Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>

    • Unsubscribe from an enhanced account subscription by its server-assigned ID. Helius Enhanced WebSocket method (Business+ plan).

      Parameters

      • subscriptionId: number

      Returns Promise<boolean>

    • Manually close the underlying WebSocket connections (standard and enhanced). Any subscription call already in flight when this is called still rejects with "WebSocket client is closed", and no new connection is left open.

      Returns void

    • Subscribe to transaction logs.

      Parameters

      • filter: LogsFilter
      • Optionalconfig: Readonly<{ commitment?: Commitment }>

      Returns Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>

    • Subscribe to program account updates.

      Parameters

      • ...args: [programId: Address, config?: Readonly<{}>]

      Returns Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>

    • Subscribe to signature confirmation status.

      Parameters

      • signature: string | Signature
      • Optionalconfig: Readonly<{ commitment?: Commitment }>

      Returns Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>

    • Subscribe to slot updates. slotSubscribe takes no parameters.

      Returns Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>

    • Unsubscribe from a transaction subscription by its server-assigned ID. Helius Enhanced WebSocket method (Business+ plan).

      Parameters

      • subscriptionId: number

      Returns Promise<boolean>