@buildonspark/issuer-sdk 0.0.92 → 0.0.93

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @buildonspark/issuer-sdk
 
+## 0.0.93
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.3.0
+
 ## 0.0.92
 
 ### Patch Changes

package/README.md

@@ -1,2 +1,3 @@
 # Welcome to Spark!
-You can find our official documentation at https://docs.spark.money/issuing/introduction
+
+You can find our official documentation at https://docs.spark.money/issuing/introduction

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildonspark/issuer-sdk",
-  "version": "0.0.92",
+  "version": "0.0.93",
   "description": "Spark Issuer SDK for token issuance",
   "license": "Apache-2.0",
   "module": "./dist/index.js",
@@ -56,8 +56,8 @@
     "depcheck": "depcheck --ignores=buffer,ts-proto,jest,ts-jest,publint",
     "dev": "yarn build -- --watch",
     "docs": "typedoc src",
-    "format:fix": "prettier src --write",
-    "format": "prettier src --check",
+    "format:fix": "prettier . --write",
+    "format": "prettier . --check",
     "lint:fix": "eslint --fix .",
     "lint:fix:continue": "eslint --fix . || exit 0",
     "lint:watch": "esw ./src -w --ext .ts,.tsx,.js --color",
@@ -72,7 +72,7 @@
     "types": "tsc"
   },
   "dependencies": {
-    "@buildonspark/spark-sdk": "0.2.13",
+    "@buildonspark/spark-sdk": "0.3.0",
     "@noble/curves": "^1.8.0",
     "@scure/btc-signer": "^1.5.0",
     "buffer": "^6.0.3"
@@ -86,7 +86,7 @@
     "jest": "^29.7.0",
     "madge": "^8.0.0",
     "node-fetch": "^3.3.2",
-    "prettier": "^3.5.1",
+    "prettier": "^3.6.2",
     "publint": "^0.3.9",
     "ts-jest": "^29.2.5",
     "tsup": "^8.4.0",

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

@@ -1,12 +1,14 @@
 import {
   ConfigOptions,
   filterTokenBalanceForTokenIdentifier,
+  RPCError,
   WalletConfig,
 } from "@buildonspark/spark-sdk";
 import { jest } from "@jest/globals";
-import { bytesToHex } from "@noble/curves/utils";
+import { hexToBytes, bytesToHex } from "@noble/curves/utils";
 import { IssuerSparkWalletTesting } from "../utils/issuer-test-wallet.js";
 import { SparkWalletTesting } from "../utils/spark-testing-wallet.js";
+import { BitcoinFaucet } from "@buildonspark/spark-sdk/test-utils";
 
 export const TOKENS_V0_SCHNORR_CONFIG: Required<ConfigOptions> = {
   ...WalletConfig.LOCAL,
@@ -232,9 +234,12 @@ describe.each(TEST_CONFIGS)(
         expiryTime: new Date(Date.now() + 1000 * 60 * 60 * 24),
       });
 
-      const txId = await issuerWallet.fulfillSparkInvoice([{ invoice }]);
-      expect(typeof txId).toBe("string");
-      expect(txId.length).toBeGreaterThan(0);
+      const { tokenTransactionSuccess, tokenTransactionErrors } =
+        await issuerWallet.fulfillSparkInvoice([{ invoice }]);
+      expect(tokenTransactionErrors.length).toBe(0);
+      expect(tokenTransactionSuccess.length).toBe(1);
+      expect(tokenTransactionSuccess[0].txid).toBeDefined();
+      expect(tokenTransactionSuccess[0].txid.length).toBeGreaterThan(0);
 
       const issuerBalanceAfter = (await issuerWallet.getIssuerTokenBalance())
         .balance;
@@ -305,13 +310,16 @@ describe.each(TEST_CONFIGS)(
         expiryTime: new Date(Date.now() + 1000 * 60 * 60 * 24),
       });
 
-      const txId = await issuerWallet.fulfillSparkInvoice([
-        { invoice: invoice1 },
-        { invoice: invoice2 },
-        { invoice: invoice3 },
-      ]);
-      expect(typeof txId).toBe("string");
-      expect(txId.length).toBeGreaterThan(0);
+      const { tokenTransactionSuccess, tokenTransactionErrors } =
+        await issuerWallet.fulfillSparkInvoice([
+          { invoice: invoice1 },
+          { invoice: invoice2 },
+          { invoice: invoice3 },
+        ]);
+      expect(tokenTransactionErrors.length).toBe(0);
+      expect(tokenTransactionSuccess.length).toBe(1);
+      expect(tokenTransactionSuccess[0].txid).toBeDefined();
+      expect(tokenTransactionSuccess[0].txid.length).toBeGreaterThan(0);
 
       const issuerBalanceAfter = (await issuerWallet.getIssuerTokenBalance())
         .balance;
@@ -369,9 +377,11 @@ describe.each(TEST_CONFIGS)(
         expiryTime: new Date(Date.now() - 60_000),
       });
 
-      await expect(
-        issuerWallet.fulfillSparkInvoice([{ invoice: expiredInvoice }]),
-      ).rejects.toThrow("expired");
+      const { invalidInvoices } = await issuerWallet.fulfillSparkInvoice([
+        { invoice: expiredInvoice },
+      ]);
+      expect(invalidInvoices.length).toBe(1);
+      expect(invalidInvoices[0].invoice).toBe(expiredInvoice);
 
       const issuerBalanceAfter = (await issuerWallet.getIssuerTokenBalance())
         .balance;
@@ -420,11 +430,14 @@ describe.each(TEST_CONFIGS)(
         expiryTime: null as unknown as Date,
       });
 
-      const txId = await issuerWallet.fulfillSparkInvoice([
-        { invoice: nullExpiryInvoice },
-      ]);
-      expect(typeof txId).toBe("string");
-      expect(txId.length).toBeGreaterThan(0);
+      const { tokenTransactionSuccess, tokenTransactionErrors } =
+        await issuerWallet.fulfillSparkInvoice([
+          { invoice: nullExpiryInvoice },
+        ]);
+      expect(tokenTransactionErrors.length).toBe(0);
+      expect(tokenTransactionSuccess.length).toBe(1);
+      expect(tokenTransactionSuccess[0].txid).toBeDefined();
+      expect(tokenTransactionSuccess[0].txid.length).toBeGreaterThan(0);
 
       const issuerBalanceAfter = (await issuerWallet.getIssuerTokenBalance())
         .balance;
@@ -475,11 +488,14 @@ describe.each(TEST_CONFIGS)(
           expiryTime: new Date(Date.now() + 1000 * 60 * 60 * 24),
         });
 
-        const txId = await (issuerWallet as any).fulfillSparkInvoice([
-          { invoice: invoiceWithoutAmount, amount: tokenAmount },
-        ]);
-        expect(typeof txId).toBe("string");
-        expect(txId.length).toBeGreaterThan(0);
+        const { tokenTransactionSuccess, tokenTransactionErrors } =
+          await issuerWallet.fulfillSparkInvoice([
+            { invoice: invoiceWithoutAmount, amount: tokenAmount },
+          ]);
+        expect(tokenTransactionErrors.length).toBe(0);
+        expect(tokenTransactionSuccess.length).toBe(1);
+        expect(tokenTransactionSuccess[0].txid).toBeDefined();
+        expect(tokenTransactionSuccess[0].txid.length).toBeGreaterThan(0);
 
         const issuerBalanceAfter = (await issuerWallet.getIssuerTokenBalance())
           .balance;
@@ -496,6 +512,140 @@ describe.each(TEST_CONFIGS)(
       },
     );
 
+    tv1It(
+      `fulfillSparkInvoice successfully handles multiple mixed tokens and sats invoices`,
+      async () => {
+        const faucet = BitcoinFaucet.getInstance();
+        const { wallet: sdk } = await IssuerSparkWalletTesting.initialize({
+          options: config,
+        });
+        await sdk.createToken({
+          tokenName: `SDKONE`,
+          tokenTicker: "SDK1",
+          decimals: 0,
+          isFreezable: false,
+          maxSupply: 1_000_000n,
+        });
+        const { wallet: sdk2 } = await IssuerSparkWalletTesting.initialize({
+          options: config,
+        });
+        await sdk2.createToken({
+          tokenName: `SDKTWO`,
+          tokenTicker: "SDK2",
+          decimals: 0,
+          isFreezable: false,
+          maxSupply: 1_000_000n,
+        });
+
+        await sdk.mintTokens(1_000_000n);
+        await sdk2.mintTokens(1_000_000n);
+
+        const sdkOneTokenIdentifier = await sdk.getIssuerTokenIdentifier();
+        const sdkTwoTokenIdentifier = await sdk2.getIssuerTokenIdentifier();
+
+        await sdk2.transferTokens({
+          tokenAmount: 1_000_000n,
+          tokenIdentifier: sdkTwoTokenIdentifier,
+          receiverSparkAddress: await sdk.getSparkAddress(),
+        });
+
+        const depositAddrOne = await sdk.getSingleUseDepositAddress();
+        if (!depositAddrOne) {
+          throw new RPCError("Deposit address not found", {
+            method: "getDepositAddress",
+          });
+        }
+        const depositAddrTwo = await sdk.getSingleUseDepositAddress();
+        if (!depositAddrTwo) {
+          throw new RPCError("Deposit address not found", {
+            method: "getDepositAddress",
+          });
+        }
+        const depositAddrThree = await sdk.getSingleUseDepositAddress();
+        if (!depositAddrThree) {
+          throw new RPCError("Deposit address not found", {
+            method: "getDepositAddress",
+          });
+        }
+
+        const oneThousand = await faucet.sendToAddress(depositAddrOne, 1_000n);
+        const twoThousand = await faucet.sendToAddress(depositAddrTwo, 2_000n);
+        const threeThousand = await faucet.sendToAddress(
+          depositAddrThree,
+          3_000n,
+        );
+
+        await sdk.claimDeposit(oneThousand.id);
+        await sdk.claimDeposit(twoThousand.id);
+        await sdk.claimDeposit(threeThousand.id);
+
+        const balance = await sdk.getBalance();
+        expect(balance.balance).toBe(6_000n);
+
+        const tomorrow = new Date(Date.now() + 1000 * 60 * 60 * 24);
+        const invoice1000 = await sdk2.createSatsInvoice({
+          amount: 1_000,
+          memo: "Test invoice",
+          expiryTime: tomorrow,
+        });
+        const invoice2000 = await sdk2.createSatsInvoice({
+          amount: 2_000,
+          memo: "Test invoice",
+          expiryTime: tomorrow,
+        });
+        const invoiceNilAmount = await sdk2.createSatsInvoice({
+          memo: "Test invoice",
+          expiryTime: tomorrow,
+        });
+        const sdkOneTokenInvoiceA = await sdk2.createTokensInvoice({
+          amount: 1_000n,
+          tokenIdentifier: sdkOneTokenIdentifier,
+          memo: "Test invoice",
+          expiryTime: tomorrow,
+        });
+        const sdkOneTokenInvoiceB = await sdk2.createTokensInvoice({
+          amount: 2_000n,
+          tokenIdentifier: sdkOneTokenIdentifier,
+          memo: "Test invoice",
+          expiryTime: tomorrow,
+        });
+        const sdkTwoTokenInvoiceA = await sdk2.createTokensInvoice({
+          amount: 1_000n,
+          tokenIdentifier: sdkTwoTokenIdentifier,
+          memo: "Test invoice",
+          expiryTime: tomorrow,
+        });
+        const sdkTwoTokenNilAmountInvoiceB = await sdk2.createTokensInvoice({
+          tokenIdentifier: sdkTwoTokenIdentifier,
+          memo: "Test invoice",
+          expiryTime: tomorrow,
+        });
+
+        const transferResults = await sdk.fulfillSparkInvoice([
+          { invoice: invoice1000 },
+          { invoice: invoice2000 },
+          { invoice: invoiceNilAmount, amount: 3_000n },
+          { invoice: sdkOneTokenInvoiceA },
+          { invoice: sdkOneTokenInvoiceB },
+          { invoice: sdkTwoTokenInvoiceA },
+          { invoice: sdkTwoTokenNilAmountInvoiceB, amount: 3_000n },
+        ]);
+
+        const {
+          satsTransactionSuccess,
+          satsTransactionErrors,
+          tokenTransactionSuccess,
+          tokenTransactionErrors,
+          invalidInvoices,
+        } = transferResults;
+        expect(satsTransactionErrors.length).toBe(0);
+        expect(tokenTransactionErrors.length).toBe(0);
+        expect(satsTransactionSuccess.length).toBe(3); // one sats success per invoice
+        expect(tokenTransactionSuccess.length).toBe(2); // two token assets - divided into two token transactions
+        expect(invalidInvoices.length).toBe(0);
+      },
+    );
+
     it("should create, mint, and batchtransfer tokens", async () => {
       const tokenAmount: bigint = 999n;