@buildonspark/spark-sdk 0.1.46 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @buildonspark/spark-sdk
 
+## 0.2.0
+
+### Minor Changes
+
+- Remove key map state from signer interface.
+  - The SDK now passes around the derivation details regarding the signing key instead of forcing the signer to maintain a pubkey to privkey map
+- Parameter changes to transferTokens() and batchTransferTokens()
+- Parameter changes to queryTokenTransactions()
+- Replaced getIssuerTokenInfo() with getIssuerTokenMetadata()
+- Rename HumanReadableTokenIdentifier to Bech32mTokenIdentifier
+  - Bech32mTokenIdentifier must now be passed as tokenIdentifier in transferTokens() batchTransferTokens
+
+## 0.1.47
+
+### Patch Changes
+
+- - Move some less common imports to root. If you were using these import paths please update them to import the same objects from @buildonspark/spark-sdk instead:
+    - @buildonspark/spark-sdk/address
+    - @buildonspark/spark-sdk/signer
+    - @buildonspark/spark-sdk/services/wallet-config
+    - @buildonspark/spark-sdk/utils
+    - @buildonspark/spark-sdk/token-transactions
+    - @buildonspark/spark-sdk/config
+    - @buildonspark/spark-sdk/lrc-connection
+    - @buildonspark/spark-sdk/connection
+
 ## 0.1.46
 
 ### Patch Changes

package/dist/{chunk-BGGEVUJK.js → chunk-2ENZX6LT.js}

@@ -54,6 +54,8 @@ __export(spark_exports, {
   InitiatePreimageSwapRequest: () => InitiatePreimageSwapRequest,
   InitiatePreimageSwapRequest_Reason: () => InitiatePreimageSwapRequest_Reason,
   InitiatePreimageSwapResponse: () => InitiatePreimageSwapResponse,
+  InitiateStaticDepositUtxoRefundRequest: () => InitiateStaticDepositUtxoRefundRequest,
+  InitiateStaticDepositUtxoRefundResponse: () => InitiateStaticDepositUtxoRefundResponse,
   InitiateUtxoSwapRequest: () => InitiateUtxoSwapRequest,
   InitiateUtxoSwapResponse: () => InitiateUtxoSwapResponse,
   InvestigateLeavesRequest: () => InvestigateLeavesRequest,
@@ -4026,7 +4028,12 @@ var TokenTransactionConfirmationMetadata = {
   }
 };
 function createBaseTokenTransactionWithStatus() {
-  return { tokenTransaction: void 0, status: 0, confirmationMetadata: void 0 };
+  return {
+    tokenTransaction: void 0,
+    status: 0,
+    confirmationMetadata: void 0,
+    tokenTransactionHash: new Uint8Array(0)
+  };
 }
 var TokenTransactionWithStatus = {
   encode(message, writer = new BinaryWriter4()) {
@@ -4039,6 +4046,9 @@ var TokenTransactionWithStatus = {
     if (message.confirmationMetadata !== void 0) {
       TokenTransactionConfirmationMetadata.encode(message.confirmationMetadata, writer.uint32(26).fork()).join();
     }
+    if (message.tokenTransactionHash.length !== 0) {
+      writer.uint32(34).bytes(message.tokenTransactionHash);
+    }
     return writer;
   },
   decode(input, length) {
@@ -4069,6 +4079,13 @@ var TokenTransactionWithStatus = {
           message.confirmationMetadata = TokenTransactionConfirmationMetadata.decode(reader, reader.uint32());
           continue;
         }
+        case 4: {
+          if (tag !== 34) {
+            break;
+          }
+          message.tokenTransactionHash = reader.bytes();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -4081,7 +4098,8 @@ var TokenTransactionWithStatus = {
     return {
       tokenTransaction: isSet3(object.tokenTransaction) ? TokenTransaction.fromJSON(object.tokenTransaction) : void 0,
       status: isSet3(object.status) ? tokenTransactionStatusFromJSON(object.status) : 0,
-      confirmationMetadata: isSet3(object.confirmationMetadata) ? TokenTransactionConfirmationMetadata.fromJSON(object.confirmationMetadata) : void 0
+      confirmationMetadata: isSet3(object.confirmationMetadata) ? TokenTransactionConfirmationMetadata.fromJSON(object.confirmationMetadata) : void 0,
+      tokenTransactionHash: isSet3(object.tokenTransactionHash) ? bytesFromBase642(object.tokenTransactionHash) : new Uint8Array(0)
     };
   },
   toJSON(message) {
@@ -4095,6 +4113,9 @@ var TokenTransactionWithStatus = {
     if (message.confirmationMetadata !== void 0) {
       obj.confirmationMetadata = TokenTransactionConfirmationMetadata.toJSON(message.confirmationMetadata);
     }
+    if (message.tokenTransactionHash.length !== 0) {
+      obj.tokenTransactionHash = base64FromBytes2(message.tokenTransactionHash);
+    }
     return obj;
   },
   create(base) {
@@ -4105,6 +4126,7 @@ var TokenTransactionWithStatus = {
     message.tokenTransaction = object.tokenTransaction !== void 0 && object.tokenTransaction !== null ? TokenTransaction.fromPartial(object.tokenTransaction) : void 0;
     message.status = object.status ?? 0;
     message.confirmationMetadata = object.confirmationMetadata !== void 0 && object.confirmationMetadata !== null ? TokenTransactionConfirmationMetadata.fromPartial(object.confirmationMetadata) : void 0;
+    message.tokenTransactionHash = object.tokenTransactionHash ?? new Uint8Array(0);
     return message;
   }
 };
@@ -8979,13 +9001,16 @@ var RequestedSigningCommitments_SigningNonceCommitmentsEntry = {
   }
 };
 function createBaseGetSigningCommitmentsRequest() {
-  return { nodeIds: [] };
+  return { nodeIds: [], count: 0 };
 }
 var GetSigningCommitmentsRequest = {
   encode(message, writer = new BinaryWriter4()) {
     for (const v of message.nodeIds) {
       writer.uint32(10).string(v);
     }
+    if (message.count !== 0) {
+      writer.uint32(16).uint32(message.count);
+    }
     return writer;
   },
   decode(input, length) {
@@ -9002,6 +9027,13 @@ var GetSigningCommitmentsRequest = {
           message.nodeIds.push(reader.string());
           continue;
         }
+        case 2: {
+          if (tag !== 16) {
+            break;
+          }
+          message.count = reader.uint32();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -9012,7 +9044,8 @@ var GetSigningCommitmentsRequest = {
   },
   fromJSON(object) {
     return {
-      nodeIds: globalThis.Array.isArray(object?.nodeIds) ? object.nodeIds.map((e) => globalThis.String(e)) : []
+      nodeIds: globalThis.Array.isArray(object?.nodeIds) ? object.nodeIds.map((e) => globalThis.String(e)) : [],
+      count: isSet3(object.count) ? globalThis.Number(object.count) : 0
     };
   },
   toJSON(message) {
@@ -9020,6 +9053,9 @@ var GetSigningCommitmentsRequest = {
     if (message.nodeIds?.length) {
       obj.nodeIds = message.nodeIds;
     }
+    if (message.count !== 0) {
+      obj.count = Math.round(message.count);
+    }
     return obj;
   },
   create(base) {
@@ -9028,6 +9064,7 @@ var GetSigningCommitmentsRequest = {
   fromPartial(object) {
     const message = createBaseGetSigningCommitmentsRequest();
     message.nodeIds = object.nodeIds?.map((e) => e) || [];
+    message.count = object.count ?? 0;
     return message;
   }
 };
@@ -12524,7 +12561,7 @@ var QueryUnusedDepositAddressesRequest = {
   }
 };
 function createBaseQueryStaticDepositAddressesRequest() {
-  return { identityPublicKey: new Uint8Array(0), network: 0, limit: 0, offset: 0 };
+  return { identityPublicKey: new Uint8Array(0), network: 0, limit: 0, offset: 0, depositAddress: void 0 };
 }
 var QueryStaticDepositAddressesRequest = {
   encode(message, writer = new BinaryWriter4()) {
@@ -12540,6 +12577,9 @@ var QueryStaticDepositAddressesRequest = {
     if (message.offset !== 0) {
       writer.uint32(40).int64(message.offset);
     }
+    if (message.depositAddress !== void 0) {
+      writer.uint32(50).string(message.depositAddress);
+    }
     return writer;
   },
   decode(input, length) {
@@ -12577,6 +12617,13 @@ var QueryStaticDepositAddressesRequest = {
           message.offset = longToNumber2(reader.int64());
           continue;
         }
+        case 6: {
+          if (tag !== 50) {
+            break;
+          }
+          message.depositAddress = reader.string();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -12590,7 +12637,8 @@ var QueryStaticDepositAddressesRequest = {
       identityPublicKey: isSet3(object.identityPublicKey) ? bytesFromBase642(object.identityPublicKey) : new Uint8Array(0),
       network: isSet3(object.network) ? networkFromJSON(object.network) : 0,
       limit: isSet3(object.limit) ? globalThis.Number(object.limit) : 0,
-      offset: isSet3(object.offset) ? globalThis.Number(object.offset) : 0
+      offset: isSet3(object.offset) ? globalThis.Number(object.offset) : 0,
+      depositAddress: isSet3(object.depositAddress) ? globalThis.String(object.depositAddress) : void 0
     };
   },
   toJSON(message) {
@@ -12607,6 +12655,9 @@ var QueryStaticDepositAddressesRequest = {
     if (message.offset !== 0) {
       obj.offset = Math.round(message.offset);
     }
+    if (message.depositAddress !== void 0) {
+      obj.depositAddress = message.depositAddress;
+    }
     return obj;
   },
   create(base) {
@@ -12618,6 +12669,7 @@ var QueryStaticDepositAddressesRequest = {
     message.network = object.network ?? 0;
     message.limit = object.limit ?? 0;
     message.offset = object.offset ?? 0;
+    message.depositAddress = object.depositAddress ?? void 0;
     return message;
   }
 };
@@ -13235,6 +13287,157 @@ var PaymentIntentFields = {
     return message;
   }
 };
+function createBaseInitiateStaticDepositUtxoRefundRequest() {
+  return { onChainUtxo: void 0, refundTxSigningJob: void 0, userSignature: new Uint8Array(0) };
+}
+var InitiateStaticDepositUtxoRefundRequest = {
+  encode(message, writer = new BinaryWriter4()) {
+    if (message.onChainUtxo !== void 0) {
+      UTXO.encode(message.onChainUtxo, writer.uint32(10).fork()).join();
+    }
+    if (message.refundTxSigningJob !== void 0) {
+      SigningJob.encode(message.refundTxSigningJob, writer.uint32(26).fork()).join();
+    }
+    if (message.userSignature.length !== 0) {
+      writer.uint32(34).bytes(message.userSignature);
+    }
+    return writer;
+  },
+  decode(input, length) {
+    const reader = input instanceof BinaryReader4 ? input : new BinaryReader4(input);
+    const end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseInitiateStaticDepositUtxoRefundRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+          message.onChainUtxo = UTXO.decode(reader, reader.uint32());
+          continue;
+        }
+        case 3: {
+          if (tag !== 26) {
+            break;
+          }
+          message.refundTxSigningJob = SigningJob.decode(reader, reader.uint32());
+          continue;
+        }
+        case 4: {
+          if (tag !== 34) {
+            break;
+          }
+          message.userSignature = reader.bytes();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+  fromJSON(object) {
+    return {
+      onChainUtxo: isSet3(object.onChainUtxo) ? UTXO.fromJSON(object.onChainUtxo) : void 0,
+      refundTxSigningJob: isSet3(object.refundTxSigningJob) ? SigningJob.fromJSON(object.refundTxSigningJob) : void 0,
+      userSignature: isSet3(object.userSignature) ? bytesFromBase642(object.userSignature) : new Uint8Array(0)
+    };
+  },
+  toJSON(message) {
+    const obj = {};
+    if (message.onChainUtxo !== void 0) {
+      obj.onChainUtxo = UTXO.toJSON(message.onChainUtxo);
+    }
+    if (message.refundTxSigningJob !== void 0) {
+      obj.refundTxSigningJob = SigningJob.toJSON(message.refundTxSigningJob);
+    }
+    if (message.userSignature.length !== 0) {
+      obj.userSignature = base64FromBytes2(message.userSignature);
+    }
+    return obj;
+  },
+  create(base) {
+    return InitiateStaticDepositUtxoRefundRequest.fromPartial(base ?? {});
+  },
+  fromPartial(object) {
+    const message = createBaseInitiateStaticDepositUtxoRefundRequest();
+    message.onChainUtxo = object.onChainUtxo !== void 0 && object.onChainUtxo !== null ? UTXO.fromPartial(object.onChainUtxo) : void 0;
+    message.refundTxSigningJob = object.refundTxSigningJob !== void 0 && object.refundTxSigningJob !== null ? SigningJob.fromPartial(object.refundTxSigningJob) : void 0;
+    message.userSignature = object.userSignature ?? new Uint8Array(0);
+    return message;
+  }
+};
+function createBaseInitiateStaticDepositUtxoRefundResponse() {
+  return { refundTxSigningResult: void 0, depositAddress: void 0 };
+}
+var InitiateStaticDepositUtxoRefundResponse = {
+  encode(message, writer = new BinaryWriter4()) {
+    if (message.refundTxSigningResult !== void 0) {
+      SigningResult2.encode(message.refundTxSigningResult, writer.uint32(10).fork()).join();
+    }
+    if (message.depositAddress !== void 0) {
+      DepositAddressQueryResult.encode(message.depositAddress, writer.uint32(18).fork()).join();
+    }
+    return writer;
+  },
+  decode(input, length) {
+    const reader = input instanceof BinaryReader4 ? input : new BinaryReader4(input);
+    const end = length === void 0 ? reader.len : reader.pos + length;
+    const message = createBaseInitiateStaticDepositUtxoRefundResponse();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+          message.refundTxSigningResult = SigningResult2.decode(reader, reader.uint32());
+          continue;
+        }
+        case 2: {
+          if (tag !== 18) {
+            break;
+          }
+          message.depositAddress = DepositAddressQueryResult.decode(reader, reader.uint32());
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+  fromJSON(object) {
+    return {
+      refundTxSigningResult: isSet3(object.refundTxSigningResult) ? SigningResult2.fromJSON(object.refundTxSigningResult) : void 0,
+      depositAddress: isSet3(object.depositAddress) ? DepositAddressQueryResult.fromJSON(object.depositAddress) : void 0
+    };
+  },
+  toJSON(message) {
+    const obj = {};
+    if (message.refundTxSigningResult !== void 0) {
+      obj.refundTxSigningResult = SigningResult2.toJSON(message.refundTxSigningResult);
+    }
+    if (message.depositAddress !== void 0) {
+      obj.depositAddress = DepositAddressQueryResult.toJSON(message.depositAddress);
+    }
+    return obj;
+  },
+  create(base) {
+    return InitiateStaticDepositUtxoRefundResponse.fromPartial(base ?? {});
+  },
+  fromPartial(object) {
+    const message = createBaseInitiateStaticDepositUtxoRefundResponse();
+    message.refundTxSigningResult = object.refundTxSigningResult !== void 0 && object.refundTxSigningResult !== null ? SigningResult2.fromPartial(object.refundTxSigningResult) : void 0;
+    message.depositAddress = object.depositAddress !== void 0 && object.depositAddress !== null ? DepositAddressQueryResult.fromPartial(object.depositAddress) : void 0;
+    return message;
+  }
+};
 function createBaseInitiateUtxoSwapRequest() {
   return {
     onChainUtxo: void 0,
@@ -14628,6 +14831,14 @@ var SparkServiceDefinition = {
       responseStream: false,
       options: {}
     },
+    create_tree_v2: {
+      name: "create_tree_v2",
+      requestType: CreateTreeRequest,
+      requestStream: false,
+      responseType: CreateTreeResponse,
+      responseStream: false,
+      options: {}
+    },
     get_signing_operator_list: {
       name: "get_signing_operator_list",
       requestType: Empty,
@@ -14757,7 +14968,28 @@ var SparkServiceDefinition = {
       responseStream: true,
       options: {}
     },
-    /** Claim a deposit to a static address from SSP side */
+    /**
+     * Signs the provided refund transaction which spends the UTXO from a static
+     * deposit address. If successful, the UTXO will no longer be available to claim on
+     * the Spark network, and the refund transaction must be broadcasted on L1 to claim
+     * the funds. Returns an error if the UTXO has already been claimed.
+     */
+    initiate_static_deposit_utxo_refund: {
+      name: "initiate_static_deposit_utxo_refund",
+      requestType: InitiateStaticDepositUtxoRefundRequest,
+      requestStream: false,
+      responseType: InitiateStaticDepositUtxoRefundResponse,
+      responseStream: false,
+      options: {}
+    },
+    /**
+     * DEPRECATED: This unified method is being split for better clarity and type safety
+     *
+     * For swap operations: Use spark_ssp_internal.initiate_static_deposit_utxo_swap()
+     * For refund operations: Use initiate_static_deposit_utxo_refund()
+     *
+     * @deprecated
+     */
     initiate_utxo_swap: {
       name: "initiate_utxo_swap",
       requestType: InitiateUtxoSwapRequest,
@@ -14994,6 +15226,8 @@ export {
   QueryBalanceResponse_NodeBalancesEntry,
   SparkAddress,
   PaymentIntentFields,
+  InitiateStaticDepositUtxoRefundRequest,
+  InitiateStaticDepositUtxoRefundResponse,
   InitiateUtxoSwapRequest,
   InitiateUtxoSwapResponse,
   ExitingTree,

package/dist/{chunk-LHRD2WT6.js → chunk-4JD4HIAN.js}

@@ -3,7 +3,7 @@ import {
   Timestamp,
   networkFromJSON,
   networkToJSON
-} from "./chunk-BGGEVUJK.js";
+} from "./chunk-2ENZX6LT.js";
 
 // src/proto/spark_token.ts
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
@@ -2147,7 +2147,12 @@ var TokenTransactionConfirmationMetadata = {
   }
 };
 function createBaseTokenTransactionWithStatus() {
-  return { tokenTransaction: void 0, status: 0, confirmationMetadata: void 0 };
+  return {
+    tokenTransaction: void 0,
+    status: 0,
+    confirmationMetadata: void 0,
+    tokenTransactionHash: new Uint8Array(0)
+  };
 }
 var TokenTransactionWithStatus = {
   encode(message, writer = new BinaryWriter()) {
@@ -2160,6 +2165,9 @@ var TokenTransactionWithStatus = {
     if (message.confirmationMetadata !== void 0) {
       TokenTransactionConfirmationMetadata.encode(message.confirmationMetadata, writer.uint32(26).fork()).join();
     }
+    if (message.tokenTransactionHash.length !== 0) {
+      writer.uint32(34).bytes(message.tokenTransactionHash);
+    }
     return writer;
   },
   decode(input, length) {
@@ -2190,6 +2198,13 @@ var TokenTransactionWithStatus = {
           message.confirmationMetadata = TokenTransactionConfirmationMetadata.decode(reader, reader.uint32());
           continue;
         }
+        case 4: {
+          if (tag !== 34) {
+            break;
+          }
+          message.tokenTransactionHash = reader.bytes();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -2202,7 +2217,8 @@ var TokenTransactionWithStatus = {
     return {
       tokenTransaction: isSet(object.tokenTransaction) ? TokenTransaction.fromJSON(object.tokenTransaction) : void 0,
       status: isSet(object.status) ? tokenTransactionStatusFromJSON(object.status) : 0,
-      confirmationMetadata: isSet(object.confirmationMetadata) ? TokenTransactionConfirmationMetadata.fromJSON(object.confirmationMetadata) : void 0
+      confirmationMetadata: isSet(object.confirmationMetadata) ? TokenTransactionConfirmationMetadata.fromJSON(object.confirmationMetadata) : void 0,
+      tokenTransactionHash: isSet(object.tokenTransactionHash) ? bytesFromBase64(object.tokenTransactionHash) : new Uint8Array(0)
     };
   },
   toJSON(message) {
@@ -2216,6 +2232,9 @@ var TokenTransactionWithStatus = {
     if (message.confirmationMetadata !== void 0) {
       obj.confirmationMetadata = TokenTransactionConfirmationMetadata.toJSON(message.confirmationMetadata);
     }
+    if (message.tokenTransactionHash.length !== 0) {
+      obj.tokenTransactionHash = base64FromBytes(message.tokenTransactionHash);
+    }
     return obj;
   },
   create(base) {
@@ -2226,6 +2245,7 @@ var TokenTransactionWithStatus = {
     message.tokenTransaction = object.tokenTransaction !== void 0 && object.tokenTransaction !== null ? TokenTransaction.fromPartial(object.tokenTransaction) : void 0;
     message.status = object.status ?? 0;
     message.confirmationMetadata = object.confirmationMetadata !== void 0 && object.confirmationMetadata !== null ? TokenTransactionConfirmationMetadata.fromPartial(object.confirmationMetadata) : void 0;
+    message.tokenTransactionHash = object.tokenTransactionHash ?? new Uint8Array(0);
     return message;
   }
 };

package/dist/{chunk-I54FARY2.js → chunk-CDLETEDT.js}

@@ -1,6 +1,13 @@
-import {
-  BitcoinNetwork_default
-} from "./chunk-HMLOC6TE.js";
+// src/graphql/objects/BitcoinNetwork.ts
+var BitcoinNetwork = /* @__PURE__ */ ((BitcoinNetwork2) => {
+  BitcoinNetwork2["FUTURE_VALUE"] = "FUTURE_VALUE";
+  BitcoinNetwork2["MAINNET"] = "MAINNET";
+  BitcoinNetwork2["REGTEST"] = "REGTEST";
+  BitcoinNetwork2["SIGNET"] = "SIGNET";
+  BitcoinNetwork2["TESTNET"] = "TESTNET";
+  return BitcoinNetwork2;
+})(BitcoinNetwork || {});
+var BitcoinNetwork_default = BitcoinNetwork;
 
 // src/graphql/objects/ClaimStaticDeposit.ts
 import { isObject } from "@lightsparkdev/core";
@@ -1459,6 +1466,7 @@ fragment SparkWalletUserFragment on SparkWalletUser {
 var SparkWalletUser_default = SparkWalletUser;
 
 export {
+  BitcoinNetwork_default,
   CurrencyUnit_default,
   CurrencyAmountFromJson,
   ExitSpeed_default,

package/dist/{chunk-OBFKIEMP.js → chunk-TM6CHQXC.js}

@@ -2,7 +2,7 @@ import {
   Network,
   TransferStatus,
   TransferType
-} from "./chunk-BGGEVUJK.js";
+} from "./chunk-2ENZX6LT.js";
 
 // src/types/sdk-types.ts
 import { bytesToHex } from "@noble/curves/abstract/utils";