@1sat/templates 0.0.1

package/dist/bsv21/bsv21.d.ts

@@ -0,0 +1,231 @@
+import { type LockingScript, type Script, type ScriptTemplate, type UnlockingScript } from '@bsv/sdk';
+import type { TokenInscription, TokenOptions } from '../bsv20/bsv20.js';
+import Inscription from '../inscription/inscription.js';
+/**
+ * BSV-21 token operation types
+ */
+export type BSV21Operation = 'deploy+mint' | 'transfer' | 'burn';
+/**
+ * BSV-21 token data structure for JSON payload
+ */
+export interface BSV21TokenData extends TokenInscription {
+    /** Token operation */
+    op: BSV21Operation;
+    /** Token symbol (for deploy+mint only) */
+    sym?: string;
+    /** Decimals (for deploy+mint only, max 18) */
+    dec?: number;
+    /** Icon URL or data URI (for deploy+mint only) */
+    icon?: string;
+    /** Token ID (for transfer/burn only) */
+    id?: string;
+}
+/**
+ * BSV-21 token inscription interface (compatible with js-1sat-ord)
+ */
+export interface BSV21Inscription extends TokenInscription {
+    /** Token operation */
+    op: 'deploy+mint' | 'transfer' | 'burn';
+    /** Token symbol (for deploy+mint only) */
+    sym?: string;
+    /** Decimals (for deploy+mint only, max 18) */
+    dec?: number;
+    /** Icon URL or data URI (for deploy+mint only) */
+    icon?: string;
+    /** Token ID (for transfer/burn only) */
+    id?: string;
+}
+/**
+ * BSV-21 token creation options
+ */
+export interface BSV21Options extends TokenOptions {
+}
+/**
+ * BSV-21 class implementing ScriptTemplate for advanced token functionality.
+ *
+ * BSV-21 is an advanced token standard that builds on inscriptions to create
+ * sophisticated tokens with rich metadata, file attachments, and complex operations.
+ * Unlike BSV-20's simple JSON structure, BSV-21 leverages the full power of
+ * inscriptions for token data storage.
+ *
+ * @example
+ * ```typescript
+ * // Create deploy+mint token (initial token creation)
+ * const token = BSV21.deployMint("MYTOKEN", 1000000n, 8, "https://example.com/icon.png");
+ * const lockingScript = token.lock();
+ *
+ * // Transfer tokens
+ * const transfer = BSV21.transfer("token_deployment_outpoint", 500n);
+ * const transferScript = transfer.lock();
+ *
+ * // Parse token from script
+ * const parsed = BSV21.decode(someScript);
+ * if (parsed) {
+ *   console.log(`Symbol: ${parsed.getSymbol()}`);
+ *   console.log(`Amount: ${parsed.getAmount()}`);
+ *   console.log(`Operation: ${parsed.tokenData.op}`);
+ * }
+ * ```
+ */
+export default class BSV21 implements ScriptTemplate {
+    /** BSV-21 token data */
+    readonly tokenData: BSV21TokenData;
+    /** Underlying inscription containing the token data */
+    readonly inscription: Inscription;
+    /**
+     * Creates a new BSV21 instance
+     *
+     * @param tokenData - The token data structure
+     * @param inscription - The inscription containing the token data
+     */
+    constructor(tokenData: BSV21TokenData, inscription: Inscription);
+    /**
+     * Creates a deploy+mint token (initial token creation with minting)
+     *
+     * @param symbol - Token symbol/ticker (e.g., "MYTOKEN")
+     * @param amount - Initial amount to mint
+     * @param decimals - Number of decimal places (0-18, default 0)
+     * @param icon - Optional icon URL or data URI
+     * @param options - Optional inscription parameters
+     * @returns A new BSV21 instance
+     */
+    static deployMint(symbol: string, amount: bigint, decimals?: number, icon?: string, options?: BSV21Options): BSV21;
+    /**
+     * Creates a transfer token for moving tokens between addresses
+     *
+     * @param tokenId - Token deployment transaction outpoint (txid_vout)
+     * @param amount - Amount to transfer
+     * @param options - Optional inscription parameters
+     * @returns A new BSV21 instance
+     */
+    static transfer(tokenId: string, amount: bigint, options?: BSV21Options): BSV21;
+    /**
+     * Creates a burn token for permanently destroying tokens
+     *
+     * @param tokenId - Token deployment transaction outpoint (txid_vout)
+     * @param amount - Amount to burn
+     * @param options - Optional inscription parameters
+     * @returns A new BSV21 instance
+     */
+    static burn(tokenId: string, amount: bigint, options?: BSV21Options): BSV21;
+    /**
+     * Decodes a BSV-21 token from a script
+     *
+     * @param script - The script containing BSV-21 token data
+     * @returns Decoded BSV-21 token or null if not found/invalid
+     */
+    static decode(script: Script): BSV21 | null;
+    /**
+     * Creates a locking script containing the BSV-21 token inscription
+     *
+     * @param lockingScript - Optional locking script to append as suffix
+     * @returns A locking script containing the token data
+     */
+    lock(lockingScript?: LockingScript): LockingScript;
+    /**
+     * BSV-21 tokens cannot be unlocked directly as they are data containers
+     *
+     * @throws Error indicating unlock is not supported
+     */
+    unlock(): {
+        sign: () => Promise<UnlockingScript>;
+        estimateLength: () => Promise<number>;
+    };
+    /**
+     * Gets the token amount as BigInt
+     *
+     * @returns Token amount
+     */
+    getAmount(): bigint;
+    /**
+     * Gets the token amount as BigInt (concise method)
+     *
+     * @returns Token amount
+     */
+    amount(): bigint;
+    /**
+     * Gets the token symbol (for deploy+mint operations)
+     *
+     * @returns Token symbol or undefined for transfer/burn operations
+     */
+    getSymbol(): string | undefined;
+    /**
+     * Gets the token symbol (concise method)
+     *
+     * @returns Token symbol or undefined for transfer/burn operations
+     */
+    symbol(): string | undefined;
+    /**
+     * Gets the number of decimal places (for deploy+mint operations)
+     *
+     * @returns Number of decimals, defaults to 0
+     */
+    getDecimals(): number;
+    /**
+     * Gets the token ID (for transfer/burn operations)
+     *
+     * @returns Token deployment outpoint or undefined for deploy+mint operations
+     */
+    getTokenId(): string | undefined;
+    /**
+     * Gets the icon URL or data URI (for deploy+mint operations)
+     *
+     * @returns Icon string or undefined
+     */
+    getIcon(): string | undefined;
+    /**
+     * Checks if this token has an icon
+     *
+     * @returns true if icon is present
+     */
+    hasIcon(): boolean;
+    /**
+     * Gets the token operation type
+     *
+     * @returns The operation (deploy+mint, transfer, or burn)
+     */
+    getOperation(): BSV21Operation;
+    /**
+     * Gets the token operation type (concise method)
+     *
+     * @returns The operation (deploy+mint, transfer, or burn)
+     */
+    operation(): BSV21Operation;
+    /**
+     * Checks if this is a deploy+mint operation
+     *
+     * @returns true for deploy+mint operations
+     */
+    isDeployMint(): boolean;
+    /**
+     * Checks if this is a transfer operation
+     *
+     * @returns true for transfer operations
+     */
+    isTransfer(): boolean;
+    /**
+     * Checks if this is a burn operation
+     *
+     * @returns true for burn operations
+     */
+    isBurn(): boolean;
+    /**
+     * Gets the underlying inscription
+     *
+     * @returns The inscription containing the token data
+     */
+    getInscription(): Inscription;
+    /**
+     * Gets the token data as formatted JSON string
+     *
+     * @returns JSON representation of token data
+     */
+    toJSON(): string;
+    /**
+     * Validates the token data structure
+     *
+     * @returns true if token data is valid
+     */
+    validate(): boolean;
+}
+//# sourceMappingURL=bsv21.d.ts.map

package/dist/bsv21/bsv21.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bsv21.d.ts","sourceRoot":"","sources":["../../src/bsv21/bsv21.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,aAAa,EAClB,KAAK,MAAM,EACX,KAAK,cAAc,EACnB,KAAK,eAAe,EAEpB,MAAM,UAAU,CAAA;AACjB,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACvE,OAAO,WAAW,MAAM,+BAA+B,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,UAAU,GAAG,MAAM,CAAA;AAEhE;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACvD,sBAAsB;IACtB,EAAE,EAAE,cAAc,CAAA;IAClB,0CAA0C;IAC1C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,wCAAwC;IACxC,EAAE,CAAC,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACzD,sBAAsB;IACtB,EAAE,EAAE,aAAa,GAAG,UAAU,GAAG,MAAM,CAAA;IACvC,0CAA0C;IAC1C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,wCAAwC;IACxC,EAAE,CAAC,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;CAAG;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,OAAO,OAAO,KAAM,YAAW,cAAc;IACnD,wBAAwB;IACxB,SAAgB,SAAS,EAAE,cAAc,CAAA;IACzC,uDAAuD;IACvD,SAAgB,WAAW,EAAE,WAAW,CAAA;IAExC;;;;;OAKG;gBACS,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAK/D;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,CAChB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,QAAQ,SAAI,EACZ,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,GAAE,YAAiB,GACxB,KAAK;IAqDR;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CACd,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,YAAiB,GACxB,KAAK;IAsCR;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACV,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,YAAiB,GACxB,KAAK;IAsCR;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI;IA+F3C;;;;;OAKG;IACH,IAAI,CAAC,aAAa,CAAC,EAAE,aAAa,GAAG,aAAa;IAsBlD;;;;OAIG;IACH,MAAM,IAAI;QACT,IAAI,EAAE,MAAM,OAAO,CAAC,eAAe,CAAC,CAAA;QACpC,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;KACrC;IAID;;;;OAIG;IACH,SAAS,IAAI,MAAM;IAInB;;;;OAIG;IACH,MAAM,IAAI,MAAM;IAIhB;;;;OAIG;IACH,SAAS,IAAI,MAAM,GAAG,SAAS;IAI/B;;;;OAIG;IACH,MAAM,IAAI,MAAM,GAAG,SAAS;IAI5B;;;;OAIG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;OAIG;IACH,UAAU,IAAI,MAAM,GAAG,SAAS;IAIhC;;;;OAIG;IACH,OAAO,IAAI,MAAM,GAAG,SAAS;IAI7B;;;;OAIG;IACH,OAAO,IAAI,OAAO;IAIlB;;;;OAIG;IACH,YAAY,IAAI,cAAc;IAI9B;;;;OAIG;IACH,SAAS,IAAI,cAAc;IAI3B;;;;OAIG;IACH,YAAY,IAAI,OAAO;IAIvB;;;;OAIG;IACH,UAAU,IAAI,OAAO;IAIrB;;;;OAIG;IACH,MAAM,IAAI,OAAO;IAIjB;;;;OAIG;IACH,cAAc,IAAI,WAAW;IAI7B;;;;OAIG;IACH,MAAM,IAAI,MAAM;IAIhB;;;;OAIG;IACH,QAAQ,IAAI,OAAO;CA0DnB"}