@buildonspark/spark-sdk 0.4.1 → 0.4.2

package/src/tests/integration/ssp/lightning.test.ts

@@ -2,12 +2,16 @@ import { describe, expect, it } from "@jest/globals";
 import { ConfigOptions } from "../../../services/wallet-config.js";
 import { SparkWallet } from "../../../spark-wallet/spark-wallet.node.js";
 import {
-  BitcoinNetwork,
   CurrencyUnit,
   LightningReceiveRequestStatus,
 } from "../../../types/index.js";
-import { NetworkType } from "../../../utils/network.js";
 import { ValidationError } from "../../../errors/types.js";
+import { BitcoinFaucet } from "../../utils/test-faucet.js";
+import { SparkWalletTestingWithStream } from "../../utils/spark-testing-wallet.js";
+import { waitForClaim } from "../../utils/utils.js";
+
+const DEPOSIT_AMOUNT = 10000n;
+const INVOICE_AMOUNT = 1000;
 
 const options: ConfigOptions = {
   network: "LOCAL",
@@ -55,6 +59,67 @@ describe("Lightning Network provider", () => {
     );
   });
 
+  describe("should pay lightning invoice", () => {
+    it("should pay lightning invoice created by another wallet", async () => {
+      const faucet = BitcoinFaucet.getInstance();
+
+      const { wallet: aliceWallet } =
+        await SparkWalletTestingWithStream.initialize({
+          options: {
+            network: "LOCAL",
+          },
+        });
+
+      const { wallet: bobWallet } =
+        await SparkWalletTestingWithStream.initialize({
+          options: {
+            network: "LOCAL",
+          },
+        });
+
+      const depositAddress = await aliceWallet.getSingleUseDepositAddress();
+      expect(depositAddress).toBeDefined();
+
+      const signedTx = await faucet.sendToAddress(
+        depositAddress,
+        DEPOSIT_AMOUNT,
+      );
+
+      // Wait for the transaction to be mined
+      await faucet.mineBlocksAndWaitForMiningToComplete(6);
+
+      await aliceWallet.claimDeposit(signedTx.id);
+
+      await waitForClaim({ wallet: aliceWallet });
+
+      const { balance } = await aliceWallet.getBalance();
+      expect(balance).toBe(DEPOSIT_AMOUNT);
+
+      const invoice = await bobWallet.createLightningInvoice({
+        amountSats: INVOICE_AMOUNT,
+        memo: "test",
+        expirySeconds: 10,
+      });
+
+      expect(invoice).toBeDefined();
+
+      await aliceWallet.payLightningInvoice({
+        invoice: invoice.invoice.encodedInvoice,
+        maxFeeSats: 100,
+      });
+
+      await waitForClaim({ wallet: bobWallet });
+
+      const { balance: bobBalance } = await bobWallet.getBalance();
+      expect(bobBalance).toBe(BigInt(INVOICE_AMOUNT));
+
+      const { balance: aliceBalance } = await aliceWallet.getBalance();
+      expect(aliceBalance).toBeLessThan(
+        DEPOSIT_AMOUNT - BigInt(INVOICE_AMOUNT),
+      );
+    }, 120000);
+  });
+
   describe("should fail to create lightning invoice", () => {
     it(`should fail to create lightning invoice with invalid amount`, async () => {
       await expect(

package/src/tests/integration/ssp/swap.test.ts

@@ -1,5 +1,4 @@
 import { describe, expect, it } from "@jest/globals";
-import { SparkWalletTesting } from "../../utils/spark-testing-wallet.js";
 import { BitcoinFaucet } from "../../utils/test-faucet.js";
 import { SparkWalletTestingWithStream } from "../../utils/spark-testing-wallet.js";
 

package/src/tests/integration/static_deposit.test.ts

@@ -48,7 +48,8 @@ describe("SSP static deposit address integration", () => {
       ).rejects.toThrow();
     }, 600000);
 
-    it("should refund and broadcast a static deposit refund transaction", async () => {
+    // Skipping because chainwatcher is not catching up to the transaction.
+    it.skip("should refund and broadcast a static deposit refund transaction", async () => {
       const {
         wallet: userWallet,
         depositAddress,

package/src/tests/integration/transfer.test.ts

@@ -5,8 +5,6 @@ import { wordlist } from "@scure/bip39/wordlists/english";
 import { uuidv7 } from "uuidv7";
 import { RPCError } from "../../errors/types.js";
 import {
-  decodeSparkAddress,
-  isLegacySparkAddress,
   KeyDerivation,
   KeyDerivationType,
   SparkWalletEvent,
@@ -18,7 +16,7 @@ import { SigningService } from "../../services/signing.js";
 import type { LeafKeyTweak } from "../../services/transfer.js";
 import { TransferService } from "../../services/transfer.js";
 import {
-  ConfigOptions,
+  type ConfigOptions,
   getLocalSigningOperators,
   WalletConfig,
 } from "../../services/wallet-config.js";
@@ -1277,26 +1275,9 @@ describe.each(walletTypes)("transfer v2", ({ name, Signer, createTree }) => {
       bobSigningService,
     );
 
-    const legacySparkAddress = await bob.getSparkAddress();
-    const newSparkAddress =
-      "sparkl1pgssxlp9dr9ypzqf2havm5weefu6470l062k3ujtw4uu6gjmfgl599rxucvvkr";
-
-    // TODO: Remove this once we upgrade to the new spark address format
-    expect(isLegacySparkAddress(legacySparkAddress)).toBe(true);
-
-    const decodedLegacySparkAddress = decodeSparkAddress(
-      legacySparkAddress,
-      "LOCAL",
-    );
-    const decodedNewSparkAddress = decodeSparkAddress(newSparkAddress, "LOCAL");
-
-    expect(decodedLegacySparkAddress).toMatchObject({
-      ...decodedNewSparkAddress,
-    });
-
     await alice.transfer({
       amountSats: 1000,
-      receiverSparkAddress: newSparkAddress,
+      receiverSparkAddress: await bob.getSparkAddress(),
     });
 
     const pendingTransfers = await bob.queryPendingTransfers();
@@ -1319,13 +1300,12 @@ describe.each(walletTypes)("transfer v2", ({ name, Signer, createTree }) => {
   });
 });
 
-// TODO: (CNT-493) Re-enable invoice functionality once spark address migration is complete
-describe.skip.each(walletTypes)(
+describe.each(walletTypes)(
   "fulfill spark invoice",
   ({ name, Signer, createTree }) => {
     jest.setTimeout(25_000);
 
-    it.skip(`${name} - test multiple valid transfers with invoice and nil amount invoice`, async () => {
+    it(`${name} - test multiple valid transfers with invoice and nil amount invoice`, async () => {
       const faucet = BitcoinFaucet.getInstance();
 
       const options: ConfigOptions = {
@@ -1512,7 +1492,7 @@ describe.skip.each(walletTypes)(
         amount: 1_000,
         memo: "Test invoice",
         expiryTime: tomorrow,
-        senderPublicKey: await sdk2.getIdentityPublicKey(), // invalid sender public key - receiver as sender
+        senderSparkAddress: await sdk2.getSparkAddress(), // invalid sender public key - receiver as sender
       });
 
       const transferResults = await sdk.fulfillSparkInvoice([
@@ -1573,7 +1553,7 @@ describe.skip.each(walletTypes)(
         amount: 1_000,
         memo: "Test invoice",
         expiryTime: yesterday,
-        senderPublicKey: await sdk.getIdentityPublicKey(),
+        senderSparkAddress: await sdk.getSparkAddress(),
       });
 
       const transferResults = await sdk.fulfillSparkInvoice([
@@ -1583,7 +1563,7 @@ describe.skip.each(walletTypes)(
       expect(invalidInvoices.length).toBe(1);
     });
 
-    it.skip(`${name} - should error when paying the same invoice twice`, async () => {
+    it(`${name} - should error when paying the same invoice twice`, async () => {
       const faucet = BitcoinFaucet.getInstance();
 
       const options: ConfigOptions = {
@@ -1629,7 +1609,7 @@ describe.skip.each(walletTypes)(
         amount: 1_000,
         memo: "Test invoice",
         expiryTime: tomorrow,
-        senderPublicKey: await sdk.getIdentityPublicKey(),
+        senderSparkAddress: await sdk.getSparkAddress(),
       });
 
       await sdk.fulfillSparkInvoice([{ invoice: invoice1000 }]);

package/src/tests/token-hashing.test.ts

@@ -30,11 +30,11 @@ const TEST_OPERATOR_PUB_KEY = new Uint8Array([
 const TEST_INVOICE_ATTACHMENTS = [
   {
     sparkInvoice:
-      "sprt1pgssypkrjhrpzt2hw0ggrmndanmm035ley75nxu3gejaju4wx9nq86lwzfjqsqgjzqqe3zul2fm8a24y576t0ne2ehup5fg2yz4r6hxlhatyu9kpw09s2fk36ta5j0k85qascf6snpuy4sp0rp4ezyspvs4qgmt9d4hnyggzqmpet3s394th85ypaek7eaahc60uj02fnwg5vewew2hrzesra0hqflc0vn",
+      "sparkrt1pgssx5us3wkqjza8g80xz3a9gznx25msq6g3ty8exfym9q3ahcv86vsnzfmssqgjzqqejtaxmwj8ms9rn58574nvlq4j5zr5v4ehgnt9d4hnyggr2wgghtqfpwn5rhnpg7j5pfn92dcqdyg4jrunyjdjsg7muxraxgfn5rqgandgr3sxzrqdmew8qydzvz3qpylysylkgcaw9vpm2jzspls0qtr5kfmlwz244rvuk25w5w2sgc2pyqsraqdyp8tf57a6cn2egttaas9ms3whssenmjqt8wag3lgyvdzjskfeupt8xwwdx4agxdm9f0wefzj28jmdxqeudwcwdj9vfl9sdr65x06r0tasf5fwz2",
   },
   {
     sparkInvoice:
-      "sprt1pgssypkrjhrpzt2hw0ggrmndanmm035ley75nxu3gejaju4wx9nq86lwzf5ssqgjzqqe3zulcs6h42v0kqkdsv9utxyp5fs2yz4r6hxlhatyu9kpw09s2fk36ta5j0k85qascf6snpuy4sp0rp4ezyszq86z5zryd9nxvmt9d4hnyggzqmpet3s394th85ypaek7eaahc60uj02fnwg5vewew2hrzesra0hql7r5ne",
+      "sparkrt1pgssx5us3wkqjza8g80xz3a9gznx25msq6g3ty8exfym9q3ahcv86vsnzfmqsqgjzqqejtavuhf8n5uh9a74zw66kqaz5zr5v4ehgnt9d4hnyggr2wgghtqfpwn5rhnpg7j5pfn92dcqdyg4jrunyjdjsg7muxraxgfn5zcglrwcr3sxzzqt3wrjrgnq5gqf8eyp8ajx8t3tqw65s5q0urczca9jwlmsj4dgm89j4r4rj5zxzsfqyqlgrfqw9ucldgmfzs5zmkekj90thwzmn6ps55gdjnz23aarjkf245608yg0v2x6xdpdrz6m8xjlhtru0kygcu4zhqwlth9duadfqpruuzx4tc7fdckn",
   },
 ];
 
@@ -202,8 +202,8 @@ describe("hash token transaction", () => {
     const hash = hashTokenTransactionV2(tokenTransaction, false);
 
     expect(Array.from(hash)).toEqual([
-      139, 4, 220, 112, 69, 32, 149, 81, 90, 67, 151, 101, 240, 182, 13, 123,
-      70, 4, 153, 159, 172, 225, 15, 120, 71, 219, 154, 27, 72, 167, 2, 149,
+      19, 39, 37, 63, 91, 26, 243, 192, 252, 18, 74, 19, 59, 241, 142, 11, 20,
+      6, 129, 246, 162, 133, 158, 123, 133, 98, 169, 100, 172, 163, 231, 32,
     ]);
   });
 });

package/src/tests/xchain-address.test.ts

@@ -5,17 +5,17 @@ describe("xchain-address", () => {
     [
       "mainnet",
       "bc1pvluhspufxmuus9wh3dshxhxfg3656c9mwfw85scaydyp7sk9800sl4h5ae",
-      "sp1pgssyele0qrcjdheeq2a0zmpwdwvj3r4f4stkuju0fp36g6grapv2w7ltce4pm",
+      "spark1pgssyele0qrcjdheeq2a0zmpwdwvj3r4f4stkuju0fp36g6grapv2w7l8am2cp",
     ],
     [
       "testnet",
       "tb1psw24aa3jkdkndr68gy2gk3ws4hm7dnsccqqtd92fxxqv2jhv5fcqkfyu7v",
-      "spt1pgss9qu4tmmr9vmdx685wsg53dzapt0hum8p3sqqk625jvvqc49wegns9pkyp6",
+      "sparkt1pgss9qu4tmmr9vmdx685wsg53dzapt0hum8p3sqqk625jvvqc49wegnst05852",
     ],
     [
       "regtest",
       "bcrt1p47kh0ff29d3rjw2n43vxqgmrgv9az562x37x6dp4ehyqq7ezyhcqlz5y42",
-      "sprt1pgss9tadw7jj52mz8yu48tzcvq3kxsct69f55drud56rtnwgqpajyf0sp8jkjq",
+      "sparkrt1pgss9tadw7jj52mz8yu48tzcvq3kxsct69f55drud56rtnwgqpajyf0stj62w6",
     ],
   ])(
     "getSparkAddressFromTaproot success (%s)",

package/src/utils/address.ts

@@ -63,14 +63,14 @@ export interface DecodedSparkAddressData {
 
 export function encodeSparkAddress(
   payload: SparkAddressData,
-): LegacySparkAddressFormat {
+): SparkAddressFormat {
   return encodeSparkAddressWithSignature(payload);
 }
 
 export function encodeSparkAddressWithSignature(
   payload: SparkAddressData,
   signature?: Uint8Array,
-): LegacySparkAddressFormat {
+): SparkAddressFormat {
   try {
     isValidPublicKey(payload.identityPublicKey);
     const identityPublicKey = hexToBytes(payload.identityPublicKey);
@@ -99,9 +99,9 @@ export function encodeSparkAddressWithSignature(
     const words = bech32m.toWords(serializedPayload);
 
     return bech32mEncode(
-      LegacyAddressNetwork[payload.network],
+      AddressNetwork[payload.network],
       words,
-    ) as LegacySparkAddressFormat;
+    ) as SparkAddressFormat;
   } catch (error) {
     throw new ValidationError(
       "Failed to encode Spark address",
@@ -193,6 +193,7 @@ export function decodeSparkAddress(
 const PrefixToNetwork: Record<string, NetworkType> = Object.fromEntries(
   Object.entries(AddressNetwork).map(([k, v]) => [v, k as NetworkType]),
 ) as Record<string, NetworkType>;
+
 const LegacyPrefixToNetwork: Record<string, NetworkType> = Object.fromEntries(
   Object.entries(LegacyAddressNetwork).map(([k, v]) => [v, k as NetworkType]),
 ) as Record<string, NetworkType>;
@@ -210,6 +211,7 @@ export function getNetworkFromSparkAddress(address: string): NetworkType {
   }
   return network;
 }
+
 export function isLegacySparkAddress(
   address: string,
 ): address is LegacySparkAddressFormat {