@vechain/sdk-network/src/utils/subscriptions/beat.ts

This module serves as the standard interface connecting decentralized applications (dApps) and users to the VeChainThor blockchain

import { thorest } from '../thorest';
import { type BlockSubscriptionOptions } from './types';

/**
 * Returns the URL for subscribing to new beats through a websocket connection.
 * @note This subscribes to the legacy beats.
 * [Legacy Beat source code](https://github.com/vechain/thor/blob/abf1da466b554dcc9c1ad30cb8e75a860b046bf5/api/subscriptions/beat_reader.go#L29)
 *
 * @param baseURL - The URL of the node to request the subscription from.
 * @param options - (optional) other optional parameters for the request.
 *                  `blockID` - The block id to start from, defaults to the best block.
 *
 * @returns The websocket subscription URL.
 */
const getLegacyBeatSubscriptionUrl = (
    baseURL: string,
    options?: BlockSubscriptionOptions
): string => {
    return thorest.subscriptions.get.BEAT_LEGACY(baseURL, options?.blockID);
};

/**
 * Returns the URL for subscribing to new beats through a websocket connection.
 * @note this subscribes to the updated version of the beats. The new version uses a dynamic size bloom filter.
 *
 * @param baseURL - The URL of the node to request the subscription from.
 * @param options - (optional) other optional parameters for the request.
 *                 `blockID` - The block id to start from, defaults to the best block.
 *
 * @returns The websocket subscription URL.
 */
const getBeatSubscriptionUrl = (
    baseURL: string,
    options?: BlockSubscriptionOptions
): string => {
    return thorest.subscriptions.get.BEAT(baseURL, options?.blockID);
};

export { getLegacyBeatSubscriptionUrl, getBeatSubscriptionUrl };