@bsv/sdk/dist/types/src/transaction/Broadcaster.d.ts

BSV Blockchain Software Development Kit

import Transaction from './Transaction.js';
/**
 * Defines the structure of a successful broadcast response.
 *
 * @interface
 * @property {string} status - The status of the response, indicating success.
 * @property {string} txid - The transaction ID of the broadcasted transaction.
 * @property {string} message - A human-readable success message.
 */
export interface BroadcastResponse {
    status: 'success';
    txid: string;
    message: string;
    competingTxs?: string[];
}
/**
 * Defines the structure of a failed broadcast response.
 *
 * @interface
 * @property {string} status - The status of the response, indicating an error.
 * @property {string} code - A machine-readable error code representing the type of error encountered.
 * @property {string} txid - The transaction ID of the broadcasted transaction.
 * @property {string} description - A detailed description of the error.
 * @property {object} more - The unparsed response data from the underlying broadcast service.
 */
export interface BroadcastFailure {
    status: 'error';
    code: string;
    txid?: string;
    description: string;
    more?: object;
}
/**
 * Represents the interface for a transaction broadcaster.
 * This interface defines a standard method for broadcasting transactions.
 *
 * @interface
 * @property {function} broadcast - A function that takes a Transaction object and returns a promise.
 *                                  The promise resolves to either a BroadcastResponse or a BroadcastFailure.
 * @property {function} broadcastMany - A function that takes an array of Transaction objects and returns a promise.
 *                                  The promise resolves to an array of broadcast result response objects.
 */
export interface Broadcaster {
    broadcast: (transaction: Transaction) => Promise<BroadcastResponse | BroadcastFailure>;
    broadcastMany?: (txs: Transaction[]) => Promise<object[]>;
}
/**
 * Convenience type guard for response from `Broadcaster.broadcast`
 */
export declare function isBroadcastResponse(r: BroadcastResponse | BroadcastFailure): r is BroadcastResponse;
/**
 * Convenience type guard for response from `Broadcaster.broadcast`
 */
export declare function isBroadcastFailure(r: BroadcastResponse | BroadcastFailure): r is BroadcastFailure;
//# sourceMappingURL=Broadcaster.d.ts.map