@1sat/templates 0.0.1

package/dist/bsv20/bsv20.d.ts

@@ -0,0 +1,277 @@
+import { type LockingScript, type Script, type ScriptTemplate, type UnlockingScript } from '@bsv/sdk';
+import Inscription from '../inscription/inscription.js';
+/**
+ * BSV-20 token operation types
+ */
+export type BSV20Operation = 'deploy' | 'mint' | 'transfer' | 'burn';
+/**
+ * Token data structure for JSON payload
+ */
+export interface TokenData {
+    /** Protocol identifier (always "bsv-20") */
+    p: 'bsv-20';
+    /** Token operation */
+    op: string;
+    /** Amount as string to handle large numbers */
+    amt: string;
+}
+/**
+ * BSV-20 token data structure for JSON payload
+ */
+export interface BSV20TokenData extends TokenData {
+    /** Token operation */
+    op: BSV20Operation;
+    /** Token ticker/symbol (for deploy, mint, transfer, burn) */
+    tick?: string;
+    /** Decimals (for deploy only, max 18) */
+    dec?: number;
+    /** Maximum supply (for deploy only) */
+    max?: string;
+    /** Limit per mint operation (for deploy only) */
+    lim?: string;
+    /** Token deployment ID (for transfer/burn operations) */
+    id?: string;
+}
+/**
+ * Token creation options
+ */
+export interface TokenOptions {
+    /** Optional parent inscription reference (36-byte outpoint) */
+    parent?: Uint8Array;
+    /** Optional script prefix to prepend before inscription (e.g., P2PKH locking script) */
+    scriptPrefix?: Script | LockingScript;
+    /** Optional script suffix to append after inscription (e.g., OP_RETURN data) */
+    scriptSuffix?: Script | LockingScript;
+}
+/**
+ * Token inscription base interface (compatible with js-1sat-ord)
+ */
+export interface TokenInscription {
+    /** Protocol identifier (always "bsv-20") */
+    p: 'bsv-20';
+    /** Token operation */
+    op: string;
+    /** Amount as string to handle large numbers */
+    amt: string;
+}
+/**
+ * BSV-20 token inscription interface (compatible with js-1sat-ord)
+ */
+export interface BSV20Inscription extends TokenInscription {
+    /** Token operation */
+    op: 'deploy' | 'mint' | 'transfer' | 'burn';
+    /** Token ticker/symbol (for deploy, mint, transfer, burn) */
+    tick: string;
+    /** Decimals (for deploy only, max 18) */
+    dec?: number;
+    /** Maximum supply (for deploy only) */
+    max?: string;
+    /** Limit per mint operation (for deploy only) */
+    lim?: string;
+}
+/**
+ * BSV-20 token creation options
+ */
+export interface BSV20Options extends TokenOptions {
+}
+/**
+ * BSV-20 class implementing ScriptTemplate for basic fungible tokens.
+ *
+ * BSV-20 is the foundational token standard for BSV blockchain, providing
+ * simple and efficient fungible tokens with ticker-based identification.
+ * It serves as the base layer for the token economy on BSV.
+ *
+ * @example
+ * ```typescript
+ * // Deploy a new token
+ * const deploy = BSV20.deploy("MYTOKEN", BigInt("21000000"), 8, BigInt("1000000"));
+ * const deployScript = deploy.lock();
+ *
+ * // Mint tokens
+ * const mint = BSV20.mint("MYTOKEN", BigInt("1000000"));
+ * const mintScript = mint.lock();
+ *
+ * // Transfer tokens
+ * const transfer = BSV20.transfer("MYTOKEN", BigInt("500"));
+ * const transferScript = transfer.lock();
+ *
+ * // Parse token from script
+ * const parsed = BSV20.decode(someScript);
+ * if (parsed) {
+ *   console.log(`Ticker: ${parsed.getTicker()}`);
+ *   console.log(`Amount: ${parsed.getAmount()}`);
+ *   console.log(`Operation: ${parsed.tokenData.op}`);
+ * }
+ * ```
+ */
+export default class BSV20 implements ScriptTemplate {
+    /** BSV-20 token data */
+    readonly tokenData: BSV20TokenData;
+    /** Underlying inscription containing the token data */
+    readonly inscription: Inscription;
+    /**
+     * Creates a new BSV20 instance
+     *
+     * @param tokenData - The token data structure
+     * @param inscription - The inscription containing the token data
+     */
+    constructor(tokenData: BSV20TokenData, inscription: Inscription);
+    /**
+     * Creates a deploy operation for a new BSV-20 token
+     *
+     * @param ticker - Token ticker/symbol (1-32 characters)
+     * @param maxSupply - Maximum total supply
+     * @param decimals - Number of decimal places (0-18, default 0)
+     * @param limitPerMint - Optional limit per mint operation
+     * @param options - Optional inscription parameters
+     * @returns A new BSV20 instance
+     */
+    static deploy(ticker: string, maxSupply: bigint, decimals?: number, limitPerMint?: bigint, options?: BSV20Options): BSV20;
+    /**
+     * Creates a mint operation for an existing BSV-20 token
+     *
+     * @param ticker - Token ticker to mint
+     * @param amount - Amount to mint
+     * @param options - Optional inscription parameters
+     * @returns A new BSV20 instance
+     */
+    static mint(ticker: string, amount: bigint, options?: BSV20Options): BSV20;
+    /**
+     * Creates a transfer operation for moving BSV-20 tokens
+     *
+     * @param ticker - Token ticker to transfer
+     * @param amount - Amount to transfer
+     * @param options - Optional inscription parameters
+     * @returns A new BSV20 instance
+     */
+    static transfer(ticker: string, amount: bigint, options?: BSV20Options): BSV20;
+    /**
+     * Creates a burn operation for permanently destroying BSV-20 tokens
+     *
+     * @param ticker - Token ticker to burn
+     * @param amount - Amount to burn
+     * @param options - Optional inscription parameters
+     * @returns A new BSV20 instance
+     */
+    static burn(ticker: string, amount: bigint, options?: BSV20Options): BSV20;
+    /**
+     * Decodes a BSV-20 token from a script
+     *
+     * @param script - The script containing BSV-20 token data
+     * @returns Decoded BSV-20 token or null if not found/invalid
+     */
+    static decode(script: Script): BSV20 | null;
+    /**
+     * Creates a locking script containing the BSV-20 token inscription
+     *
+     * @param lockingScript - Optional locking script to append as suffix
+     * @returns A locking script containing the token data
+     */
+    lock(lockingScript?: LockingScript): LockingScript;
+    /**
+     * BSV-20 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 ticker/symbol
+     *
+     * @returns Token ticker
+     */
+    getTicker(): string | undefined;
+    /**
+     * Gets the token ticker/symbol (concise method)
+     *
+     * @returns Token ticker
+     */
+    ticker(): string | undefined;
+    /**
+     * Gets the number of decimal places (for deploy operations)
+     *
+     * @returns Number of decimals, defaults to 0
+     */
+    getDecimals(): number;
+    /**
+     * Gets the maximum supply (for deploy operations)
+     *
+     * @returns Maximum supply as BigInt or undefined
+     */
+    getMaxSupply(): bigint | undefined;
+    /**
+     * Gets the limit per mint operation (for deploy operations)
+     *
+     * @returns Limit per mint as BigInt or undefined
+     */
+    getLimitPerMint(): bigint | undefined;
+    /**
+     * Gets the token operation type
+     *
+     * @returns The operation (deploy, mint, transfer, or burn)
+     */
+    getOperation(): BSV20Operation;
+    /**
+     * Gets the token operation type (concise method)
+     *
+     * @returns The operation (deploy, mint, transfer, or burn)
+     */
+    operation(): BSV20Operation;
+    /**
+     * Checks if this is a deploy operation
+     *
+     * @returns true for deploy operations
+     */
+    isDeploy(): boolean;
+    /**
+     * Checks if this is a mint operation
+     *
+     * @returns true for mint operations
+     */
+    isMint(): 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=bsv20.d.ts.map

package/dist/bsv20/bsv20.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bsv20.d.ts","sourceRoot":"","sources":["../../src/bsv20/bsv20.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,aAAa,EAClB,KAAK,MAAM,EACX,KAAK,cAAc,EACnB,KAAK,eAAe,EAEpB,MAAM,UAAU,CAAA;AACjB,OAAO,WAAW,MAAM,+BAA+B,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,CAAA;AAEpE;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,4CAA4C;IAC5C,CAAC,EAAE,QAAQ,CAAA;IACX,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,+CAA+C;IAC/C,GAAG,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,SAAS;IAChD,sBAAsB;IACtB,EAAE,EAAE,cAAc,CAAA;IAClB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,iDAAiD;IACjD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,yDAAyD;IACzD,EAAE,CAAC,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,+DAA+D;IAC/D,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,wFAAwF;IACxF,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IACrC,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,4CAA4C;IAC5C,CAAC,EAAE,QAAQ,CAAA;IACX,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,+CAA+C;IAC/C,GAAG,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACzD,sBAAsB;IACtB,EAAE,EAAE,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,CAAA;IAC3C,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,iDAAiD;IACjD,GAAG,CAAC,EAAE,MAAM,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;CAAG;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;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,MAAM,CACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,QAAQ,SAAI,EACZ,YAAY,CAAC,EAAE,MAAM,EACrB,OAAO,GAAE,YAAiB,GACxB,KAAK;IAyDR;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACV,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,YAAiB,GACxB,KAAK;IA+BR;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,YAAiB,GACxB,KAAK;IA+BR;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACV,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,YAAiB,GACxB,KAAK;IA+BR;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI;IAsG3C;;;;;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,YAAY,IAAI,MAAM,GAAG,SAAS;IAIlC;;;;OAIG;IACH,eAAe,IAAI,MAAM,GAAG,SAAS;IAIrC;;;;OAIG;IACH,YAAY,IAAI,cAAc;IAI9B;;;;OAIG;IACH,SAAS,IAAI,cAAc;IAI3B;;;;OAIG;IACH,QAAQ,IAAI,OAAO;IAInB;;;;OAIG;IACH,MAAM,IAAI,OAAO;IAIjB;;;;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;CAuEnB"}