@1sat/templates 0.0.1

package/dist/bitcom/bap.d.ts

@@ -0,0 +1,126 @@
+import { type LockingScript, type ScriptTemplate } from '@bsv/sdk';
+import { type BitComDecoded } from './bitcom.js';
+/**
+ * Bitcoin Attestation Protocol (BAP) Types
+ */
+export declare enum BAPAttestationType {
+    ID = "ID",
+    ATTEST = "ATTEST",
+    REVOKE = "REVOKE",
+    ALIAS = "ALIAS"
+}
+/**
+ * BAP Data Structure
+ */
+export interface BAPData {
+    bitcomIndex?: number;
+    type: BAPAttestationType;
+    idKey?: string;
+    address?: string;
+    sequence: bigint;
+    algorithm?: string;
+    signerAddr?: string;
+    signature?: string;
+    rootAddress?: string;
+    isSignedByID: boolean;
+    profile?: unknown;
+}
+/**
+ * BAP Protocol Prefix
+ */
+export declare const BAP_PROTOCOL_PREFIX = "1BAPSuaPnfGnSBM3GLV9yhxUdYe4vGbdMT";
+/**
+ * Bitcoin Attestation Protocol (BAP) Template
+ *
+ * BAP is an advanced identity and attestation system that builds on AIP to provide
+ * verifiable claims, identity verification, and decentralized reputation management.
+ *
+ * Core attestation types:
+ * - ID: Create and register digital identities with cryptographic proof
+ * - ATTEST: Make verifiable claims and attestations about other identities
+ * - REVOKE: Revoke previous attestations or invalidate claims
+ * - ALIAS: Create human-readable aliases for identities
+ */
+export default class BAP implements ScriptTemplate {
+    bitcomIndex?: number;
+    type: BAPAttestationType;
+    idKey?: string;
+    address?: string;
+    sequence: bigint;
+    algorithm?: string;
+    signerAddr?: string;
+    signature?: string;
+    rootAddress?: string;
+    isSignedByID: boolean;
+    profile?: unknown;
+    constructor(data: BAPData);
+    /**
+     * Creates a BAP locking script
+     *
+     * @returns LockingScript - The BAP locking script
+     */
+    lock(): LockingScript;
+    /**
+     * Decodes a BAP protocol from BitCom structure
+     *
+     * @param bitcom - The BitCom decoded structure
+     * @returns BAP | null - The decoded BAP data, or null if not found
+     */
+    static decode(bitcom: BitComDecoded): BAP | null;
+    /**
+     * Creates a BAP ID attestation
+     *
+     * @param identityKey - The identity public key
+     * @param address - The associated address
+     * @param algorithm - The AIP algorithm
+     * @param signerAddr - The signer address
+     * @param signature - The AIP signature
+     * @returns BAP - The ID attestation
+     */
+    static createID(identityKey: string, address: string, algorithm?: string, signerAddr?: string, signature?: string): BAP;
+    /**
+     * Creates a BAP ATTEST attestation
+     *
+     * @param txid - The transaction ID being attested to
+     * @param sequence - The sequence number
+     * @param algorithm - The AIP algorithm
+     * @param signerAddr - The signer address
+     * @param signature - The AIP signature
+     * @returns BAP - The ATTEST attestation
+     */
+    static createAttest(txid: string, sequence: bigint, algorithm?: string, signerAddr?: string, signature?: string): BAP;
+    /**
+     * Creates a BAP REVOKE attestation
+     *
+     * @param txid - The transaction ID being revoked
+     * @param sequence - The sequence number
+     * @param algorithm - The AIP algorithm
+     * @param signerAddr - The signer address
+     * @param signature - The AIP signature
+     * @returns BAP - The REVOKE attestation
+     */
+    static createRevoke(txid: string, sequence: bigint, algorithm?: string, signerAddr?: string, signature?: string): BAP;
+    /**
+     * Creates a BAP ALIAS attestation
+     *
+     * @param alias - The human-readable alias
+     * @param profile - The profile data
+     * @param algorithm - The AIP algorithm
+     * @param signerAddr - The signer address
+     * @param signature - The AIP signature
+     * @returns BAP - The ALIAS attestation
+     */
+    static createAlias(alias: string, profile: unknown, algorithm?: string, signerAddr?: string, signature?: string): BAP;
+    /**
+     * Verifies the AIP signature for the BAP attestation
+     *
+     * @param _protocolData - The protocol data for signature verification
+     * @returns boolean - True if signature is valid
+     */
+    verifySignature(_protocolData: unknown[]): boolean;
+    /**
+     * Placeholder for unlock method - BAP is read-only
+     */
+    unlock(): never;
+}
+//# sourceMappingURL=bap.d.ts.map

package/dist/bitcom/bap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bap.d.ts","sourceRoot":"","sources":["../../src/bitcom/bap.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,aAAa,EAElB,KAAK,cAAc,EAEnB,MAAM,UAAU,CAAA;AACjB,OAAe,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAA;AAExD;;GAEG;AACH,oBAAY,kBAAkB;IAC7B,EAAE,OAAO;IACT,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,KAAK,UAAU;CACf;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,kBAAkB,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,OAAO,CAAA;IACrB,OAAO,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,uCAAuC,CAAA;AAEvE;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,OAAO,OAAO,GAAI,YAAW,cAAc;IACjD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,kBAAkB,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,OAAO,CAAA;IACrB,OAAO,CAAC,EAAE,OAAO,CAAA;gBAEL,IAAI,EAAE,OAAO;IAczB;;;;OAIG;IACH,IAAI,IAAI,aAAa;IAwDrB;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,GAAG,GAAG,IAAI;IAyHhD;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,CACd,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM,EACnB,SAAS,CAAC,EAAE,MAAM,GAChB,GAAG;IAcN;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAClB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM,EACnB,SAAS,CAAC,EAAE,MAAM,GAChB,GAAG;IAaN;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAClB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM,EACnB,SAAS,CAAC,EAAE,MAAM,GAChB,GAAG;IAaN;;;;;;;;;OASG;IACH,MAAM,CAAC,WAAW,CACjB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,OAAO,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM,EACnB,SAAS,CAAC,EAAE,MAAM,GAChB,GAAG;IAcN;;;;;OAKG;IACH,eAAe,CAAC,aAAa,EAAE,OAAO,EAAE,GAAG,OAAO;IAiBlD;;OAEG;IACH,MAAM,IAAI,KAAK;CAKf"}

package/dist/bitcom/bap.js

@@ -0,0 +1,334 @@
+import { Script, Utils, } from '@bsv/sdk';
+import BitCom from './bitcom.js';
+/**
+ * Bitcoin Attestation Protocol (BAP) Types
+ */
+export var BAPAttestationType;
+(function (BAPAttestationType) {
+    BAPAttestationType["ID"] = "ID";
+    BAPAttestationType["ATTEST"] = "ATTEST";
+    BAPAttestationType["REVOKE"] = "REVOKE";
+    BAPAttestationType["ALIAS"] = "ALIAS";
+})(BAPAttestationType || (BAPAttestationType = {}));
+/**
+ * BAP Protocol Prefix
+ */
+export const BAP_PROTOCOL_PREFIX = '1BAPSuaPnfGnSBM3GLV9yhxUdYe4vGbdMT';
+/**
+ * Bitcoin Attestation Protocol (BAP) Template
+ *
+ * BAP is an advanced identity and attestation system that builds on AIP to provide
+ * verifiable claims, identity verification, and decentralized reputation management.
+ *
+ * Core attestation types:
+ * - ID: Create and register digital identities with cryptographic proof
+ * - ATTEST: Make verifiable claims and attestations about other identities
+ * - REVOKE: Revoke previous attestations or invalidate claims
+ * - ALIAS: Create human-readable aliases for identities
+ */
+export default class BAP {
+    bitcomIndex;
+    type;
+    idKey;
+    address;
+    sequence;
+    algorithm;
+    signerAddr;
+    signature;
+    rootAddress;
+    isSignedByID;
+    profile;
+    constructor(data) {
+        this.bitcomIndex = data.bitcomIndex;
+        this.type = data.type;
+        this.idKey = data.idKey;
+        this.address = data.address;
+        this.sequence = data.sequence;
+        this.algorithm = data.algorithm;
+        this.signerAddr = data.signerAddr;
+        this.signature = data.signature;
+        this.rootAddress = data.rootAddress;
+        this.isSignedByID = data.isSignedByID;
+        this.profile = data.profile;
+    }
+    /**
+     * Creates a BAP locking script
+     *
+     * @returns LockingScript - The BAP locking script
+     */
+    lock() {
+        const script = new Script();
+        // Add attestation type
+        script.writeBin(Utils.toArray(this.type, 'utf8'));
+        // Add type-specific data
+        if (this.type === BAPAttestationType.ID) {
+            if (this.idKey != null && this.idKey !== '') {
+                script.writeBin(Utils.toArray(this.idKey, 'utf8'));
+            }
+            if (this.address != null && this.address !== '') {
+                script.writeBin(Utils.toArray(this.address, 'utf8'));
+            }
+        }
+        else if (this.type === BAPAttestationType.ATTEST ||
+            this.type === BAPAttestationType.REVOKE) {
+            if (this.idKey != null && this.idKey !== '') {
+                script.writeBin(Utils.toArray(this.idKey, 'utf8'));
+            }
+            // Add sequence number
+            script.writeBin(Utils.toArray(this.sequence.toString(), 'utf8'));
+        }
+        else if (this.type === BAPAttestationType.ALIAS) {
+            if (this.idKey != null && this.idKey !== '') {
+                script.writeBin(Utils.toArray(this.idKey, 'utf8'));
+            }
+            if (this.profile != null) {
+                const profileJson = JSON.stringify(this.profile);
+                script.writeBin(Utils.toArray(profileJson, 'utf8'));
+            }
+        }
+        // Add AIP signature data
+        if (this.algorithm != null && this.algorithm !== '') {
+            script.writeBin(Utils.toArray(this.algorithm, 'utf8'));
+        }
+        if (this.signerAddr != null && this.signerAddr !== '') {
+            script.writeBin(Utils.toArray(this.signerAddr, 'utf8'));
+        }
+        if (this.signature != null && this.signature !== '') {
+            script.writeBin(Utils.toArray(this.signature, 'utf8'));
+        }
+        // Create BitCom structure
+        const bitcom = new BitCom([
+            {
+                protocol: BAP_PROTOCOL_PREFIX,
+                script: script.toBinary(),
+                pos: 0,
+            },
+        ]);
+        return bitcom.lock();
+    }
+    /**
+     * Decodes a BAP protocol from BitCom structure
+     *
+     * @param bitcom - The BitCom decoded structure
+     * @returns BAP | null - The decoded BAP data, or null if not found
+     */
+    static decode(bitcom) {
+        if (bitcom == null ||
+            bitcom.protocols == null ||
+            bitcom.protocols.length === 0) {
+            return null;
+        }
+        // Find BAP protocol
+        const bapProtocol = bitcom.protocols.find((p) => p.protocol === BAP_PROTOCOL_PREFIX);
+        if (bapProtocol == null) {
+            return null;
+        }
+        try {
+            // Parse the protocol script data
+            const script = Script.fromBinary(bapProtocol.script);
+            const chunks = script.chunks;
+            if (chunks.length < 1) {
+                return null;
+            }
+            // Extract attestation type
+            const typeChunk = chunks[0];
+            if (typeChunk.data == null) {
+                return null;
+            }
+            const type = Utils.toUTF8(typeChunk.data);
+            // AIP signature data comes after type-specific data (no pipe delimiter)
+            const bapData = {
+                bitcomIndex: bapProtocol.pos,
+                type,
+                sequence: BigInt(0),
+                isSignedByID: false,
+            };
+            // Parse type-specific data
+            if (type === BAPAttestationType.ID) {
+                if (chunks.length > 1 && chunks[1].data != null) {
+                    bapData.idKey = Utils.toUTF8(chunks[1].data);
+                }
+                if (chunks.length > 2 && chunks[2].data != null) {
+                    bapData.address = Utils.toUTF8(chunks[2].data);
+                }
+                bapData.isSignedByID = true;
+            }
+            else if (type === BAPAttestationType.ATTEST ||
+                type === BAPAttestationType.REVOKE) {
+                if (chunks.length > 1 && chunks[1].data != null) {
+                    bapData.idKey = Utils.toUTF8(chunks[1].data);
+                }
+                if (chunks.length > 2 && chunks[2].data != null) {
+                    const sequenceStr = Utils.toUTF8(chunks[2].data);
+                    bapData.sequence = BigInt(sequenceStr);
+                }
+            }
+            else if (type === BAPAttestationType.ALIAS) {
+                if (chunks.length > 1 && chunks[1].data != null) {
+                    bapData.idKey = Utils.toUTF8(chunks[1].data);
+                }
+                if (chunks.length > 2 && chunks[2].data != null) {
+                    try {
+                        const profileJson = Utils.toUTF8(chunks[2].data);
+                        bapData.profile = JSON.parse(profileJson);
+                    }
+                    catch {
+                        // Invalid JSON, store as raw data
+                        bapData.profile = Utils.toUTF8(chunks[2].data);
+                    }
+                }
+            }
+            // Calculate where AIP data starts based on type (after type-specific fields)
+            const aipStartIdx = 3; // Default: after type, idKey, and one more field
+            // Parse AIP signature data if present (algorithm, signerAddr, signature)
+            if (chunks.length > aipStartIdx && chunks[aipStartIdx].data != null) {
+                bapData.algorithm = Utils.toUTF8(chunks[aipStartIdx].data);
+            }
+            if (chunks.length > aipStartIdx + 1 &&
+                chunks[aipStartIdx + 1].data != null) {
+                const signerData = chunks[aipStartIdx + 1].data;
+                if (signerData != null) {
+                    bapData.signerAddr = Utils.toUTF8(signerData);
+                }
+            }
+            if (chunks.length > aipStartIdx + 2 &&
+                chunks[aipStartIdx + 2].data != null) {
+                const signatureData = chunks[aipStartIdx + 2].data;
+                if (signatureData != null) {
+                    bapData.signature = Utils.toUTF8(signatureData);
+                }
+            }
+            // Set root address if we have signer address
+            if (bapData.signerAddr != null && bapData.signerAddr !== '') {
+                bapData.rootAddress = bapData.signerAddr;
+            }
+            // Set isSignedByID based on attestation type
+            if (type === BAPAttestationType.ID) {
+                bapData.isSignedByID = true; // ID attestations are always signed by the identity
+            }
+            else {
+                bapData.isSignedByID = false; // ATTEST/REVOKE/ALIAS are not signed by the ID itself
+            }
+            return new BAP(bapData);
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Creates a BAP ID attestation
+     *
+     * @param identityKey - The identity public key
+     * @param address - The associated address
+     * @param algorithm - The AIP algorithm
+     * @param signerAddr - The signer address
+     * @param signature - The AIP signature
+     * @returns BAP - The ID attestation
+     */
+    static createID(identityKey, address, algorithm, signerAddr, signature) {
+        return new BAP({
+            type: BAPAttestationType.ID,
+            idKey: identityKey,
+            address,
+            sequence: BigInt(0),
+            algorithm,
+            signerAddr,
+            signature,
+            rootAddress: signerAddr,
+            isSignedByID: true,
+        });
+    }
+    /**
+     * Creates a BAP ATTEST attestation
+     *
+     * @param txid - The transaction ID being attested to
+     * @param sequence - The sequence number
+     * @param algorithm - The AIP algorithm
+     * @param signerAddr - The signer address
+     * @param signature - The AIP signature
+     * @returns BAP - The ATTEST attestation
+     */
+    static createAttest(txid, sequence, algorithm, signerAddr, signature) {
+        return new BAP({
+            type: BAPAttestationType.ATTEST,
+            idKey: txid,
+            sequence,
+            algorithm,
+            signerAddr,
+            signature,
+            rootAddress: signerAddr,
+            isSignedByID: false,
+        });
+    }
+    /**
+     * Creates a BAP REVOKE attestation
+     *
+     * @param txid - The transaction ID being revoked
+     * @param sequence - The sequence number
+     * @param algorithm - The AIP algorithm
+     * @param signerAddr - The signer address
+     * @param signature - The AIP signature
+     * @returns BAP - The REVOKE attestation
+     */
+    static createRevoke(txid, sequence, algorithm, signerAddr, signature) {
+        return new BAP({
+            type: BAPAttestationType.REVOKE,
+            idKey: txid,
+            sequence,
+            algorithm,
+            signerAddr,
+            signature,
+            rootAddress: signerAddr,
+            isSignedByID: false,
+        });
+    }
+    /**
+     * Creates a BAP ALIAS attestation
+     *
+     * @param alias - The human-readable alias
+     * @param profile - The profile data
+     * @param algorithm - The AIP algorithm
+     * @param signerAddr - The signer address
+     * @param signature - The AIP signature
+     * @returns BAP - The ALIAS attestation
+     */
+    static createAlias(alias, profile, algorithm, signerAddr, signature) {
+        return new BAP({
+            type: BAPAttestationType.ALIAS,
+            idKey: alias,
+            sequence: BigInt(0),
+            profile,
+            algorithm,
+            signerAddr,
+            signature,
+            rootAddress: signerAddr,
+            isSignedByID: false,
+        });
+    }
+    /**
+     * Verifies the AIP signature for the BAP attestation
+     *
+     * @param _protocolData - The protocol data for signature verification
+     * @returns boolean - True if signature is valid
+     */
+    verifySignature(_protocolData) {
+        if (this.algorithm == null ||
+            this.algorithm === '' ||
+            this.signerAddr == null ||
+            this.signerAddr === '' ||
+            this.signature == null ||
+            this.signature === '') {
+            return false;
+        }
+        // This would need to be implemented with actual AIP verification
+        // For now, return true if all signature components are present
+        return true;
+    }
+    /**
+     * Placeholder for unlock method - BAP is read-only
+     */
+    unlock() {
+        throw new Error('BAP attestations cannot be unlocked - they are read-only identity records');
+    }
+}
+//# sourceMappingURL=bap.js.map

package/dist/bitcom/bap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bap.js","sourceRoot":"","sources":["../../src/bitcom/bap.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,MAAM,EAEN,KAAK,GACL,MAAM,UAAU,CAAA;AACjB,OAAO,MAA8B,MAAM,aAAa,CAAA;AAExD;;GAEG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC7B,+BAAS,CAAA;IACT,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,qCAAe,CAAA;AAChB,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAmBD;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,oCAAoC,CAAA;AAEvE;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,OAAO,OAAO,GAAG;IACvB,WAAW,CAAS;IACpB,IAAI,CAAoB;IACxB,KAAK,CAAS;IACd,OAAO,CAAS;IAChB,QAAQ,CAAQ;IAChB,SAAS,CAAS;IAClB,UAAU,CAAS;IACnB,SAAS,CAAS;IAClB,WAAW,CAAS;IACpB,YAAY,CAAS;IACrB,OAAO,CAAU;IAEjB,YAAY,IAAa;QACxB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAC/B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAA;QACrC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI;QACH,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAA;QAE3B,uBAAuB;QACvB,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;QAEjD,yBAAyB;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,EAAE,EAAE,CAAC;YACzC,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC7C,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;YACnD,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,EAAE,EAAE,CAAC;gBACjD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;YACrD,CAAC;QACF,CAAC;aAAM,IACN,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,MAAM;YACvC,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,MAAM,EACtC,CAAC;YACF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC7C,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;YACnD,CAAC;YACD,sBAAsB;YACtB,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;QACjE,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,KAAK,EAAE,CAAC;YACnD,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,EAAE,EAAE,CAAC;gBAC7C,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;YACnD,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;gBAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;gBAChD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAA;YACpD,CAAC;QACF,CAAC;QAED,yBAAyB;QACzB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,EAAE,EAAE,CAAC;YACrD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAA;QACvD,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YACvD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAA;QACxD,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,EAAE,EAAE,CAAC;YACrD,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAA;QACvD,CAAC;QAED,0BAA0B;QAC1B,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;YACzB;gBACC,QAAQ,EAAE,mBAAmB;gBAC7B,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE;gBACzB,GAAG,EAAE,CAAC;aACN;SACD,CAAC,CAAA;QAEF,OAAO,MAAM,CAAC,IAAI,EAAE,CAAA;IACrB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAqB;QAClC,IACC,MAAM,IAAI,IAAI;YACd,MAAM,CAAC,SAAS,IAAI,IAAI;YACxB,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAC5B,CAAC;YACF,OAAO,IAAI,CAAA;QACZ,CAAC;QAED,oBAAoB;QACpB,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,mBAAmB,CACzC,CAAA;QACD,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACzB,OAAO,IAAI,CAAA;QACZ,CAAC;QAED,IAAI,CAAC;YACJ,iCAAiC;YACjC,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;YACpD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;YAE5B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAA;YACZ,CAAC;YAED,2BAA2B;YAC3B,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;YAC3B,IAAI,SAAS,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;gBAC5B,OAAO,IAAI,CAAA;YACZ,CAAC;YACD,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAuB,CAAA;YAE/D,wEAAwE;YAExE,MAAM,OAAO,GAAY;gBACxB,WAAW,EAAE,WAAW,CAAC,GAAG;gBAC5B,IAAI;gBACJ,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;gBACnB,YAAY,EAAE,KAAK;aACnB,CAAA;YAED,2BAA2B;YAC3B,IAAI,IAAI,KAAK,kBAAkB,CAAC,EAAE,EAAE,CAAC;gBACpC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACjD,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;gBAC7C,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACjD,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;gBAC/C,CAAC;gBACD,OAAO,CAAC,YAAY,GAAG,IAAI,CAAA;YAC5B,CAAC;iBAAM,IACN,IAAI,KAAK,kBAAkB,CAAC,MAAM;gBAClC,IAAI,KAAK,kBAAkB,CAAC,MAAM,EACjC,CAAC;gBACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACjD,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;gBAC7C,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACjD,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;oBAChD,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA;gBACvC,CAAC;YACF,CAAC;iBAAM,IAAI,IAAI,KAAK,kBAAkB,CAAC,KAAK,EAAE,CAAC;gBAC9C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACjD,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;gBAC7C,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACjD,IAAI,CAAC;wBACJ,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;wBAChD,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;oBAC1C,CAAC;oBAAC,MAAM,CAAC;wBACR,kCAAkC;wBAClC,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;oBAC/C,CAAC;gBACF,CAAC;YACF,CAAC;YAED,6EAA6E;YAC7E,MAAM,WAAW,GAAG,CAAC,CAAA,CAAC,iDAAiD;YAEvE,yEAAyE;YACzE,IAAI,MAAM,CAAC,MAAM,GAAG,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;gBACrE,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAK,CAAC,CAAA;YAC5D,CAAC;YACD,IACC,MAAM,CAAC,MAAM,GAAG,WAAW,GAAG,CAAC;gBAC/B,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EACnC,CAAC;gBACF,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;gBAC/C,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;oBACxB,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;gBAC9C,CAAC;YACF,CAAC;YACD,IACC,MAAM,CAAC,MAAM,GAAG,WAAW,GAAG,CAAC;gBAC/B,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EACnC,CAAC;gBACF,MAAM,aAAa,GAAG,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;gBAClD,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;oBAC3B,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;gBAChD,CAAC;YACF,CAAC;YAED,6CAA6C;YAC7C,IAAI,OAAO,CAAC,UAAU,IAAI,IAAI,IAAI,OAAO,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;gBAC7D,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,CAAA;YACzC,CAAC;YAED,6CAA6C;YAC7C,IAAI,IAAI,KAAK,kBAAkB,CAAC,EAAE,EAAE,CAAC;gBACpC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAA,CAAC,oDAAoD;YACjF,CAAC;iBAAM,CAAC;gBACP,OAAO,CAAC,YAAY,GAAG,KAAK,CAAA,CAAC,sDAAsD;YACpF,CAAC;YAED,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAA;QACxB,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,IAAI,CAAA;QACZ,CAAC;IACF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,QAAQ,CACd,WAAmB,EACnB,OAAe,EACf,SAAkB,EAClB,UAAmB,EACnB,SAAkB;QAElB,OAAO,IAAI,GAAG,CAAC;YACd,IAAI,EAAE,kBAAkB,CAAC,EAAE;YAC3B,KAAK,EAAE,WAAW;YAClB,OAAO;YACP,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;YACnB,SAAS;YACT,UAAU;YACV,SAAS;YACT,WAAW,EAAE,UAAU;YACvB,YAAY,EAAE,IAAI;SAClB,CAAC,CAAA;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAClB,IAAY,EACZ,QAAgB,EAChB,SAAkB,EAClB,UAAmB,EACnB,SAAkB;QAElB,OAAO,IAAI,GAAG,CAAC;YACd,IAAI,EAAE,kBAAkB,CAAC,MAAM;YAC/B,KAAK,EAAE,IAAI;YACX,QAAQ;YACR,SAAS;YACT,UAAU;YACV,SAAS;YACT,WAAW,EAAE,UAAU;YACvB,YAAY,EAAE,KAAK;SACnB,CAAC,CAAA;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAClB,IAAY,EACZ,QAAgB,EAChB,SAAkB,EAClB,UAAmB,EACnB,SAAkB;QAElB,OAAO,IAAI,GAAG,CAAC;YACd,IAAI,EAAE,kBAAkB,CAAC,MAAM;YAC/B,KAAK,EAAE,IAAI;YACX,QAAQ;YACR,SAAS;YACT,UAAU;YACV,SAAS;YACT,WAAW,EAAE,UAAU;YACvB,YAAY,EAAE,KAAK;SACnB,CAAC,CAAA;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,WAAW,CACjB,KAAa,EACb,OAAgB,EAChB,SAAkB,EAClB,UAAmB,EACnB,SAAkB;QAElB,OAAO,IAAI,GAAG,CAAC;YACd,IAAI,EAAE,kBAAkB,CAAC,KAAK;YAC9B,KAAK,EAAE,KAAK;YACZ,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;YACnB,OAAO;YACP,SAAS;YACT,UAAU;YACV,SAAS;YACT,WAAW,EAAE,UAAU;YACvB,YAAY,EAAE,KAAK;SACnB,CAAC,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,aAAwB;QACvC,IACC,IAAI,CAAC,SAAS,IAAI,IAAI;YACtB,IAAI,CAAC,SAAS,KAAK,EAAE;YACrB,IAAI,CAAC,UAAU,IAAI,IAAI;YACvB,IAAI,CAAC,UAAU,KAAK,EAAE;YACtB,IAAI,CAAC,SAAS,IAAI,IAAI;YACtB,IAAI,CAAC,SAAS,KAAK,EAAE,EACpB,CAAC;YACF,OAAO,KAAK,CAAA;QACb,CAAC;QAED,iEAAiE;QACjE,+DAA+D;QAC/D,OAAO,IAAI,CAAA;IACZ,CAAC;IAED;;OAEG;IACH,MAAM;QACL,MAAM,IAAI,KAAK,CACd,2EAA2E,CAC3E,CAAA;IACF,CAAC;CACD"}

package/dist/bitcom/bitcom.d.ts

@@ -0,0 +1,75 @@
+import { LockingScript, Script } from '@bsv/sdk';
+/**
+ * Represents a protocol within a transaction
+ */
+export interface Protocol {
+    protocol: string;
+    script: number[];
+    pos: number;
+}
+/**
+ * Represents a BitCom protocol within a transaction (deprecated - use Protocol)
+ * @deprecated Use Protocol instead
+ */
+export interface BitComProtocol extends Protocol {
+    protocol: string;
+    script: number[];
+    pos: number;
+}
+/**
+ * Represents the complete BitCom structure of a transaction
+ */
+export interface BitComDecoded {
+    protocols: Protocol[];
+    scriptPrefix: number[];
+}
+/**
+ * BitCom template for handling multi-protocol Bitcoin transactions
+ *
+ * BitCom allows multiple protocols to be embedded in a single transaction output
+ * using the pipe ('|') delimiter to separate different protocol sections.
+ *
+ * This implementation mirrors the Go template structure and behavior.
+ */
+export default class BitCom {
+    protocols: Protocol[];
+    scriptPrefix: number[];
+    constructor(protocols?: Protocol[], scriptPrefix?: number[]);
+    /**
+     * Decodes a script to extract BitCom protocol data
+     *
+     * Mirrors the Go implementation's decode algorithm exactly.
+     *
+     * @param script - The script to decode
+     * @returns BitComDecoded - The decoded BitCom structure, or null if no OP_RETURN found
+     */
+    static decode(script: Script | LockingScript): BitComDecoded | null;
+    /**
+     * Creates a locking script from the BitCom structure
+     *
+     * Mirrors the Go Lock() method exactly.
+     *
+     * @returns LockingScript - The BitCom locking script
+     */
+    lock(): LockingScript;
+    /**
+     * Finds the position of OP_RETURN in the script
+     *
+     * Mirrors the Go findReturn function exactly.
+     *
+     * @param scriptBytes - The script bytes to search
+     * @param from - Starting position
+     * @returns number - Position of OP_RETURN, or -1 if not found
+     */
+    private static findReturn;
+    /**
+     * Converts various input types to a Script object
+     *
+     * Mirrors the Go ToScript function exactly.
+     *
+     * @param data - The data to convert (Script, LockingScript, or byte array)
+     * @returns Script - The converted script, or null if conversion fails
+     */
+    static toScript(data: Script | LockingScript | number[]): Script | null;
+}
+//# sourceMappingURL=bitcom.d.ts.map

package/dist/bitcom/bitcom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bitcom.d.ts","sourceRoot":"","sources":["../../src/bitcom/bitcom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAM,MAAM,EAAS,MAAM,UAAU,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,YAAY,EAAE,MAAM,EAAE,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IAC1B,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,YAAY,EAAE,MAAM,EAAE,CAAA;gBAEV,SAAS,GAAE,QAAQ,EAAO,EAAE,YAAY,GAAE,MAAM,EAAO;IAKnE;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,aAAa,GAAG,IAAI;IA8FnE;;;;;;OAMG;IACH,IAAI,IAAI,aAAa;IA2CrB;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;IASzB;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI;CAevE"}