solpay/lib/order.d.ts

Solana Payment API.

import { type ParsedTransactionWithMeta, type SignaturesForAddressOptions } from "@solana/web3.js";
import type { Order, OrderConfig } from './type';
/**
 * Example:
 * ```
    const order = await createOrder({
        pay_to: "BSzG62Khqw5pbbWPmoe8iZekExekFQBJmjYhiXhcVvtS",
        coin_type: "SOL", // Optional: "USDT", "USDC"
        coin_amount: 0.00001,
        timeout: 60_000,
    });
 * ```
 * @see {@link orderPaid()}
 */
export declare function createOrder(config: OrderConfig): Promise<Order>;
/**
 * Example:
 * ```
 * const parsedTransactionWithMeta = await orderPaid(order);
 *
 * if (parsedTransactionWithMeta) {
 *      const signature = parsedTransactionWithMeta.transaction.signatures[0];
 * }
 * ```
 * @see {@link createOrder()}
 */
export declare function orderPaid(order: Order): Promise<ParsedTransactionWithMeta | undefined>;
/**
 * Validate order via blockchain.
 *
 * See also: https://github.com/anza-xyz/solana-pay/blob/master/core/src/validateTransfer.ts
 */
export declare function confirmOrderPaid(order: Order, _options?: SignaturesForAddressOptions): Promise<ParsedTransactionWithMeta | undefined>;