@buildonspark/spark-sdk 0.3.6 → 0.3.7

package/dist/native/{index.d.cts → index.react-native.d.cts}

@@ -3301,7 +3301,7 @@ interface ClaimStaticDepositOutput {
 
 interface CompleteCoopExitInput {
     userOutboundTransferExternalId: string;
-    coopExitRequestId: string;
+    coopExitRequestId?: string | undefined;
 }
 
 interface CompleteLeavesSwapInput {
@@ -3389,11 +3389,12 @@ interface LightningSendFeeEstimateOutput {
 interface RequestCoopExitInput {
     leafExternalIds: string[];
     withdrawalAddress: string;
-    idempotencyKey: string;
+    idempotencyKey?: string | undefined;
     exitSpeed: ExitSpeed;
     withdrawAll: boolean;
     feeLeafExternalIds?: string[] | undefined;
     feeQuoteId?: string | undefined;
+    userOutboundTransferExternalId?: string | undefined;
 }
 
 interface UserLeafInput {
@@ -3453,12 +3454,13 @@ interface RequestLightningReceiveInput {
 
 interface RequestLightningSendInput {
     encodedInvoice: string;
-    idempotencyKey: string;
+    idempotencyKey?: string | undefined;
     /**
- * The amount you will pay for this invoice in sats. It should ONLY be set when the invoice amount is
- * zero.
-**/
+     * The amount you will pay for this invoice in sats. It should ONLY be set when the invoice amount is
+     * zero.
+     **/
     amountSats?: number | undefined;
+    userOutboundTransferExternalId?: string | undefined;
 }
 
 interface StaticDepositQuoteInput {
@@ -3515,10 +3517,10 @@ declare class SspClient {
     getLightningSendFeeEstimate(encodedInvoice: string, amountSats?: number): Promise<LightningSendFeeEstimateOutput | null>;
     getCoopExitFeeEstimate({ leafExternalIds, withdrawalAddress, }: CoopExitFeeEstimatesInput): Promise<CoopExitFeeEstimatesOutput | null>;
     getCurrentUser(): Promise<void>;
-    completeCoopExit({ userOutboundTransferExternalId, coopExitRequestId, }: CompleteCoopExitInput): Promise<CoopExitRequest | null>;
-    requestCoopExit({ leafExternalIds, withdrawalAddress, idempotencyKey, exitSpeed, feeLeafExternalIds, feeQuoteId, withdrawAll, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
+    completeCoopExit({ userOutboundTransferExternalId, }: CompleteCoopExitInput): Promise<CoopExitRequest | null>;
+    requestCoopExit({ leafExternalIds, withdrawalAddress, exitSpeed, feeLeafExternalIds, feeQuoteId, withdrawAll, userOutboundTransferExternalId, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
     requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
-    requestLightningSend({ encodedInvoice, idempotencyKey, amountSats, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
+    requestLightningSend({ encodedInvoice, amountSats, userOutboundTransferExternalId, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
     requestLeaveSwap({ adaptorPubkey, directAdaptorPubkey, directFromCpfpAdaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, targetAmountSatsList, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     completeLeaveSwap({ adaptorSecretKey, directAdaptorSecretKey, directFromCpfpAdaptorSecretKey, userOutboundTransferExternalId, leavesSwapRequestId, }: CompleteLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     getLightningReceiveRequest(id: string): Promise<LightningReceiveRequest | null>;
@@ -3578,7 +3580,7 @@ declare class WalletConfigService implements HasSspClientOptions {
     private readonly config;
     readonly signer: SparkSigner;
     readonly sspClientOptions: SspClientOptions;
-    constructor(options?: ConfigOptions, signer?: SparkSigner);
+    constructor(options: ConfigOptions | undefined, signer: SparkSigner);
     private getDefaultConfig;
     getCoordinatorAddress(): string;
     getSigningOperators(): Readonly<Record<string, SigningOperator>>;
@@ -3849,10 +3851,11 @@ declare abstract class SparkWallet extends EventEmitter<SparkWalletEvents> {
     protected tokenOutputs: TokenOutputsMap;
     private claimTransfersInterval;
     private tracer;
-    constructor(options?: ConfigOptions, signer?: SparkSigner);
+    constructor(options?: ConfigOptions, signerArg?: SparkSigner);
     static initialize<T extends SparkWallet>(this: new (options?: ConfigOptions, signer?: SparkSigner) => T, { mnemonicOrSeed, accountNumber, signer, options }: SparkWalletProps): Promise<InitWalletResponse<T>>;
     private createClientsAndSyncWallet;
     private getSspClient;
+    protected buildSigner(): DefaultSparkSigner;
     protected buildConnectionManager(config: WalletConfigService): ConnectionManager;
     private handleStreamEvent;
     protected setupBackgroundStream(): Promise<void>;
@@ -4742,6 +4745,11 @@ declare class ConnectionManagerBrowser extends ConnectionManager {
     }>;
 }
 
+declare class SparkWalletReactNative extends SparkWallet {
+    protected buildSigner(): ReactNativeSparkSigner;
+    protected buildConnectionManager(config: WalletConfigService): ConnectionManagerBrowser;
+}
+
 interface FetchOwnedTokenOutputsParams {
     ownerPublicKeys: Uint8Array[];
     issuerPublicKeys?: Uint8Array[];
@@ -4787,8 +4795,4 @@ declare class TokenTransactionService {
     private createSignaturesForOperators;
 }
 
-declare class SparkWalletReactNative extends SparkWallet {
-    protected buildConnectionManager(config: WalletConfigService): ConnectionManagerBrowser;
-}
-
 export { AuthenticationError, ConnectionManager as BaseConnectionManager, type Bech32mTokenIdentifier, type Bech32mTokenIdentifierData, type BroadcastConfig, type BroadcastResult, type ConfigOptions, ConfigurationError, ConnectionManagerBrowser as ConnectionManager, type CreateLightningInvoiceParams, DEFAULT_FEE_SATS, DIRECT_TIMELOCK_OFFSET, type DecodedSparkAddressData, ReactNativeSparkSigner as DefaultSparkSigner, type DepositParams, type FeeBumpTxChain, type FeeBumpTxPackage, type FeeRate, type FulfillSparkInvoiceResponse, type GroupSparkInvoicesResult, INITIAL_DIRECT_SEQUENCE, INITIAL_SEQUENCE, type InitWalletResponse, InternalValidationError, type InvalidInvoice, LOGGER_NAMES, type LeafInfo, type LegacySparkAddressFormat, type LoggerName, Network, NetworkError, NetworkToProto, type NetworkType, NotImplementedError, type PayLightningInvoiceParams, RPCError, type RawTokenIdentifierHex, ReactNativeSparkSigner, type SparkAddressData, type SparkAddressFormat, SparkSDKError, SparkSdkLogger, SparkWalletReactNative as SparkWallet, SparkWalletEvent, type SparkWalletEventType, type SparkWalletEvents, type SparkWalletProps, TEST_UNILATERAL_DIRECT_SEQUENCE, TEST_UNILATERAL_SEQUENCE, type TokenBalanceMap, type TokenInvoice, type TokenMetadataMap, type TokenOutputsMap, TokenTransactionService, type TransferParams, type TransferWithInvoiceOutcome, type TransferWithInvoiceParams, type TxChain, type UserTokenMetadata, type Utxo, ValidationError, type VerifiableSecretShare, WalletConfig, WalletConfigService, addPrivateKeys, addPublicKeys, applyAdaptorToSignature, applyAdditiveTweakToPublicKey, assertBech32, bech32mDecode, bigIntToPrivateKey, checkIfSelectedOutputsAreAvailable, checkIfValidSequence, collectResponses, computeTaprootKeyNoScript, computerLagrangeCoefficients, constructFeeBumpTx, constructUnilateralExitFeeBumpPackages, constructUnilateralExitTxs, createConnectorRefundTransactions, createLeafNodeTx, createNodeTx, createNodeTxs, createRefundTx, createRefundTxs, createRootTx, createSigningCommitment, createSigningNonce, createSplitTx, decodeBech32mTokenIdentifier, decodeBytesToSigningCommitment, decodeBytesToSigningNonce, decodeSparkAddress, doesLeafNeedRefresh, encodeBech32mTokenIdentifier, encodeSigningCommitmentToBytes, encodeSigningNonceToBytes, encodeSparkAddress, encodeSparkAddressWithSignature, evaluatePolynomial, fieldDiv, filterTokenBalanceForTokenIdentifier, generateAdaptorFromSignature, generatePolynomialForSecretSharing, generateSignatureFromExistingAdaptor, getCurrentTimelock, getEphemeralAnchorOutput, getLatestDepositTxId, getNetwork, getNetworkFromAddress, getNetworkFromBech32mTokenIdentifier, getNetworkFromSparkAddress, getNetworkFromString, getNextTransactionSequence, getP2TRAddressFromPkScript, getP2TRAddressFromPublicKey, getP2TRScriptFromPublicKey, getP2WPKHAddressFromPublicKey, getRandomBigInt, getRandomSigningNonce, getSigHashFromTx, getSigningCommitmentFromNonce, getSparkAddressFromTaproot, getTransactionSequence, getTransferPackageSigningPayload, getTxEstimatedVbytesSizeByNumberOfInputsOutputs, getTxFromRawTxBytes, getTxFromRawTxHex, getTxId, getTxIdNoReverse, isEphemeralAnchorOutput, isLegacySparkAddress, isSafeForNumber, isTxBroadcast, isValidPublicKey, isValidSparkAddress, lastKeyWithTarget, maybeApplyFee, modInverse, proofOfPossessionMessageHashForDepositAddress, protoToNetwork, recoverSecret, splitSecret, splitSecretWithProofs, subtractPrivateKeys, subtractPublicKeys, sumAvailableTokens, sumOfPrivateKeys, toProtoTimestamp, validateOutboundAdaptorSignature, validateShare, validateSparkInvoiceFields, validateSparkInvoiceSignature };

package/dist/native/{index.d.ts → index.react-native.d.ts}

@@ -3301,7 +3301,7 @@ interface ClaimStaticDepositOutput {
 
 interface CompleteCoopExitInput {
     userOutboundTransferExternalId: string;
-    coopExitRequestId: string;
+    coopExitRequestId?: string | undefined;
 }
 
 interface CompleteLeavesSwapInput {
@@ -3389,11 +3389,12 @@ interface LightningSendFeeEstimateOutput {
 interface RequestCoopExitInput {
     leafExternalIds: string[];
     withdrawalAddress: string;
-    idempotencyKey: string;
+    idempotencyKey?: string | undefined;
     exitSpeed: ExitSpeed;
     withdrawAll: boolean;
     feeLeafExternalIds?: string[] | undefined;
     feeQuoteId?: string | undefined;
+    userOutboundTransferExternalId?: string | undefined;
 }
 
 interface UserLeafInput {
@@ -3453,12 +3454,13 @@ interface RequestLightningReceiveInput {
 
 interface RequestLightningSendInput {
     encodedInvoice: string;
-    idempotencyKey: string;
+    idempotencyKey?: string | undefined;
     /**
- * The amount you will pay for this invoice in sats. It should ONLY be set when the invoice amount is
- * zero.
-**/
+     * The amount you will pay for this invoice in sats. It should ONLY be set when the invoice amount is
+     * zero.
+     **/
     amountSats?: number | undefined;
+    userOutboundTransferExternalId?: string | undefined;
 }
 
 interface StaticDepositQuoteInput {
@@ -3515,10 +3517,10 @@ declare class SspClient {
     getLightningSendFeeEstimate(encodedInvoice: string, amountSats?: number): Promise<LightningSendFeeEstimateOutput | null>;
     getCoopExitFeeEstimate({ leafExternalIds, withdrawalAddress, }: CoopExitFeeEstimatesInput): Promise<CoopExitFeeEstimatesOutput | null>;
     getCurrentUser(): Promise<void>;
-    completeCoopExit({ userOutboundTransferExternalId, coopExitRequestId, }: CompleteCoopExitInput): Promise<CoopExitRequest | null>;
-    requestCoopExit({ leafExternalIds, withdrawalAddress, idempotencyKey, exitSpeed, feeLeafExternalIds, feeQuoteId, withdrawAll, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
+    completeCoopExit({ userOutboundTransferExternalId, }: CompleteCoopExitInput): Promise<CoopExitRequest | null>;
+    requestCoopExit({ leafExternalIds, withdrawalAddress, exitSpeed, feeLeafExternalIds, feeQuoteId, withdrawAll, userOutboundTransferExternalId, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
     requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
-    requestLightningSend({ encodedInvoice, idempotencyKey, amountSats, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
+    requestLightningSend({ encodedInvoice, amountSats, userOutboundTransferExternalId, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
     requestLeaveSwap({ adaptorPubkey, directAdaptorPubkey, directFromCpfpAdaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, targetAmountSatsList, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     completeLeaveSwap({ adaptorSecretKey, directAdaptorSecretKey, directFromCpfpAdaptorSecretKey, userOutboundTransferExternalId, leavesSwapRequestId, }: CompleteLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     getLightningReceiveRequest(id: string): Promise<LightningReceiveRequest | null>;
@@ -3578,7 +3580,7 @@ declare class WalletConfigService implements HasSspClientOptions {
     private readonly config;
     readonly signer: SparkSigner;
     readonly sspClientOptions: SspClientOptions;
-    constructor(options?: ConfigOptions, signer?: SparkSigner);
+    constructor(options: ConfigOptions | undefined, signer: SparkSigner);
     private getDefaultConfig;
     getCoordinatorAddress(): string;
     getSigningOperators(): Readonly<Record<string, SigningOperator>>;
@@ -3849,10 +3851,11 @@ declare abstract class SparkWallet extends EventEmitter<SparkWalletEvents> {
     protected tokenOutputs: TokenOutputsMap;
     private claimTransfersInterval;
     private tracer;
-    constructor(options?: ConfigOptions, signer?: SparkSigner);
+    constructor(options?: ConfigOptions, signerArg?: SparkSigner);
     static initialize<T extends SparkWallet>(this: new (options?: ConfigOptions, signer?: SparkSigner) => T, { mnemonicOrSeed, accountNumber, signer, options }: SparkWalletProps): Promise<InitWalletResponse<T>>;
     private createClientsAndSyncWallet;
     private getSspClient;
+    protected buildSigner(): DefaultSparkSigner;
     protected buildConnectionManager(config: WalletConfigService): ConnectionManager;
     private handleStreamEvent;
     protected setupBackgroundStream(): Promise<void>;
@@ -4742,6 +4745,11 @@ declare class ConnectionManagerBrowser extends ConnectionManager {
     }>;
 }
 
+declare class SparkWalletReactNative extends SparkWallet {
+    protected buildSigner(): ReactNativeSparkSigner;
+    protected buildConnectionManager(config: WalletConfigService): ConnectionManagerBrowser;
+}
+
 interface FetchOwnedTokenOutputsParams {
     ownerPublicKeys: Uint8Array[];
     issuerPublicKeys?: Uint8Array[];
@@ -4787,8 +4795,4 @@ declare class TokenTransactionService {
     private createSignaturesForOperators;
 }
 
-declare class SparkWalletReactNative extends SparkWallet {
-    protected buildConnectionManager(config: WalletConfigService): ConnectionManagerBrowser;
-}
-
 export { AuthenticationError, ConnectionManager as BaseConnectionManager, type Bech32mTokenIdentifier, type Bech32mTokenIdentifierData, type BroadcastConfig, type BroadcastResult, type ConfigOptions, ConfigurationError, ConnectionManagerBrowser as ConnectionManager, type CreateLightningInvoiceParams, DEFAULT_FEE_SATS, DIRECT_TIMELOCK_OFFSET, type DecodedSparkAddressData, ReactNativeSparkSigner as DefaultSparkSigner, type DepositParams, type FeeBumpTxChain, type FeeBumpTxPackage, type FeeRate, type FulfillSparkInvoiceResponse, type GroupSparkInvoicesResult, INITIAL_DIRECT_SEQUENCE, INITIAL_SEQUENCE, type InitWalletResponse, InternalValidationError, type InvalidInvoice, LOGGER_NAMES, type LeafInfo, type LegacySparkAddressFormat, type LoggerName, Network, NetworkError, NetworkToProto, type NetworkType, NotImplementedError, type PayLightningInvoiceParams, RPCError, type RawTokenIdentifierHex, ReactNativeSparkSigner, type SparkAddressData, type SparkAddressFormat, SparkSDKError, SparkSdkLogger, SparkWalletReactNative as SparkWallet, SparkWalletEvent, type SparkWalletEventType, type SparkWalletEvents, type SparkWalletProps, TEST_UNILATERAL_DIRECT_SEQUENCE, TEST_UNILATERAL_SEQUENCE, type TokenBalanceMap, type TokenInvoice, type TokenMetadataMap, type TokenOutputsMap, TokenTransactionService, type TransferParams, type TransferWithInvoiceOutcome, type TransferWithInvoiceParams, type TxChain, type UserTokenMetadata, type Utxo, ValidationError, type VerifiableSecretShare, WalletConfig, WalletConfigService, addPrivateKeys, addPublicKeys, applyAdaptorToSignature, applyAdditiveTweakToPublicKey, assertBech32, bech32mDecode, bigIntToPrivateKey, checkIfSelectedOutputsAreAvailable, checkIfValidSequence, collectResponses, computeTaprootKeyNoScript, computerLagrangeCoefficients, constructFeeBumpTx, constructUnilateralExitFeeBumpPackages, constructUnilateralExitTxs, createConnectorRefundTransactions, createLeafNodeTx, createNodeTx, createNodeTxs, createRefundTx, createRefundTxs, createRootTx, createSigningCommitment, createSigningNonce, createSplitTx, decodeBech32mTokenIdentifier, decodeBytesToSigningCommitment, decodeBytesToSigningNonce, decodeSparkAddress, doesLeafNeedRefresh, encodeBech32mTokenIdentifier, encodeSigningCommitmentToBytes, encodeSigningNonceToBytes, encodeSparkAddress, encodeSparkAddressWithSignature, evaluatePolynomial, fieldDiv, filterTokenBalanceForTokenIdentifier, generateAdaptorFromSignature, generatePolynomialForSecretSharing, generateSignatureFromExistingAdaptor, getCurrentTimelock, getEphemeralAnchorOutput, getLatestDepositTxId, getNetwork, getNetworkFromAddress, getNetworkFromBech32mTokenIdentifier, getNetworkFromSparkAddress, getNetworkFromString, getNextTransactionSequence, getP2TRAddressFromPkScript, getP2TRAddressFromPublicKey, getP2TRScriptFromPublicKey, getP2WPKHAddressFromPublicKey, getRandomBigInt, getRandomSigningNonce, getSigHashFromTx, getSigningCommitmentFromNonce, getSparkAddressFromTaproot, getTransactionSequence, getTransferPackageSigningPayload, getTxEstimatedVbytesSizeByNumberOfInputsOutputs, getTxFromRawTxBytes, getTxFromRawTxHex, getTxId, getTxIdNoReverse, isEphemeralAnchorOutput, isLegacySparkAddress, isSafeForNumber, isTxBroadcast, isValidPublicKey, isValidSparkAddress, lastKeyWithTarget, maybeApplyFee, modInverse, proofOfPossessionMessageHashForDepositAddress, protoToNetwork, recoverSecret, splitSecret, splitSecretWithProofs, subtractPrivateKeys, subtractPublicKeys, sumAvailableTokens, sumOfPrivateKeys, toProtoTimestamp, validateOutboundAdaptorSignature, validateShare, validateSparkInvoiceFields, validateSparkInvoiceSignature };