@buildonspark/issuer-sdk 0.0.99 → 0.0.100

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

@@ -0,0 +1,149 @@
+import { SparkWallet, ConfigOptions, SparkSigner, Bech32mTokenIdentifier } from '@buildonspark/spark-sdk';
+import { OutputWithPreviousTransactionData } from '@buildonspark/spark-sdk/proto/spark';
+
+/**
+ * Token metadata containing essential information about issuer's token.
+ * This is the wallet's internal representation with JavaScript-friendly types.
+ *
+ * rawTokenIdentifier: This is the raw binary token identifier - This is used to encode the human readable token identifier.
+ *
+ * tokenPublicKey: This is the hex-encoded public key of the token issuer - Same as issuerPublicKey.
+ *
+ * @example
+ * ```typescript
+ * const tokenMetadata: IssuerTokenMetadata = {
+ *   rawTokenIdentifier: new Uint8Array([1, 2, 3]),
+ *   tokenPublicKey: "0348fbb...",
+ *   tokenName: "SparkToken",
+ *   tokenTicker: "SPK",
+ *   decimals: 8,
+ *   maxSupply: 1000000n
+ *   isFreezable: true
+ * };
+ * ```
+ */
+type IssuerTokenMetadata = {
+    /** Raw binary token identifier - This is used to encode the human readable token identifier */
+    rawTokenIdentifier: Uint8Array;
+    /** Public key of the token issuer - Same as issuerPublicKey */
+    tokenPublicKey: string;
+    /** Human-readable name of the token (e.g., SparkToken)*/
+    tokenName: string;
+    /** Short ticker symbol for the token (e.g., "SPK") */
+    tokenTicker: string;
+    /** Number of decimal places for token amounts */
+    decimals: number;
+    /** Maximum supply of tokens that can ever be minted */
+    maxSupply: bigint;
+    /** Whether the token is freezable */
+    isFreezable: boolean;
+};
+interface TokenDistribution {
+    totalCirculatingSupply: bigint;
+    totalIssued: bigint;
+    totalBurned: bigint;
+    numHoldingAddress: number;
+    numConfirmedTransactions: bigint;
+}
+
+/**
+ * Represents a Spark wallet with minting capabilities.
+ * This class extends the base SparkWallet with additional functionality for token minting,
+ * burning, and freezing operations.
+ */
+declare abstract class IssuerSparkWallet extends SparkWallet {
+    private issuerTokenTransactionService;
+    private tokenFreezeService;
+    protected tracerId: string;
+    /**
+     * Initializes a new IssuerSparkWallet instance.
+     * Inherits the generic static initialize from the base class.
+     */
+    constructor(configOptions?: ConfigOptions, signer?: SparkSigner);
+    /**
+     * Gets the token balance for the issuer's token.
+     * @returns An object containing the token balance as a bigint
+     */
+    getIssuerTokenBalance(): Promise<{
+        tokenIdentifier: Bech32mTokenIdentifier | undefined;
+        balance: bigint;
+    }>;
+    /**
+     * Retrieves information about the issuer's token.
+     * @returns An object containing token information including public key, name, symbol, decimals, max supply, and freeze status
+     * @throws {NetworkError} If the token metadata cannot be retrieved
+     */
+    getIssuerTokenMetadata(): Promise<IssuerTokenMetadata>;
+    /**
+     * Retrieves the bech32m encoded token identifier for the issuer's token.
+     * @returns The bech32m encoded token identifier for the issuer's token
+     * @throws {NetworkError} If the token identifier cannot be retrieved
+     */
+    getIssuerTokenIdentifier(): Promise<Bech32mTokenIdentifier>;
+    /**
+     * Create a new token on Spark.
+     *
+     * @param params - Object containing token creation parameters.
+     * @param params.tokenName - The name of the token.
+     * @param params.tokenTicker - The ticker symbol for the token.
+     * @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>.
+     *
+     * @returns The transaction ID of the announcement.
+     *
+     * @throws {ValidationError} If `decimals` is not a safe integer or other validation fails.
+     * @throws {NetworkError} If the announcement transaction cannot be broadcast.
+     */
+    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, }: {
+        tokenName: string;
+        tokenTicker: string;
+        decimals: number;
+        isFreezable: boolean;
+        maxSupply?: bigint;
+    }): Promise<string>;
+    /**
+     * Mints new tokens
+     * @param tokenAmount - The amount of tokens to mint
+     * @returns The transaction ID of the mint operation
+     */
+    mintTokens(tokenAmount: bigint): Promise<string>;
+    /**
+     * Burns issuer's tokens
+     * @param tokenAmount - The amount of tokens to burn
+     * @param selectedOutputs - Optional array of outputs to use for the burn operation
+     * @returns The transaction ID of the burn operation
+     */
+    burnTokens(tokenAmount: bigint, selectedOutputs?: OutputWithPreviousTransactionData[]): Promise<string>;
+    /**
+     * Freezes tokens associated with a specific Spark address.
+     * @param sparkAddress - The Spark address whose tokens should be frozen
+     * @returns An object containing the IDs of impacted outputs and the total amount of frozen tokens
+     */
+    freezeTokens(sparkAddress: string): Promise<{
+        impactedOutputIds: string[];
+        impactedTokenAmount: bigint;
+    }>;
+    /**
+     * Unfreezes previously frozen tokens associated with a specific Spark address.
+     * @param sparkAddress - The Spark address whose tokens should be unfrozen
+     * @returns An object containing the IDs of impacted outputs and the total amount of unfrozen tokens
+     */
+    unfreezeTokens(sparkAddress: string): Promise<{
+        impactedOutputIds: string[];
+        impactedTokenAmount: bigint;
+    }>;
+    /**
+     * Retrieves the distribution information for the issuer's token.
+     * @throws {NotImplementedError} This feature is not yet supported
+     */
+    getIssuerTokenDistribution(): Promise<TokenDistribution>;
+    protected getTraceName(methodName: string): string;
+    private wrapPublicIssuerSparkWalletMethodWithOtelSpan;
+    private wrapIssuerSparkWalletMethodsWithTracing;
+}
+
+declare class IssuerSparkWalletReactNative extends IssuerSparkWallet {
+}
+
+export { IssuerSparkWalletReactNative as IssuerSparkWallet, type IssuerTokenMetadata, type TokenDistribution };

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

@@ -0,0 +1,149 @@
+import { SparkWallet, ConfigOptions, SparkSigner, Bech32mTokenIdentifier } from '@buildonspark/spark-sdk';
+import { OutputWithPreviousTransactionData } from '@buildonspark/spark-sdk/proto/spark';
+
+/**
+ * Token metadata containing essential information about issuer's token.
+ * This is the wallet's internal representation with JavaScript-friendly types.
+ *
+ * rawTokenIdentifier: This is the raw binary token identifier - This is used to encode the human readable token identifier.
+ *
+ * tokenPublicKey: This is the hex-encoded public key of the token issuer - Same as issuerPublicKey.
+ *
+ * @example
+ * ```typescript
+ * const tokenMetadata: IssuerTokenMetadata = {
+ *   rawTokenIdentifier: new Uint8Array([1, 2, 3]),
+ *   tokenPublicKey: "0348fbb...",
+ *   tokenName: "SparkToken",
+ *   tokenTicker: "SPK",
+ *   decimals: 8,
+ *   maxSupply: 1000000n
+ *   isFreezable: true
+ * };
+ * ```
+ */
+type IssuerTokenMetadata = {
+    /** Raw binary token identifier - This is used to encode the human readable token identifier */
+    rawTokenIdentifier: Uint8Array;
+    /** Public key of the token issuer - Same as issuerPublicKey */
+    tokenPublicKey: string;
+    /** Human-readable name of the token (e.g., SparkToken)*/
+    tokenName: string;
+    /** Short ticker symbol for the token (e.g., "SPK") */
+    tokenTicker: string;
+    /** Number of decimal places for token amounts */
+    decimals: number;
+    /** Maximum supply of tokens that can ever be minted */
+    maxSupply: bigint;
+    /** Whether the token is freezable */
+    isFreezable: boolean;
+};
+interface TokenDistribution {
+    totalCirculatingSupply: bigint;
+    totalIssued: bigint;
+    totalBurned: bigint;
+    numHoldingAddress: number;
+    numConfirmedTransactions: bigint;
+}
+
+/**
+ * Represents a Spark wallet with minting capabilities.
+ * This class extends the base SparkWallet with additional functionality for token minting,
+ * burning, and freezing operations.
+ */
+declare abstract class IssuerSparkWallet extends SparkWallet {
+    private issuerTokenTransactionService;
+    private tokenFreezeService;
+    protected tracerId: string;
+    /**
+     * Initializes a new IssuerSparkWallet instance.
+     * Inherits the generic static initialize from the base class.
+     */
+    constructor(configOptions?: ConfigOptions, signer?: SparkSigner);
+    /**
+     * Gets the token balance for the issuer's token.
+     * @returns An object containing the token balance as a bigint
+     */
+    getIssuerTokenBalance(): Promise<{
+        tokenIdentifier: Bech32mTokenIdentifier | undefined;
+        balance: bigint;
+    }>;
+    /**
+     * Retrieves information about the issuer's token.
+     * @returns An object containing token information including public key, name, symbol, decimals, max supply, and freeze status
+     * @throws {NetworkError} If the token metadata cannot be retrieved
+     */
+    getIssuerTokenMetadata(): Promise<IssuerTokenMetadata>;
+    /**
+     * Retrieves the bech32m encoded token identifier for the issuer's token.
+     * @returns The bech32m encoded token identifier for the issuer's token
+     * @throws {NetworkError} If the token identifier cannot be retrieved
+     */
+    getIssuerTokenIdentifier(): Promise<Bech32mTokenIdentifier>;
+    /**
+     * Create a new token on Spark.
+     *
+     * @param params - Object containing token creation parameters.
+     * @param params.tokenName - The name of the token.
+     * @param params.tokenTicker - The ticker symbol for the token.
+     * @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>.
+     *
+     * @returns The transaction ID of the announcement.
+     *
+     * @throws {ValidationError} If `decimals` is not a safe integer or other validation fails.
+     * @throws {NetworkError} If the announcement transaction cannot be broadcast.
+     */
+    createToken({ tokenName, tokenTicker, decimals, isFreezable, maxSupply, }: {
+        tokenName: string;
+        tokenTicker: string;
+        decimals: number;
+        isFreezable: boolean;
+        maxSupply?: bigint;
+    }): Promise<string>;
+    /**
+     * Mints new tokens
+     * @param tokenAmount - The amount of tokens to mint
+     * @returns The transaction ID of the mint operation
+     */
+    mintTokens(tokenAmount: bigint): Promise<string>;
+    /**
+     * Burns issuer's tokens
+     * @param tokenAmount - The amount of tokens to burn
+     * @param selectedOutputs - Optional array of outputs to use for the burn operation
+     * @returns The transaction ID of the burn operation
+     */
+    burnTokens(tokenAmount: bigint, selectedOutputs?: OutputWithPreviousTransactionData[]): Promise<string>;
+    /**
+     * Freezes tokens associated with a specific Spark address.
+     * @param sparkAddress - The Spark address whose tokens should be frozen
+     * @returns An object containing the IDs of impacted outputs and the total amount of frozen tokens
+     */
+    freezeTokens(sparkAddress: string): Promise<{
+        impactedOutputIds: string[];
+        impactedTokenAmount: bigint;
+    }>;
+    /**
+     * Unfreezes previously frozen tokens associated with a specific Spark address.
+     * @param sparkAddress - The Spark address whose tokens should be unfrozen
+     * @returns An object containing the IDs of impacted outputs and the total amount of unfrozen tokens
+     */
+    unfreezeTokens(sparkAddress: string): Promise<{
+        impactedOutputIds: string[];
+        impactedTokenAmount: bigint;
+    }>;
+    /**
+     * Retrieves the distribution information for the issuer's token.
+     * @throws {NotImplementedError} This feature is not yet supported
+     */
+    getIssuerTokenDistribution(): Promise<TokenDistribution>;
+    protected getTraceName(methodName: string): string;
+    private wrapPublicIssuerSparkWalletMethodWithOtelSpan;
+    private wrapIssuerSparkWalletMethodsWithTracing;
+}
+
+declare class IssuerSparkWalletReactNative extends IssuerSparkWallet {
+}
+
+export { IssuerSparkWalletReactNative as IssuerSparkWallet, type IssuerTokenMetadata, type TokenDistribution };