@bwalletx/connect 0.5.4 → 0.7.0

package/dist/wallets-CbzMtxrf.d.cts

@@ -1,250 +0,0 @@
-import { WalletInterface } from '@bsv/sdk';
-
-/** localStorage-shaped storage. Methods may be sync or async. */
-interface PairStorage {
-    getItem(key: string): string | null | Promise<string | null>;
-    setItem(key: string, value: string): void | Promise<void>;
-    removeItem(key: string): void | Promise<void>;
-}
-/** The minimum of the browser WebSocket API this package uses (the `ws` package also fits). */
-interface SocketLike {
-    readonly readyState: number;
-    onopen: ((ev: unknown) => void) | null;
-    onmessage: ((ev: {
-        data: unknown;
-    }) => void) | null;
-    onerror: ((ev: unknown) => void) | null;
-    onclose: ((ev: unknown) => void) | null;
-    send(data: string): void;
-    close(): void;
-}
-type SocketFactory = (url: string) => SocketLike;
-interface PairConnectionOptions {
-    /** Where the pairing is kept so it survives a reload. Default: localStorage, else memory only. */
-    storage?: PairStorage | null;
-    /** Storage key. Default 'bwalletx.connect.pairing.v1'. */
-    storageKey?: string;
-    /** Opens a socket. Default: the global WebSocket. Pass one to run in Node or to test. */
-    socket?: SocketFactory;
-    /** Per-call timeout in ms. Default 120000. */
-    callTimeoutMs?: number;
-}
-interface PairingOptions extends PairConnectionOptions {
-    /** Show this link as a QR code, and as text to copy (web.bwalletx.com takes it pasted). */
-    onLink: (link: string) => void;
-    /** Show this 4-digit code. The wallet shows the same one; the user checks they match. */
-    onCode: (code: string) => void;
-    signal?: AbortSignal;
-    /** Relay host. Default relay.bwallet.space. */
-    relay?: string;
-    /** This page's origin, as the relay will see it. Default location.origin. */
-    origin?: string;
-}
-/** A BRC-100 wallet whose every call goes, end-to-end encrypted, to the paired phone or web wallet. */
-type PairedWallet = WalletInterface & {
-    /** Close the relay connection. The pairing stays stored; the next call reconnects. */
-    close(): void;
-    /** Tell the wallet to unpair, close, and delete the stored pairing. */
-    forget(): Promise<void>;
-};
-/**
- * Pair with bWalletX on a phone (scan the QR) or web.bwalletx.com (paste the link).
- * Resolves with a wallet once the user taps Connect. The pairing is stored (see `storage`) so
- * `restorePairing()` can reconnect after a reload without a new QR.
- */
-declare function pairBwalletX(opts: PairingOptions): Promise<PairedWallet>;
-/**
- * The wallet from a pairing stored by an earlier `pairBwalletX`, or null if there is none.
- * It connects on the first call. The wallet must still have this site paired.
- */
-declare function restorePairing(opts?: PairConnectionOptions): Promise<PairedWallet | null>;
-/** Delete the stored pairing without telling the wallet. */
-declare function clearPairing(opts?: Pick<PairConnectionOptions, 'storage' | 'storageKey'>): Promise<void>;
-
-/**
- * Browser-side payment helpers on top of the BRC-100 wallet's createAction. Works with any
- * BRC-100 wallet. Each helper asks the wallet once; it never retries a spend. If a call fails
- * the error says whether the wallet may have sent anything (`maybeSent`).
- */
-
-/** BRC-29 payment protocol id. */
-declare const BRC29_PROTOCOL: [2, string];
-type PayTo = string;
-interface PayOutput {
-    /** Locking script hex. */
-    script: string;
-    satoshis: number;
-    description?: string;
-}
-interface PayRequest {
-    to: PayTo;
-    /** Amount in satoshis. Give this or `usd`. */
-    sats?: number;
-    /** Amount in US dollars, converted at `usdPerBsv` (or the live WhatsOnChain rate). */
-    usd?: number;
-    /** Shown in the wallet and, with `memoOnChain`, written in an OP_RETURN output. */
-    memo?: string;
-    memoOnChain?: boolean;
-    /** Labels for the wallet's history. */
-    labels?: string[];
-}
-interface PayOptions {
-    /** Fixed rate for `usd`. Otherwise fetched from WhatsOnChain. */
-    usdPerBsv?: number | (() => Promise<number>);
-    /** Resolve a paymail to outputs. Default: bsvalias P2P payment destination (needs CORS on the paymail host). */
-    resolvePaymail?: (paymail: string, sats: number) => Promise<{
-        outputs: PayOutput[];
-        reference?: string;
-        submit?: (rawTxHex: string) => Promise<void>;
-    }>;
-    fetch?: typeof fetch;
-}
-interface Brc29Remittance {
-    senderIdentityKey: string;
-    derivationPrefix: string;
-    derivationSuffix: string;
-    outputIndex: number;
-}
-interface PayResult {
-    txid: string;
-    /** Atomic BEEF (BRC-95) if the wallet returned it. Send it to your server's verifyPayment. */
-    tx?: number[];
-    sats: number;
-    outputs: PayOutput[];
-    /** For an identity-key payment: what the recipient needs to internalize the output (BRC-29). Deliver it to them. */
-    remittance?: Brc29Remittance;
-}
-type PaymentErrorCode = 'BAD_REQUEST' | 'RESOLVE_FAILED' | 'RATE_FAILED' | 'WALLET_REJECTED' | 'WALLET_ERROR' | 'NOT_SUPPORTED';
-declare class PaymentError extends Error {
-    readonly code: PaymentErrorCode;
-    /** true when the wallet was asked to spend and the outcome is unknown. Check before trying again. */
-    readonly maybeSent: boolean;
-    readonly cause?: unknown | undefined;
-    constructor(code: PaymentErrorCode, message: string, 
-    /** true when the wallet was asked to spend and the outcome is unknown. Check before trying again. */
-    maybeSent?: boolean, cause?: unknown | undefined);
-}
-/** A wallet that is not BRC-100 (the HandCash transitional adapter) can still pay through this. */
-interface LegacyPayer {
-    pay(req: PayRequest & {
-        sats: number;
-    }): Promise<PayResult>;
-}
-type PaySource = WalletInterface | LegacyPayer;
-declare const isIdentityKeyHex: (s: string) => boolean;
-declare const isPaymail: (s: string) => boolean;
-/** Satoshis for a request (sats as given, or usd converted, rounded up). */
-declare function amountInSats(req: Pick<PayRequest, 'sats' | 'usd'>, o?: PayOptions): Promise<number>;
-/** Default paymail resolver: bsvalias P2P Payment Destination (BRC-? / capability 2a40af698840). */
-declare function resolvePaymailP2P(paymail: string, sats: number, f?: typeof fetch): Promise<{
-    outputs: {
-        script: string;
-        satoshis: number;
-    }[];
-    reference: string | undefined;
-    submit: ((hex: string) => Promise<void>) | undefined;
-}>;
-/** Pay a paymail, address or identity key. One wallet prompt; never retried. */
-declare function pay(source: PaySource, req: PayRequest, o?: PayOptions): Promise<PayResult>;
-/** pay() labelled as a tip. */
-declare function tip(source: PaySource, req: PayRequest, o?: PayOptions): Promise<PayResult>;
-interface TokenQuote {
-    /** Outputs to fund, as your server priced them (e.g. payment to the seller + fee). */
-    outputs: PayOutput[];
-    description?: string;
-    /** Called with the result after the wallet signs; e.g. POST txid + tx to your server for verifyPayment. */
-    onPaid?: (r: PayResult) => Promise<void> | void;
-}
-interface BuyTokenRequest {
-    token: string;
-    amount: number | string;
-    /** The hook point: return the outputs for this purchase (usually from your server). */
-    quote: (req: {
-        token: string;
-        amount: number | string;
-    }) => Promise<TokenQuote>;
-    labels?: string[];
-}
-/** Buy a token: your `quote` hook prices it, the wallet pays once, `onPaid` delivers it. */
-declare function buyToken(source: PaySource, req: BuyTokenRequest): Promise<PayResult>;
-
-/**
- * Every wallet the user could connect with, behind one interface. BRC-100 first: bWalletX, then any
- * other wallet that announces itself (Yours, Metanet, ...), the in-app browser, optional localhost
- * desktop wallets, phone pairing, and app-supplied adapters (e.g. the transitional HandCash one).
- */
-
-type WalletKind = 'brc100' | 'pairing' | 'handcash' | 'custom';
-interface ConnectedWallet {
-    /** The BRC-100 wallet. null for a non-BRC-100 adapter (HandCash today). */
-    wallet: WalletInterface | null;
-    /** What pay/tip use: the BRC-100 wallet, or the adapter's own payer. */
-    payer: PaySource | null;
-    /** The identity public key (hex) when the wallet has one. */
-    identityKey: string | null;
-    handle?: string;
-    paymail?: string;
-    /** Which option connected. */
-    optionId: string;
-    kind: WalletKind;
-    /** True for adapters kept only until the vendor ships BRC-100. */
-    transitional?: boolean;
-}
-interface WalletOption {
-    id: string;
-    name: string;
-    icon?: string;
-    kind: WalletKind;
-    rdns?: string;
-    /** True for bWalletX (extension, in-app or paired). */
-    isBwalletX: boolean;
-    connect(): Promise<ConnectedWallet>;
-}
-/** Wrap any BRC-100 wallet as a picker option. */
-declare function brc100Option(wallet: WalletInterface, info: {
-    id: string;
-    name: string;
-    icon?: string;
-    rdns?: string;
-    isBwalletX?: boolean;
-}): WalletOption;
-/** Phone / web.bwalletx.com pairing as an option (shows a QR through `pairing`). Reuses a stored pairing first. */
-declare function pairingOption(pairing: PairingOptions | (() => PairingOptions)): WalletOption;
-interface HandCashAdapterOptions {
-    /**
-     * Your existing HandCash Connect login (redirect/popup + your server route). Resolve with the
-     * profile once the user is signed in. This package does not import any HandCash SDK.
-     */
-    login(): Promise<{
-        handle: string;
-        paymail?: string;
-        identityKey?: string;
-    }>;
-    /** Your existing HandCash pay call (usually a server route using the auth token). Optional. */
-    pay?: Extract<PaySource, {
-        pay: unknown;
-    }>['pay'];
-    icon?: string;
-}
-/**
- * TRANSITIONAL. Keeps existing HandCash users working behind the same picker until HandCash's
- * BRC-100 support ships; then remove this and HandCash appears as an ordinary BRC-100 wallet.
- */
-declare function handcashAdapter(o: HandCashAdapterOptions): WalletOption;
-interface DiscoverWalletsOptions {
-    /** Longest wait for BRC-100 announcements, ms. Default 300; ends early once a wallet has announced. */
-    ms?: number;
-    /**
-     * Also probe desktop wallets on localhost (Metanet / json-api on 3321, Cicada on 3301).
-     * Off by default: some browsers prompt for local-network access.
-     */
-    probeLocal?: boolean;
-    /** Add the phone pairing option (needs a way to show the QR, e.g. pairingModal()). */
-    pairing?: PairingOptions | (() => PairingOptions);
-    /** App-supplied options appended at the end (e.g. handcashAdapter(...)). */
-    extra?: WalletOption[];
-}
-/** All wallets we can see, bWalletX first. SSR-safe: resolves [] (plus `extra`) outside a browser. */
-declare function discoverWallets(o?: DiscoverWalletsOptions): Promise<WalletOption[]>;
-
-export { restorePairing as A, type BuyTokenRequest as B, type ConnectedWallet as C, type DiscoverWalletsOptions as D, tip as E, type HandCashAdapterOptions as H, type LegacyPayer as L, type PayRequest as P, type SocketFactory as S, type TokenQuote as T, type WalletOption as W, type PayResult as a, type PayOptions as b, PaymentError as c, brc100Option as d, discoverWallets as e, type PairingOptions as f, BRC29_PROTOCOL as g, handcashAdapter as h, type Brc29Remittance as i, type PairConnectionOptions as j, type PairStorage as k, type PairedWallet as l, type PayOutput as m, type PaySource as n, type PaymentErrorCode as o, pairingOption as p, type SocketLike as q, type WalletKind as r, amountInSats as s, buyToken as t, clearPairing as u, isIdentityKeyHex as v, isPaymail as w, pairBwalletX as x, pay as y, resolvePaymailP2P as z };

package/dist/wallets-CbzMtxrf.d.ts

@@ -1,250 +0,0 @@
-import { WalletInterface } from '@bsv/sdk';
-
-/** localStorage-shaped storage. Methods may be sync or async. */
-interface PairStorage {
-    getItem(key: string): string | null | Promise<string | null>;
-    setItem(key: string, value: string): void | Promise<void>;
-    removeItem(key: string): void | Promise<void>;
-}
-/** The minimum of the browser WebSocket API this package uses (the `ws` package also fits). */
-interface SocketLike {
-    readonly readyState: number;
-    onopen: ((ev: unknown) => void) | null;
-    onmessage: ((ev: {
-        data: unknown;
-    }) => void) | null;
-    onerror: ((ev: unknown) => void) | null;
-    onclose: ((ev: unknown) => void) | null;
-    send(data: string): void;
-    close(): void;
-}
-type SocketFactory = (url: string) => SocketLike;
-interface PairConnectionOptions {
-    /** Where the pairing is kept so it survives a reload. Default: localStorage, else memory only. */
-    storage?: PairStorage | null;
-    /** Storage key. Default 'bwalletx.connect.pairing.v1'. */
-    storageKey?: string;
-    /** Opens a socket. Default: the global WebSocket. Pass one to run in Node or to test. */
-    socket?: SocketFactory;
-    /** Per-call timeout in ms. Default 120000. */
-    callTimeoutMs?: number;
-}
-interface PairingOptions extends PairConnectionOptions {
-    /** Show this link as a QR code, and as text to copy (web.bwalletx.com takes it pasted). */
-    onLink: (link: string) => void;
-    /** Show this 4-digit code. The wallet shows the same one; the user checks they match. */
-    onCode: (code: string) => void;
-    signal?: AbortSignal;
-    /** Relay host. Default relay.bwallet.space. */
-    relay?: string;
-    /** This page's origin, as the relay will see it. Default location.origin. */
-    origin?: string;
-}
-/** A BRC-100 wallet whose every call goes, end-to-end encrypted, to the paired phone or web wallet. */
-type PairedWallet = WalletInterface & {
-    /** Close the relay connection. The pairing stays stored; the next call reconnects. */
-    close(): void;
-    /** Tell the wallet to unpair, close, and delete the stored pairing. */
-    forget(): Promise<void>;
-};
-/**
- * Pair with bWalletX on a phone (scan the QR) or web.bwalletx.com (paste the link).
- * Resolves with a wallet once the user taps Connect. The pairing is stored (see `storage`) so
- * `restorePairing()` can reconnect after a reload without a new QR.
- */
-declare function pairBwalletX(opts: PairingOptions): Promise<PairedWallet>;
-/**
- * The wallet from a pairing stored by an earlier `pairBwalletX`, or null if there is none.
- * It connects on the first call. The wallet must still have this site paired.
- */
-declare function restorePairing(opts?: PairConnectionOptions): Promise<PairedWallet | null>;
-/** Delete the stored pairing without telling the wallet. */
-declare function clearPairing(opts?: Pick<PairConnectionOptions, 'storage' | 'storageKey'>): Promise<void>;
-
-/**
- * Browser-side payment helpers on top of the BRC-100 wallet's createAction. Works with any
- * BRC-100 wallet. Each helper asks the wallet once; it never retries a spend. If a call fails
- * the error says whether the wallet may have sent anything (`maybeSent`).
- */
-
-/** BRC-29 payment protocol id. */
-declare const BRC29_PROTOCOL: [2, string];
-type PayTo = string;
-interface PayOutput {
-    /** Locking script hex. */
-    script: string;
-    satoshis: number;
-    description?: string;
-}
-interface PayRequest {
-    to: PayTo;
-    /** Amount in satoshis. Give this or `usd`. */
-    sats?: number;
-    /** Amount in US dollars, converted at `usdPerBsv` (or the live WhatsOnChain rate). */
-    usd?: number;
-    /** Shown in the wallet and, with `memoOnChain`, written in an OP_RETURN output. */
-    memo?: string;
-    memoOnChain?: boolean;
-    /** Labels for the wallet's history. */
-    labels?: string[];
-}
-interface PayOptions {
-    /** Fixed rate for `usd`. Otherwise fetched from WhatsOnChain. */
-    usdPerBsv?: number | (() => Promise<number>);
-    /** Resolve a paymail to outputs. Default: bsvalias P2P payment destination (needs CORS on the paymail host). */
-    resolvePaymail?: (paymail: string, sats: number) => Promise<{
-        outputs: PayOutput[];
-        reference?: string;
-        submit?: (rawTxHex: string) => Promise<void>;
-    }>;
-    fetch?: typeof fetch;
-}
-interface Brc29Remittance {
-    senderIdentityKey: string;
-    derivationPrefix: string;
-    derivationSuffix: string;
-    outputIndex: number;
-}
-interface PayResult {
-    txid: string;
-    /** Atomic BEEF (BRC-95) if the wallet returned it. Send it to your server's verifyPayment. */
-    tx?: number[];
-    sats: number;
-    outputs: PayOutput[];
-    /** For an identity-key payment: what the recipient needs to internalize the output (BRC-29). Deliver it to them. */
-    remittance?: Brc29Remittance;
-}
-type PaymentErrorCode = 'BAD_REQUEST' | 'RESOLVE_FAILED' | 'RATE_FAILED' | 'WALLET_REJECTED' | 'WALLET_ERROR' | 'NOT_SUPPORTED';
-declare class PaymentError extends Error {
-    readonly code: PaymentErrorCode;
-    /** true when the wallet was asked to spend and the outcome is unknown. Check before trying again. */
-    readonly maybeSent: boolean;
-    readonly cause?: unknown | undefined;
-    constructor(code: PaymentErrorCode, message: string, 
-    /** true when the wallet was asked to spend and the outcome is unknown. Check before trying again. */
-    maybeSent?: boolean, cause?: unknown | undefined);
-}
-/** A wallet that is not BRC-100 (the HandCash transitional adapter) can still pay through this. */
-interface LegacyPayer {
-    pay(req: PayRequest & {
-        sats: number;
-    }): Promise<PayResult>;
-}
-type PaySource = WalletInterface | LegacyPayer;
-declare const isIdentityKeyHex: (s: string) => boolean;
-declare const isPaymail: (s: string) => boolean;
-/** Satoshis for a request (sats as given, or usd converted, rounded up). */
-declare function amountInSats(req: Pick<PayRequest, 'sats' | 'usd'>, o?: PayOptions): Promise<number>;
-/** Default paymail resolver: bsvalias P2P Payment Destination (BRC-? / capability 2a40af698840). */
-declare function resolvePaymailP2P(paymail: string, sats: number, f?: typeof fetch): Promise<{
-    outputs: {
-        script: string;
-        satoshis: number;
-    }[];
-    reference: string | undefined;
-    submit: ((hex: string) => Promise<void>) | undefined;
-}>;
-/** Pay a paymail, address or identity key. One wallet prompt; never retried. */
-declare function pay(source: PaySource, req: PayRequest, o?: PayOptions): Promise<PayResult>;
-/** pay() labelled as a tip. */
-declare function tip(source: PaySource, req: PayRequest, o?: PayOptions): Promise<PayResult>;
-interface TokenQuote {
-    /** Outputs to fund, as your server priced them (e.g. payment to the seller + fee). */
-    outputs: PayOutput[];
-    description?: string;
-    /** Called with the result after the wallet signs; e.g. POST txid + tx to your server for verifyPayment. */
-    onPaid?: (r: PayResult) => Promise<void> | void;
-}
-interface BuyTokenRequest {
-    token: string;
-    amount: number | string;
-    /** The hook point: return the outputs for this purchase (usually from your server). */
-    quote: (req: {
-        token: string;
-        amount: number | string;
-    }) => Promise<TokenQuote>;
-    labels?: string[];
-}
-/** Buy a token: your `quote` hook prices it, the wallet pays once, `onPaid` delivers it. */
-declare function buyToken(source: PaySource, req: BuyTokenRequest): Promise<PayResult>;
-
-/**
- * Every wallet the user could connect with, behind one interface. BRC-100 first: bWalletX, then any
- * other wallet that announces itself (Yours, Metanet, ...), the in-app browser, optional localhost
- * desktop wallets, phone pairing, and app-supplied adapters (e.g. the transitional HandCash one).
- */
-
-type WalletKind = 'brc100' | 'pairing' | 'handcash' | 'custom';
-interface ConnectedWallet {
-    /** The BRC-100 wallet. null for a non-BRC-100 adapter (HandCash today). */
-    wallet: WalletInterface | null;
-    /** What pay/tip use: the BRC-100 wallet, or the adapter's own payer. */
-    payer: PaySource | null;
-    /** The identity public key (hex) when the wallet has one. */
-    identityKey: string | null;
-    handle?: string;
-    paymail?: string;
-    /** Which option connected. */
-    optionId: string;
-    kind: WalletKind;
-    /** True for adapters kept only until the vendor ships BRC-100. */
-    transitional?: boolean;
-}
-interface WalletOption {
-    id: string;
-    name: string;
-    icon?: string;
-    kind: WalletKind;
-    rdns?: string;
-    /** True for bWalletX (extension, in-app or paired). */
-    isBwalletX: boolean;
-    connect(): Promise<ConnectedWallet>;
-}
-/** Wrap any BRC-100 wallet as a picker option. */
-declare function brc100Option(wallet: WalletInterface, info: {
-    id: string;
-    name: string;
-    icon?: string;
-    rdns?: string;
-    isBwalletX?: boolean;
-}): WalletOption;
-/** Phone / web.bwalletx.com pairing as an option (shows a QR through `pairing`). Reuses a stored pairing first. */
-declare function pairingOption(pairing: PairingOptions | (() => PairingOptions)): WalletOption;
-interface HandCashAdapterOptions {
-    /**
-     * Your existing HandCash Connect login (redirect/popup + your server route). Resolve with the
-     * profile once the user is signed in. This package does not import any HandCash SDK.
-     */
-    login(): Promise<{
-        handle: string;
-        paymail?: string;
-        identityKey?: string;
-    }>;
-    /** Your existing HandCash pay call (usually a server route using the auth token). Optional. */
-    pay?: Extract<PaySource, {
-        pay: unknown;
-    }>['pay'];
-    icon?: string;
-}
-/**
- * TRANSITIONAL. Keeps existing HandCash users working behind the same picker until HandCash's
- * BRC-100 support ships; then remove this and HandCash appears as an ordinary BRC-100 wallet.
- */
-declare function handcashAdapter(o: HandCashAdapterOptions): WalletOption;
-interface DiscoverWalletsOptions {
-    /** Longest wait for BRC-100 announcements, ms. Default 300; ends early once a wallet has announced. */
-    ms?: number;
-    /**
-     * Also probe desktop wallets on localhost (Metanet / json-api on 3321, Cicada on 3301).
-     * Off by default: some browsers prompt for local-network access.
-     */
-    probeLocal?: boolean;
-    /** Add the phone pairing option (needs a way to show the QR, e.g. pairingModal()). */
-    pairing?: PairingOptions | (() => PairingOptions);
-    /** App-supplied options appended at the end (e.g. handcashAdapter(...)). */
-    extra?: WalletOption[];
-}
-/** All wallets we can see, bWalletX first. SSR-safe: resolves [] (plus `extra`) outside a browser. */
-declare function discoverWallets(o?: DiscoverWalletsOptions): Promise<WalletOption[]>;
-
-export { restorePairing as A, type BuyTokenRequest as B, type ConnectedWallet as C, type DiscoverWalletsOptions as D, tip as E, type HandCashAdapterOptions as H, type LegacyPayer as L, type PayRequest as P, type SocketFactory as S, type TokenQuote as T, type WalletOption as W, type PayResult as a, type PayOptions as b, PaymentError as c, brc100Option as d, discoverWallets as e, type PairingOptions as f, BRC29_PROTOCOL as g, handcashAdapter as h, type Brc29Remittance as i, type PairConnectionOptions as j, type PairStorage as k, type PairedWallet as l, type PayOutput as m, type PaySource as n, type PaymentErrorCode as o, pairingOption as p, type SocketLike as q, type WalletKind as r, amountInSats as s, buyToken as t, clearPairing as u, isIdentityKeyHex as v, isPaymail as w, pairBwalletX as x, pay as y, resolvePaymailP2P as z };