@buildonspark/issuer-sdk 0.1.11 → 0.1.13

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @buildonspark/issuer-sdk
 
+## 0.1.13
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.6.3
+
+## 0.1.12
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.6.2
+
 ## 0.1.11
 
 ### Patch Changes

package/dist/index.browser.js

@@ -296,7 +296,7 @@ var IssuerSparkWallet = class extends SparkWallet {
 		};
 		return {
 			tokenIdentifier: issuerBalance[0][0],
-			balance: issuerBalance[0][1].balance
+			balance: issuerBalance[0][1].ownedBalance
 		};
 	}
 	/**
@@ -310,9 +310,9 @@ var IssuerSparkWallet = class extends SparkWallet {
 			tokenIdentifier: void 0,
 			balance: 0n
 		}];
-		return issuerBalance.map(([tokenIdentifier, { balance }]) => ({
+		return issuerBalance.map(([tokenIdentifier, { ownedBalance }]) => ({
 			tokenIdentifier,
-			balance
+			balance: ownedBalance
 		}));
 	}
 	/**

package/dist/index.node.cjs

@@ -296,7 +296,7 @@ var IssuerSparkWallet = class extends _buildonspark_spark_sdk.SparkWallet {
 		};
 		return {
 			tokenIdentifier: issuerBalance[0][0],
-			balance: issuerBalance[0][1].balance
+			balance: issuerBalance[0][1].ownedBalance
 		};
 	}
 	/**
@@ -310,9 +310,9 @@ var IssuerSparkWallet = class extends _buildonspark_spark_sdk.SparkWallet {
 			tokenIdentifier: void 0,
 			balance: 0n
 		}];
-		return issuerBalance.map(([tokenIdentifier, { balance }]) => ({
+		return issuerBalance.map(([tokenIdentifier, { ownedBalance }]) => ({
 			tokenIdentifier,
-			balance
+			balance: ownedBalance
 		}));
 	}
 	/**

package/dist/index.node.js

@@ -296,7 +296,7 @@ var IssuerSparkWallet = class extends SparkWallet {
 		};
 		return {
 			tokenIdentifier: issuerBalance[0][0],
-			balance: issuerBalance[0][1].balance
+			balance: issuerBalance[0][1].ownedBalance
 		};
 	}
 	/**
@@ -310,9 +310,9 @@ var IssuerSparkWallet = class extends SparkWallet {
 			tokenIdentifier: void 0,
 			balance: 0n
 		}];
-		return issuerBalance.map(([tokenIdentifier, { balance }]) => ({
+		return issuerBalance.map(([tokenIdentifier, { ownedBalance }]) => ({
 			tokenIdentifier,
-			balance
+			balance: ownedBalance
 		}));
 	}
 	/**

package/dist/native/index.react-native.cjs

@@ -339,7 +339,7 @@ var IssuerSparkWallet = class extends _buildonspark_spark_sdk.SparkWallet {
 		};
 		return {
 			tokenIdentifier: issuerBalance[0][0],
-			balance: issuerBalance[0][1].balance
+			balance: issuerBalance[0][1].ownedBalance
 		};
 	}
 	/**
@@ -353,9 +353,9 @@ var IssuerSparkWallet = class extends _buildonspark_spark_sdk.SparkWallet {
 			tokenIdentifier: void 0,
 			balance: 0n
 		}];
-		return issuerBalance.map(([tokenIdentifier, { balance }]) => ({
+		return issuerBalance.map(([tokenIdentifier, { ownedBalance }]) => ({
 			tokenIdentifier,
-			balance
+			balance: ownedBalance
 		}));
 	}
 	/**

package/dist/native/index.react-native.js

@@ -339,7 +339,7 @@ var IssuerSparkWallet = class extends SparkWallet {
 		};
 		return {
 			tokenIdentifier: issuerBalance[0][0],
-			balance: issuerBalance[0][1].balance
+			balance: issuerBalance[0][1].ownedBalance
 		};
 	}
 	/**
@@ -353,9 +353,9 @@ var IssuerSparkWallet = class extends SparkWallet {
 			tokenIdentifier: void 0,
 			balance: 0n
 		}];
-		return issuerBalance.map(([tokenIdentifier, { balance }]) => ({
+		return issuerBalance.map(([tokenIdentifier, { ownedBalance }]) => ({
 			tokenIdentifier,
-			balance
+			balance: ownedBalance
 		}));
 	}
 	/**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildonspark/issuer-sdk",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "Spark Issuer SDK for token issuance",
   "license": "Apache-2.0",
   "keywords": [
@@ -82,7 +82,7 @@
     "types": "tsc"
   },
   "dependencies": {
-    "@buildonspark/spark-sdk": "0.6.1",
+    "@buildonspark/spark-sdk": "0.6.3",
     "@noble/curves": "^1.8.0",
     "@scure/btc-signer": "^1.5.0",
     "buffer": "^6.0.3"

package/src/issuer-wallet/issuer-spark-wallet.ts

@@ -71,7 +71,7 @@ export abstract class IssuerSparkWallet extends SparkWallet {
     const balanceObj = await this.getBalance();
     const issuerBalance = [...balanceObj.tokenBalances.entries()].filter(
       ([, info]) => info.tokenMetadata.tokenPublicKey === publicKey,
-    ); // [tokenIdentifier, { balance, tokenMetadata }]
+    ); // [tokenIdentifier, { ownedBalance, availableToSendBalance, tokenMetadata }]
 
     if (issuerBalance.length > 1) {
       throw new SparkValidationError(
@@ -93,7 +93,7 @@ export abstract class IssuerSparkWallet extends SparkWallet {
 
     return {
       tokenIdentifier: issuerBalance[0][0],
-      balance: issuerBalance[0][1].balance,
+      balance: issuerBalance[0][1].ownedBalance,
     };
   }
 
@@ -111,7 +111,7 @@ export abstract class IssuerSparkWallet extends SparkWallet {
     const balanceObj = await this.getBalance();
     const issuerBalance = [...balanceObj.tokenBalances.entries()].filter(
       ([, info]) => info.tokenMetadata.tokenPublicKey === publicKey,
-    ); // [tokenIdentifier, { balance, tokenMetadata }]
+    ); // [tokenIdentifier, { ownedBalance, availableToSendBalance, tokenMetadata }]
 
     if (issuerBalance.length === 0) {
       return [
@@ -122,9 +122,9 @@ export abstract class IssuerSparkWallet extends SparkWallet {
       ];
     }
 
-    return issuerBalance.map(([tokenIdentifier, { balance }]) => ({
+    return issuerBalance.map(([tokenIdentifier, { ownedBalance }]) => ({
       tokenIdentifier,
-      balance,
+      balance: ownedBalance,
     }));
   }
 

package/src/tests/integration/multi-token-issuer.test.ts

@@ -234,8 +234,8 @@ describe.each(TEST_CONFIGS)(
       const receiverSecondBalance = receiverBalances.tokenBalances.get(
         secondTokenIdentifier,
       );
-      expect(receiverFirstBalance?.balance).toEqual(TOKEN_AMOUNT);
-      expect(receiverSecondBalance?.balance).toEqual(TOKEN_AMOUNT);
+      expect(receiverFirstBalance?.ownedBalance).toEqual(TOKEN_AMOUNT);
+      expect(receiverSecondBalance?.ownedBalance).toEqual(TOKEN_AMOUNT);
 
       // === Freezing tokens ===
       // Legacy single token issuer method - should fail when multiple tokens are created
@@ -304,8 +304,12 @@ describe.each(TEST_CONFIGS)(
         receiverBalancesAfterTransferBack.tokenBalances.get(
           secondTokenIdentifier,
         );
-      expect(receiverFirstBalanceAfterTransferBack?.balance).toBeUndefined();
-      expect(receiverSecondBalanceAfterTransferBack?.balance).toBeUndefined();
+      expect(
+        receiverFirstBalanceAfterTransferBack?.ownedBalance,
+      ).toBeUndefined();
+      expect(
+        receiverSecondBalanceAfterTransferBack?.ownedBalance,
+      ).toBeUndefined();
 
       // Verify that the issuer has the correct balances
       const issuerBalances = await issuerWallet.getIssuerTokenBalances();
@@ -389,7 +393,7 @@ describe.each(TEST_CONFIGS)(
       expect(
         issuerBalanceAfterMint.tokenBalances.get(
           createTransactionDetails.tokenIdentifier,
-        )?.balance,
+        )?.ownedBalance,
       ).toEqual(TOKEN_AMOUNT);
 
       const transferHash = await issuerWallet.transferTokens({
@@ -404,14 +408,14 @@ describe.each(TEST_CONFIGS)(
       expect(
         receiverBalance.tokenBalances.get(
           createTransactionDetails.tokenIdentifier,
-        )?.balance,
+        )?.ownedBalance,
       ).toEqual(TOKEN_AMOUNT);
 
       const issuerBalanceAfterTransfer = await issuerWallet.getBalance();
       expect(
         issuerBalanceAfterTransfer.tokenBalances.get(
           createTransactionDetails.tokenIdentifier,
-        )?.balance,
+        )?.ownedBalance,
       ).toBeUndefined();
 
       // === Freezing tokens ===
@@ -451,7 +455,7 @@ describe.each(TEST_CONFIGS)(
       expect(
         receiverBalanceAfterTransferOfUnfrozenToken.tokenBalances.get(
           createTransactionDetails.tokenIdentifier,
-        )?.balance,
+        )?.ownedBalance,
       ).toBeUndefined();
 
       const issuerBalanceAfterTransferOfUnfrozenToken =
@@ -459,7 +463,7 @@ describe.each(TEST_CONFIGS)(
       expect(
         issuerBalanceAfterTransferOfUnfrozenToken.tokenBalances.get(
           createTransactionDetails.tokenIdentifier,
-        )?.balance,
+        )?.ownedBalance,
       ).toEqual(TOKEN_AMOUNT);
 
       // === Burning tokens ===
@@ -472,7 +476,7 @@ describe.each(TEST_CONFIGS)(
       expect(
         issuerBalanceAfterBurn.tokenBalances.get(
           createTransactionDetails.tokenIdentifier,
-        )?.balance,
+        )?.ownedBalance,
       ).toBeUndefined();
     });
   },

package/src/tests/integration/nft-creation.test.ts

@@ -65,7 +65,9 @@ describe.each(TEST_CONFIGS)(
       expect(satsBalance).toEqual(0n);
       expect(tokenBalancesMap.size).toEqual(1);
       expect(tokenBalancesMap.get(bech32mTokenIdentifier)).toBeDefined();
-      expect(tokenBalancesMap.get(bech32mTokenIdentifier)?.balance).toEqual(1n);
+      expect(
+        tokenBalancesMap.get(bech32mTokenIdentifier)?.ownedBalance,
+      ).toEqual(1n);
 
       const tokenMetadata = tokenBalancesMap.get(
         bech32mTokenIdentifier,

package/src/tests/integration/token-invoices.test.ts

@@ -83,7 +83,7 @@ describe.each(TEST_CONFIGS)(
         receiverBalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(receiverBalance.balance).toEqual(tokenAmount);
+      expect(receiverBalance.ownedBalance).toEqual(tokenAmount);
     });
 
     it("should transfer tokens using multiple spark invoices", async () => {
@@ -176,14 +176,14 @@ describe.each(TEST_CONFIGS)(
         receiver1BalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(receiver1Balance.balance).toEqual(amount1 + amount2);
+      expect(receiver1Balance.ownedBalance).toEqual(amount1 + amount2);
 
       const receiver2BalanceObj = await receiverWallet2.getBalance();
       const receiver2Balance = filterTokenBalanceForTokenIdentifier(
         receiver2BalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(receiver2Balance.balance).toEqual(amount3);
+      expect(receiver2Balance.ownedBalance).toEqual(amount3);
     });
 
     it("should fail to fulfill an expired spark invoice", async () => {
@@ -236,7 +236,7 @@ describe.each(TEST_CONFIGS)(
         receiverBalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(receiverBalance.balance).toEqual(0n);
+      expect(receiverBalance.ownedBalance).toEqual(0n);
     });
 
     it("should fulfill a spark invoice with null expiry", async () => {
@@ -306,7 +306,7 @@ describe.each(TEST_CONFIGS)(
         receiverBalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(receiverBalance.balance).toEqual(tokenAmount);
+      expect(receiverBalance.ownedBalance).toEqual(tokenAmount);
     });
 
     it("should fulfill a tokens invoice without amount by passing amount parameter", async () => {
@@ -377,7 +377,7 @@ describe.each(TEST_CONFIGS)(
         receiverBalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(receiverBalance.balance).toEqual(tokenAmount);
+      expect(receiverBalance.ownedBalance).toEqual(tokenAmount);
     });
 
     it(`fulfillSparkInvoice successfully handles multiple mixed tokens and sats invoices`, async () => {

package/src/tests/integration/token-lifecycle.test.ts

@@ -55,7 +55,7 @@ describe.each(TEST_CONFIGS)(
         userBalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(userBalanceAfterTransfer.balance).toEqual(tokenAmount);
+      expect(userBalanceAfterTransfer.ownedBalance).toEqual(tokenAmount);
 
       const freezeResponse = await issuerWallet.freezeTokens(userSparkAddress);
       expect(freezeResponse.impactedTokenOutputs.length).toBeGreaterThan(0);
@@ -145,7 +145,7 @@ describe.each(TEST_CONFIGS)(
         userBalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(userBalanceAfterTransfer.balance).toEqual(tokenAmount);
+      expect(userBalanceAfterTransfer.ownedBalance).toEqual(tokenAmount);
 
       await userWallet.transferTokens({
         tokenIdentifier,
@@ -159,7 +159,7 @@ describe.each(TEST_CONFIGS)(
         tokenIdentifier!,
       );
 
-      expect(userBalanceAfterTransferBack.balance).toEqual(0n);
+      expect(userBalanceAfterTransferBack.ownedBalance).toEqual(0n);
 
       const issuerTokenBalance = (await issuerWallet.getIssuerTokenBalance())
         .balance;

package/src/tests/integration/token-monitoring.test.ts

@@ -47,7 +47,7 @@ describe.each(TEST_CONFIGS)(
         userBalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(userBalance.balance).toBeGreaterThanOrEqual(tokenAmount);
+      expect(userBalance.ownedBalance).toBeGreaterThanOrEqual(tokenAmount);
 
       const response = await issuerWallet.queryTokenTransactions({
         tokenIdentifiers: [tokenIdentifier!],

package/src/tests/integration/token-outputs.test.ts

@@ -86,7 +86,7 @@ describe.each(TEST_CONFIGS)(
         userBalanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(userBalance.balance).toBe(100n);
+      expect(userBalance.ownedBalance).toBe(100n);
     });
 
     it("should prevent concurrent transactions from spending the same outputs using tokenOutputsLocks", async () => {
@@ -166,11 +166,12 @@ describe.each(TEST_CONFIGS)(
         tokenIdentifier!,
       );
 
-      const totalReceived = user1Balance.balance + user2Balance.balance;
+      const totalReceived =
+        user1Balance.ownedBalance + user2Balance.ownedBalance;
       expect(totalReceived).toBe(transferAmount);
       expect(
-        user1Balance.balance === transferAmount ||
-          user2Balance.balance === transferAmount,
+        user1Balance.ownedBalance === transferAmount ||
+          user2Balance.ownedBalance === transferAmount,
       ).toBe(true);
     });
   },

package/src/tests/integration/token-transfers.test.ts

@@ -41,7 +41,7 @@ describe.each(TEST_CONFIGS)(
         balanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(userBalance.balance).toBeGreaterThanOrEqual(tokenAmount);
+      expect(userBalance.ownedBalance).toBeGreaterThanOrEqual(tokenAmount);
     });
 
     it("should create, mint, and batchtransfer tokens", async () => {
@@ -110,19 +110,19 @@ describe.each(TEST_CONFIGS)(
         balanceObj?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(destinationBalance.balance).toEqual(tokenAmount / 3n);
+      expect(destinationBalance.ownedBalance).toEqual(tokenAmount / 3n);
       const balanceObj2 = await destinationWallet2.getBalance();
       const destinationBalance2 = filterTokenBalanceForTokenIdentifier(
         balanceObj2?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(destinationBalance2.balance).toEqual(tokenAmount / 3n);
+      expect(destinationBalance2.ownedBalance).toEqual(tokenAmount / 3n);
       const balanceObj3 = await destinationWallet3.getBalance();
       const destinationBalance3 = filterTokenBalanceForTokenIdentifier(
         balanceObj3?.tokenBalances,
         tokenIdentifier!,
       );
-      expect(destinationBalance3.balance).toEqual(tokenAmount / 3n);
+      expect(destinationBalance3.ownedBalance).toEqual(tokenAmount / 3n);
     });
   },
 );

package/src/tests/stress/transfers.test.ts

@@ -77,7 +77,7 @@ describe("Stress test for token transfers", () => {
           tokenIdentifier!,
         );
         expect(issuerBalance.balance).toEqual(0n);
-        expect(userBalance.balance).toEqual(TOKEN_AMOUNT);
+        expect(userBalance.ownedBalance).toEqual(TOKEN_AMOUNT);
 
         // Transfer tokens from user to issuer
         await userWallet.transferTokens({
@@ -94,7 +94,7 @@ describe("Stress test for token transfers", () => {
           );
         const issuerBalanceAfterTransferBack =
           await issuerWallet.getIssuerTokenBalance();
-        expect(userBalanceAfterTransferBack.balance).toEqual(0n);
+        expect(userBalanceAfterTransferBack.ownedBalance).toEqual(0n);
         expect(issuerBalanceAfterTransferBack.balance).toEqual(TOKEN_AMOUNT);
       } catch (error: any) {
         const end_time = Date.now();