@buildonspark/spark-sdk 0.2.4 → 0.2.5

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @buildonspark/spark-sdk
 
+## 0.2.5
+
+### Patch Changes
+
+- Attach the SSP request object to spark transfer if it exists
+- Update static deposit refund flow to take sats per vbyte
+- Allow the creation of multiple refunds in static deposit refund flow
+- Add new function to claim a static deposit while specifying a max fee
+
 ## 0.2.4
 
 ### Patch Changes

package/dist/{chunk-3SEOTO43.js → chunk-3SPMJMUX.js}

@@ -35,7 +35,7 @@ function mapTransferLeafToWalletTransferLeaf(proto) {
     intermediateRefundTx: bytesToHex(proto.intermediateRefundTx)
   };
 }
-function mapTransferToWalletTransfer(proto, identityPublicKey) {
+function mapTransferToWalletTransfer(proto, identityPublicKey, userRequest) {
   const receiverIdentityPublicKey = bytesToHex(proto.receiverIdentityPublicKey);
   const senderIdentityPublicKey = bytesToHex(proto.senderIdentityPublicKey);
   return {
@@ -49,7 +49,8 @@ function mapTransferToWalletTransfer(proto, identityPublicKey) {
     createdTime: proto.createdTime ? new Date(proto.createdTime) : void 0,
     updatedTime: proto.updatedTime ? new Date(proto.updatedTime) : void 0,
     type: TransferType[proto.type],
-    transferDirection: receiverIdentityPublicKey === identityPublicKey ? "INCOMING" /* INCOMING */ : "OUTGOING" /* OUTGOING */
+    transferDirection: receiverIdentityPublicKey === identityPublicKey ? "INCOMING" /* INCOMING */ : "OUTGOING" /* OUTGOING */,
+    userRequest
   };
 }
 

package/dist/{chunk-WAQKYSDI.js → chunk-CQY5ML2A.js}

@@ -1498,14 +1498,15 @@ export {
   LightningSendRequestFromJson,
   FRAGMENT6 as FRAGMENT4,
   getLightningSendRequestQuery,
+  ClaimStaticDepositStatus_default,
+  ClaimStaticDepositFromJson,
+  getClaimStaticDepositQuery,
   ClaimStaticDepositRequestType_default,
   CoopExitFeeQuoteFromJson,
   FRAGMENT2 as FRAGMENT5,
   getCoopExitFeeQuoteQuery,
-  ClaimStaticDepositStatus_default,
   FRAGMENT7 as FRAGMENT6,
   getUserRequestQuery,
-  getClaimStaticDepositQuery,
   SparkUserRequestStatus_default,
   SparkUserRequestType_default,
   SparkWalletUser_default

package/dist/{chunk-TVUMSHWA.js → chunk-LQZL2D3Y.js}

@@ -1,6 +1,6 @@
 import {
   setCrypto
-} from "./chunk-W4ZRBSWM.js";
+} from "./chunk-U7LRIWTF.js";
 
 // src/index.ts
 var cryptoImpl = typeof window !== "undefined" && window.crypto ? window.crypto : typeof global !== "undefined" && global.crypto ? global.crypto : null;

package/dist/{chunk-W4ZRBSWM.js → chunk-U7LRIWTF.js}

@@ -4,9 +4,10 @@ import {
 import {
   mapTransferToWalletTransfer,
   mapTreeNodeToWalletLeaf
-} from "./chunk-3SEOTO43.js";
+} from "./chunk-3SPMJMUX.js";
 import {
   BitcoinNetwork_default,
+  ClaimStaticDepositFromJson,
   ClaimStaticDepositRequestType_default,
   CoopExitFeeQuoteFromJson,
   CurrencyAmountFromJson,
@@ -22,7 +23,7 @@ import {
   LightningSendRequestFromJson,
   SparkCoopExitRequestStatus_default,
   TransferFromJson
-} from "./chunk-WAQKYSDI.js";
+} from "./chunk-CQY5ML2A.js";
 import {
   Empty,
   SendLeafKeyTweaks,
@@ -577,7 +578,7 @@ import * as ecies from "eciesjs";
 import { isNode } from "@lightsparkdev/core";
 var isReactNative = typeof navigator !== "undefined" && navigator.product === "ReactNative";
 var isBun = globalThis.Bun !== void 0;
-var packageVersion = true ? "0.2.4" : "unknown";
+var packageVersion = true ? "0.2.5" : "unknown";
 var baseEnvStr = "unknown";
 if (isBun) {
   const bunVersion = "version" in globalThis.Bun ? globalThis.Bun.version : "unknown-version";
@@ -2911,6 +2912,12 @@ function getTxId(tx) {
 function getTxIdNoReverse(tx) {
   return bytesToHex4(sha2563(sha2563(tx.toBytes(true))));
 }
+function getTxEstimatedVbytesSizeByNumberOfInputsOutputs(numInputs, numOutputs) {
+  const TX_OVERHEAD = 10;
+  const IN_VBYTES = 150;
+  const OUT_VBYTES = 34;
+  return TX_OVERHEAD + numInputs * IN_VBYTES + numOutputs * OUT_VBYTES;
+}
 
 // src/utils/transaction.ts
 import { Transaction as Transaction2 } from "@scure/btc-signer";
@@ -7587,14 +7594,18 @@ var LightningSendFeeEstimate = `
   ${FRAGMENT13}
 `;
 
-// src/graphql/queries/Transfer.ts
-var GetTransfer = `
-  query Transfer($transfer_spark_id: UUID!) {
-    transfer(transfer_spark_id: $transfer_spark_id) {
+// src/graphql/queries/Transfers.ts
+var GetTransfers = `
+  query Transfers($transfer_spark_ids: [UUID!]!) {
+    transfers(transfer_spark_ids: $transfer_spark_ids) {
       ...TransferFragment
+      transfer_user_request: user_request {
+        ...UserRequestFragment
+      }
     }
   }
   ${FRAGMENT}
+  ${FRAGMENT6}
 `;
 
 // src/graphql/queries/UserRequest.ts
@@ -7950,14 +7961,47 @@ var SspClient = class {
       }
     });
   }
-  async getTransfer(id) {
+  async getTransfers(ids) {
     return await this.executeRawQuery({
-      queryPayload: GetTransfer,
+      queryPayload: GetTransfers,
       variables: {
-        transfer_spark_id: id
+        transfer_spark_ids: ids
       },
       constructObject: (response) => {
-        return TransferFromJson(response.transfer);
+        return response.transfers.map((transfer) => {
+          const transferObj = TransferFromJson(
+            transfer
+          );
+          switch (transfer.transfer_user_request.__typename) {
+            case "ClaimStaticDeposit":
+              transferObj.userRequest = ClaimStaticDepositFromJson(
+                transfer.transfer_user_request
+              );
+              break;
+            case "CoopExitRequest":
+              transferObj.userRequest = CoopExitRequestFromJson(
+                transfer.transfer_user_request
+              );
+              break;
+            case "LeavesSwapRequest":
+              transferObj.userRequest = LeavesSwapRequestFromJson(
+                transfer.transfer_user_request
+              );
+              break;
+            case "LightningReceiveRequest":
+              transferObj.userRequest = LightningReceiveRequestFromJson(
+                transfer.transfer_user_request
+              );
+              break;
+            case "LightningSendRequest":
+              transferObj.userRequest = LightningSendRequestFromJson(
+                transfer.transfer_user_request
+              );
+              break;
+          }
+          const { userRequestId, ...rest } = transferObj;
+          return rest;
+        });
       }
     });
   }
@@ -12187,9 +12231,22 @@ var SparkWallet = class _SparkWallet extends EventEmitter {
     const identityPublicKey = bytesToHex11(
       await this.config.signer.getIdentityPublicKey()
     );
+    const userRequests = await this.sspClient?.getTransfers(
+      transfers.transfers.map((transfer) => transfer.id)
+    );
+    const userRequestsMap = /* @__PURE__ */ new Map();
+    for (const userRequest of userRequests || []) {
+      if (userRequest && userRequest.sparkId && userRequest.userRequest) {
+        userRequestsMap.set(userRequest.sparkId, userRequest.userRequest);
+      }
+    }
     return {
       transfers: transfers.transfers.map(
-        (transfer) => mapTransferToWalletTransfer(transfer, identityPublicKey)
+        (transfer) => mapTransferToWalletTransfer(
+          transfer,
+          identityPublicKey,
+          userRequestsMap.get(transfer.id)
+        )
       ),
       offset: transfers.offset
     };
@@ -12372,7 +12429,9 @@ var SparkWallet = class _SparkWallet extends EventEmitter {
       network = BitcoinNetwork_default.REGTEST;
     }
     if (outputIndex === void 0) {
-      outputIndex = await this.getDepositTransactionVout(transactionId);
+      outputIndex = await this.getDepositTransactionVout({
+        txid: transactionId
+      });
     }
     const quote = await sspClient.getClaimDepositQuote({
       transactionId,
@@ -12403,7 +12462,9 @@ var SparkWallet = class _SparkWallet extends EventEmitter {
       throw new Error("SSP client not initialized");
     }
     if (outputIndex === void 0) {
-      outputIndex = await this.getDepositTransactionVout(transactionId);
+      outputIndex = await this.getDepositTransactionVout({
+        txid: transactionId
+      });
     }
     let network = this.config.getSspNetwork();
     if (network === BitcoinNetwork_default.FUTURE_VALUE) {
@@ -12437,25 +12498,94 @@ var SparkWallet = class _SparkWallet extends EventEmitter {
     }
     return response;
   }
+  /**
+   * Get a quote on how much credit you can claim for a deposit from the SSP. If the quote charges less fees than the max fee, claim the deposit.
+   *
+   * @param {Object} params - The parameters object
+   * @param {string} params.transactionId - The ID of the transaction
+   * @param {number} params.maxFee - The maximum fee to claim the deposit for
+   * @param {number} [params.outputIndex] - The index of the output
+   * @returns {Promise<StaticDepositQuoteOutput>} Quote for claiming a deposit to a static deposit address
+   */
+  async claimStaticDepositWithMaxFee({
+    transactionId,
+    maxFee,
+    outputIndex
+  }) {
+    const sspClient = this.getSspClient();
+    let network = this.config.getSspNetwork();
+    if (network === BitcoinNetwork_default.FUTURE_VALUE) {
+      network = BitcoinNetwork_default.REGTEST;
+    }
+    const depositTx = await this.getDepositTransaction(transactionId);
+    if (outputIndex === void 0) {
+      outputIndex = await this.getDepositTransactionVout({
+        txid: transactionId,
+        depositTx
+      });
+    }
+    const depositAmount = Number(depositTx.getOutput(outputIndex).amount);
+    const quote = await sspClient.getClaimDepositQuote({
+      transactionId,
+      outputIndex,
+      network
+    });
+    if (!quote) {
+      throw new Error("Failed to get claim deposit quote");
+    }
+    const { creditAmountSats, signature: sspSignature } = quote;
+    const feeCharged = depositAmount - creditAmountSats;
+    if (feeCharged > maxFee) {
+      throw new ValidationError("Fee larger than max fee", {
+        field: "feeCharged",
+        value: feeCharged
+      });
+    }
+    const response = await this.claimStaticDeposit({
+      transactionId,
+      creditAmountSats,
+      sspSignature,
+      outputIndex
+    });
+    if (!response) {
+      throw new Error("Failed to claim static deposit");
+    }
+    return response;
+  }
   /**
    * 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
+   * @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.fee] - **@deprecated** The fee to refund
+   * @param {number} [params.satsPerVbyteFee] - The fee per vbyte to refund
    * @returns {Promise<string>} The hex of the refund transaction
    */
   async refundStaticDeposit({
     depositTransactionId,
     outputIndex,
     destinationAddress,
-    fee
+    fee,
+    satsPerVbyteFee
   }) {
-    if (fee <= 300) {
+    if (fee !== void 0) {
+      console.warn(
+        `refundStaticDeposit(): \`fee\` parameter is deprecated and will be removed; please switch to \`satsPerVbyteFee\`.`
+      );
+    }
+    if (fee === void 0 && satsPerVbyteFee === void 0) {
+      throw new ValidationError("Fee or satsPerVbyteFee must be provided");
+    }
+    if (satsPerVbyteFee && satsPerVbyteFee > 150) {
+      throw new ValidationError("satsPerVbyteFee must be less than 150");
+    }
+    const finalFee = satsPerVbyteFee ? satsPerVbyteFee * getTxEstimatedVbytesSizeByNumberOfInputsOutputs(1, 1) : fee;
+    if (finalFee <= 200) {
       throw new ValidationError("Fee must be greater than 300", {
         field: "fee",
-        value: fee
+        value: finalFee
       });
     }
     let network = this.config.getNetwork();
@@ -12463,10 +12593,13 @@ var SparkWallet = class _SparkWallet extends EventEmitter {
     const networkJSON = networkToJSON(networkType);
     const depositTx = await this.getDepositTransaction(depositTransactionId);
     if (outputIndex === void 0) {
-      outputIndex = await this.getDepositTransactionVout(depositTransactionId);
+      outputIndex = await this.getDepositTransactionVout({
+        txid: depositTransactionId,
+        depositTx
+      });
     }
     const totalAmount = depositTx.getOutput(outputIndex).amount;
-    const creditAmountSats = Number(totalAmount) - fee;
+    const creditAmountSats = Number(totalAmount) - finalFee;
     if (creditAmountSats <= 0) {
       throw new ValidationError(
         "Fee too large. Credit amount must be greater than 0",
@@ -12514,26 +12647,14 @@ var SparkWallet = class _SparkWallet extends EventEmitter {
     const sparkClient = await this.connectionManager.createSparkClient(
       this.config.getCoordinatorAddress()
     );
-    const transferId = uuidv75();
-    const swapResponse = await sparkClient.initiate_utxo_swap({
+    const swapResponse = await sparkClient.initiate_static_deposit_utxo_refund({
       onChainUtxo: {
         txid: hexToBytes12(depositTransactionId),
         vout: outputIndex,
         network: networkType
       },
-      requestType: 2 /* Refund */,
-      amount: {
-        creditAmountSats: 0,
-        $case: "creditAmountSats"
-      },
       userSignature: swapResponseUserSignature,
-      sspSignature: new Uint8Array(),
-      transfer: {
-        transferId,
-        ownerIdentityPublicKey: await this.config.signer.getIdentityPublicKey(),
-        receiverIdentityPublicKey: await this.config.signer.getIdentityPublicKey()
-      },
-      spendTxSigningJob: signingJob
+      refundTxSigningJob: signingJob
     });
     if (!swapResponse) {
       throw new Error("Failed to initiate utxo swap");
@@ -12546,15 +12667,15 @@ var SparkWallet = class _SparkWallet extends EventEmitter {
         path: 0
       },
       selfCommitment: signingNonceCommitment,
-      statechainCommitments: swapResponse.spendTxSigningResult.signingNonceCommitments,
+      statechainCommitments: swapResponse.refundTxSigningResult.signingNonceCommitments,
       verifyingKey: swapResponse.depositAddress.verifyingPublicKey
     });
     const signatureResult = await this.config.signer.aggregateFrost({
       message: spendTxSighash,
-      statechainSignatures: swapResponse.spendTxSigningResult.signatureShares,
-      statechainPublicKeys: swapResponse.spendTxSigningResult.publicKeys,
+      statechainSignatures: swapResponse.refundTxSigningResult.signatureShares,
+      statechainPublicKeys: swapResponse.refundTxSigningResult.publicKeys,
       verifyingKey: swapResponse.depositAddress.verifyingPublicKey,
-      statechainCommitments: swapResponse.spendTxSigningResult.signingNonceCommitments,
+      statechainCommitments: swapResponse.refundTxSigningResult.signingNonceCommitments,
       selfCommitment: signingNonceCommitment,
       publicKey: await this.config.signer.getStaticDepositSigningKey(0),
       selfSignature: userSignature
@@ -12607,8 +12728,13 @@ var SparkWallet = class _SparkWallet extends EventEmitter {
     }
     return payload;
   }
-  async getDepositTransactionVout(txid) {
-    const depositTx = await this.getDepositTransaction(txid);
+  async getDepositTransactionVout({
+    txid,
+    depositTx
+  }) {
+    if (!depositTx) {
+      depositTx = await this.getDepositTransaction(txid);
+    }
     const staticDepositAddresses = new Set(
       await this.queryStaticDepositAddresses()
     );
@@ -13823,11 +13949,12 @@ var SparkWallet = class _SparkWallet extends EventEmitter {
    * Gets a transfer that has been sent by the SSP to the wallet.
    *
    * @param {string} id - The ID of the transfer
-   * @returns {Promise<GraphQLTransferObj | null>} The transfer
+   * @returns {Promise<TransferWithUserRequest | undefined>} The transfer
    */
   async getTransferFromSsp(id) {
     const sspClient = this.getSspClient();
-    return await sspClient.getTransfer(id);
+    const transfers = await sspClient.getTransfers([id]);
+    return transfers?.[0];
   }
   /**
    * Gets a transfer, that the wallet is a participant of, in the Spark network.
@@ -15037,6 +15164,7 @@ __export(utils_exports, {
   getSparkAddressFromTaproot: () => getSparkAddressFromTaproot,
   getTransactionSequence: () => getTransactionSequence,
   getTransferPackageSigningPayload: () => getTransferPackageSigningPayload,
+  getTxEstimatedVbytesSizeByNumberOfInputsOutputs: () => getTxEstimatedVbytesSizeByNumberOfInputsOutputs,
   getTxFromRawTxBytes: () => getTxFromRawTxBytes,
   getTxFromRawTxHex: () => getTxFromRawTxHex,
   getTxId: () => getTxId,
@@ -15124,6 +15252,7 @@ export {
   getSigHashFromTx,
   getTxId,
   getTxIdNoReverse,
+  getTxEstimatedVbytesSizeByNumberOfInputsOutputs,
   DIRECT_TIMELOCK_OFFSET,
   INITIAL_SEQUENCE,
   INITIAL_DIRECT_SEQUENCE,