@buildonspark/spark-sdk 0.2.11 → 0.2.13

package/dist/bare/index.d.cts

@@ -863,6 +863,13 @@ declare enum UtxoSwapRequestType {
     Refund = 2,
     UNRECOGNIZED = -1
 }
+declare enum InvoiceStatus {
+    NOT_FOUND = 0,
+    PENDING = 1,
+    FINALIZED = 2,
+    EXPIRED = 3,
+    UNRECOGNIZED = -1
+}
 declare enum InitiatePreimageSwapRequest_Reason {
     /** REASON_SEND - The associated lightning service is sending the payment. */
     REASON_SEND = 0,
@@ -953,6 +960,21 @@ interface GenerateDepositAddressResponse {
     depositAddress: Address | undefined;
 }
 declare const GenerateDepositAddressResponse: MessageFns$2<GenerateDepositAddressResponse>;
+/** GenerateStaticDepositAddressRequest is the request to generate a static deposit address. */
+interface GenerateStaticDepositAddressRequest {
+    /** The signing public key of the user. */
+    signingPublicKey: Uint8Array;
+    /** The identity public key of the user. */
+    identityPublicKey: Uint8Array;
+    /** The network of the bitcoin network. */
+    network: Network$1;
+}
+declare const GenerateStaticDepositAddressRequest: MessageFns$2<GenerateStaticDepositAddressRequest>;
+/** GenerateStaticDepositAddressResponse is the response to the request to generate a static deposit address. */
+interface GenerateStaticDepositAddressResponse {
+    depositAddress: Address | undefined;
+}
+declare const GenerateStaticDepositAddressResponse: MessageFns$2<GenerateStaticDepositAddressResponse>;
 /**
  * UTXO represents a utxo on the bitcoin network.
  * The UTXO is used to create a tree on Spark, it can also be an off-chain utxo so that the user
@@ -1544,6 +1566,7 @@ interface TransferLeaf {
     intermediateRefundTx: Uint8Array;
     intermediateDirectRefundTx: Uint8Array;
     intermediateDirectFromCpfpRefundTx: Uint8Array;
+    pendingKeyTweakPublicKey: Uint8Array;
 }
 declare const TransferLeaf: MessageFns$2<TransferLeaf>;
 interface TransferFilter {
@@ -1743,6 +1766,7 @@ interface QueryUserSignedRefundsRequest {
 declare const QueryUserSignedRefundsRequest: MessageFns$2<QueryUserSignedRefundsRequest>;
 interface QueryUserSignedRefundsResponse {
     userSignedRefunds: UserSignedRefund[];
+    transfer: Transfer | undefined;
 }
 declare const QueryUserSignedRefundsResponse: MessageFns$2<QueryUserSignedRefundsResponse>;
 interface ProvidePreimageRequest {
@@ -1824,6 +1848,7 @@ interface DepositAddressQueryResult {
     userSigningPublicKey: Uint8Array;
     verifyingPublicKey: Uint8Array;
     leafId?: string | undefined;
+    proofOfPossession?: DepositAddressProof | undefined;
 }
 declare const DepositAddressQueryResult: MessageFns$2<DepositAddressQueryResult>;
 interface QueryUnusedDepositAddressesResponse {
@@ -1986,6 +2011,7 @@ interface GetUtxosForAddressRequest {
     offset: number;
     limit: number;
     network: Network$1;
+    excludeClaimed: boolean;
 }
 declare const GetUtxosForAddressRequest: MessageFns$2<GetUtxosForAddressRequest>;
 interface GetUtxosForAddressResponse {
@@ -1993,8 +2019,27 @@ interface GetUtxosForAddressResponse {
     offset: number;
 }
 declare const GetUtxosForAddressResponse: MessageFns$2<GetUtxosForAddressResponse>;
+interface QuerySparkInvoicesRequest {
+    limit: number;
+    offset: number;
+    /** returns the status for the provided list of spark invoices. */
+    invoice: string[];
+}
+declare const QuerySparkInvoicesRequest: MessageFns$2<QuerySparkInvoicesRequest>;
+interface QuerySparkInvoicesResponse {
+    offset: number;
+    invoiceStatuses: InvoiceResponse[];
+}
+declare const QuerySparkInvoicesResponse: MessageFns$2<QuerySparkInvoicesResponse>;
+interface InvoiceResponse {
+    invoice: string;
+    status: InvoiceStatus;
+}
+declare const InvoiceResponse: MessageFns$2<InvoiceResponse>;
 interface SparkServiceClient<CallOptionsExt = {}> {
     generate_deposit_address(request: DeepPartial$2<GenerateDepositAddressRequest>, options?: CallOptions & CallOptionsExt): Promise<GenerateDepositAddressResponse>;
+    /** Generates a new static deposit address of the user or returns the existing one for the specified network. */
+    generate_static_deposit_address(request: DeepPartial$2<GenerateStaticDepositAddressRequest>, options?: CallOptions & CallOptionsExt): Promise<GenerateStaticDepositAddressResponse>;
     start_deposit_tree_creation(request: DeepPartial$2<StartDepositTreeCreationRequest>, options?: CallOptions & CallOptionsExt): Promise<StartDepositTreeCreationResponse>;
     /**
      * This is deprecated, please use start_deposit_tree_creation instead.
@@ -2087,6 +2132,7 @@ interface SparkServiceClient<CallOptionsExt = {}> {
     start_transfer_v2(request: DeepPartial$2<StartTransferRequest>, options?: CallOptions & CallOptionsExt): Promise<StartTransferResponse>;
     refresh_timelock_v2(request: DeepPartial$2<RefreshTimelockRequest>, options?: CallOptions & CallOptionsExt): Promise<RefreshTimelockResponse>;
     get_utxos_for_address(request: DeepPartial$2<GetUtxosForAddressRequest>, options?: CallOptions & CallOptionsExt): Promise<GetUtxosForAddressResponse>;
+    query_spark_invoices(request: DeepPartial$2<QuerySparkInvoicesRequest>, options?: CallOptions & CallOptionsExt): Promise<QuerySparkInvoicesResponse>;
 }
 type Builtin$2 = Date | Function | Uint8Array | string | number | boolean | undefined;
 type DeepPartial$2<T> = T extends Builtin$2 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$2<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$2<U>> : T extends {
@@ -2979,7 +3025,6 @@ declare class TransferService extends BaseTransferService {
     private prepareClaimLeafKeyTweaks;
     claimTransferSignRefunds(transfer: Transfer, leafKeys: LeafKeyTweak[], proofMap?: Map<string, Uint8Array[]>): Promise<NodeSignatures[]>;
     private finalizeNodeSignatures;
-    cancelTransfer(transfer: Transfer, operatorAddress: string): Promise<Transfer | undefined>;
     queryPendingTransfersBySender(operatorAddress: string): Promise<QueryTransfersResponse>;
     private refreshTimelockNodesInternal;
     refreshTimelockNodes(node: TreeNode, parentNode: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
@@ -3286,8 +3331,6 @@ declare class SparkWallet extends EventEmitter {
     getStaticDepositAddress(): Promise<string>;
     /**
      * Generates a deposit address for receiving funds.
-     *
-     * @param {boolean} static - Whether the address is static or single use
      * @returns {Promise<string>} A deposit address
      * @private
      */
@@ -3301,7 +3344,7 @@ declare class SparkWallet extends EventEmitter {
      * @param offset - Pagination offset (default 0).
      * @returns {Promise<{ txid: string, vout: number }[]>} List of confirmed UTXOs.
      */
-    getUtxosForDepositAddress(depositAddress: string, limit?: number, offset?: number): Promise<{
+    getUtxosForDepositAddress(depositAddress: string, limit?: number, offset?: number, excludeClaimed?: boolean): Promise<{
         txid: string;
         vout: number;
     }[]>;
@@ -3360,6 +3403,29 @@ declare class SparkWallet extends EventEmitter {
         /** @deprecated use `satsPerVbyteFee` */ fee?: number;
         satsPerVbyteFee?: number;
     }): Promise<string>;
+    /**
+     * Refunds a static deposit and broadcasts the transaction to the network.
+     *
+     * @param {Object} params - The refund parameters
+     * @param {string} params.depositTransactionId - The ID of the transaction
+     * @param {number} [params.outputIndex] - The index of the output
+     * @param {string} params.destinationAddress - The destination address
+     * @param {number} [params.satsPerVbyteFee] - The fee per vbyte to refund
+     * @returns {Promise<string>} The transaction ID
+     */
+    refundAndBroadcastStaticDeposit({ depositTransactionId, outputIndex, destinationAddress, satsPerVbyteFee, }: {
+        depositTransactionId: string;
+        outputIndex?: number;
+        destinationAddress: string;
+        satsPerVbyteFee?: number;
+    }): Promise<string>;
+    /**
+     * Broadcasts a transaction to the network.
+     *
+     * @param {string} txHex - The hex of the transaction
+     * @returns {Promise<string>} The transaction ID
+     */
+    private broadcastTx;
     private getStaticDepositSigningPayload;
     private getDepositTransactionVout;
     private getDepositTransaction;
@@ -3445,13 +3511,6 @@ declare class SparkWallet extends EventEmitter {
      * @private
      */
     private claimTransfers;
-    /**
-     * Cancels all sender-initiated transfers.
-     *
-     * @returns {Promise<void>}
-     * @private
-     */
-    private cancelAllSenderInitiatedTransfers;
     /**
      * Creates a Lightning invoice for receiving payments.
      *

package/dist/bare/index.d.ts

@@ -863,6 +863,13 @@ declare enum UtxoSwapRequestType {
     Refund = 2,
     UNRECOGNIZED = -1
 }
+declare enum InvoiceStatus {
+    NOT_FOUND = 0,
+    PENDING = 1,
+    FINALIZED = 2,
+    EXPIRED = 3,
+    UNRECOGNIZED = -1
+}
 declare enum InitiatePreimageSwapRequest_Reason {
     /** REASON_SEND - The associated lightning service is sending the payment. */
     REASON_SEND = 0,
@@ -953,6 +960,21 @@ interface GenerateDepositAddressResponse {
     depositAddress: Address | undefined;
 }
 declare const GenerateDepositAddressResponse: MessageFns$2<GenerateDepositAddressResponse>;
+/** GenerateStaticDepositAddressRequest is the request to generate a static deposit address. */
+interface GenerateStaticDepositAddressRequest {
+    /** The signing public key of the user. */
+    signingPublicKey: Uint8Array;
+    /** The identity public key of the user. */
+    identityPublicKey: Uint8Array;
+    /** The network of the bitcoin network. */
+    network: Network$1;
+}
+declare const GenerateStaticDepositAddressRequest: MessageFns$2<GenerateStaticDepositAddressRequest>;
+/** GenerateStaticDepositAddressResponse is the response to the request to generate a static deposit address. */
+interface GenerateStaticDepositAddressResponse {
+    depositAddress: Address | undefined;
+}
+declare const GenerateStaticDepositAddressResponse: MessageFns$2<GenerateStaticDepositAddressResponse>;
 /**
  * UTXO represents a utxo on the bitcoin network.
  * The UTXO is used to create a tree on Spark, it can also be an off-chain utxo so that the user
@@ -1544,6 +1566,7 @@ interface TransferLeaf {
     intermediateRefundTx: Uint8Array;
     intermediateDirectRefundTx: Uint8Array;
     intermediateDirectFromCpfpRefundTx: Uint8Array;
+    pendingKeyTweakPublicKey: Uint8Array;
 }
 declare const TransferLeaf: MessageFns$2<TransferLeaf>;
 interface TransferFilter {
@@ -1743,6 +1766,7 @@ interface QueryUserSignedRefundsRequest {
 declare const QueryUserSignedRefundsRequest: MessageFns$2<QueryUserSignedRefundsRequest>;
 interface QueryUserSignedRefundsResponse {
     userSignedRefunds: UserSignedRefund[];
+    transfer: Transfer | undefined;
 }
 declare const QueryUserSignedRefundsResponse: MessageFns$2<QueryUserSignedRefundsResponse>;
 interface ProvidePreimageRequest {
@@ -1824,6 +1848,7 @@ interface DepositAddressQueryResult {
     userSigningPublicKey: Uint8Array;
     verifyingPublicKey: Uint8Array;
     leafId?: string | undefined;
+    proofOfPossession?: DepositAddressProof | undefined;
 }
 declare const DepositAddressQueryResult: MessageFns$2<DepositAddressQueryResult>;
 interface QueryUnusedDepositAddressesResponse {
@@ -1986,6 +2011,7 @@ interface GetUtxosForAddressRequest {
     offset: number;
     limit: number;
     network: Network$1;
+    excludeClaimed: boolean;
 }
 declare const GetUtxosForAddressRequest: MessageFns$2<GetUtxosForAddressRequest>;
 interface GetUtxosForAddressResponse {
@@ -1993,8 +2019,27 @@ interface GetUtxosForAddressResponse {
     offset: number;
 }
 declare const GetUtxosForAddressResponse: MessageFns$2<GetUtxosForAddressResponse>;
+interface QuerySparkInvoicesRequest {
+    limit: number;
+    offset: number;
+    /** returns the status for the provided list of spark invoices. */
+    invoice: string[];
+}
+declare const QuerySparkInvoicesRequest: MessageFns$2<QuerySparkInvoicesRequest>;
+interface QuerySparkInvoicesResponse {
+    offset: number;
+    invoiceStatuses: InvoiceResponse[];
+}
+declare const QuerySparkInvoicesResponse: MessageFns$2<QuerySparkInvoicesResponse>;
+interface InvoiceResponse {
+    invoice: string;
+    status: InvoiceStatus;
+}
+declare const InvoiceResponse: MessageFns$2<InvoiceResponse>;
 interface SparkServiceClient<CallOptionsExt = {}> {
     generate_deposit_address(request: DeepPartial$2<GenerateDepositAddressRequest>, options?: CallOptions & CallOptionsExt): Promise<GenerateDepositAddressResponse>;
+    /** Generates a new static deposit address of the user or returns the existing one for the specified network. */
+    generate_static_deposit_address(request: DeepPartial$2<GenerateStaticDepositAddressRequest>, options?: CallOptions & CallOptionsExt): Promise<GenerateStaticDepositAddressResponse>;
     start_deposit_tree_creation(request: DeepPartial$2<StartDepositTreeCreationRequest>, options?: CallOptions & CallOptionsExt): Promise<StartDepositTreeCreationResponse>;
     /**
      * This is deprecated, please use start_deposit_tree_creation instead.
@@ -2087,6 +2132,7 @@ interface SparkServiceClient<CallOptionsExt = {}> {
     start_transfer_v2(request: DeepPartial$2<StartTransferRequest>, options?: CallOptions & CallOptionsExt): Promise<StartTransferResponse>;
     refresh_timelock_v2(request: DeepPartial$2<RefreshTimelockRequest>, options?: CallOptions & CallOptionsExt): Promise<RefreshTimelockResponse>;
     get_utxos_for_address(request: DeepPartial$2<GetUtxosForAddressRequest>, options?: CallOptions & CallOptionsExt): Promise<GetUtxosForAddressResponse>;
+    query_spark_invoices(request: DeepPartial$2<QuerySparkInvoicesRequest>, options?: CallOptions & CallOptionsExt): Promise<QuerySparkInvoicesResponse>;
 }
 type Builtin$2 = Date | Function | Uint8Array | string | number | boolean | undefined;
 type DeepPartial$2<T> = T extends Builtin$2 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$2<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$2<U>> : T extends {
@@ -2979,7 +3025,6 @@ declare class TransferService extends BaseTransferService {
     private prepareClaimLeafKeyTweaks;
     claimTransferSignRefunds(transfer: Transfer, leafKeys: LeafKeyTweak[], proofMap?: Map<string, Uint8Array[]>): Promise<NodeSignatures[]>;
     private finalizeNodeSignatures;
-    cancelTransfer(transfer: Transfer, operatorAddress: string): Promise<Transfer | undefined>;
     queryPendingTransfersBySender(operatorAddress: string): Promise<QueryTransfersResponse>;
     private refreshTimelockNodesInternal;
     refreshTimelockNodes(node: TreeNode, parentNode: TreeNode): Promise<FinalizeNodeSignaturesResponse>;
@@ -3286,8 +3331,6 @@ declare class SparkWallet extends EventEmitter {
     getStaticDepositAddress(): Promise<string>;
     /**
      * Generates a deposit address for receiving funds.
-     *
-     * @param {boolean} static - Whether the address is static or single use
      * @returns {Promise<string>} A deposit address
      * @private
      */
@@ -3301,7 +3344,7 @@ declare class SparkWallet extends EventEmitter {
      * @param offset - Pagination offset (default 0).
      * @returns {Promise<{ txid: string, vout: number }[]>} List of confirmed UTXOs.
      */
-    getUtxosForDepositAddress(depositAddress: string, limit?: number, offset?: number): Promise<{
+    getUtxosForDepositAddress(depositAddress: string, limit?: number, offset?: number, excludeClaimed?: boolean): Promise<{
         txid: string;
         vout: number;
     }[]>;
@@ -3360,6 +3403,29 @@ declare class SparkWallet extends EventEmitter {
         /** @deprecated use `satsPerVbyteFee` */ fee?: number;
         satsPerVbyteFee?: number;
     }): Promise<string>;
+    /**
+     * Refunds a static deposit and broadcasts the transaction to the network.
+     *
+     * @param {Object} params - The refund parameters
+     * @param {string} params.depositTransactionId - The ID of the transaction
+     * @param {number} [params.outputIndex] - The index of the output
+     * @param {string} params.destinationAddress - The destination address
+     * @param {number} [params.satsPerVbyteFee] - The fee per vbyte to refund
+     * @returns {Promise<string>} The transaction ID
+     */
+    refundAndBroadcastStaticDeposit({ depositTransactionId, outputIndex, destinationAddress, satsPerVbyteFee, }: {
+        depositTransactionId: string;
+        outputIndex?: number;
+        destinationAddress: string;
+        satsPerVbyteFee?: number;
+    }): Promise<string>;
+    /**
+     * Broadcasts a transaction to the network.
+     *
+     * @param {string} txHex - The hex of the transaction
+     * @returns {Promise<string>} The transaction ID
+     */
+    private broadcastTx;
     private getStaticDepositSigningPayload;
     private getDepositTransactionVout;
     private getDepositTransaction;
@@ -3445,13 +3511,6 @@ declare class SparkWallet extends EventEmitter {
      * @private
      */
     private claimTransfers;
-    /**
-     * Cancels all sender-initiated transfers.
-     *
-     * @returns {Promise<void>}
-     * @private
-     */
-    private cancelAllSenderInitiatedTransfers;
     /**
      * Creates a Lightning invoice for receiving payments.
      *