@solana/pay/dist/watchReference.d.ts

`@solana/pay` is a JavaScript library for facilitating commerce on Solana by using a token transfer URL scheme. The URL scheme ensures that no matter the wallet or service used, the payment request must be created and interpreted in one standard way.

import type { Signature } from '@solana/kit';
import type { LogsNotificationsApi } from '@solana/rpc-subscriptions-api';
import type { RpcSubscriptions } from '@solana/rpc-subscriptions-spec';
import type { Finality, Reference } from './types.js';
/** Options for {@link watchReference}. */
export interface WatchReferenceOptions {
    /** Commitment level for the subscription. Defaults to `confirmed`. */
    commitment?: Finality;
    /** Abort signal to cancel the subscription. */
    abortSignal?: AbortSignal;
}
/** Result returned by {@link watchReference}. */
export interface WatchReferenceResult {
    /** The transaction signature. */
    signature: Signature;
    /** Error if the transaction failed, null if it succeeded. */
    err: unknown | null;
}
/**
 * Watch for a transaction referencing a given address using WebSocket subscriptions.
 *
 * Unlike {@link findReference}, which polls via HTTP, this function subscribes
 * to `logsNotifications` filtered by `{ mentions: [reference] }` and resolves
 * as soon as a matching transaction lands.
 *
 * @param rpcSubscriptions - An RPC subscriptions client supporting `logsNotifications`.
 * @param reference - `reference` in the [Solana Pay spec](https://github.com/solana-foundation/pay/blob/main/typescript/packages/solana-pay/spec/SPEC.md#reference).
 * @param options - Options for the subscription.
 *
 * @throws {FindReferenceError} If the subscription is aborted before a transaction is found.
 */
export declare function watchReference(rpcSubscriptions: RpcSubscriptions<LogsNotificationsApi>, reference: Reference, options?: WatchReferenceOptions): Promise<WatchReferenceResult>;
//# sourceMappingURL=watchReference.d.ts.map