Class StacksApiWebSocketClient

Hierarchy

  • StacksApiWebSocketClient

Constructors

constructor

Properties

eventEmitter idCursor pendingRequests webSocket

Methods

handleNotification rpcCall subscribeAddressBalanceUpdates subscribeAddressTransactions subscribeBlocks subscribeMempool subscribeMicroblocks subscribeNftAssetEventUpdates subscribeNftCollectionEventUpdates subscribeNftEventUpdates subscribeTxUpdates connect

Constructors

constructor

Properties

eventEmitter

eventEmitter: EventEmitter<{ addressBalanceUpdate: ((event: RpcAddressBalanceNotificationParams) => void); addressTxUpdate: ((event: RpcAddressTxNotificationParams) => void); block: ((event: Block) => void); mempool: ((event: Transaction) => void); microblock: ((event: Microblock) => void); nftAssetEventUpdate: ((event: NftEvent) => void); nftCollectionEventUpdate: ((event: NftEvent) => void); nftEventUpdate: ((event: NftEvent) => void); txUpdate: ((event: Transaction | MempoolTransaction) => any) }, any> = ...

idCursor

idCursor: number = 0

pendingRequests

pendingRequests: Map<ID, { reject: ((error: any) => void); resolve: ((result: any) => void) }> = ...

webSocket

webSocket: IWebSocket

Methods

handleNotification

  • Parameters

    • data: NotificationObject

    Returns void

Private rpcCall

  • Type Parameters

    • TResult = void

    Parameters

    • method: string
    • params: any

    Returns Promise<TResult>

subscribeAddressBalanceUpdates

  • Parameters

    • address: string
    • update: ((event: RpcAddressBalanceNotificationParams) => any)
        • (event: RpcAddressBalanceNotificationParams): any

        • Parameters

          • event: RpcAddressBalanceNotificationParams

          Returns any

    Returns Promise<Subscription>

subscribeAddressTransactions

  • Parameters

    • address: string
    • update: ((event: RpcAddressTxNotificationParams) => any)
        • (event: RpcAddressTxNotificationParams): any

        • Parameters

          • event: RpcAddressTxNotificationParams

          Returns any

    Returns Promise<Subscription>

subscribeBlocks

  • Parameters

    • update: ((event: Block) => any)
        • (event: Block): any

        • Parameters

          • event: Block

          Returns any

    Returns Promise<Subscription>

subscribeMempool

  • Parameters

    • update: ((event: Transaction) => any)
        • (event: Transaction): any

        • Parameters

          • event: Transaction

          Returns any

    Returns Promise<Subscription>

subscribeMicroblocks

  • Parameters

    • update: ((event: Microblock) => any)
        • (event: Microblock): any

        • Parameters

          • event: Microblock

          Returns any

    Returns Promise<Subscription>

subscribeNftAssetEventUpdates

  • Parameters

    • assetIdentifier: string
    • value: string
    • update: ((event: NftEvent) => any)
        • (event: NftEvent): any

        • Parameters

          • event: NftEvent

          Returns any

    Returns Promise<Subscription>

subscribeNftCollectionEventUpdates

  • Parameters

    • assetIdentifier: string
    • update: ((event: NftEvent) => any)
        • (event: NftEvent): any

        • Parameters

          • event: NftEvent

          Returns any

    Returns Promise<Subscription>

subscribeNftEventUpdates

  • Parameters

    • update: ((event: NftEvent) => any)
        • (event: NftEvent): any

        • Parameters

          • event: NftEvent

          Returns any

    Returns Promise<Subscription>

subscribeTxUpdates

  • Parameters

    • txId: string
    • update: ((event: Transaction | MempoolTransaction) => any)
        • (event: Transaction | MempoolTransaction): any

        • Parameters

          • event: Transaction | MempoolTransaction

          Returns any

    Returns Promise<Subscription>

Static connect

Settings

Member Visibility

Theme

Generated using TypeDoc