@buildonspark/spark-sdk 0.1.45 → 0.1.47

package/dist/{RequestLightningSendInput-DEPd_fPO.d.ts → client-D7KgLN44.d.ts}

@@ -1,6 +1,210 @@
 import { Query } from '@lightsparkdev/core';
-import { B as BitcoinNetwork } from './BitcoinNetwork-TnABML0T.js';
-import { S as SparkSigner } from './signer-BocS_J6B.js';
+import { d as TreeNode } from './spark-BbUrbvZz.js';
+import { TokenSigner, Receipt } from '@buildonspark/lrc20-sdk';
+import { Transaction } from '@scure/btc-signer';
+import { Psbt } from 'bitcoinjs-lib';
+import { HDKey } from '@scure/bip32';
+import { b as ISigningCommitment } from './types-BADxR3bm.js';
+
+/** This is an enum identifying a particular Bitcoin Network. **/
+declare enum BitcoinNetwork {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    /** The production version of the Bitcoin Blockchain. **/
+    MAINNET = "MAINNET",
+    /** A test version of the Bitcoin Blockchain, maintained by Lightspark. **/
+    REGTEST = "REGTEST",
+    /** A test version of the Bitcoin Blockchain, maintained by a centralized organization. Not in use at Lightspark. **/
+    SIGNET = "SIGNET",
+    /** A test version of the Bitcoin Blockchain, publicly available. **/
+    TESTNET = "TESTNET"
+}
+
+type Polynomial = {
+    fieldModulus: bigint;
+    coefficients: bigint[];
+    proofs: Uint8Array[];
+};
+type SecretShare = {
+    fieldModulus: bigint;
+    threshold: number;
+    index: bigint;
+    share: bigint;
+};
+type VerifiableSecretShare = SecretShare & {
+    proofs: Uint8Array[];
+};
+declare function getRandomBigInt(max: bigint): bigint;
+declare function modInverse(a: bigint, m: bigint): bigint;
+declare function evaluatePolynomial(polynomial: Polynomial, x: bigint): bigint;
+declare function fieldDiv(numerator: bigint, denominator: bigint, fieldModulus: bigint): bigint;
+declare function computerLagrangeCoefficients(index: bigint, points: SecretShare[]): bigint;
+declare function generatePolynomialForSecretSharing(fieldModulus: bigint, secret: bigint, degree: number): Polynomial;
+declare function splitSecret(fieldModulus: bigint, secret: bigint, threshold: number, numberOfShares: number): SecretShare[];
+declare function splitSecretWithProofs(secret: bigint, fieldModulus: bigint, threshold: number, numberOfShares: number): VerifiableSecretShare[];
+declare function recoverSecret(shares: VerifiableSecretShare[]): bigint;
+declare function validateShare(share: VerifiableSecretShare): void;
+declare function bigIntToPrivateKey(value: bigint): Uint8Array;
+
+type SigningNonce = {
+    binding: Uint8Array;
+    hiding: Uint8Array;
+};
+type SigningCommitment = {
+    binding: Uint8Array;
+    hiding: Uint8Array;
+};
+type SignFrostParams = {
+    message: Uint8Array;
+    privateAsPubKey: Uint8Array;
+    publicKey: Uint8Array;
+    verifyingKey: Uint8Array;
+    selfCommitment: ISigningCommitment;
+    statechainCommitments?: {
+        [key: string]: ISigningCommitment;
+    } | undefined;
+    adaptorPubKey?: Uint8Array | undefined;
+};
+type AggregateFrostParams = Omit<SignFrostParams, "privateAsPubKey"> & {
+    selfSignature: Uint8Array;
+    statechainSignatures?: {
+        [key: string]: Uint8Array;
+    } | undefined;
+    statechainPublicKeys?: {
+        [key: string]: Uint8Array;
+    } | undefined;
+};
+type SplitSecretWithProofsParams = {
+    secret: Uint8Array;
+    curveOrder: bigint;
+    threshold: number;
+    numShares: number;
+    isSecretPubkey?: boolean;
+};
+type DerivedHDKey = {
+    hdKey: HDKey;
+    privateKey: Uint8Array;
+    publicKey: Uint8Array;
+};
+type KeyPair = {
+    privateKey: Uint8Array;
+    publicKey: Uint8Array;
+};
+
+interface SparkKeysGenerator {
+    deriveKeysFromSeed(seed: Uint8Array, accountNumber: number): Promise<{
+        masterPublicKey: Uint8Array;
+        identityKey: KeyPair;
+        signingHDKey: DerivedHDKey;
+        depositKey: KeyPair;
+        staticDepositHDKey: DerivedHDKey;
+    }>;
+}
+declare class TaprootOutputKeysGenerator implements SparkKeysGenerator {
+    private readonly useAddressIndex;
+    constructor(useAddressIndex?: boolean);
+    deriveKeysFromSeed(seed: Uint8Array, accountNumber: number): Promise<{
+        masterPublicKey: Uint8Array;
+        identityKey: KeyPair;
+        signingHDKey: DerivedHDKey;
+        depositKey: KeyPair;
+        staticDepositHDKey: DerivedHDKey;
+    }>;
+}
+interface SparkSigner extends TokenSigner {
+    getIdentityPublicKey(): Promise<Uint8Array>;
+    getDepositSigningKey(): Promise<Uint8Array>;
+    generateStaticDepositKey(idx: number): Promise<Uint8Array>;
+    getStaticDepositSigningKey(idx: number): Promise<Uint8Array>;
+    getStaticDepositSecretKey(idx: number): Promise<Uint8Array>;
+    generateMnemonic(): Promise<string>;
+    mnemonicToSeed(mnemonic: string): Promise<Uint8Array>;
+    createSparkWalletFromSeed(seed: Uint8Array | string, accountNumber?: number): Promise<string>;
+    restoreSigningKeysFromLeafs(leafs: TreeNode[]): Promise<void>;
+    getTrackedPublicKeys(): Promise<Uint8Array[]>;
+    generatePublicKey(hash?: Uint8Array): Promise<Uint8Array>;
+    removePublicKey(publicKey: Uint8Array): Promise<void>;
+    getSchnorrPublicKey(publicKey: Uint8Array): Promise<Uint8Array>;
+    signSchnorr(message: Uint8Array, publicKey: Uint8Array): Promise<Uint8Array>;
+    signSchnorrWithIdentityKey(message: Uint8Array): Promise<Uint8Array>;
+    subtractPrivateKeysGivenPublicKeys(first: Uint8Array, second: Uint8Array): Promise<Uint8Array>;
+    splitSecretWithProofs(params: SplitSecretWithProofsParams): Promise<VerifiableSecretShare[]>;
+    signFrost(params: SignFrostParams): Promise<Uint8Array>;
+    aggregateFrost(params: AggregateFrostParams): Promise<Uint8Array>;
+    signMessageWithPublicKey(message: Uint8Array, publicKey: Uint8Array, compact?: boolean): Promise<Uint8Array>;
+    signMessageWithIdentityKey(message: Uint8Array, compact?: boolean): Promise<Uint8Array>;
+    validateMessageWithIdentityKey(message: Uint8Array, signature: Uint8Array): Promise<boolean>;
+    signTransactionIndex(tx: Transaction, index: number, publicKey: Uint8Array): void;
+    encryptLeafPrivateKeyEcies(receiverPublicKey: Uint8Array, publicKey: Uint8Array): Promise<Uint8Array>;
+    decryptEcies(ciphertext: Uint8Array): Promise<Uint8Array>;
+    getRandomSigningCommitment(): Promise<SigningCommitment>;
+    hashRandomPrivateKey(): Promise<Uint8Array>;
+    generateAdaptorFromSignature(signature: Uint8Array): Promise<{
+        adaptorSignature: Uint8Array;
+        adaptorPublicKey: Uint8Array;
+    }>;
+    getDepositSigningKey(): Promise<Uint8Array>;
+    getMasterPublicKey(): Promise<Uint8Array>;
+}
+declare class DefaultSparkSigner implements SparkSigner {
+    private masterPublicKey;
+    private identityKey;
+    private signingKey;
+    private depositKey;
+    private staticDepositKey;
+    private staticDepositKeyMap;
+    protected publicKeyToPrivateKeyMap: Map<string, string>;
+    protected commitmentToNonceMap: Map<SigningCommitment, SigningNonce>;
+    private readonly keysGenerator;
+    constructor({ sparkKeysGenerator, }?: {
+        sparkKeysGenerator?: SparkKeysGenerator;
+    });
+    private deriveSigningKey;
+    restoreSigningKeysFromLeafs(leafs: TreeNode[]): Promise<void>;
+    getSchnorrPublicKey(publicKey: Uint8Array): Promise<Uint8Array>;
+    signSchnorr(message: Uint8Array, publicKey: Uint8Array): Promise<Uint8Array>;
+    signSchnorrWithIdentityKey(message: Uint8Array): Promise<Uint8Array>;
+    getIdentityPublicKey(): Promise<Uint8Array>;
+    getDepositSigningKey(): Promise<Uint8Array>;
+    generateStaticDepositKey(idx: number): Promise<Uint8Array>;
+    getStaticDepositSigningKey(idx: number): Promise<Uint8Array>;
+    getStaticDepositSecretKey(idx: number): Promise<Uint8Array>;
+    generateMnemonic(): Promise<string>;
+    mnemonicToSeed(mnemonic: string): Promise<Uint8Array>;
+    getTrackedPublicKeys(): Promise<Uint8Array[]>;
+    generatePublicKey(hash?: Uint8Array): Promise<Uint8Array>;
+    removePublicKey(publicKey: Uint8Array): Promise<void>;
+    subtractPrivateKeysGivenPublicKeys(first: Uint8Array, second: Uint8Array): Promise<Uint8Array>;
+    splitSecretWithProofs({ secret, curveOrder, threshold, numShares, isSecretPubkey, }: SplitSecretWithProofsParams): Promise<VerifiableSecretShare[]>;
+    signFrost({ message, privateAsPubKey, publicKey, verifyingKey, selfCommitment, statechainCommitments, adaptorPubKey, }: SignFrostParams): Promise<Uint8Array>;
+    aggregateFrost({ message, publicKey, verifyingKey, selfCommitment, statechainCommitments, adaptorPubKey, selfSignature, statechainSignatures, statechainPublicKeys, }: AggregateFrostParams): Promise<Uint8Array>;
+    createSparkWalletFromSeed(seed: Uint8Array | string, accountNumber?: number): Promise<string>;
+    signMessageWithPublicKey(message: Uint8Array, publicKey: Uint8Array, compact?: boolean): Promise<Uint8Array>;
+    signMessageWithIdentityKey(message: Uint8Array, compact?: boolean): Promise<Uint8Array>;
+    encryptLeafPrivateKeyEcies(receiverPublicKey: Uint8Array, publicKey: Uint8Array): Promise<Uint8Array>;
+    decryptEcies(ciphertext: Uint8Array): Promise<Uint8Array>;
+    getRandomSigningCommitment(): Promise<SigningCommitment>;
+    hashRandomPrivateKey(): Promise<Uint8Array>;
+    generateAdaptorFromSignature(signature: Uint8Array): Promise<{
+        adaptorSignature: Uint8Array;
+        adaptorPublicKey: Uint8Array;
+    }>;
+    getMasterPublicKey(): Promise<Uint8Array>;
+    validateMessageWithIdentityKey(message: Uint8Array, signature: Uint8Array): Promise<boolean>;
+    signPsbt(psbt: Psbt, input: number, sighashTypes?: number[], receipt?: Receipt): Promise<Psbt>;
+    private getReceiptPrivateKey;
+    signTransactionIndex(tx: Transaction, index: number, publicKey: Uint8Array): void;
+}
+declare class TaprootSparkSigner extends DefaultSparkSigner {
+    constructor(useAddressIndex?: boolean);
+}
+
+interface ClaimStaticDepositOutput {
+    transferId: string;
+}
 
 /** This enum identifies the unit of currency associated with a CurrencyAmount. **/
 declare enum CurrencyUnit {
@@ -51,19 +255,38 @@ interface CurrencyAmount {
     preferredCurrencyValueApprox: number;
 }
 
-interface ClaimStaticDepositOutput {
-    transferId: string;
+declare enum ExitSpeed {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    FAST = "FAST",
+    MEDIUM = "MEDIUM",
+    SLOW = "SLOW"
 }
 
-interface CompleteCoopExitInput {
-    userOutboundTransferExternalId: string;
-    coopExitRequestId: string;
+declare enum SparkCoopExitRequestStatus {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    INITIATED = "INITIATED",
+    INBOUND_TRANSFER_CHECKED = "INBOUND_TRANSFER_CHECKED",
+    TX_SIGNED = "TX_SIGNED",
+    TX_BROADCASTED = "TX_BROADCASTED",
+    WAITING_ON_TX_CONFIRMATIONS = "WAITING_ON_TX_CONFIRMATIONS",
+    SUCCEEDED = "SUCCEEDED",
+    EXPIRED = "EXPIRED",
+    FAILED = "FAILED"
 }
 
-interface CompleteLeavesSwapInput {
-    adaptorSecretKey: string;
-    userOutboundTransferExternalId: string;
-    leavesSwapRequestId: string;
+interface Leaf {
+    /** The amount of the leaf. **/
+    amount: CurrencyAmount;
+    /** The id of the leaf known at signing operators. **/
+    sparkNodeId: string;
 }
 
 /** This is an object representing information about a page returned by the Lightspark API. For more information, please see the “Pagination” section of our API docs for more information about its usage. **/
@@ -74,6 +297,94 @@ interface PageInfo {
     endCursor?: string | undefined;
 }
 
+interface SparkTransferToLeavesConnection {
+    /**
+     * The total count of objects in this connection, using the current filters. It is different from the
+     * number of objects returned in the current page (in the `entities` field).
+     **/
+    count: number;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
+    /** The leaves for the current page of this connection. **/
+    entities: Leaf[];
+    /** The typename of the object **/
+    typename: string;
+}
+
+declare class Transfer {
+    /** The total amount of the transfer. **/
+    readonly totalAmount: CurrencyAmount;
+    /** The id of the transfer known at signing operators. If not set, the transfer hasn't been
+     * initialized. **/
+    readonly sparkId?: string | undefined;
+    /** The user request this transfer belongs to, if there is any **/
+    readonly userRequestId?: string | undefined;
+    constructor(
+    /** The total amount of the transfer. **/
+    totalAmount: CurrencyAmount, 
+    /** The id of the transfer known at signing operators. If not set, the transfer hasn't been
+     * initialized. **/
+    sparkId?: string | undefined, 
+    /** The user request this transfer belongs to, if there is any **/
+    userRequestId?: string | undefined);
+    getLeaves(client: SspClient, first?: number | undefined, after?: string | undefined): Promise<SparkTransferToLeavesConnection>;
+    toJson(): {
+        transfer_total_amount: any;
+        transfer_spark_id: string | undefined;
+        transfer_user_request: {
+            id: string | undefined;
+        };
+    };
+}
+
+interface CoopExitRequest {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string;
+    /** The date and time when the entity was first created. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The network the lightning send request is on. **/
+    network: BitcoinNetwork;
+    /** The fee user pays for the coop exit not including the L1 broadcast fee. **/
+    fee: CurrencyAmount;
+    /** The L1 broadcast fee user pays for the coop exit. **/
+    l1BroadcastFee: CurrencyAmount;
+    /** The status of this coop exit request. **/
+    status: SparkCoopExitRequestStatus;
+    /** The time when the coop exit request expires and the UTXOs are released. **/
+    expiresAt: string;
+    /** The raw connector transaction. **/
+    rawConnectorTransaction: string;
+    /** The raw coop exit L1 transaction. **/
+    rawCoopExitTransaction: string;
+    /** The transaction id of the coop exit transaction. **/
+    coopExitTxid: string;
+    /** The typename of the object **/
+    typename: string;
+    /** The fee quote user requested for this coop exit. **/
+    feeQuoteId?: string | undefined;
+    /** The exit speed user requested for this coop exit. **/
+    exitSpeed?: ExitSpeed | undefined;
+    /** The swap transfer. **/
+    transfer?: Transfer | undefined;
+}
+declare const getCoopExitRequestQuery: (id: string) => Query<CoopExitRequest>;
+
+interface CompleteCoopExitInput {
+    userOutboundTransferExternalId: string;
+    coopExitRequestId: string;
+}
+
+interface CompleteLeavesSwapInput {
+    adaptorSecretKey: string;
+    userOutboundTransferExternalId: string;
+    leavesSwapRequestId: string;
+}
+
 interface CoopExitFeeEstimate {
     userFee: CurrencyAmount;
     l1BroadcastFee: CurrencyAmount;
@@ -128,31 +439,22 @@ interface CoopExitFeeQuoteInput {
     withdrawalAddress: string;
 }
 
-declare enum ExitSpeed {
-    /**
-     * This is an enum value that represents values that could be added in the future.
-     * Clients should support unknown values as more of them could be added without notice.
-     */
-    FUTURE_VALUE = "FUTURE_VALUE",
-    FAST = "FAST",
-    MEDIUM = "MEDIUM",
-    SLOW = "SLOW"
+interface GetChallengeOutput {
+    protectedChallenge: string;
 }
 
-declare enum SparkCoopExitRequestStatus {
-    /**
-     * This is an enum value that represents values that could be added in the future.
-     * Clients should support unknown values as more of them could be added without notice.
-     */
-    FUTURE_VALUE = "FUTURE_VALUE",
-    INITIATED = "INITIATED",
-    INBOUND_TRANSFER_CHECKED = "INBOUND_TRANSFER_CHECKED",
-    TX_SIGNED = "TX_SIGNED",
-    TX_BROADCASTED = "TX_BROADCASTED",
-    WAITING_ON_TX_CONFIRMATIONS = "WAITING_ON_TX_CONFIRMATIONS",
-    SUCCEEDED = "SUCCEEDED",
-    EXPIRED = "EXPIRED",
-    FAILED = "FAILED"
+interface Invoice {
+    encodedInvoice: string;
+    bitcoinNetwork: BitcoinNetwork;
+    paymentHash: string;
+    amount: CurrencyAmount;
+    createdAt: string;
+    expiresAt: string;
+    memo?: string | undefined;
+}
+
+interface LeavesSwapFeeEstimateOutput {
+    feeEstimate: CurrencyAmount;
 }
 
 declare enum SparkLeavesSwapRequestStatus {
@@ -210,16 +512,6 @@ interface LeavesSwapRequest {
 }
 declare const getLeavesSwapRequestQuery: (id: string) => Query<LeavesSwapRequest>;
 
-interface Invoice {
-    encodedInvoice: string;
-    bitcoinNetwork: BitcoinNetwork;
-    paymentHash: string;
-    amount: CurrencyAmount;
-    createdAt: string;
-    expiresAt: string;
-    memo?: string | undefined;
-}
-
 declare enum LightningReceiveRequestStatus {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -265,176 +557,16 @@ interface LightningReceiveRequest {
 }
 declare const getLightningReceiveRequestQuery: (id: string) => Query<LightningReceiveRequest>;
 
-interface LightningSendFeeEstimateOutput {
-    feeEstimate: CurrencyAmount;
-}
-
-interface StaticDepositQuoteInput {
-    /** The transaction id of the deposit. **/
-    transactionId: string;
-    /** The output index of the deposit. **/
-    outputIndex: number;
-    /** The bitcoin network of the deposit. **/
-    network: BitcoinNetwork;
-}
-
-interface StaticDepositQuoteOutput {
-    /** The transaction id of the deposit. **/
-    transactionId: string;
-    /** The output index of the deposit. **/
-    outputIndex: number;
-    /** The bitcoin network of the deposit. **/
-    network: BitcoinNetwork;
-    /** The amount of sats that will be credited to the user's balance. **/
-    creditAmountSats: number;
-    /** The signature of the quote. **/
-    signature: string;
-}
-
-interface VerifyChallengeOutput {
-    validUntil: string;
-    sessionToken: string;
-}
-
-interface SspClientOptions {
-    baseUrl: string;
-    identityPublicKey: string;
-    schemaEndpoint?: string;
-}
-interface MayHaveSspClientOptions {
-    readonly sspClientOptions?: SspClientOptions;
-}
-interface HasSspClientOptions {
-    readonly sspClientOptions: SspClientOptions;
-}
-declare class SspClient {
-    private readonly requester;
-    private readonly signer;
-    private readonly authProvider;
-    constructor(config: HasSspClientOptions & {
-        signer: SparkSigner;
-    });
-    executeRawQuery<T>(query: Query<T>, needsAuth?: boolean): Promise<T | null>;
-    getSwapFeeEstimate(amountSats: number): Promise<LeavesSwapFeeEstimateOutput | null>;
-    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>;
-    requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
-    requestLightningSend({ encodedInvoice, idempotencyKey, amountSats, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
-    requestLeaveSwap({ adaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, targetAmountSatsList, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
-    completeLeaveSwap({ adaptorSecretKey, userOutboundTransferExternalId, leavesSwapRequestId, }: CompleteLeavesSwapInput): Promise<LeavesSwapRequest | null>;
-    getLightningReceiveRequest(id: string): Promise<LightningReceiveRequest | null>;
-    getLightningSendRequest(id: string): Promise<LightningSendRequest | null>;
-    getLeaveSwapRequest(id: string): Promise<LeavesSwapRequest | null>;
-    getCoopExitRequest(id: string): Promise<CoopExitRequest | null>;
-    getClaimDepositQuote({ transactionId, outputIndex, network, }: StaticDepositQuoteInput): Promise<StaticDepositQuoteOutput | null>;
-    claimStaticDeposit({ transactionId, outputIndex, network, creditAmountSats, depositSecretKey, signature, sspSignature, }: {
-        transactionId: string;
-        outputIndex: number;
-        network: BitcoinNetwork;
-        creditAmountSats: number;
-        depositSecretKey: string;
-        signature: string;
-        sspSignature: string;
-    }): Promise<ClaimStaticDepositOutput | null>;
-    getTransfer(id: string): Promise<Transfer | null>;
-    getChallenge(): Promise<GetChallengeOutput | null>;
-    verifyChallenge(signature: string, protectedChallenge: string): Promise<VerifyChallengeOutput | null>;
-    authenticate(): Promise<void>;
-    getCoopExitFeeQuote({ leafExternalIds, withdrawalAddress, }: CoopExitFeeQuoteInput): Promise<CoopExitFeeQuote | null>;
-}
-
-interface Leaf {
-    /** The amount of the leaf. **/
-    amount: CurrencyAmount;
-    /** The id of the leaf known at signing operators. **/
-    sparkNodeId: string;
-}
-
-interface SparkTransferToLeavesConnection {
-    /**
-     * The total count of objects in this connection, using the current filters. It is different from the
-     * number of objects returned in the current page (in the `entities` field).
-     **/
-    count: number;
-    /** An object that holds pagination information about the objects in this connection. **/
-    pageInfo: PageInfo;
-    /** The leaves for the current page of this connection. **/
-    entities: Leaf[];
-    /** The typename of the object **/
-    typename: string;
-}
-
-declare class Transfer {
-    /** The total amount of the transfer. **/
-    readonly totalAmount: CurrencyAmount;
-    /** The id of the transfer known at signing operators. If not set, the transfer hasn't been
-     * initialized. **/
-    readonly sparkId?: string | undefined;
-    /** The user request this transfer belongs to, if there is any **/
-    readonly userRequestId?: string | undefined;
-    constructor(
-    /** The total amount of the transfer. **/
-    totalAmount: CurrencyAmount, 
-    /** The id of the transfer known at signing operators. If not set, the transfer hasn't been
-     * initialized. **/
-    sparkId?: string | undefined, 
-    /** The user request this transfer belongs to, if there is any **/
-    userRequestId?: string | undefined);
-    getLeaves(client: SspClient, first?: number | undefined, after?: string | undefined): Promise<SparkTransferToLeavesConnection>;
-    toJson(): {
-        transfer_total_amount: any;
-        transfer_spark_id: string | undefined;
-        transfer_user_request: {
-            id: string | undefined;
-        };
-    };
-}
-
-interface CoopExitRequest {
+interface LightningSendFeeEstimateInput {
+    encodedInvoice: string;
     /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
-     **/
-    id: string;
-    /** The date and time when the entity was first created. **/
-    createdAt: string;
-    /** The date and time when the entity was last updated. **/
-    updatedAt: string;
-    /** The network the lightning send request is on. **/
-    network: BitcoinNetwork;
-    /** The fee user pays for the coop exit not including the L1 broadcast fee. **/
-    fee: CurrencyAmount;
-    /** The L1 broadcast fee user pays for the coop exit. **/
-    l1BroadcastFee: CurrencyAmount;
-    /** The status of this coop exit request. **/
-    status: SparkCoopExitRequestStatus;
-    /** The time when the coop exit request expires and the UTXOs are released. **/
-    expiresAt: string;
-    /** The raw connector transaction. **/
-    rawConnectorTransaction: string;
-    /** The raw coop exit L1 transaction. **/
-    rawCoopExitTransaction: string;
-    /** The transaction id of the coop exit transaction. **/
-    coopExitTxid: string;
-    /** The typename of the object **/
-    typename: string;
-    /** The fee quote user requested for this coop exit. **/
-    feeQuoteId?: string | undefined;
-    /** The exit speed user requested for this coop exit. **/
-    exitSpeed?: ExitSpeed | undefined;
-    /** The swap transfer. **/
-    transfer?: Transfer | undefined;
-}
-declare const getCoopExitRequestQuery: (id: string) => Query<CoopExitRequest>;
-
-interface GetChallengeOutput {
-    protectedChallenge: string;
+ * The amount you will pay for this invoice in sats. It should ONLY be set when the invoice amount is
+ * zero.
+**/
+    amountSats?: number | undefined;
 }
 
-interface LeavesSwapFeeEstimateOutput {
+interface LightningSendFeeEstimateOutput {
     feeEstimate: CurrencyAmount;
 }
 
@@ -551,4 +683,82 @@ interface RequestLightningSendInput {
     amountSats?: number | undefined;
 }
 
-export { type SparkTransferToLeavesConnection as A, type StaticDepositQuoteInput as B, type ClaimStaticDepositOutput as C, type StaticDepositQuoteOutput as D, ExitSpeed as E, type SwapLeaf as F, type GetChallengeOutput as G, type HasSspClientOptions as H, type Invoice as I, type SspClientOptions as J, SspClient as K, type Leaf as L, type MayHaveSspClientOptions as M, type PageInfo as P, type RequestCoopExitInput as R, SparkCoopExitRequestStatus as S, Transfer as T, type UserLeafInput as U, type VerifyChallengeOutput as V, type CompleteCoopExitInput as a, type CompleteLeavesSwapInput as b, type CoopExitFeeEstimate as c, type CoopExitFeeEstimatesInput as d, type CoopExitFeeEstimatesOutput as e, type CoopExitFeeQuote as f, getCoopExitFeeQuoteQuery as g, type CoopExitFeeQuoteInput as h, type CoopExitRequest as i, getCoopExitRequestQuery as j, type CurrencyAmount as k, CurrencyUnit as l, type LeavesSwapFeeEstimateOutput as m, getLeavesSwapRequestQuery as n, type LeavesSwapRequest as o, getLightningReceiveRequestQuery as p, type LightningReceiveRequest as q, LightningReceiveRequestStatus as r, type LightningSendFeeEstimateOutput as s, getLightningSendRequestQuery as t, type LightningSendRequest as u, LightningSendRequestStatus as v, type RequestLeavesSwapInput as w, type RequestLightningReceiveInput as x, type RequestLightningSendInput as y, SparkLeavesSwapRequestStatus as z };
+interface StaticDepositQuoteInput {
+    /** The transaction id of the deposit. **/
+    transactionId: string;
+    /** The output index of the deposit. **/
+    outputIndex: number;
+    /** The bitcoin network of the deposit. **/
+    network: BitcoinNetwork;
+}
+
+interface StaticDepositQuoteOutput {
+    /** The transaction id of the deposit. **/
+    transactionId: string;
+    /** The output index of the deposit. **/
+    outputIndex: number;
+    /** The bitcoin network of the deposit. **/
+    network: BitcoinNetwork;
+    /** The amount of sats that will be credited to the user's balance. **/
+    creditAmountSats: number;
+    /** The signature of the quote. **/
+    signature: string;
+}
+
+interface VerifyChallengeOutput {
+    validUntil: string;
+    sessionToken: string;
+}
+
+interface SspClientOptions {
+    baseUrl: string;
+    identityPublicKey: string;
+    schemaEndpoint?: string;
+}
+interface MayHaveSspClientOptions {
+    readonly sspClientOptions?: SspClientOptions;
+}
+interface HasSspClientOptions {
+    readonly sspClientOptions: SspClientOptions;
+}
+declare class SspClient {
+    private readonly requester;
+    private readonly signer;
+    private readonly authProvider;
+    private authPromise?;
+    constructor(config: HasSspClientOptions & {
+        signer: SparkSigner;
+    });
+    executeRawQuery<T>(query: Query<T>, needsAuth?: boolean): Promise<T | null>;
+    getSwapFeeEstimate(amountSats: number): Promise<LeavesSwapFeeEstimateOutput | null>;
+    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>;
+    requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
+    requestLightningSend({ encodedInvoice, idempotencyKey, amountSats, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
+    requestLeaveSwap({ adaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, targetAmountSatsList, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
+    completeLeaveSwap({ adaptorSecretKey, userOutboundTransferExternalId, leavesSwapRequestId, }: CompleteLeavesSwapInput): Promise<LeavesSwapRequest | null>;
+    getLightningReceiveRequest(id: string): Promise<LightningReceiveRequest | null>;
+    getLightningSendRequest(id: string): Promise<LightningSendRequest | null>;
+    getLeaveSwapRequest(id: string): Promise<LeavesSwapRequest | null>;
+    getCoopExitRequest(id: string): Promise<CoopExitRequest | null>;
+    getClaimDepositQuote({ transactionId, outputIndex, network, }: StaticDepositQuoteInput): Promise<StaticDepositQuoteOutput | null>;
+    claimStaticDeposit({ transactionId, outputIndex, network, creditAmountSats, depositSecretKey, signature, sspSignature, }: {
+        transactionId: string;
+        outputIndex: number;
+        network: BitcoinNetwork;
+        creditAmountSats: number;
+        depositSecretKey: string;
+        signature: string;
+        sspSignature: string;
+    }): Promise<ClaimStaticDepositOutput | null>;
+    getTransfer(id: string): Promise<Transfer | null>;
+    getChallenge(): Promise<GetChallengeOutput | null>;
+    verifyChallenge(signature: string, protectedChallenge: string): Promise<VerifyChallengeOutput | null>;
+    authenticate(): Promise<void>;
+    getCoopExitFeeQuote({ leafExternalIds, withdrawalAddress, }: CoopExitFeeQuoteInput): Promise<CoopExitFeeQuote | null>;
+}
+
+export { TaprootOutputKeysGenerator as $, SparkLeavesSwapRequestStatus as A, BitcoinNetwork as B, type ClaimStaticDepositOutput as C, type SparkTransferToLeavesConnection as D, ExitSpeed as E, type StaticDepositQuoteInput as F, type GetChallengeOutput as G, type StaticDepositQuoteOutput as H, type Invoice as I, type SwapLeaf as J, type SparkSigner as K, type Leaf as L, type MayHaveSspClientOptions as M, type SspClientOptions as N, type HasSspClientOptions as O, type PageInfo as P, type SigningCommitment as Q, type RequestCoopExitInput as R, SparkCoopExitRequestStatus as S, Transfer as T, type UserLeafInput as U, type VerifyChallengeOutput as V, type VerifiableSecretShare as W, SspClient as X, type SigningNonce as Y, DefaultSparkSigner as Z, TaprootSparkSigner as _, type CompleteCoopExitInput as a, getRandomBigInt as a0, modInverse as a1, evaluatePolynomial as a2, fieldDiv as a3, computerLagrangeCoefficients as a4, generatePolynomialForSecretSharing as a5, splitSecret as a6, splitSecretWithProofs as a7, recoverSecret as a8, validateShare as a9, bigIntToPrivateKey as aa, type SignFrostParams as ab, type AggregateFrostParams as ac, type SplitSecretWithProofsParams as ad, type DerivedHDKey as ae, type KeyPair as af, type CompleteLeavesSwapInput as b, type CoopExitFeeEstimate as c, type CoopExitFeeEstimatesInput as d, type CoopExitFeeEstimatesOutput as e, type CoopExitFeeQuote as f, getCoopExitFeeQuoteQuery as g, type CoopExitFeeQuoteInput as h, type CoopExitRequest as i, getCoopExitRequestQuery as j, type CurrencyAmount as k, CurrencyUnit as l, type LeavesSwapFeeEstimateOutput as m, getLeavesSwapRequestQuery as n, type LeavesSwapRequest as o, getLightningReceiveRequestQuery as p, type LightningReceiveRequest as q, LightningReceiveRequestStatus as r, type LightningSendFeeEstimateInput as s, type LightningSendFeeEstimateOutput as t, getLightningSendRequestQuery as u, type LightningSendRequest as v, LightningSendRequestStatus as w, type RequestLeavesSwapInput as x, type RequestLightningReceiveInput as y, type RequestLightningSendInput as z };