@buildonspark/issuer-sdk 0.0.63 → 0.0.65

package/CHANGELOG.md

@@ -0,0 +1,562 @@
+# @buildonspark/issuer-sdk
+
+## 0.0.65
+
+### Patch Changes
+
+- Add signer interface
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.55
+  - @buildonspark/spark-sdk@0.1.34
+
+## 0.0.64
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.1.33
+
+## 0.0.63
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.1.32
+
+## 0.0.62
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.54
+  - @buildonspark/spark-sdk@0.1.31
+
+## 0.0.61
+
+### Patch Changes
+
+- Update issuer-wallet directory
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.53
+  - @buildonspark/spark-sdk@0.1.30
+
+## 0.0.60
+
+### Patch Changes
+
+- - Proto files for lrc20 monitoring operations have been moved to @buildonspark/issuer-sdk/proto/lrc20
+  - The monitoring operations have been modified to accept either strings or enums, generated from protos
+- Updated dependencies
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.52
+  - @buildonspark/spark-sdk@0.1.29
+
+## 0.0.59
+
+### Patch Changes
+
+- - Fixes
+- Updated dependencies
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.51
+  - @buildonspark/spark-sdk@0.1.28
+
+## 0.0.58
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.50
+  - @buildonspark/spark-sdk@0.1.27
+
+## 0.0.57
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.1.26
+
+## 0.0.56
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.1.25
+
+## 0.0.55
+
+### Patch Changes
+
+- - Add tracer
+  - Token transfer with multiple outputs
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.1.24
+
+## 0.0.54
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.49
+  - @buildonspark/spark-sdk@0.1.23
+
+## 0.0.53
+
+### Patch Changes
+
+- Update homepage URL
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.48
+  - @buildonspark/spark-sdk@0.1.22
+
+## 0.0.52
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.47
+  - @buildonspark/spark-sdk@0.1.21
+
+## 0.0.51
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.46
+  - @buildonspark/spark-sdk@0.1.20
+
+## 0.0.50
+
+### Patch Changes
+
+- React Native support
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.45
+  - @buildonspark/spark-sdk@0.1.19
+
+## 0.0.49
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.1.18
+
+## 0.0.48
+
+### Patch Changes
+
+- Updated dependencies
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.44
+  - @buildonspark/spark-sdk@0.1.17
+
+## 0.0.47
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.43
+  - @buildonspark/spark-sdk@0.1.16
+
+## 0.0.46
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.1.15
+
+## 0.0.45
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.42
+  - @buildonspark/spark-sdk@0.1.14
+
+## 0.0.44
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.41
+  - @buildonspark/spark-sdk@0.1.13
+
+## 0.0.43
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.40
+  - @buildonspark/spark-sdk@0.1.12
+
+## 0.0.42
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.39
+  - @buildonspark/spark-sdk@0.1.11
+
+## 0.0.41
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.38
+  - @buildonspark/spark-sdk@0.1.10
+
+## 0.0.40
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.37
+  - @buildonspark/spark-sdk@0.1.9
+
+## 0.0.39
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.36
+  - @buildonspark/spark-sdk@0.1.8
+
+## 0.0.38
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.35
+  - @buildonspark/spark-sdk@0.1.7
+
+## 0.0.37
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.34
+  - @buildonspark/spark-sdk@0.1.6
+
+## 0.0.36
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.33
+  - @buildonspark/spark-sdk@0.1.5
+
+## 0.0.35
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.32
+  - @buildonspark/spark-sdk@0.1.4
+
+## 0.0.34
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.31
+  - @buildonspark/spark-sdk@0.1.3
+
+## 0.0.33
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.30
+  - @buildonspark/spark-sdk@0.1.2
+
+## 0.0.32
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.29
+  - @buildonspark/spark-sdk@0.1.1
+
+## 0.0.31
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.1.0
+
+## 0.0.30
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.28
+  - @buildonspark/spark-sdk@0.0.30
+
+## 0.0.29
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.27
+  - @buildonspark/spark-sdk@0.0.29
+
+## 0.0.28
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.26
+  - @buildonspark/spark-sdk@0.0.28
+
+## 0.0.27
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.25
+  - @buildonspark/spark-sdk@0.0.27
+
+## 0.0.26
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.24
+  - @buildonspark/spark-sdk@0.0.26
+
+## 0.0.25
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.23
+  - @buildonspark/spark-sdk@0.0.25
+
+## 0.0.24
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.22
+  - @buildonspark/spark-sdk@0.0.24
+
+## 0.0.23
+
+### Patch Changes
+
+- CJS support and package improvements
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.21
+  - @buildonspark/spark-sdk@0.0.23
+
+## 0.0.22
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.20
+  - @buildonspark/spark-sdk@0.0.22
+
+## 0.0.21
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.19
+  - @buildonspark/spark-sdk@0.0.21
+
+## 0.0.20
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.18
+  - @buildonspark/spark-sdk@0.0.20
+
+## 0.0.19
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.17
+  - @buildonspark/spark-sdk@0.0.19
+
+## 0.0.18
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.16
+  - @buildonspark/spark-sdk@0.0.18
+
+## 0.0.17
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.15
+  - @buildonspark/spark-sdk@0.0.17
+
+## 0.0.16
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.14
+  - @buildonspark/spark-sdk@0.0.16
+
+## 0.0.15
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.13
+  - @buildonspark/spark-sdk@0.0.15
+
+## 0.0.14
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.12
+  - @buildonspark/spark-sdk@0.0.14
+
+## 0.0.13
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.11
+  - @buildonspark/spark-sdk@0.0.13
+
+## 0.0.12
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.10
+  - @buildonspark/spark-sdk@0.0.12
+
+## 0.0.11
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.9
+  - @buildonspark/spark-sdk@0.0.11
+
+## 0.0.10
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.8
+  - @buildonspark/spark-sdk@0.0.10
+
+## 0.0.9
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.7
+  - @buildonspark/spark-sdk@0.0.9
+
+## 0.0.8
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.6
+  - @buildonspark/spark-sdk@0.0.8
+
+## 0.0.7
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.5
+  - @buildonspark/spark-sdk@0.0.7
+
+## 0.0.6
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.4
+  - @buildonspark/spark-sdk@0.0.6
+
+## 0.0.4
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.2
+  - @buildonspark/spark-sdk@0.0.4
+
+## 0.0.3
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/lrc20-sdk@0.0.1
+  - @buildonspark/spark-sdk@0.0.3
+
+## 0.0.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.0.2
+
+## 0.0.1
+
+### Patch Changes
+
+- Fixes
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.0.1

package/dist/index.cjs

@@ -343,8 +343,8 @@ var IssuerSparkWallet = class _IssuerSparkWallet extends import_spark_sdk3.Spark
       this.announceTokenL1.bind(this)
     );
   }
-  constructor(configOptions) {
-    super(configOptions);
+  constructor(configOptions, signer) {
+    super(configOptions, signer);
     this.issuerTokenTransactionService = new IssuerTokenTransactionService(
       this.config,
       this.connectionManager
@@ -608,9 +608,10 @@ var IssuerSparkWallet = class _IssuerSparkWallet extends import_spark_sdk3.Spark
         announcement,
         feeRateSatsPerVb
       );
-      return await this.lrc20Wallet.broadcastRawBtcTransaction(
+      const txId = await this.lrc20Wallet.broadcastRawBtcTransaction(
         tx.bitcoin_tx.toHex()
       );
+      return txId;
     } catch (error) {
       throw new import_spark_sdk3.NetworkError(
         "Failed to broadcast announcement transaction on L1",

package/dist/index.d.cts

@@ -3,6 +3,7 @@ import { OutputWithPreviousTransactionData } from '@buildonspark/spark-sdk/proto
 import { Layer, OperationType } from '@buildonspark/spark-sdk/proto/lrc20';
 import { ConfigOptions } from '@buildonspark/spark-sdk/services/wallet-config';
 import { TokenActivityResponse, TokenDistribution } from './types.cjs';
+import { SparkSigner } from '@buildonspark/spark-sdk/signer';
 
 type IssuerTokenInfo = {
     tokenPublicKey: string;
@@ -32,7 +33,7 @@ declare class IssuerSparkWallet extends SparkWallet {
         wallet: IssuerSparkWallet;
     }>;
     private wrapIssuerSparkWalletWithTracing;
-    protected constructor(configOptions?: ConfigOptions);
+    protected constructor(configOptions?: ConfigOptions, signer?: SparkSigner);
     /**
      * Gets the token balance for the issuer's token.
      * @returns An object containing the token balance as a bigint

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { OutputWithPreviousTransactionData } from '@buildonspark/spark-sdk/proto
 import { Layer, OperationType } from '@buildonspark/spark-sdk/proto/lrc20';
 import { ConfigOptions } from '@buildonspark/spark-sdk/services/wallet-config';
 import { TokenActivityResponse, TokenDistribution } from './types.js';
+import { SparkSigner } from '@buildonspark/spark-sdk/signer';
 
 type IssuerTokenInfo = {
     tokenPublicKey: string;
@@ -32,7 +33,7 @@ declare class IssuerSparkWallet extends SparkWallet {
         wallet: IssuerSparkWallet;
     }>;
     private wrapIssuerSparkWalletWithTracing;
-    protected constructor(configOptions?: ConfigOptions);
+    protected constructor(configOptions?: ConfigOptions, signer?: SparkSigner);
     /**
      * Gets the token balance for the issuer's token.
      * @returns An object containing the token balance as a bigint

package/dist/index.js

@@ -328,8 +328,8 @@ var IssuerSparkWallet = class _IssuerSparkWallet extends SparkWallet {
       this.announceTokenL1.bind(this)
     );
   }
-  constructor(configOptions) {
-    super(configOptions);
+  constructor(configOptions, signer) {
+    super(configOptions, signer);
     this.issuerTokenTransactionService = new IssuerTokenTransactionService(
       this.config,
       this.connectionManager
@@ -593,9 +593,10 @@ var IssuerSparkWallet = class _IssuerSparkWallet extends SparkWallet {
         announcement,
         feeRateSatsPerVb
       );
-      return await this.lrc20Wallet.broadcastRawBtcTransaction(
+      const txId = await this.lrc20Wallet.broadcastRawBtcTransaction(
         tx.bitcoin_tx.toHex()
       );
+      return txId;
     } catch (error) {
       throw new NetworkError2(
         "Failed to broadcast announcement transaction on L1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildonspark/issuer-sdk",
-  "version": "0.0.63",
+  "version": "0.0.65",
   "description": "Spark Issuer SDK for token issuance",
   "license": "Apache-2.0",
   "module": "./dist/index.js",
@@ -35,7 +35,8 @@
   },
   "files": [
     "dist",
-    "src"
+    "src",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "yarn tsc && tsup",
@@ -61,9 +62,9 @@
     "types": "tsc"
   },
   "dependencies": {
-    "@buildonspark/lrc20-sdk": "0.0.54",
-    "@buildonspark/spark-sdk": "0.1.32",
-    "@lightsparkdev/core": "^1.4.0",
+    "@buildonspark/lrc20-sdk": "0.0.55",
+    "@buildonspark/spark-sdk": "0.1.34",
+    "@lightsparkdev/core": "^1.4.1",
     "@noble/curves": "^1.8.0",
     "@scure/btc-signer": "^1.5.0",
     "bitcoinjs-lib": "^6.1.5",

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

@@ -27,6 +27,7 @@ import {
   ListAllTokenTransactionsCursor,
   OperationType,
 } from "@buildonspark/spark-sdk/proto/lrc20";
+import { SparkSigner } from "@buildonspark/spark-sdk/signer";
 
 const BURN_ADDRESS = "02".repeat(33);
 
@@ -112,8 +113,8 @@ export class IssuerSparkWallet extends SparkWallet {
     );
   }
 
-  protected constructor(configOptions?: ConfigOptions) {
-    super(configOptions);
+  protected constructor(configOptions?: ConfigOptions, signer?: SparkSigner) {
+    super(configOptions, signer);
     this.issuerTokenTransactionService = new IssuerTokenTransactionService(
       this.config,
       this.connectionManager,
@@ -420,6 +421,7 @@ export class IssuerSparkWallet extends SparkWallet {
     }
 
     await this.lrc20Wallet!.syncWallet();
+
     const tokenPublicKey = new TokenPubkey(this.lrc20Wallet!.pubkey);
 
     const announcement = new TokenPubkeyAnnouncement(
@@ -437,9 +439,11 @@ export class IssuerSparkWallet extends SparkWallet {
         feeRateSatsPerVb,
       );
 
-      return await this.lrc20Wallet!.broadcastRawBtcTransaction(
+      const txId = await this.lrc20Wallet!.broadcastRawBtcTransaction(
         tx.bitcoin_tx.toHex(),
       );
+
+      return txId;
     } catch (error) {
       throw new NetworkError(
         "Failed to broadcast announcement transaction on L1",

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

@@ -515,6 +515,42 @@ describe("token integration tests", () => {
     expect(tokenBalance.balance).toEqual(tokenAmount);
   });
 
+  it("it should be able to announce a token with name of size equal to MAX_SYMBOL_SIZE", async () => {
+    const { wallet: issuerWallet } = await IssuerSparkWalletTesting.initialize({
+      options: LOCAL_WALLET_CONFIG_SCHNORR,
+    });
+
+    await fundAndAnnounce(issuerWallet, 1n, 0, "MaxSupply", "TESTAA");
+  });
+
+  it("it should be able to announce a token with symbol of size equal to MAX_NAME_SIZE", async () => {
+    const { wallet: issuerWallet } = await IssuerSparkWalletTesting.initialize({
+      options: LOCAL_WALLET_CONFIG_SCHNORR,
+    });
+
+    await fundAndAnnounce(issuerWallet, 1n, 0, "ABCDEFGHIJKLMNOPQ", "MQS");
+  });
+
+  it("it should NOT be able to announce a token with ( symbol size + name size ) > MAX_NAME_AND_SYMBOL_SIZE", async () => {
+    const { wallet: issuerWallet } = await IssuerSparkWalletTesting.initialize({
+      options: LOCAL_WALLET_CONFIG_SCHNORR,
+    });
+
+    await expect(
+      fundAndAnnounce(issuerWallet, 1n, 0, "ABCDEFGHIJKLMNOPQ", "TESTAB"),
+    ).rejects.toThrow();
+  });
+
+  it("it should NOT be able to announce a token with ( symbol size + name size ) > MAX_NAME_AND_SYMBOL_SIZE, and size is calculated in bytes", async () => {
+    const { wallet: issuerWallet } = await IssuerSparkWalletTesting.initialize({
+      options: LOCAL_WALLET_CONFIG_SCHNORR,
+    });
+
+    await expect(
+      fundAndAnnounce(issuerWallet, 1n, 0, "ABCDEFGHIJKLMNOPQ", "🥸🥸"),
+    ).rejects.toThrow();
+  });
+
   // freeze is hardcoded to mainnet
   brokenTestFn(
     "should announce, mint, freeze and unfreeze tokens with ECDSA",