Function ethUnsubscribe

Asynchronously unsubscribes from a VeChain event subscription. This function attempts to unsubscribe from either 'newHeads' or log subscriptions based on the provided subscriptionId. If the provider is not available or the subscriptionId does not match any active subscriptions, it may throw an error or return false, respectively.

Link

eth_unsubscribe

Throws

  • ethUnsubscribe(params, provider?): Promise<boolean>

  • Parameters

    • params: unknown[]

      An array containing the subscription ID as its first element. The subscription ID is used to identify and unsubscribe from the corresponding Ethereum event subscription.

    • Optionalprovider: VeChainProvider

      An optional VeChainProvider instance that contains the subscription manager. This manager holds the active subscriptions and is used to unsubscribe from them. If the provider is not provided or is undefined, the function throws an error indicating that the provider is not available.

    Returns Promise<boolean>

    A Promise that resolves to true if the unsubscription was successful, or false if the specified subscription ID does not match any active subscriptions.

Settings

Member Visibility