@buildonspark/spark-sdk 0.1.34 → 0.1.36

package/dist/native/index.d.cts

@@ -1705,7 +1705,7 @@ declare class SspClient {
     getCurrentUser(): Promise<void>;
     completeCoopExit({ userOutboundTransferExternalId, coopExitRequestId, }: CompleteCoopExitInput): Promise<CoopExitRequest | null>;
     requestCoopExit({ leafExternalIds, withdrawalAddress, idempotencyKey, exitSpeed, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
-    requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
+    requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
     requestLightningSend({ encodedInvoice, idempotencyKey, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
     requestLeaveSwap({ adaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     completeLeaveSwap({ adaptorSecretKey, userOutboundTransferExternalId, leavesSwapRequestId, }: CompleteLeavesSwapInput): Promise<LeavesSwapRequest | null>;
@@ -1911,6 +1911,11 @@ interface RequestLightningReceiveInput {
  * the creator of this request.
 **/
     receiverIdentityPubkey?: string | undefined;
+    /**
+ * The h tag of the invoice. This is the hash of a longer description to include in the lightning
+ * invoice. It is used in LNURL and UMA as the hash of the metadata.
+**/
+    descriptionHash?: string | undefined;
 }
 
 interface RequestLightningSendInput {
@@ -1940,7 +1945,7 @@ type ConfigOptions = MayHaveLrc20WalletApiConfig & MayHaveSspClientOptions & {
     readonly frostSignerAddress?: string;
     readonly lrc20Address?: string;
     readonly threshold?: number;
-    readonly useTokenTransactionSchnorrSignatures?: boolean;
+    readonly tokenSignatures?: "ECDSA" | "SCHNORR";
     readonly electrsUrl?: string;
     readonly lrc20ApiConfig?: LRC20WalletApiConfig;
     readonly sspClientOptions?: SspClientOptions;
@@ -1966,7 +1971,7 @@ declare class WalletConfigService implements HasLrc20WalletApiConfig, HasSspClie
     getNetwork(): Network;
     getNetworkType(): NetworkType;
     getNetworkProto(): number;
-    shouldSignTokenTransactionsWithSchnorr(): boolean;
+    getTokenSignatures(): "ECDSA" | "SCHNORR";
     getElectrsUrl(): string;
     getSspIdentityPublicKey(): string;
 }
@@ -2461,6 +2466,7 @@ type CreateLightningInvoiceParams = {
     expirySeconds?: number;
     includeSparkAddress?: boolean;
     receiverIdentityPubkey?: string;
+    descriptionHash?: string;
 };
 type PayLightningInvoiceParams = {
     invoice: string;
@@ -2654,7 +2660,7 @@ declare class SparkWallet extends EventEmitter {
      * @private
      */
     private generateDepositAddress;
-    private queryStaticDepositAddresses;
+    queryStaticDepositAddresses(): Promise<string[]>;
     /**
      * Get a quote on how much credit you can claim for a deposit from the SSP.
      *
@@ -2678,8 +2684,24 @@ declare class SparkWallet extends EventEmitter {
         sspSignature: string;
         outputIndex?: number;
     }): Promise<ClaimStaticDepositOutput | null>;
+    /**
+     * Refunds a static deposit to a destination address.
+     *
+     * @param {string} depositTransactionId - The ID of the transaction
+     * @param {number} [outputIndex] - The index of the output
+     * @param {string} destinationAddress - The destination address
+     * @param {number} fee - The fee to refund
+     * @returns {Promise<string>} The hex of the refund transaction
+     */
+    refundStaticDeposit({ depositTransactionId, outputIndex, destinationAddress, fee, }: {
+        depositTransactionId: string;
+        outputIndex?: number;
+        destinationAddress: string;
+        fee: number;
+    }): Promise<string>;
     private getStaticDepositSigningPayload;
     private getDepositTransactionVout;
+    private getDepositTransaction;
     /**
      * Finalizes a deposit to the wallet.
      *
@@ -2763,13 +2785,14 @@ declare class SparkWallet extends EventEmitter {
      *
      * @param {Object} params - Parameters for the lightning invoice
      * @param {number} params.amountSats - Amount in satoshis
-     * @param {string} params.memo - Description for the invoice
+     * @param {string} [params.memo] - Description for the invoice. Should not be provided if the descriptionHash is provided.
      * @param {number} [params.expirySeconds] - Optional expiry time in seconds
      * @param {boolean} [params.includeSparkAddress] - Optional boolean signalling whether or not to include the spark address in the invoice
      * @param {string} [params.receiverIdentityPubkey] - Optional public key of the wallet receiving the lightning invoice. If not present, the receiver will be the creator of this request.
+     * @param {string} [params.descriptionHash] - Optional h tag of the invoice. This is the hash of a longer description to include in the lightning invoice. It is used in LNURL and UMA as the hash of the metadata. This field is mutually exclusive with the memo field. Only one or the other should be provided.
      * @returns {Promise<LightningReceiveRequest>} BOLT11 encoded invoice
      */
-    createLightningInvoice({ amountSats, memo, expirySeconds, includeSparkAddress, receiverIdentityPubkey, }: CreateLightningInvoiceParams): Promise<LightningReceiveRequest>;
+    createLightningInvoice({ amountSats, memo, expirySeconds, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: CreateLightningInvoiceParams): Promise<LightningReceiveRequest>;
     /**
      * Pays a Lightning invoice.
      *

package/dist/native/index.d.ts

@@ -1705,7 +1705,7 @@ declare class SspClient {
     getCurrentUser(): Promise<void>;
     completeCoopExit({ userOutboundTransferExternalId, coopExitRequestId, }: CompleteCoopExitInput): Promise<CoopExitRequest | null>;
     requestCoopExit({ leafExternalIds, withdrawalAddress, idempotencyKey, exitSpeed, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
-    requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
+    requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
     requestLightningSend({ encodedInvoice, idempotencyKey, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
     requestLeaveSwap({ adaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     completeLeaveSwap({ adaptorSecretKey, userOutboundTransferExternalId, leavesSwapRequestId, }: CompleteLeavesSwapInput): Promise<LeavesSwapRequest | null>;
@@ -1911,6 +1911,11 @@ interface RequestLightningReceiveInput {
  * the creator of this request.
 **/
     receiverIdentityPubkey?: string | undefined;
+    /**
+ * The h tag of the invoice. This is the hash of a longer description to include in the lightning
+ * invoice. It is used in LNURL and UMA as the hash of the metadata.
+**/
+    descriptionHash?: string | undefined;
 }
 
 interface RequestLightningSendInput {
@@ -1940,7 +1945,7 @@ type ConfigOptions = MayHaveLrc20WalletApiConfig & MayHaveSspClientOptions & {
     readonly frostSignerAddress?: string;
     readonly lrc20Address?: string;
     readonly threshold?: number;
-    readonly useTokenTransactionSchnorrSignatures?: boolean;
+    readonly tokenSignatures?: "ECDSA" | "SCHNORR";
     readonly electrsUrl?: string;
     readonly lrc20ApiConfig?: LRC20WalletApiConfig;
     readonly sspClientOptions?: SspClientOptions;
@@ -1966,7 +1971,7 @@ declare class WalletConfigService implements HasLrc20WalletApiConfig, HasSspClie
     getNetwork(): Network;
     getNetworkType(): NetworkType;
     getNetworkProto(): number;
-    shouldSignTokenTransactionsWithSchnorr(): boolean;
+    getTokenSignatures(): "ECDSA" | "SCHNORR";
     getElectrsUrl(): string;
     getSspIdentityPublicKey(): string;
 }
@@ -2461,6 +2466,7 @@ type CreateLightningInvoiceParams = {
     expirySeconds?: number;
     includeSparkAddress?: boolean;
     receiverIdentityPubkey?: string;
+    descriptionHash?: string;
 };
 type PayLightningInvoiceParams = {
     invoice: string;
@@ -2654,7 +2660,7 @@ declare class SparkWallet extends EventEmitter {
      * @private
      */
     private generateDepositAddress;
-    private queryStaticDepositAddresses;
+    queryStaticDepositAddresses(): Promise<string[]>;
     /**
      * Get a quote on how much credit you can claim for a deposit from the SSP.
      *
@@ -2678,8 +2684,24 @@ declare class SparkWallet extends EventEmitter {
         sspSignature: string;
         outputIndex?: number;
     }): Promise<ClaimStaticDepositOutput | null>;
+    /**
+     * Refunds a static deposit to a destination address.
+     *
+     * @param {string} depositTransactionId - The ID of the transaction
+     * @param {number} [outputIndex] - The index of the output
+     * @param {string} destinationAddress - The destination address
+     * @param {number} fee - The fee to refund
+     * @returns {Promise<string>} The hex of the refund transaction
+     */
+    refundStaticDeposit({ depositTransactionId, outputIndex, destinationAddress, fee, }: {
+        depositTransactionId: string;
+        outputIndex?: number;
+        destinationAddress: string;
+        fee: number;
+    }): Promise<string>;
     private getStaticDepositSigningPayload;
     private getDepositTransactionVout;
+    private getDepositTransaction;
     /**
      * Finalizes a deposit to the wallet.
      *
@@ -2763,13 +2785,14 @@ declare class SparkWallet extends EventEmitter {
      *
      * @param {Object} params - Parameters for the lightning invoice
      * @param {number} params.amountSats - Amount in satoshis
-     * @param {string} params.memo - Description for the invoice
+     * @param {string} [params.memo] - Description for the invoice. Should not be provided if the descriptionHash is provided.
      * @param {number} [params.expirySeconds] - Optional expiry time in seconds
      * @param {boolean} [params.includeSparkAddress] - Optional boolean signalling whether or not to include the spark address in the invoice
      * @param {string} [params.receiverIdentityPubkey] - Optional public key of the wallet receiving the lightning invoice. If not present, the receiver will be the creator of this request.
+     * @param {string} [params.descriptionHash] - Optional h tag of the invoice. This is the hash of a longer description to include in the lightning invoice. It is used in LNURL and UMA as the hash of the metadata. This field is mutually exclusive with the memo field. Only one or the other should be provided.
      * @returns {Promise<LightningReceiveRequest>} BOLT11 encoded invoice
      */
-    createLightningInvoice({ amountSats, memo, expirySeconds, includeSparkAddress, receiverIdentityPubkey, }: CreateLightningInvoiceParams): Promise<LightningReceiveRequest>;
+    createLightningInvoice({ amountSats, memo, expirySeconds, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: CreateLightningInvoiceParams): Promise<LightningReceiveRequest>;
     /**
      * Pays a Lightning invoice.
      *