Helius SDK - v2.2.2
    Preparing search index...

    Interface WsAsync

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

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

    interface WsAsync {
        accountNotifications(
            ...args: [address: Address, config?: Readonly<{}>],
        ): Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>;
        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(
            config?: Readonly<{ commitment?: Commitment }>,
        ): Promise<PendingRpcSubscriptionsRequest<Readonly<{}>>>;
    }
    Index

    Methods

    accountNotifications close logsNotifications programNotifications signatureNotifications slotNotifications

    Methods

    • Subscribe to account updates.

      Parameters

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

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

    • 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.

      Parameters

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

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

    Settings

    Member Visibility

    On This Page

    Methods