@buildonspark/issuer-sdk 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @buildonspark/issuer-sdk
 
+## 0.1.2
+
+### Patch Changes
+
+- **getIssuerTokenMetadata()**
+  - Convert extraMetadata from Buffer to Uint8Array for better cross-platform compatibility. Returns undefined when no metadata is present instead of an empty buffer on getIssuerTokenMetadata()
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.5.2
+
+## 0.1.1
+
+### Patch Changes
+
+- **Token transaction v3**
+  - Updated test configs and expanded test coverage to include both v2 and v3 token transactions
+
+  **Extra metadata field available when creating new tokens**
+  - Added a field to accept additional bytes data to attach to token creates
+
+- Updated dependencies
+  - @buildonspark/spark-sdk@0.5.1
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/index.browser.d.ts

@@ -38,6 +38,8 @@ type IssuerTokenMetadata = {
     maxSupply: bigint;
     /** Whether the token is freezable */
     isFreezable: boolean;
+    /** Extra metadata of the token */
+    extraMetadata?: Uint8Array;
 };
 interface TokenDistribution {
     totalCirculatingSupply: bigint;
@@ -90,18 +92,20 @@ declare abstract class IssuerSparkWallet extends SparkWallet {
      * @param params.decimals - The number of decimal places for the token.
      * @param params.isFreezable - Whether the token can be frozen.
      * @param [params.maxSupply=0n] - (Optional) The maximum supply of the token. Defaults to <code>0n</code>.
+     * @param params.extraMetadata - (Optional) This can be used to store additional bytes data to be associated with a token, like image data.
      *
      * @returns The transaction ID of the announcement.
      *
      * @throws {SparkValidationError} If `decimals` is not a safe integer or other validation fails.
      * @throws {SparkRequestError} If the announcement transaction cannot be broadcast.
      */
-    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, }: {
+    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, extraMetadata, }: {
         tokenName: string;
         tokenTicker: string;
         decimals: number;
         isFreezable: boolean;
         maxSupply?: bigint;
+        extraMetadata?: Uint8Array;
     }): Promise<string>;
     /**
      * Mints new tokens

package/dist/index.browser.js

@@ -210,7 +210,7 @@ var IssuerTokenTransactionService = class extends TokenTransactionService {
       ]
     };
   }
-  async constructCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable) {
+  async constructCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable, extraMetadata) {
     return {
       version: 2,
       network: this.config.getNetworkProto(),
@@ -222,7 +222,8 @@ var IssuerTokenTransactionService = class extends TokenTransactionService {
           tokenTicker,
           decimals,
           maxSupply: numberToBytesBE(maxSupply, 16),
-          isFreezable
+          isFreezable,
+          extraMetadata
         }
       },
       tokenOutputs: [],
@@ -232,7 +233,7 @@ var IssuerTokenTransactionService = class extends TokenTransactionService {
       invoiceAttachments: []
     };
   }
-  async constructPartialCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable) {
+  async constructPartialCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable, extraMetadata) {
     return {
       version: 3,
       tokenTransactionMetadata: {
@@ -250,7 +251,8 @@ var IssuerTokenTransactionService = class extends TokenTransactionService {
           tokenTicker,
           decimals,
           maxSupply: numberToBytesBE(maxSupply, 16),
-          isFreezable
+          isFreezable,
+          extraMetadata
         }
       },
       partialTokenOutputs: []
@@ -269,7 +271,8 @@ var MIN_SYMBOL_SIZE = 3;
 var MAX_SYMBOL_SIZE = 6;
 var MAX_DECIMALS = 255;
 var MAXIMUM_MAX_SUPPLY = (1n << 128n) - 1n;
-function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply) {
+var MAX_TOKEN_CONTENT_SIZE = 1024;
+function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply, extraMetadata) {
   if (!isNfcNormalized(tokenName)) {
     throw new SparkValidationError2("Token name must be NFC-normalised UTF-8", {
       field: "tokenName",
@@ -328,6 +331,16 @@ function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply) {
       expected: `>=0 and <=${MAXIMUM_MAX_SUPPLY.toString()}`
     });
   }
+  if (extraMetadata && extraMetadata.length > MAX_TOKEN_CONTENT_SIZE) {
+    throw new SparkValidationError2(
+      `Extra metadata must be less than ${MAX_TOKEN_CONTENT_SIZE} bytes`,
+      {
+        field: "extraMetadata",
+        value: extraMetadata.length,
+        expected: `<${MAX_TOKEN_CONTENT_SIZE}`
+      }
+    );
+  }
 }
 
 // src/issuer-wallet/issuer-spark-wallet.ts
@@ -393,7 +406,8 @@ var IssuerSparkWallet = class extends SparkWallet {
         tokenTicker: metadata.tokenTicker,
         decimals: metadata.decimals,
         maxSupply: bytesToNumberBE(metadata.maxSupply),
-        isFreezable: metadata.isFreezable
+        isFreezable: metadata.isFreezable,
+        extraMetadata: metadata.extraMetadata ? new Uint8Array(metadata.extraMetadata) : void 0
       };
     }
     const sparkTokenClient = await this.connectionManager.createSparkTokenClient(
@@ -428,7 +442,8 @@ var IssuerSparkWallet = class extends SparkWallet {
         tokenTicker: metadata.tokenTicker,
         decimals: metadata.decimals,
         maxSupply: bytesToNumberBE(metadata.maxSupply),
-        isFreezable: metadata.isFreezable
+        isFreezable: metadata.isFreezable,
+        extraMetadata: metadata.extraMetadata
       };
     } catch (error) {
       throw new SparkRequestError2("Failed to fetch token metadata", { error });
@@ -455,6 +470,7 @@ var IssuerSparkWallet = class extends SparkWallet {
    * @param params.decimals - The number of decimal places for the token.
    * @param params.isFreezable - Whether the token can be frozen.
    * @param [params.maxSupply=0n] - (Optional) The maximum supply of the token. Defaults to <code>0n</code>.
+   * @param params.extraMetadata - (Optional) This can be used to store additional bytes data to be associated with a token, like image data.
    *
    * @returns The transaction ID of the announcement.
    *
@@ -466,9 +482,16 @@ var IssuerSparkWallet = class extends SparkWallet {
     tokenTicker,
     decimals,
     isFreezable,
-    maxSupply = 0n
+    maxSupply = 0n,
+    extraMetadata
   }) {
-    validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply);
+    validateTokenParameters(
+      tokenName,
+      tokenTicker,
+      decimals,
+      maxSupply,
+      extraMetadata
+    );
     const issuerPublicKey = await super.getIdentityPublicKey();
     if (this.config.getTokenTransactionVersion() === "V2") {
       const tokenTransaction = await this.issuerTokenTransactionService.constructCreateTokenTransaction(
@@ -477,7 +500,8 @@ var IssuerSparkWallet = class extends SparkWallet {
         tokenTicker,
         decimals,
         maxSupply,
-        isFreezable
+        isFreezable,
+        extraMetadata
       );
       return await this.issuerTokenTransactionService.broadcastTokenTransaction(
         tokenTransaction
@@ -489,7 +513,8 @@ var IssuerSparkWallet = class extends SparkWallet {
         tokenTicker,
         decimals,
         maxSupply,
-        isFreezable
+        isFreezable,
+        extraMetadata
       );
       return await this.issuerTokenTransactionService.broadcastTokenTransactionV3(
         partialTokenTransaction

package/dist/index.node.cjs

@@ -225,7 +225,7 @@ var IssuerTokenTransactionService = class extends import_spark_sdk3.TokenTransac
       ]
     };
   }
-  async constructCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable) {
+  async constructCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable, extraMetadata) {
     return {
       version: 2,
       network: this.config.getNetworkProto(),
@@ -237,7 +237,8 @@ var IssuerTokenTransactionService = class extends import_spark_sdk3.TokenTransac
           tokenTicker,
           decimals,
           maxSupply: (0, import_utils3.numberToBytesBE)(maxSupply, 16),
-          isFreezable
+          isFreezable,
+          extraMetadata
         }
       },
       tokenOutputs: [],
@@ -247,7 +248,7 @@ var IssuerTokenTransactionService = class extends import_spark_sdk3.TokenTransac
       invoiceAttachments: []
     };
   }
-  async constructPartialCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable) {
+  async constructPartialCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable, extraMetadata) {
     return {
       version: 3,
       tokenTransactionMetadata: {
@@ -265,7 +266,8 @@ var IssuerTokenTransactionService = class extends import_spark_sdk3.TokenTransac
           tokenTicker,
           decimals,
           maxSupply: (0, import_utils3.numberToBytesBE)(maxSupply, 16),
-          isFreezable
+          isFreezable,
+          extraMetadata
         }
       },
       partialTokenOutputs: []
@@ -284,7 +286,8 @@ var MIN_SYMBOL_SIZE = 3;
 var MAX_SYMBOL_SIZE = 6;
 var MAX_DECIMALS = 255;
 var MAXIMUM_MAX_SUPPLY = (1n << 128n) - 1n;
-function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply) {
+var MAX_TOKEN_CONTENT_SIZE = 1024;
+function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply, extraMetadata) {
   if (!isNfcNormalized(tokenName)) {
     throw new import_spark_sdk4.SparkValidationError("Token name must be NFC-normalised UTF-8", {
       field: "tokenName",
@@ -343,6 +346,16 @@ function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply) {
       expected: `>=0 and <=${MAXIMUM_MAX_SUPPLY.toString()}`
     });
   }
+  if (extraMetadata && extraMetadata.length > MAX_TOKEN_CONTENT_SIZE) {
+    throw new import_spark_sdk4.SparkValidationError(
+      `Extra metadata must be less than ${MAX_TOKEN_CONTENT_SIZE} bytes`,
+      {
+        field: "extraMetadata",
+        value: extraMetadata.length,
+        expected: `<${MAX_TOKEN_CONTENT_SIZE}`
+      }
+    );
+  }
 }
 
 // src/issuer-wallet/issuer-spark-wallet.ts
@@ -408,7 +421,8 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
         tokenTicker: metadata.tokenTicker,
         decimals: metadata.decimals,
         maxSupply: (0, import_utils4.bytesToNumberBE)(metadata.maxSupply),
-        isFreezable: metadata.isFreezable
+        isFreezable: metadata.isFreezable,
+        extraMetadata: metadata.extraMetadata ? new Uint8Array(metadata.extraMetadata) : void 0
       };
     }
     const sparkTokenClient = await this.connectionManager.createSparkTokenClient(
@@ -443,7 +457,8 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
         tokenTicker: metadata.tokenTicker,
         decimals: metadata.decimals,
         maxSupply: (0, import_utils4.bytesToNumberBE)(metadata.maxSupply),
-        isFreezable: metadata.isFreezable
+        isFreezable: metadata.isFreezable,
+        extraMetadata: metadata.extraMetadata
       };
     } catch (error) {
       throw new import_spark_sdk5.SparkRequestError("Failed to fetch token metadata", { error });
@@ -470,6 +485,7 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
    * @param params.decimals - The number of decimal places for the token.
    * @param params.isFreezable - Whether the token can be frozen.
    * @param [params.maxSupply=0n] - (Optional) The maximum supply of the token. Defaults to <code>0n</code>.
+   * @param params.extraMetadata - (Optional) This can be used to store additional bytes data to be associated with a token, like image data.
    *
    * @returns The transaction ID of the announcement.
    *
@@ -481,9 +497,16 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
     tokenTicker,
     decimals,
     isFreezable,
-    maxSupply = 0n
+    maxSupply = 0n,
+    extraMetadata
   }) {
-    validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply);
+    validateTokenParameters(
+      tokenName,
+      tokenTicker,
+      decimals,
+      maxSupply,
+      extraMetadata
+    );
     const issuerPublicKey = await super.getIdentityPublicKey();
     if (this.config.getTokenTransactionVersion() === "V2") {
       const tokenTransaction = await this.issuerTokenTransactionService.constructCreateTokenTransaction(
@@ -492,7 +515,8 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
         tokenTicker,
         decimals,
         maxSupply,
-        isFreezable
+        isFreezable,
+        extraMetadata
       );
       return await this.issuerTokenTransactionService.broadcastTokenTransaction(
         tokenTransaction
@@ -504,7 +528,8 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
         tokenTicker,
         decimals,
         maxSupply,
-        isFreezable
+        isFreezable,
+        extraMetadata
       );
       return await this.issuerTokenTransactionService.broadcastTokenTransactionV3(
         partialTokenTransaction

package/dist/index.node.d.cts

@@ -38,6 +38,8 @@ type IssuerTokenMetadata = {
     maxSupply: bigint;
     /** Whether the token is freezable */
     isFreezable: boolean;
+    /** Extra metadata of the token */
+    extraMetadata?: Uint8Array;
 };
 interface TokenDistribution {
     totalCirculatingSupply: bigint;
@@ -90,18 +92,20 @@ declare abstract class IssuerSparkWallet extends SparkWallet {
      * @param params.decimals - The number of decimal places for the token.
      * @param params.isFreezable - Whether the token can be frozen.
      * @param [params.maxSupply=0n] - (Optional) The maximum supply of the token. Defaults to <code>0n</code>.
+     * @param params.extraMetadata - (Optional) This can be used to store additional bytes data to be associated with a token, like image data.
      *
      * @returns The transaction ID of the announcement.
      *
      * @throws {SparkValidationError} If `decimals` is not a safe integer or other validation fails.
      * @throws {SparkRequestError} If the announcement transaction cannot be broadcast.
      */
-    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, }: {
+    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, extraMetadata, }: {
         tokenName: string;
         tokenTicker: string;
         decimals: number;
         isFreezable: boolean;
         maxSupply?: bigint;
+        extraMetadata?: Uint8Array;
     }): Promise<string>;
     /**
      * Mints new tokens

package/dist/index.node.d.ts

@@ -38,6 +38,8 @@ type IssuerTokenMetadata = {
     maxSupply: bigint;
     /** Whether the token is freezable */
     isFreezable: boolean;
+    /** Extra metadata of the token */
+    extraMetadata?: Uint8Array;
 };
 interface TokenDistribution {
     totalCirculatingSupply: bigint;
@@ -90,18 +92,20 @@ declare abstract class IssuerSparkWallet extends SparkWallet {
      * @param params.decimals - The number of decimal places for the token.
      * @param params.isFreezable - Whether the token can be frozen.
      * @param [params.maxSupply=0n] - (Optional) The maximum supply of the token. Defaults to <code>0n</code>.
+     * @param params.extraMetadata - (Optional) This can be used to store additional bytes data to be associated with a token, like image data.
      *
      * @returns The transaction ID of the announcement.
      *
      * @throws {SparkValidationError} If `decimals` is not a safe integer or other validation fails.
      * @throws {SparkRequestError} If the announcement transaction cannot be broadcast.
      */
-    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, }: {
+    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, extraMetadata, }: {
         tokenName: string;
         tokenTicker: string;
         decimals: number;
         isFreezable: boolean;
         maxSupply?: bigint;
+        extraMetadata?: Uint8Array;
     }): Promise<string>;
     /**
      * Mints new tokens

package/dist/index.node.js

@@ -200,7 +200,7 @@ var IssuerTokenTransactionService = class extends TokenTransactionService {
       ]
     };
   }
-  async constructCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable) {
+  async constructCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable, extraMetadata) {
     return {
       version: 2,
       network: this.config.getNetworkProto(),
@@ -212,7 +212,8 @@ var IssuerTokenTransactionService = class extends TokenTransactionService {
           tokenTicker,
           decimals,
           maxSupply: numberToBytesBE(maxSupply, 16),
-          isFreezable
+          isFreezable,
+          extraMetadata
         }
       },
       tokenOutputs: [],
@@ -222,7 +223,7 @@ var IssuerTokenTransactionService = class extends TokenTransactionService {
       invoiceAttachments: []
     };
   }
-  async constructPartialCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable) {
+  async constructPartialCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable, extraMetadata) {
     return {
       version: 3,
       tokenTransactionMetadata: {
@@ -240,7 +241,8 @@ var IssuerTokenTransactionService = class extends TokenTransactionService {
           tokenTicker,
           decimals,
           maxSupply: numberToBytesBE(maxSupply, 16),
-          isFreezable
+          isFreezable,
+          extraMetadata
         }
       },
       partialTokenOutputs: []
@@ -259,7 +261,8 @@ var MIN_SYMBOL_SIZE = 3;
 var MAX_SYMBOL_SIZE = 6;
 var MAX_DECIMALS = 255;
 var MAXIMUM_MAX_SUPPLY = (1n << 128n) - 1n;
-function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply) {
+var MAX_TOKEN_CONTENT_SIZE = 1024;
+function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply, extraMetadata) {
   if (!isNfcNormalized(tokenName)) {
     throw new SparkValidationError2("Token name must be NFC-normalised UTF-8", {
       field: "tokenName",
@@ -318,6 +321,16 @@ function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply) {
       expected: `>=0 and <=${MAXIMUM_MAX_SUPPLY.toString()}`
     });
   }
+  if (extraMetadata && extraMetadata.length > MAX_TOKEN_CONTENT_SIZE) {
+    throw new SparkValidationError2(
+      `Extra metadata must be less than ${MAX_TOKEN_CONTENT_SIZE} bytes`,
+      {
+        field: "extraMetadata",
+        value: extraMetadata.length,
+        expected: `<${MAX_TOKEN_CONTENT_SIZE}`
+      }
+    );
+  }
 }
 
 // src/issuer-wallet/issuer-spark-wallet.ts
@@ -383,7 +396,8 @@ var IssuerSparkWallet = class extends SparkWallet {
         tokenTicker: metadata.tokenTicker,
         decimals: metadata.decimals,
         maxSupply: bytesToNumberBE(metadata.maxSupply),
-        isFreezable: metadata.isFreezable
+        isFreezable: metadata.isFreezable,
+        extraMetadata: metadata.extraMetadata ? new Uint8Array(metadata.extraMetadata) : void 0
       };
     }
     const sparkTokenClient = await this.connectionManager.createSparkTokenClient(
@@ -418,7 +432,8 @@ var IssuerSparkWallet = class extends SparkWallet {
         tokenTicker: metadata.tokenTicker,
         decimals: metadata.decimals,
         maxSupply: bytesToNumberBE(metadata.maxSupply),
-        isFreezable: metadata.isFreezable
+        isFreezable: metadata.isFreezable,
+        extraMetadata: metadata.extraMetadata
       };
     } catch (error) {
       throw new SparkRequestError2("Failed to fetch token metadata", { error });
@@ -445,6 +460,7 @@ var IssuerSparkWallet = class extends SparkWallet {
    * @param params.decimals - The number of decimal places for the token.
    * @param params.isFreezable - Whether the token can be frozen.
    * @param [params.maxSupply=0n] - (Optional) The maximum supply of the token. Defaults to <code>0n</code>.
+   * @param params.extraMetadata - (Optional) This can be used to store additional bytes data to be associated with a token, like image data.
    *
    * @returns The transaction ID of the announcement.
    *
@@ -456,9 +472,16 @@ var IssuerSparkWallet = class extends SparkWallet {
     tokenTicker,
     decimals,
     isFreezable,
-    maxSupply = 0n
+    maxSupply = 0n,
+    extraMetadata
   }) {
-    validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply);
+    validateTokenParameters(
+      tokenName,
+      tokenTicker,
+      decimals,
+      maxSupply,
+      extraMetadata
+    );
     const issuerPublicKey = await super.getIdentityPublicKey();
     if (this.config.getTokenTransactionVersion() === "V2") {
       const tokenTransaction = await this.issuerTokenTransactionService.constructCreateTokenTransaction(
@@ -467,7 +490,8 @@ var IssuerSparkWallet = class extends SparkWallet {
         tokenTicker,
         decimals,
         maxSupply,
-        isFreezable
+        isFreezable,
+        extraMetadata
       );
       return await this.issuerTokenTransactionService.broadcastTokenTransaction(
         tokenTransaction
@@ -479,7 +503,8 @@ var IssuerSparkWallet = class extends SparkWallet {
         tokenTicker,
         decimals,
         maxSupply,
-        isFreezable
+        isFreezable,
+        extraMetadata
       );
       return await this.issuerTokenTransactionService.broadcastTokenTransactionV3(
         partialTokenTransaction

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

@@ -228,7 +228,7 @@ var IssuerTokenTransactionService = class extends import_spark_sdk3.TokenTransac
       ]
     };
   }
-  async constructCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable) {
+  async constructCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable, extraMetadata) {
     return {
       version: 2,
       network: this.config.getNetworkProto(),
@@ -240,7 +240,8 @@ var IssuerTokenTransactionService = class extends import_spark_sdk3.TokenTransac
           tokenTicker,
           decimals,
           maxSupply: (0, import_utils3.numberToBytesBE)(maxSupply, 16),
-          isFreezable
+          isFreezable,
+          extraMetadata
         }
       },
       tokenOutputs: [],
@@ -250,7 +251,7 @@ var IssuerTokenTransactionService = class extends import_spark_sdk3.TokenTransac
       invoiceAttachments: []
     };
   }
-  async constructPartialCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable) {
+  async constructPartialCreateTokenTransaction(tokenPublicKey, tokenName, tokenTicker, decimals, maxSupply, isFreezable, extraMetadata) {
     return {
       version: 3,
       tokenTransactionMetadata: {
@@ -268,7 +269,8 @@ var IssuerTokenTransactionService = class extends import_spark_sdk3.TokenTransac
           tokenTicker,
           decimals,
           maxSupply: (0, import_utils3.numberToBytesBE)(maxSupply, 16),
-          isFreezable
+          isFreezable,
+          extraMetadata
         }
       },
       partialTokenOutputs: []
@@ -287,7 +289,8 @@ var MIN_SYMBOL_SIZE = 3;
 var MAX_SYMBOL_SIZE = 6;
 var MAX_DECIMALS = 255;
 var MAXIMUM_MAX_SUPPLY = (1n << 128n) - 1n;
-function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply) {
+var MAX_TOKEN_CONTENT_SIZE = 1024;
+function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply, extraMetadata) {
   if (!isNfcNormalized(tokenName)) {
     throw new import_spark_sdk4.SparkValidationError("Token name must be NFC-normalised UTF-8", {
       field: "tokenName",
@@ -346,6 +349,16 @@ function validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply) {
       expected: `>=0 and <=${MAXIMUM_MAX_SUPPLY.toString()}`
     });
   }
+  if (extraMetadata && extraMetadata.length > MAX_TOKEN_CONTENT_SIZE) {
+    throw new import_spark_sdk4.SparkValidationError(
+      `Extra metadata must be less than ${MAX_TOKEN_CONTENT_SIZE} bytes`,
+      {
+        field: "extraMetadata",
+        value: extraMetadata.length,
+        expected: `<${MAX_TOKEN_CONTENT_SIZE}`
+      }
+    );
+  }
 }
 
 // src/issuer-wallet/issuer-spark-wallet.ts
@@ -411,7 +424,8 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
         tokenTicker: metadata.tokenTicker,
         decimals: metadata.decimals,
         maxSupply: (0, import_utils4.bytesToNumberBE)(metadata.maxSupply),
-        isFreezable: metadata.isFreezable
+        isFreezable: metadata.isFreezable,
+        extraMetadata: metadata.extraMetadata ? new Uint8Array(metadata.extraMetadata) : void 0
       };
     }
     const sparkTokenClient = await this.connectionManager.createSparkTokenClient(
@@ -446,7 +460,8 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
         tokenTicker: metadata.tokenTicker,
         decimals: metadata.decimals,
         maxSupply: (0, import_utils4.bytesToNumberBE)(metadata.maxSupply),
-        isFreezable: metadata.isFreezable
+        isFreezable: metadata.isFreezable,
+        extraMetadata: metadata.extraMetadata
       };
     } catch (error) {
       throw new import_spark_sdk5.SparkRequestError("Failed to fetch token metadata", { error });
@@ -473,6 +488,7 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
    * @param params.decimals - The number of decimal places for the token.
    * @param params.isFreezable - Whether the token can be frozen.
    * @param [params.maxSupply=0n] - (Optional) The maximum supply of the token. Defaults to <code>0n</code>.
+   * @param params.extraMetadata - (Optional) This can be used to store additional bytes data to be associated with a token, like image data.
    *
    * @returns The transaction ID of the announcement.
    *
@@ -484,9 +500,16 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
     tokenTicker,
     decimals,
     isFreezable,
-    maxSupply = 0n
+    maxSupply = 0n,
+    extraMetadata
   }) {
-    validateTokenParameters(tokenName, tokenTicker, decimals, maxSupply);
+    validateTokenParameters(
+      tokenName,
+      tokenTicker,
+      decimals,
+      maxSupply,
+      extraMetadata
+    );
     const issuerPublicKey = await super.getIdentityPublicKey();
     if (this.config.getTokenTransactionVersion() === "V2") {
       const tokenTransaction = await this.issuerTokenTransactionService.constructCreateTokenTransaction(
@@ -495,7 +518,8 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
         tokenTicker,
         decimals,
         maxSupply,
-        isFreezable
+        isFreezable,
+        extraMetadata
       );
       return await this.issuerTokenTransactionService.broadcastTokenTransaction(
         tokenTransaction
@@ -507,7 +531,8 @@ var IssuerSparkWallet = class extends import_spark_sdk5.SparkWallet {
         tokenTicker,
         decimals,
         maxSupply,
-        isFreezable
+        isFreezable,
+        extraMetadata
       );
       return await this.issuerTokenTransactionService.broadcastTokenTransactionV3(
         partialTokenTransaction

package/dist/native/index.react-native.d.cts

@@ -38,6 +38,8 @@ type IssuerTokenMetadata = {
     maxSupply: bigint;
     /** Whether the token is freezable */
     isFreezable: boolean;
+    /** Extra metadata of the token */
+    extraMetadata?: Uint8Array;
 };
 interface TokenDistribution {
     totalCirculatingSupply: bigint;
@@ -90,18 +92,20 @@ declare abstract class IssuerSparkWallet extends SparkWallet {
      * @param params.decimals - The number of decimal places for the token.
      * @param params.isFreezable - Whether the token can be frozen.
      * @param [params.maxSupply=0n] - (Optional) The maximum supply of the token. Defaults to <code>0n</code>.
+     * @param params.extraMetadata - (Optional) This can be used to store additional bytes data to be associated with a token, like image data.
      *
      * @returns The transaction ID of the announcement.
      *
      * @throws {SparkValidationError} If `decimals` is not a safe integer or other validation fails.
      * @throws {SparkRequestError} If the announcement transaction cannot be broadcast.
      */
-    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, }: {
+    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, extraMetadata, }: {
         tokenName: string;
         tokenTicker: string;
         decimals: number;
         isFreezable: boolean;
         maxSupply?: bigint;
+        extraMetadata?: Uint8Array;
     }): Promise<string>;
     /**
      * Mints new tokens