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

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

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

/**
 * Returns the URL for subscribing to new VET transfers through a websocket connection.
 *
 * @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.
 *                  `signerAddress` - The address of the signer of the transaction to filter transfers by.
 *                  `sender` - The sender address to filter transfers by.
 *                  `recipient` - The recipient address to filter transfers by.
 *
 * @returns The websocket subscription URL.
 */
const getVETtransfersSubscriptionUrl = (
    baseURL: string,
    options?: VETtransfersSubscriptionOptions
): string => {
    return thorest.subscriptions.get.VET_TRANSFER(baseURL, {
        position: options?.blockID,
        signerAddress: options?.signerAddress,
        sender: options?.sender,
        receiver: options?.recipient
    });
};

export { getVETtransfersSubscriptionUrl };