@breeztech/breez-sdk-spark 0.15.1 → 0.16.1-dev1

package/web/breez_sdk_spark_wasm_bg.wasm.d.ts

@@ -3,13 +3,13 @@
 export const memory: WebAssembly.Memory;
 export const __wbg_bitcoinchainservicehandle_free: (a: number, b: number) => void;
 export const __wbg_breezsdk_free: (a: number, b: number) => void;
-export const __wbg_defaultsigner_free: (a: number, b: number) => void;
-export const __wbg_mysqlconnectionpool_free: (a: number, b: number) => void;
-export const __wbg_passkey_free: (a: number, b: number) => void;
-export const __wbg_postgresconnectionpool_free: (a: number, b: number) => void;
+export const __wbg_externalsigners_free: (a: number, b: number) => void;
+export const __wbg_passkeyclient_free: (a: number, b: number) => void;
+export const __wbg_passkeylabels_free: (a: number, b: number) => void;
 export const __wbg_sdkbuilder_free: (a: number, b: number) => void;
 export const __wbg_tokenissuer_free: (a: number, b: number) => void;
 export const __wbg_wasmsdkcontext_free: (a: number, b: number) => void;
+export const __wbg_wasmstorageconfig_free: (a: number, b: number) => void;
 export const bitcoinchainservicehandle_broadcastTransaction: (a: number, b: number, c: number) => any;
 export const bitcoinchainservicehandle_getAddressUtxos: (a: number, b: number, c: number) => any;
 export const bitcoinchainservicehandle_getTransactionHex: (a: number, b: number, c: number) => any;
@@ -17,18 +17,18 @@ export const bitcoinchainservicehandle_getTransactionStatus: (a: number, b: numb
 export const bitcoinchainservicehandle_recommendedFees: (a: number) => any;
 export const breezsdk_addContact: (a: number, b: any) => any;
 export const breezsdk_addEventListener: (a: number, b: any) => any;
+export const breezsdk_authorizeLightningAddressTransfer: (a: number, b: any) => any;
 export const breezsdk_buyBitcoin: (a: number, b: any) => any;
-export const breezsdk_cancelLeafOptimization: (a: number) => any;
 export const breezsdk_checkLightningAddressAvailable: (a: number, b: any) => any;
 export const breezsdk_checkMessage: (a: number, b: any) => any;
 export const breezsdk_claimDeposit: (a: number, b: any) => any;
 export const breezsdk_claimHtlcPayment: (a: number, b: any) => any;
+export const breezsdk_claimLightningAddressTransfer: (a: number, b: any) => any;
 export const breezsdk_deleteContact: (a: number, b: number, c: number) => any;
 export const breezsdk_deleteLightningAddress: (a: number) => any;
 export const breezsdk_disconnect: (a: number) => any;
 export const breezsdk_fetchConversionLimits: (a: number, b: any) => any;
 export const breezsdk_getInfo: (a: number, b: any) => any;
-export const breezsdk_getLeafOptimizationProgress: (a: number) => any;
 export const breezsdk_getLightningAddress: (a: number) => any;
 export const breezsdk_getPayment: (a: number, b: any) => any;
 export const breezsdk_getTokenIssuer: (a: number) => number;
@@ -43,6 +43,7 @@ export const breezsdk_listWebhooks: (a: number) => any;
 export const breezsdk_lnurlAuth: (a: number, b: any) => any;
 export const breezsdk_lnurlPay: (a: number, b: any) => any;
 export const breezsdk_lnurlWithdraw: (a: number, b: any) => any;
+export const breezsdk_optimizeLeaves: (a: number, b: any) => any;
 export const breezsdk_parse: (a: number, b: number, c: number) => any;
 export const breezsdk_prepareLnurlPay: (a: number, b: any) => any;
 export const breezsdk_prepareSendPayment: (a: number, b: any) => any;
@@ -55,65 +56,71 @@ export const breezsdk_registerWebhook: (a: number, b: any) => any;
 export const breezsdk_removeEventListener: (a: number, b: number, c: number) => any;
 export const breezsdk_sendPayment: (a: number, b: any) => any;
 export const breezsdk_signMessage: (a: number, b: any) => any;
-export const breezsdk_startLeafOptimization: (a: number) => any;
 export const breezsdk_syncWallet: (a: number, b: any) => any;
 export const breezsdk_unregisterWebhook: (a: number, b: any) => any;
 export const breezsdk_updateContact: (a: number, b: any) => any;
 export const breezsdk_updateUserSettings: (a: number, b: any) => any;
 export const connect: (a: any) => any;
-export const connectWithSigner: (a: any, b: any, c: number, d: number) => any;
-export const createMysqlConnectionPool: (a: any) => [number, number, number];
-export const createPostgresConnectionPool: (a: any) => [number, number, number];
+export const connectWithSigner: (a: any, b: any, c: any, d: number, e: number) => any;
+export const createTurnkeySigner: (a: any) => any;
 export const defaultConfig: (a: any) => any;
-export const defaultExternalSigner: (a: number, b: number, c: number, d: number, e: any, f: number) => [number, number, number];
+export const defaultExternalSigners: (a: number, b: number, c: number, d: number, e: any, f: number) => [number, number, number];
 export const defaultMysqlStorageConfig: (a: number, b: number) => any;
 export const defaultPostgresStorageConfig: (a: number, b: number) => any;
 export const defaultServerConfig: (a: any) => any;
-export const defaultsigner_aggregateFrost: (a: number, b: any) => any;
-export const defaultsigner_decryptEcies: (a: number, b: number, c: number, d: number, e: number) => any;
-export const defaultsigner_derivePublicKey: (a: number, b: number, c: number) => any;
-export const defaultsigner_encryptEcies: (a: number, b: number, c: number, d: number, e: number) => any;
-export const defaultsigner_encryptPrivateKeyForReceiver: (a: number, b: any, c: any) => any;
-export const defaultsigner_generateRandomSecret: (a: number) => any;
-export const defaultsigner_generateRandomSigningCommitment: (a: number) => any;
-export const defaultsigner_getPublicKeyForNode: (a: number, b: any) => any;
-export const defaultsigner_hmacSha256: (a: number, b: number, c: number, d: number, e: number) => any;
-export const defaultsigner_identityPublicKey: (a: number) => [number, number, number];
-export const defaultsigner_publicKeyFromSecret: (a: number, b: any) => any;
-export const defaultsigner_signEcdsa: (a: number, b: any, c: number, d: number) => any;
-export const defaultsigner_signEcdsaRecoverable: (a: number, b: any, c: number, d: number) => any;
-export const defaultsigner_signFrost: (a: number, b: any) => any;
-export const defaultsigner_signHashSchnorr: (a: number, b: number, c: number, d: number, e: number) => any;
-export const defaultsigner_splitSecretWithProofs: (a: number, b: any, c: number, d: number) => any;
-export const defaultsigner_staticDepositSecret: (a: number, b: number) => any;
-export const defaultsigner_staticDepositSecretEncrypted: (a: number, b: number) => any;
-export const defaultsigner_staticDepositSigningKey: (a: number, b: number) => any;
-export const defaultsigner_subtractSecrets: (a: number, b: any, c: any) => any;
+export const defaultStorage: (a: number, b: number) => number;
+export const externalbreezsignerhandle_decryptEcies: (a: number, b: number, c: number, d: number, e: number) => any;
+export const externalbreezsignerhandle_derivePublicKey: (a: number, b: number, c: number) => any;
+export const externalbreezsignerhandle_encryptEcies: (a: number, b: number, c: number, d: number, e: number) => any;
+export const externalbreezsignerhandle_hmacSha256: (a: number, b: number, c: number, d: number, e: number) => any;
+export const externalbreezsignerhandle_signEcdsa: (a: number, b: any, c: number, d: number) => any;
+export const externalbreezsignerhandle_signEcdsaRecoverable: (a: number, b: any, c: number, d: number) => any;
+export const externalbreezsignerhandle_signHashSchnorr: (a: number, b: number, c: number, d: number, e: number) => any;
+export const externalsigners_breezSigner: (a: number) => number;
+export const externalsigners_sparkSigner: (a: number) => number;
+export const externalsparksignerhandle_getIdentityPublicKey: (a: number) => any;
+export const externalsparksignerhandle_getPublicKeyForLeaf: (a: number, b: any) => any;
+export const externalsparksignerhandle_getStaticDepositPublicKey: (a: number, b: number) => any;
+export const externalsparksignerhandle_prepareClaim: (a: number, b: any) => any;
+export const externalsparksignerhandle_prepareLightningReceive: (a: number, b: any) => any;
+export const externalsparksignerhandle_prepareStaticDeposit: (a: number, b: any) => any;
+export const externalsparksignerhandle_prepareStaticDepositClaim: (a: number, b: any) => any;
+export const externalsparksignerhandle_prepareTokenTransaction: (a: number, b: any) => any;
+export const externalsparksignerhandle_prepareTransfer: (a: number, b: any) => any;
+export const externalsparksignerhandle_signAuthenticationChallenge: (a: number, b: number, c: number) => any;
+export const externalsparksignerhandle_signFrost: (a: number, b: number, c: number) => any;
+export const externalsparksignerhandle_signMessage: (a: number, b: number, c: number) => any;
+export const externalsparksignerhandle_signSparkInvoice: (a: number, b: any) => any;
+export const externalsparksignerhandle_signStaticDepositRefund: (a: number, b: any) => any;
+export const externalsparksignerhandle_startStaticDepositRefund: (a: number, b: any) => any;
 export const getSparkStatus: () => any;
 export const initLogging: (a: any, b: number, c: number) => any;
+export const mysqlStorage: (a: any) => number;
 export const newRestChainService: (a: number, b: number, c: any, d: any, e: number) => any;
 export const newSharedSdkContext: (a: any) => any;
-export const passkey_getWallet: (a: number, b: number, c: number) => any;
-export const passkey_isAvailable: (a: number) => any;
-export const passkey_listLabels: (a: number) => any;
-export const passkey_new: (a: any, b: number) => number;
-export const passkey_storeLabel: (a: number, b: number, c: number) => any;
+export const passkeyclient_checkAvailability: (a: number) => any;
+export const passkeyclient_labels: (a: number) => number;
+export const passkeyclient_new: (a: any, b: number, c: number, d: number) => number;
+export const passkeyclient_register: (a: number, b: any) => any;
+export const passkeyclient_signIn: (a: number, b: any) => any;
+export const passkeylabels_list: (a: number) => any;
+export const passkeylabels_store: (a: number, b: number, c: number) => any;
+export const postgresStorage: (a: any) => number;
 export const sdkbuilder_build: (a: number) => any;
 export const sdkbuilder_new: (a: any, b: any) => number;
-export const sdkbuilder_newWithSigner: (a: any, b: any) => number;
+export const sdkbuilder_newWithSigner: (a: any, b: any, c: any) => number;
+export const sdkbuilder_withAccountNumber: (a: number, b: number) => number;
 export const sdkbuilder_withChainService: (a: number, b: any) => number;
 export const sdkbuilder_withDefaultStorage: (a: number, b: number, c: number) => any;
 export const sdkbuilder_withFiatService: (a: number, b: any) => number;
-export const sdkbuilder_withKeySet: (a: number, b: any) => number;
 export const sdkbuilder_withLnurlClient: (a: number, b: any) => number;
 export const sdkbuilder_withMysqlBackend: (a: number, b: any) => [number, number, number];
-export const sdkbuilder_withMysqlConnectionPool: (a: number, b: number) => number;
 export const sdkbuilder_withPaymentObserver: (a: number, b: any) => number;
 export const sdkbuilder_withPostgresBackend: (a: number, b: any) => [number, number, number];
-export const sdkbuilder_withPostgresConnectionPool: (a: number, b: number) => number;
 export const sdkbuilder_withRestChainService: (a: number, b: number, c: number, d: any, e: number) => number;
 export const sdkbuilder_withSharedContext: (a: number, b: number) => number;
 export const sdkbuilder_withStorage: (a: number, b: any) => number;
+export const sdkbuilder_withStorageBackend: (a: number, b: number) => number;
 export const tokenissuer_burnIssuerToken: (a: number, b: any) => any;
 export const tokenissuer_createIssuerToken: (a: number, b: any) => any;
 export const tokenissuer_freezeIssuerToken: (a: number, b: any) => any;
@@ -139,16 +146,18 @@ export const intounderlyingsink_close: (a: number) => any;
 export const intounderlyingsink_write: (a: number, b: any) => any;
 export const intounderlyingsource_cancel: (a: number) => void;
 export const intounderlyingsource_pull: (a: number, b: any) => any;
-export const wasm_bindgen__convert__closures_____invoke__h013a98c02f3b4b21: (a: number, b: number, c: any) => [number, number];
-export const wasm_bindgen__convert__closures_____invoke__h013a98c02f3b4b21_4: (a: number, b: number, c: any) => [number, number];
-export const wasm_bindgen__convert__closures_____invoke__h013a98c02f3b4b21_5: (a: number, b: number, c: any) => [number, number];
-export const wasm_bindgen__convert__closures_____invoke__h013a98c02f3b4b21_6: (a: number, b: number, c: any) => [number, number];
-export const wasm_bindgen__convert__closures_____invoke__h013a98c02f3b4b21_7: (a: number, b: number, c: any) => [number, number];
+export const __wbg_externalbreezsignerhandle_free: (a: number, b: number) => void;
+export const __wbg_externalsparksignerhandle_free: (a: number, b: number) => void;
+export const wasm_bindgen__convert__closures_____invoke__h4bd7a023e323559c: (a: number, b: number, c: any) => [number, number];
+export const wasm_bindgen__convert__closures_____invoke__h4bd7a023e323559c_4: (a: number, b: number, c: any) => [number, number];
+export const wasm_bindgen__convert__closures_____invoke__h4bd7a023e323559c_5: (a: number, b: number, c: any) => [number, number];
+export const wasm_bindgen__convert__closures_____invoke__h4bd7a023e323559c_6: (a: number, b: number, c: any) => [number, number];
+export const wasm_bindgen__convert__closures_____invoke__h4bd7a023e323559c_7: (a: number, b: number, c: any) => [number, number];
 export const wasm_bindgen__convert__closures_____invoke__h41057d61edf43a32: (a: number, b: number, c: any, d: any) => void;
 export const wasm_bindgen__convert__closures_____invoke__h4819aba3eed2db57: (a: number, b: number, c: any) => void;
 export const wasm_bindgen__convert__closures_____invoke__h4819aba3eed2db57_2: (a: number, b: number, c: any) => void;
 export const wasm_bindgen__convert__closures_____invoke__h4819aba3eed2db57_3: (a: number, b: number, c: any) => void;
-export const wasm_bindgen__convert__closures_____invoke__h124479769cd429fd: (a: number, b: number) => void;
+export const wasm_bindgen__convert__closures_____invoke__h484cd36e13f37bd7: (a: number, b: number) => void;
 export const __wbindgen_malloc: (a: number, b: number) => number;
 export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_free: (a: number, b: number, c: number) => void;

package/web/passkey-prf-provider/index.d.ts

@@ -0,0 +1,203 @@
+import { PasskeyClient as SdkPasskeyClient } from '../breez_sdk_spark_wasm.js';
+import type {
+    PasskeyConfig,
+    PasskeyProviderOptions,
+    PrfProvider,
+    PasskeyCredential,
+    DeriveSeedsResult,
+    DeriveSeedOptions
+} from '../breez_sdk_spark_wasm.js';
+
+export type { PasskeyCredential, DeriveSeedsResult, DeriveSeedOptions, PasskeyProviderOptions };
+
+/**
+ * Outcome of a domain-association check: whether `rpId` is a valid
+ * WebAuthn scope for the current origin.
+ */
+export type DomainAssociation =
+    | { kind: 'Associated' }
+    | { kind: 'NotAssociated'; source: string; reason: string }
+    | { kind: 'Skipped'; reason: string };
+
+/**
+ * Thrown by `createPasskey` when an entry in `excludeCredentials`
+ * matches a credential already on the device. Route the user to
+ * sign-in rather than treating it as a generic registration failure.
+ */
+export declare class PasskeyAlreadyExistsError extends Error {
+    constructor(message?: string);
+}
+
+/**
+ * Thrown when the OS biometric prompt times out (around 55s) before
+ * any user interaction. Distinct from a cancel: hosts may auto-retry
+ * since the user did not deliberately abandon the flow.
+ */
+export declare class PasskeyTimedOutError extends Error {
+    constructor(message?: string);
+}
+
+/**
+ * Thrown when `deriveSeeds` cannot match a credential for this RP on
+ * the device. `message` carries diagnostic detail.
+ */
+export declare class PasskeyCredentialNotFoundError extends Error {
+    constructor(message?: string);
+}
+
+/**
+ * Thrown when the user actively dismisses the OS passkey prompt.
+ * Distinct from `PasskeyTimedOutError`: hosts should not auto-retry a
+ * deliberate cancel.
+ */
+export declare class PasskeyUserCancelledError extends Error {
+    constructor(message?: string);
+}
+
+/**
+ * Web-only options for the built-in {@link PasskeyProvider}, passed as the
+ * second constructor argument. The cross-platform Relying Party / user
+ * fields live on {@link PasskeyProviderOptions} (the first argument), and
+ * are also settable on `PasskeyConfig` for the zero-config client.
+ */
+export interface PasskeyProviderWebOptions {
+    /**
+     * Narrows the create-time chooser to one authenticator class.
+     * `'platform'` allows only the local authenticator (Touch ID, Face
+     * ID, Windows Hello, iCloud Keychain); `'cross-platform'` only
+     * roaming keys (USB, NFC, BLE, hybrid). Unset shows all.
+     */
+    authenticatorAttachment?: 'platform' | 'cross-platform';
+
+    /**
+     * WebAuthn L3 priority hints applied to both create and get,
+     * ordering the authenticator classes a supporting browser offers
+     * first (ignored otherwise). Pass `['client-device']` to favor the
+     * platform authenticator. This is the only standards-track lever for
+     * the sign-in picker, where `authenticatorAttachment` is not allowed.
+     */
+    hints?: ('client-device' | 'security-key' | 'hybrid')[];
+
+    /**
+     * Default WebAuthn `timeout` (ms) for every create and get. A hint
+     * only: platforms cap around 60s. Set it 5 to 10s under the cap so a
+     * host-side "looks like a timeout" heuristic can fire before the OS
+     * tears the prompt down. Unset uses the platform default.
+     */
+    defaultTimeoutMs?: number;
+}
+
+/**
+ * Built-in browser PRF provider: implements `PrfProvider` over the
+ * WebAuthn PRF extension, using discoverable credentials so no
+ * credential storage is needed.
+ *
+ * @example
+ * ```typescript
+ * import { PasskeyClient } from '@breeztech/breez-sdk-spark'
+ * import { PasskeyProvider } from '@breeztech/breez-sdk-spark/passkey-prf-provider'
+ *
+ * const provider = new PasskeyProvider()
+ * const client = new PasskeyClient(provider)
+ * const { wallet } = await client.signIn({ label: 'personal' })
+ * ```
+ */
+export declare class PasskeyProvider {
+    /**
+     * Breez's shared `keys.breez.technology` RP. Pass as `rpId` to opt
+     * in (Breez-registered apps only); other apps pass their own domain.
+     */
+    static readonly BREEZ_RP_ID: string;
+
+    /**
+     * Default `rpName` for the zero-config {@link PasskeyClient} /
+     * {@link PasskeyClientBuilder} path.
+     */
+    static readonly DEFAULT_RP_NAME: string;
+
+    constructor(options?: PasskeyProviderOptions, webOptions?: PasskeyProviderWebOptions);
+
+    /**
+     * Derive one 32-byte PRF output per salt (in input order), pairing
+     * salts into a single ceremony where the authenticator supports it.
+     * Worst case is one prompt per salt.
+     *
+     * @throws If authentication fails, PRF is not supported, or the user cancels.
+     */
+    deriveSeeds(salts: string[], options?: DeriveSeedOptions): Promise<DeriveSeedsResult>;
+
+    /**
+     * Create a new PRF-capable passkey. Pass `excludeCredentials`
+     * (already-registered IDs) to prevent re-registering the same
+     * device. The `user.id` is provider-minted and returned as `userId`.
+     *
+     * @throws {PasskeyAlreadyExistsError} If an entry in
+     *   `excludeCredentials` already exists on the device.
+     * @throws If the user cancels or PRF is not supported.
+     */
+    createPasskey(excludeCredentials?: Uint8Array[]): Promise<PasskeyCredential>;
+
+    /**
+     * Check if a PRF-capable passkey is available on this device.
+     *
+     * @returns true if WebAuthn with PRF extension is likely supported.
+     */
+    isSupported(): Promise<boolean>;
+
+    /**
+     * Check whether the configured `rpId` is a valid WebAuthn scope for
+     * the current origin (must be a registrable suffix of
+     * `window.location.hostname`, or equal to it). Mirrors the browser's
+     * own rule so a misconfigured `rpId` is diagnosed with a concrete
+     * reason instead of an opaque `SecurityError` at ceremony time.
+     *
+     * @returns `Associated` when in scope, `NotAssociated` with a reason
+     *   when not, or `Skipped` when no `window.location` is available.
+     */
+    checkDomainAssociation(): Promise<DomainAssociation>;
+}
+
+/**
+ * Builder for a {@link PasskeyClient} with a caller-supplied
+ * `PrfProvider`. Use it when you need a configured {@link PasskeyProvider}
+ * (custom `rpId`/`rpName`, timeout overrides) or a custom PRF backend.
+ * For the zero-config Breez-RP case, use the {@link PasskeyClient}
+ * constructor directly.
+ */
+export declare class PasskeyClientBuilder {
+    /**
+     * @param breezApiKey - Breez relay key for authenticated (NIP-42)
+     *   label storage. Omit for public relays only.
+     * @param config - `rpId` / `rpName` configure the built-in provider
+     *   (ignored when one is injected via {@link withPrfProvider});
+     *   `defaultLabel` is the label-store default.
+     */
+    constructor(breezApiKey?: string, config?: PasskeyConfig);
+
+    /** Inject the `PrfProvider` the client derives seeds through. */
+    withPrfProvider(provider: PrfProvider): PasskeyClientBuilder;
+
+    /**
+     * Build the client, defaulting to a browser {@link PasskeyProvider}
+     * on the Breez RP when no provider was injected.
+     */
+    build(): SdkPasskeyClient;
+}
+
+/**
+ * High-level passkey client. The zero-config constructor wires the
+ * built-in browser {@link PasskeyProvider} on the Breez shared RP, so a
+ * Breez-registered app needs only its relay key. Apps with their own RP
+ * or a custom PRF backend inject their own provider through
+ * {@link PasskeyClientBuilder}. The instance is the underlying SDK client
+ * (`checkAvailability`, `register`, `signIn`, `labels()`).
+ */
+export declare class PasskeyClient extends SdkPasskeyClient {
+    /**
+     * @param breezApiKey - Breez relay key for authenticated (NIP-42)
+     *   label storage. Omit for public relays only.
+     * @param config - Optional `rpId` / `rpName` for the built-in
+     *   provider (default: the Breez shared RP) plus `defaultLabel`.
+     */
+    constructor(breezApiKey?: string, config?: PasskeyConfig);
+}