@buildonspark/spark-sdk 0.3.8 → 0.4.0

package/dist/{wallet-config-BoyMVa6n.d.ts → wallet-config-Bg3kWltL.d.ts}

@@ -1,7 +1,7 @@
-import { B as BitcoinNetwork, H as HasSspClientOptions, S as SparkSigner, t as SspClientOptions, l as KeyDerivation, i as SigningCommitmentWithOptionalNonce, V as VerifiableSecretShare, D as DefaultSparkSigner, L as LeavesSwapFeeEstimateOutput, u as StaticDepositQuoteOutput, C as ClaimStaticDepositOutput, W as WalletLeaf, w as WalletTransfer, x as LightningReceiveRequest, y as LightningSendRequest, z as LightningSendFeeEstimateInput, E as ExitSpeed, F as CoopExitFeeQuote, G as CoopExitRequest, I as TransferWithUserRequest, M as MayHaveSspClientOptions } from './client-By-N7oJS.js';
+import { B as BitcoinNetwork, H as HasSspClientOptions, S as SparkSigner, t as SspClientOptions, l as KeyDerivation, i as SigningCommitmentWithOptionalNonce, V as VerifiableSecretShare, D as DefaultSparkSigner, L as LeavesSwapFeeEstimateOutput, u as StaticDepositQuoteOutput, C as ClaimStaticDepositOutput, W as WalletLeaf, w as WalletTransfer, x as LightningReceiveRequest, y as LightningSendRequest, z as LightningSendFeeEstimateInput, E as ExitSpeed, F as CoopExitFeeQuote, G as CoopExitRequest, I as TransferWithUserRequest, M as MayHaveSspClientOptions } from './client-BaQf-5gD.js';
 import * as btc from '@scure/btc-signer';
 import { Transaction } from '@scure/btc-signer';
-import { N as Network$1, e as SparkInvoiceFields, b as SparkServiceDefinition, f as SparkServiceClient, d as SubscribeToEventsResponse, R as RequestedSigningCommitments, U as UserSignedTxSigningJob, c as TreeNode, T as Transfer, g as StartTransferRequest, L as LeafRefundTxSigningResult, h as NodeSignatures, F as FinalizeNodeSignaturesResponse, Q as QueryTransfersResponse, i as QuerySparkInvoicesResponse, O as OutputWithPreviousTransactionData } from './spark-By6yHsrk.js';
+import { N as Network$1, e as SparkInvoiceFields, b as SparkServiceDefinition, f as SparkServiceClient, d as SubscribeToEventsResponse, R as RequestedSigningCommitments, U as UserSignedTxSigningJob, c as TreeNode, T as Transfer, g as StartTransferRequest, L as LeafRefundTxSigningResult, h as NodeSignatures, F as FinalizeNodeSignaturesResponse, Q as QueryTransfersResponse, i as QuerySparkInvoicesResponse, O as OutputWithPreviousTransactionData } from './spark-DOpheE8_.js';
 import { SparkTokenServiceDefinition, SparkTokenServiceClient, QueryTokenTransactionsResponse, TokenMetadata } from './proto/spark_token.js';
 import * as _scure_base from '@scure/base';
 import { Channel } from 'nice-grpc';
@@ -9,6 +9,7 @@ import { CallOptions, ClientMiddleware, ClientMiddlewareCall, Metadata } from 'n
 import { Channel as Channel$1 } from 'nice-grpc-web';
 import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
 import { RetryOptions as RetryOptions$1 } from 'nice-grpc-client-middleware-retry';
+import { TransactionOutput } from '@scure/btc-signer/psbt';
 import { SpanProcessor } from '@opentelemetry/sdk-trace-base';
 import { EventEmitter } from 'eventemitter3';
 
@@ -38,15 +39,6 @@ declare function getNetworkFromAddress(address: string): BitcoinNetwork.MAINNET
  */
 declare function getNetworkFromString(network?: string): Network;
 
-type Bech32mTokenIdentifier = `btkn1${string}` | `btknrt1${string}` | `btknt1${string}` | `btkns1${string}` | `btknl1${string}`;
-interface Bech32mTokenIdentifierData {
-    tokenIdentifier: Uint8Array;
-    network: NetworkType;
-}
-declare function encodeBech32mTokenIdentifier(payload: Bech32mTokenIdentifierData): Bech32mTokenIdentifier;
-declare function decodeBech32mTokenIdentifier(bech32mTokenIdentifier: Bech32mTokenIdentifier, network?: NetworkType): Bech32mTokenIdentifierData;
-declare function getNetworkFromBech32mTokenIdentifier(bech32mTokenIdentifier: Bech32mTokenIdentifier): NetworkType;
-
 declare const AddressNetwork: Record<NetworkType, string>;
 declare const LegacyAddressNetwork: Record<NetworkType, string>;
 type Bech32String = `${string}1${string}`;
@@ -94,6 +86,15 @@ declare function assertBech32(s: string): asserts s is Bech32String;
 declare function bech32mDecode(address: string): _scure_base.Bech32Decoded<string>;
 declare function isSafeForNumber(bi: bigint): boolean;
 
+type Bech32mTokenIdentifier = `btkn1${string}` | `btknrt1${string}` | `btknt1${string}` | `btkns1${string}` | `btknl1${string}`;
+interface Bech32mTokenIdentifierData {
+    tokenIdentifier: Uint8Array;
+    network: NetworkType;
+}
+declare function encodeBech32mTokenIdentifier(payload: Bech32mTokenIdentifierData): Bech32mTokenIdentifier;
+declare function decodeBech32mTokenIdentifier(bech32mTokenIdentifier: Bech32mTokenIdentifier, network?: NetworkType): Bech32mTokenIdentifierData;
+declare function getNetworkFromBech32mTokenIdentifier(bech32mTokenIdentifier: Bech32mTokenIdentifier): NetworkType;
+
 declare class WalletConfigService implements HasSspClientOptions {
     private readonly config;
     readonly signer: SparkSigner;
@@ -117,6 +118,7 @@ declare class WalletConfigService implements HasSspClientOptions {
     getSspIdentityPublicKey(): string;
     getConsoleOptions(): ConsoleOptions;
     getEvents(): Partial<SparkWalletEvents>;
+    getOptimizationOptions(): OptimizationOptions;
 }
 
 /** Challenge represents the core challenge data */
@@ -285,6 +287,7 @@ declare class SigningService {
         directLeafSigningJobs: UserSignedTxSigningJob[];
         directFromCpfpLeafSigningJobs: UserSignedTxSigningJob[];
     }>;
+    signSigningJobs(signingJobs: (SigningJobWithOptionalNonce & RequestedSigningCommitments)[]): Promise<Map<SigningJobType, UserSignedTxSigningJob>>;
 }
 
 type LeafKeyTweak = {
@@ -305,6 +308,17 @@ type LeafRefundSigningData = {
     directFromCpfpRefundSigningNonceCommitment: SigningCommitmentWithOptionalNonce;
     vout: number;
 };
+type SigningJobType = "split" | "directSplit" | "node" | "directNode" | "cpfp" | "direct" | "directFromCpfp";
+type SigningJobWithOptionalNonce = {
+    signingPublicKey: Uint8Array;
+    rawTx: Uint8Array;
+    signingNonceCommitment: SigningCommitmentWithOptionalNonce;
+    type: SigningJobType;
+    parentTxOut: TransactionOutput;
+    leafId: string;
+    keyDerivation: KeyDerivation;
+    verifyingKey: Uint8Array;
+};
 declare class BaseTransferService {
     protected readonly config: WalletConfigService;
     protected readonly connectionManager: ConnectionManager;
@@ -357,11 +371,12 @@ declare class TransferService extends BaseTransferService {
     claimTransferSignRefunds(transfer: Transfer, leafKeys: LeafKeyTweak[], proofMap?: Map<string, Uint8Array[]>): Promise<NodeSignatures[]>;
     private finalizeNodeSignatures;
     queryPendingTransfersBySender(operatorAddress: string): Promise<QueryTransfersResponse>;
-    private refreshTimelockNodesInternal;
-    refreshTimelockNodes(node: TreeNode, parentNode: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
-    extendTimelock(node: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
-    testonly_expireTimeLockNodeTx(node: TreeNode, parentNode: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
-    testonly_expireTimeLockRefundtx(node: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
+    renewRefundTxn(node: TreeNode, parentNode: TreeNode): Promise<TreeNode>;
+    renewNodeTxn(node: TreeNode, parentNode: TreeNode): Promise<TreeNode>;
+    private createRenewRefundSigningJobs;
+    private createRenewNodeSigningJobs;
+    renewZeroTimelockNodeTxn(node: TreeNode): Promise<TreeNode>;
+    private createRenewZeroTimelockNodeSigningJobs;
 }
 
 /**
@@ -401,13 +416,15 @@ declare abstract class SparkWallet extends EventEmitter<SparkWalletEvents> {
     private handleStreamEvent;
     protected setupBackgroundStream(): Promise<void>;
     getLeaves(isBalanceCheck?: boolean): Promise<TreeNode[]>;
-    private checkExtendLeaves;
     private verifyKey;
     private popOrThrow;
     private selectLeaves;
     private selectLeavesForSwap;
-    private areLeavesInefficient;
-    private optimizeLeaves;
+    optimizeLeaves(multiplicity?: number | undefined): AsyncGenerator<{
+        step: number;
+        total: number;
+        controller: AbortController;
+    }, void, void>;
     private syncWallet;
     private withLeaves;
     /**
@@ -712,15 +729,7 @@ declare abstract class SparkWallet extends EventEmitter<SparkWalletEvents> {
     private transferWithInvoice;
     private buildTweaksByAmount;
     private toSendTweak;
-    private checkExtendTimeLockNodes;
-    /**
-     * Internal method to refresh timelock nodes.
-     *
-     * @param {string} nodeId - The optional ID of the node to refresh. If not provided, all nodes will be checked.
-     * @returns {Promise<void>}
-     * @private
-     */
-    private checkRefreshTimelockNodes;
+    private checkRenewLeaves;
     private claimTransferCore;
     private processClaimedTransferResults;
     /**
@@ -959,13 +968,6 @@ declare abstract class SparkWallet extends EventEmitter<SparkWalletEvents> {
         nodeTimelock: number;
         refundTimelock: number;
     }>;
-    /**
-     * Refresh the timelock of a specific node.
-     *
-     * @param {string} nodeId - The ID of the node to refresh
-     * @returns {Promise<void>} Promise that resolves when the timelock is refreshed
-     */
-    testOnly_expireTimelock(nodeId: string): Promise<void>;
     private cleanup;
     cleanupConnections(): Promise<void>;
     private startPeriodicClaimTransfers;
@@ -1143,6 +1145,10 @@ type SigningOperator = {
 type ConsoleOptions = {
     otel?: boolean;
 };
+type OptimizationOptions = {
+    readonly auto?: boolean;
+    readonly multiplicity?: number;
+};
 type ConfigOptions = MayHaveSspClientOptions & {
     readonly network?: NetworkType;
     readonly signingOperators?: Readonly<Record<string, SigningOperator>>;
@@ -1158,6 +1164,7 @@ type ConfigOptions = MayHaveSspClientOptions & {
     readonly signerWithPreExistingKeys?: boolean;
     readonly console?: ConsoleOptions;
     readonly events?: Partial<SparkWalletEvents>;
+    readonly optimizationOptions?: OptimizationOptions;
 };
 declare const WalletConfig: {
     LOCAL: Required<ConfigOptions>;

package/dist/{wallet-config-xom-9UFF.d.cts → wallet-config-CuZKNo9S.d.cts}

@@ -1,7 +1,7 @@
-import { B as BitcoinNetwork, H as HasSspClientOptions, S as SparkSigner, t as SspClientOptions, l as KeyDerivation, i as SigningCommitmentWithOptionalNonce, V as VerifiableSecretShare, D as DefaultSparkSigner, L as LeavesSwapFeeEstimateOutput, u as StaticDepositQuoteOutput, C as ClaimStaticDepositOutput, W as WalletLeaf, w as WalletTransfer, x as LightningReceiveRequest, y as LightningSendRequest, z as LightningSendFeeEstimateInput, E as ExitSpeed, F as CoopExitFeeQuote, G as CoopExitRequest, I as TransferWithUserRequest, M as MayHaveSspClientOptions } from './client-pNpGP15j.cjs';
+import { B as BitcoinNetwork, H as HasSspClientOptions, S as SparkSigner, t as SspClientOptions, l as KeyDerivation, i as SigningCommitmentWithOptionalNonce, V as VerifiableSecretShare, D as DefaultSparkSigner, L as LeavesSwapFeeEstimateOutput, u as StaticDepositQuoteOutput, C as ClaimStaticDepositOutput, W as WalletLeaf, w as WalletTransfer, x as LightningReceiveRequest, y as LightningSendRequest, z as LightningSendFeeEstimateInput, E as ExitSpeed, F as CoopExitFeeQuote, G as CoopExitRequest, I as TransferWithUserRequest, M as MayHaveSspClientOptions } from './client-BIqiUNy4.cjs';
 import * as btc from '@scure/btc-signer';
 import { Transaction } from '@scure/btc-signer';
-import { N as Network$1, e as SparkInvoiceFields, b as SparkServiceDefinition, f as SparkServiceClient, d as SubscribeToEventsResponse, R as RequestedSigningCommitments, U as UserSignedTxSigningJob, c as TreeNode, T as Transfer, g as StartTransferRequest, L as LeafRefundTxSigningResult, h as NodeSignatures, F as FinalizeNodeSignaturesResponse, Q as QueryTransfersResponse, i as QuerySparkInvoicesResponse, O as OutputWithPreviousTransactionData } from './spark-By6yHsrk.cjs';
+import { N as Network$1, e as SparkInvoiceFields, b as SparkServiceDefinition, f as SparkServiceClient, d as SubscribeToEventsResponse, R as RequestedSigningCommitments, U as UserSignedTxSigningJob, c as TreeNode, T as Transfer, g as StartTransferRequest, L as LeafRefundTxSigningResult, h as NodeSignatures, F as FinalizeNodeSignaturesResponse, Q as QueryTransfersResponse, i as QuerySparkInvoicesResponse, O as OutputWithPreviousTransactionData } from './spark-DOpheE8_.cjs';
 import { SparkTokenServiceDefinition, SparkTokenServiceClient, QueryTokenTransactionsResponse, TokenMetadata } from './proto/spark_token.cjs';
 import * as _scure_base from '@scure/base';
 import { Channel } from 'nice-grpc';
@@ -9,6 +9,7 @@ import { CallOptions, ClientMiddleware, ClientMiddlewareCall, Metadata } from 'n
 import { Channel as Channel$1 } from 'nice-grpc-web';
 import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
 import { RetryOptions as RetryOptions$1 } from 'nice-grpc-client-middleware-retry';
+import { TransactionOutput } from '@scure/btc-signer/psbt';
 import { SpanProcessor } from '@opentelemetry/sdk-trace-base';
 import { EventEmitter } from 'eventemitter3';
 
@@ -38,15 +39,6 @@ declare function getNetworkFromAddress(address: string): BitcoinNetwork.MAINNET
  */
 declare function getNetworkFromString(network?: string): Network;
 
-type Bech32mTokenIdentifier = `btkn1${string}` | `btknrt1${string}` | `btknt1${string}` | `btkns1${string}` | `btknl1${string}`;
-interface Bech32mTokenIdentifierData {
-    tokenIdentifier: Uint8Array;
-    network: NetworkType;
-}
-declare function encodeBech32mTokenIdentifier(payload: Bech32mTokenIdentifierData): Bech32mTokenIdentifier;
-declare function decodeBech32mTokenIdentifier(bech32mTokenIdentifier: Bech32mTokenIdentifier, network?: NetworkType): Bech32mTokenIdentifierData;
-declare function getNetworkFromBech32mTokenIdentifier(bech32mTokenIdentifier: Bech32mTokenIdentifier): NetworkType;
-
 declare const AddressNetwork: Record<NetworkType, string>;
 declare const LegacyAddressNetwork: Record<NetworkType, string>;
 type Bech32String = `${string}1${string}`;
@@ -94,6 +86,15 @@ declare function assertBech32(s: string): asserts s is Bech32String;
 declare function bech32mDecode(address: string): _scure_base.Bech32Decoded<string>;
 declare function isSafeForNumber(bi: bigint): boolean;
 
+type Bech32mTokenIdentifier = `btkn1${string}` | `btknrt1${string}` | `btknt1${string}` | `btkns1${string}` | `btknl1${string}`;
+interface Bech32mTokenIdentifierData {
+    tokenIdentifier: Uint8Array;
+    network: NetworkType;
+}
+declare function encodeBech32mTokenIdentifier(payload: Bech32mTokenIdentifierData): Bech32mTokenIdentifier;
+declare function decodeBech32mTokenIdentifier(bech32mTokenIdentifier: Bech32mTokenIdentifier, network?: NetworkType): Bech32mTokenIdentifierData;
+declare function getNetworkFromBech32mTokenIdentifier(bech32mTokenIdentifier: Bech32mTokenIdentifier): NetworkType;
+
 declare class WalletConfigService implements HasSspClientOptions {
     private readonly config;
     readonly signer: SparkSigner;
@@ -117,6 +118,7 @@ declare class WalletConfigService implements HasSspClientOptions {
     getSspIdentityPublicKey(): string;
     getConsoleOptions(): ConsoleOptions;
     getEvents(): Partial<SparkWalletEvents>;
+    getOptimizationOptions(): OptimizationOptions;
 }
 
 /** Challenge represents the core challenge data */
@@ -285,6 +287,7 @@ declare class SigningService {
         directLeafSigningJobs: UserSignedTxSigningJob[];
         directFromCpfpLeafSigningJobs: UserSignedTxSigningJob[];
     }>;
+    signSigningJobs(signingJobs: (SigningJobWithOptionalNonce & RequestedSigningCommitments)[]): Promise<Map<SigningJobType, UserSignedTxSigningJob>>;
 }
 
 type LeafKeyTweak = {
@@ -305,6 +308,17 @@ type LeafRefundSigningData = {
     directFromCpfpRefundSigningNonceCommitment: SigningCommitmentWithOptionalNonce;
     vout: number;
 };
+type SigningJobType = "split" | "directSplit" | "node" | "directNode" | "cpfp" | "direct" | "directFromCpfp";
+type SigningJobWithOptionalNonce = {
+    signingPublicKey: Uint8Array;
+    rawTx: Uint8Array;
+    signingNonceCommitment: SigningCommitmentWithOptionalNonce;
+    type: SigningJobType;
+    parentTxOut: TransactionOutput;
+    leafId: string;
+    keyDerivation: KeyDerivation;
+    verifyingKey: Uint8Array;
+};
 declare class BaseTransferService {
     protected readonly config: WalletConfigService;
     protected readonly connectionManager: ConnectionManager;
@@ -357,11 +371,12 @@ declare class TransferService extends BaseTransferService {
     claimTransferSignRefunds(transfer: Transfer, leafKeys: LeafKeyTweak[], proofMap?: Map<string, Uint8Array[]>): Promise<NodeSignatures[]>;
     private finalizeNodeSignatures;
     queryPendingTransfersBySender(operatorAddress: string): Promise<QueryTransfersResponse>;
-    private refreshTimelockNodesInternal;
-    refreshTimelockNodes(node: TreeNode, parentNode: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
-    extendTimelock(node: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
-    testonly_expireTimeLockNodeTx(node: TreeNode, parentNode: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
-    testonly_expireTimeLockRefundtx(node: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
+    renewRefundTxn(node: TreeNode, parentNode: TreeNode): Promise<TreeNode>;
+    renewNodeTxn(node: TreeNode, parentNode: TreeNode): Promise<TreeNode>;
+    private createRenewRefundSigningJobs;
+    private createRenewNodeSigningJobs;
+    renewZeroTimelockNodeTxn(node: TreeNode): Promise<TreeNode>;
+    private createRenewZeroTimelockNodeSigningJobs;
 }
 
 /**
@@ -401,13 +416,15 @@ declare abstract class SparkWallet extends EventEmitter<SparkWalletEvents> {
     private handleStreamEvent;
     protected setupBackgroundStream(): Promise<void>;
     getLeaves(isBalanceCheck?: boolean): Promise<TreeNode[]>;
-    private checkExtendLeaves;
     private verifyKey;
     private popOrThrow;
     private selectLeaves;
     private selectLeavesForSwap;
-    private areLeavesInefficient;
-    private optimizeLeaves;
+    optimizeLeaves(multiplicity?: number | undefined): AsyncGenerator<{
+        step: number;
+        total: number;
+        controller: AbortController;
+    }, void, void>;
     private syncWallet;
     private withLeaves;
     /**
@@ -712,15 +729,7 @@ declare abstract class SparkWallet extends EventEmitter<SparkWalletEvents> {
     private transferWithInvoice;
     private buildTweaksByAmount;
     private toSendTweak;
-    private checkExtendTimeLockNodes;
-    /**
-     * Internal method to refresh timelock nodes.
-     *
-     * @param {string} nodeId - The optional ID of the node to refresh. If not provided, all nodes will be checked.
-     * @returns {Promise<void>}
-     * @private
-     */
-    private checkRefreshTimelockNodes;
+    private checkRenewLeaves;
     private claimTransferCore;
     private processClaimedTransferResults;
     /**
@@ -959,13 +968,6 @@ declare abstract class SparkWallet extends EventEmitter<SparkWalletEvents> {
         nodeTimelock: number;
         refundTimelock: number;
     }>;
-    /**
-     * Refresh the timelock of a specific node.
-     *
-     * @param {string} nodeId - The ID of the node to refresh
-     * @returns {Promise<void>} Promise that resolves when the timelock is refreshed
-     */
-    testOnly_expireTimelock(nodeId: string): Promise<void>;
     private cleanup;
     cleanupConnections(): Promise<void>;
     private startPeriodicClaimTransfers;
@@ -1143,6 +1145,10 @@ type SigningOperator = {
 type ConsoleOptions = {
     otel?: boolean;
 };
+type OptimizationOptions = {
+    readonly auto?: boolean;
+    readonly multiplicity?: number;
+};
 type ConfigOptions = MayHaveSspClientOptions & {
     readonly network?: NetworkType;
     readonly signingOperators?: Readonly<Record<string, SigningOperator>>;
@@ -1158,6 +1164,7 @@ type ConfigOptions = MayHaveSspClientOptions & {
     readonly signerWithPreExistingKeys?: boolean;
     readonly console?: ConsoleOptions;
     readonly events?: Partial<SparkWalletEvents>;
+    readonly optimizationOptions?: OptimizationOptions;
 };
 declare const WalletConfig: {
     LOCAL: Required<ConfigOptions>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildonspark/spark-sdk",
-  "version": "0.3.8",
+  "version": "0.4.0",
   "author": "",
   "license": "Apache-2.0",
   "main": "./dist/index.js",

package/src/index.react-native.ts

@@ -7,9 +7,15 @@ setCrypto(globalThis.crypto);
 export * from "./errors/index.js";
 export * from "./utils/index.js";
 
-export { ReactNativeSparkSigner } from "./signer/signer.react-native.js";
+export {
+  ReactNativeSparkSigner,
+  ReactNativeTaprootSparkSigner,
+} from "./signer/signer.react-native.js";
 /* Enable some consumers to use named import DefaultSparkSigner regardless of module, see LIG-7662 */
-export { ReactNativeSparkSigner as DefaultSparkSigner } from "./signer/signer.react-native.js";
+export {
+  ReactNativeSparkSigner as DefaultSparkSigner,
+  ReactNativeTaprootSparkSigner as TaprootSparkSigner,
+} from "./signer/signer.react-native.js";
 
 export { SparkWallet } from "./spark-wallet/spark-wallet.react-native.js";
 export * from "./spark-wallet/types.js";