@vbyte/btc-dev 1.0.0

package/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

package/README.md

@@ -0,0 +1,5 @@
+# btc-dev
+
+Experimental revision of the bitcoin [tapscript](https://www.npmjs.com/package/@cmdcode/tapscript) library.
+
+Documentation coming soon!

package/dist/class/index.d.ts

@@ -0,0 +1,5 @@
+export * from './signer.js';
+export * from './tx.js';
+export * from './txin.js';
+export * from './txout.js';
+export * from './witness.js';

package/dist/class/index.js

@@ -0,0 +1,5 @@
+export * from './signer.js';
+export * from './tx.js';
+export * from './txin.js';
+export * from './txout.js';
+export * from './witness.js';

package/dist/class/signer.d.ts

@@ -0,0 +1,18 @@
+import { Buff, Bytes } from '@vbyte/buff';
+import type { SigHashOptions, TxData } from '../types/index.js';
+export declare class TxSigner {
+    private readonly _seckey;
+    constructor(seckey: Bytes);
+    get pubkey(): {
+        segwit: Buff;
+        taproot: Buff;
+    };
+    get sign_msg(): {
+        ecdsa: (msg: Bytes) => Buff;
+        bip340: (msg: Bytes) => Buff;
+    };
+    get sign_tx(): {
+        segwit: (tx: TxData, options: SigHashOptions) => string;
+        taproot: (tx: TxData, options: SigHashOptions) => string;
+    };
+}

package/dist/class/signer.js

@@ -0,0 +1,32 @@
+import { Buff } from '@vbyte/buff';
+import { ECC } from '@vbyte/micro-lib';
+import { sign_segwit_tx, sign_taproot_tx } from '../lib/sighash/sign.js';
+export class TxSigner {
+    constructor(seckey) {
+        this._seckey = Buff.bytes(seckey).hex;
+    }
+    get pubkey() {
+        return {
+            segwit: ECC.get_pubkey(this._seckey, 'ecdsa'),
+            taproot: ECC.get_pubkey(this._seckey, 'bip340')
+        };
+    }
+    get sign_msg() {
+        return {
+            ecdsa: (msg) => {
+                const bytes = Buff.bytes(msg);
+                return ECC.sign_ecdsa(this._seckey, bytes);
+            },
+            bip340: (msg) => {
+                const bytes = Buff.bytes(msg);
+                return ECC.sign_bip340(this._seckey, bytes);
+            }
+        };
+    }
+    get sign_tx() {
+        return {
+            segwit: (tx, options) => sign_segwit_tx(this._seckey, tx, options),
+            taproot: (tx, options) => sign_taproot_tx(this._seckey, tx, options)
+        };
+    }
+}

package/dist/class/tx.d.ts

@@ -0,0 +1,38 @@
+import { TransactionInput } from './txin.js';
+import { TransactionOutput } from './txout.js';
+import type { TxData, TxTemplate, TxValue, TransactionData } from '../types/index.js';
+export declare class Transaction {
+    private readonly _size;
+    private readonly _tx;
+    private readonly _hash;
+    private readonly _value;
+    private readonly _vin;
+    private readonly _vout;
+    constructor(txdata: string | TxData | TxTemplate);
+    get data(): TransactionData;
+    get hash(): string;
+    get locktime(): {
+        hex: string;
+        data: import("../types/index.js").LocktimeInfo | null;
+        value: number;
+    };
+    get return(): import("../types/index.js").TxOutput | null;
+    get size(): {
+        segwit: number;
+        vin: number;
+        vout: number;
+        witness: number;
+        base: number;
+        real: number;
+        weight: number;
+        vsize: number;
+    };
+    get spends(): TransactionOutput[];
+    get txid(): string;
+    get value(): TxValue;
+    get version(): number;
+    get vin(): TransactionInput[];
+    get vout(): TransactionOutput[];
+    toJSON(): TransactionData;
+    toString(): string;
+}

package/dist/class/tx.js

@@ -0,0 +1,73 @@
+import { TransactionInput } from './txin.js';
+import { TransactionOutput } from './txout.js';
+import { decode_tx_data, get_txid, is_return_script, parse_tx_data, Locktime, get_txsize, get_tx_value, get_txhash, encode_tx_locktime, } from '../lib/tx/index.js';
+export class Transaction {
+    constructor(txdata) {
+        this._tx = (typeof txdata !== 'string')
+            ? parse_tx_data(txdata)
+            : decode_tx_data(txdata);
+        this._vin = this._tx.vin.map(txin => new TransactionInput(txin));
+        this._vout = this._tx.vout.map(txout => new TransactionOutput(txout));
+        this._size = get_txsize(this._tx);
+        this._hash = get_txhash(this._tx);
+        this._value = get_tx_value(this._tx);
+    }
+    get data() {
+        return {
+            hash: this.hash,
+            locktime: this.locktime,
+            return: this.return,
+            size: this.size,
+            spends: this.spends,
+            txid: this.txid,
+            value: this.value,
+            version: this.version,
+            vin: this.vin.map(txin => txin.data),
+            vout: this.vout.map(txout => txout.data)
+        };
+    }
+    get hash() {
+        return this._hash;
+    }
+    get locktime() {
+        return {
+            hex: encode_tx_locktime(this._tx.locktime).hex,
+            data: Locktime.decode(this._tx.locktime),
+            value: this._tx.locktime
+        };
+    }
+    get return() {
+        return this._tx.vout.find(txout => is_return_script(txout.script_pk)) || null;
+    }
+    get size() {
+        return {
+            ...this._size,
+            segwit: this._vin.reduce((acc, txin) => acc + (txin.witness?.vsize ?? 0), 0),
+            vin: this._vin.reduce((acc, txin) => acc + txin.size, 0),
+            vout: this._vout.reduce((acc, txout) => acc + txout.size, 0),
+            witness: this._vin.reduce((acc, txin) => acc + (txin.witness?.size ?? 0), 0)
+        };
+    }
+    get spends() {
+        return this._tx.vin
+            .filter(txin => txin.prevout !== null)
+            .map(txin => new TransactionOutput(txin.prevout));
+    }
+    get txid() {
+        return get_txid(this._tx);
+    }
+    get value() {
+        return this._value;
+    }
+    get version() {
+        return this._tx.version;
+    }
+    get vin() {
+        return this._vin;
+    }
+    get vout() {
+        return this._vout;
+    }
+    toJSON() { return this.data; }
+    toString() { return JSON.stringify(this.data); }
+}

package/dist/class/txin.d.ts

@@ -0,0 +1,29 @@
+import { TransactionOutput } from './txout.js';
+import { TransactionWitness } from './witness.js';
+import type { TxInput, TxInputField } from '../types/index.js';
+export declare class TransactionInput {
+    private readonly _size;
+    private readonly _txin;
+    private readonly _witness;
+    constructor(txin: TxInput);
+    get coinbase(): string | null;
+    get data(): TxInputField;
+    get has_prevout(): boolean;
+    get is_coinbase(): boolean;
+    get prevout(): TransactionOutput | null;
+    get script_sig(): {
+        asm: string[];
+        hex: string;
+    } | null;
+    get sequence(): {
+        hex: string;
+        data: import("../types/index.js").SequenceInfo | null;
+        value: number;
+    };
+    get size(): number;
+    get txid(): string;
+    get vout(): number;
+    get witness(): TransactionWitness | null;
+    toJSON(): TxInputField;
+    toString(): string;
+}

package/dist/class/txin.js

@@ -0,0 +1,68 @@
+import { decode_script } from '../lib/script/index.js';
+import { TransactionOutput } from './txout.js';
+import { TransactionWitness } from './witness.js';
+import { encode_txin_sequence, get_txin_size, Sequence } from '../lib/tx/index.js';
+export class TransactionInput {
+    constructor(txin) {
+        this._size = get_txin_size(txin);
+        this._txin = txin;
+        this._witness = txin.witness.length > 0
+            ? new TransactionWitness(txin.witness)
+            : null;
+    }
+    get coinbase() {
+        return this._txin.coinbase;
+    }
+    get data() {
+        return {
+            coinbase: this.coinbase,
+            prevout: this.prevout?.data ?? null,
+            script_sig: this.script_sig,
+            sequence: this.sequence,
+            size: this.size,
+            txid: this.txid,
+            vout: this.vout,
+            witness: this.witness?.data ?? null
+        };
+    }
+    get has_prevout() {
+        return this._txin.prevout !== null;
+    }
+    get is_coinbase() {
+        return this._txin.coinbase !== null;
+    }
+    get prevout() {
+        return this._txin.prevout
+            ? new TransactionOutput(this._txin.prevout)
+            : null;
+    }
+    get script_sig() {
+        if (this._txin.script_sig === null)
+            return null;
+        return {
+            asm: decode_script(this._txin.script_sig),
+            hex: this._txin.script_sig
+        };
+    }
+    get sequence() {
+        return {
+            hex: encode_txin_sequence(this._txin.sequence).hex,
+            data: Sequence.decode(this._txin.sequence),
+            value: this._txin.sequence
+        };
+    }
+    get size() {
+        return this._size;
+    }
+    get txid() {
+        return this._txin.txid;
+    }
+    get vout() {
+        return this._txin.vout;
+    }
+    get witness() {
+        return this._witness;
+    }
+    toJSON() { return this.data; }
+    toString() { return JSON.stringify(this.data); }
+}

package/dist/class/txout.d.ts

@@ -0,0 +1,18 @@
+import type { TxOutput, TxOutputField } from '../types/index.js';
+export declare class TransactionOutput {
+    private readonly _info;
+    private readonly _size;
+    private readonly _txout;
+    constructor(txout: TxOutput);
+    get data(): TxOutputField;
+    get script_pk(): {
+        hex: string;
+        asm: string[];
+    };
+    get size(): number;
+    get type(): import("../types/index.js").TxOutputType;
+    get value(): bigint;
+    get version(): import("../types/index.js").WitnessVersion;
+    toJSON(): TxOutputField;
+    toString(): string;
+}

package/dist/class/txout.js

@@ -0,0 +1,38 @@
+import { decode_script } from '../lib/script/index.js';
+import { get_txout_size, get_vout_info } from '../lib/tx/index.js';
+export class TransactionOutput {
+    constructor(txout) {
+        this._info = get_vout_info(txout);
+        this._size = get_txout_size(txout);
+        this._txout = txout;
+    }
+    get data() {
+        return {
+            script_pk: this.script_pk,
+            size: this.size,
+            type: this.type,
+            value: this.value,
+            version: this.version
+        };
+    }
+    get script_pk() {
+        return {
+            hex: this._txout.script_pk,
+            asm: decode_script(this._txout.script_pk)
+        };
+    }
+    get size() {
+        return this._size;
+    }
+    get type() {
+        return this._info.type;
+    }
+    get value() {
+        return this._txout.value;
+    }
+    get version() {
+        return this._info.version;
+    }
+    toJSON() { return this.data; }
+    toString() { return JSON.stringify(this.data); }
+}

package/dist/class/witness.d.ts

@@ -0,0 +1,20 @@
+import { Bytes } from '@vbyte/buff';
+import type { ScriptField, WitnessField, WitnessType } from '../types/index.js';
+export declare class TransactionWitness {
+    private readonly _data;
+    private readonly _meta;
+    private readonly _size;
+    constructor(witness: Bytes[]);
+    get annex(): string | null;
+    get cblock(): string | null;
+    get data(): WitnessField;
+    get params(): string[];
+    get script(): ScriptField | null;
+    get size(): number;
+    get stack(): string[];
+    get type(): WitnessType;
+    get version(): number | null;
+    get vsize(): number;
+    toJSON(): WitnessField;
+    toString(): string;
+}

package/dist/class/witness.js

@@ -0,0 +1,57 @@
+import { Buff } from '@vbyte/buff';
+import { decode_script } from '../lib/script/index.js';
+import { parse_witness_data, get_witness_size, } from '../lib/tx/index.js';
+export class TransactionWitness {
+    constructor(witness) {
+        this._data = witness.map(e => Buff.bytes(e));
+        this._meta = parse_witness_data(witness);
+        this._size = get_witness_size(witness);
+    }
+    get annex() {
+        return this._meta.annex;
+    }
+    get cblock() {
+        return this._meta.cblock;
+    }
+    get data() {
+        return {
+            annex: this.annex,
+            cblock: this.cblock,
+            params: this.params,
+            script: this.script,
+            size: this.size,
+            stack: this.stack,
+            type: this.type,
+            version: this.version,
+            vsize: this.vsize
+        };
+    }
+    get params() {
+        return this._meta.params;
+    }
+    get script() {
+        if (this._meta.script === null)
+            return null;
+        return {
+            hex: this._meta.script,
+            asm: decode_script(this._meta.script)
+        };
+    }
+    get size() {
+        return this._size.size;
+    }
+    get stack() {
+        return this._data.map(e => e.hex);
+    }
+    get type() {
+        return this._meta.type;
+    }
+    get version() {
+        return this._meta.version;
+    }
+    get vsize() {
+        return this._size.vsize;
+    }
+    toJSON() { return this.data; }
+    toString() { return JSON.stringify(this.data); }
+}

package/dist/const.d.ts

@@ -0,0 +1,22 @@
+export declare const COINBASE: {
+    TXID: string;
+    VOUT: number;
+};
+export declare const DEFAULT: {
+    LOCKTIME: number;
+    SEQUENCE: number;
+    VERSION: number;
+};
+export declare const TAPLEAF_VERSIONS: number[];
+export declare const TAPLEAF_DEFAULT_VERSION = 192;
+export declare const LOCK_SCRIPT_REGEX: Record<string, RegExp>;
+export declare const SCRIPT_INT_KEY = "";
+export declare const TX_SIZE: {
+    GLOBAL_BASE: number;
+    GLOBAL_WIT: number;
+    TXIN_BASE: number;
+    TXOUT_BASE: number;
+};
+export declare const SIGHASH_DEFAULT = 1;
+export declare const SIGHASH_SEGWIT: number[];
+export declare const SIGHASH_TAPROOT: number[];

package/dist/const.js

@@ -0,0 +1,36 @@
+export const COINBASE = {
+    TXID: '00'.repeat(32),
+    VOUT: 0xFFFFFFFF,
+};
+export const DEFAULT = {
+    LOCKTIME: 0,
+    SEQUENCE: 0xFFFFFFFF,
+    VERSION: 2,
+};
+export const TAPLEAF_VERSIONS = [
+    0xc0, 0xc2, 0xc4, 0xc6, 0xc8, 0xca, 0xcc, 0xce,
+    0xd0, 0xd2, 0xd4, 0xd6, 0xd8, 0xda, 0xdc, 0xde,
+    0xe0, 0xe2, 0xe4, 0xe6, 0xe8, 0xea, 0xec, 0xee,
+    0xf0, 0xf2, 0xf4, 0xf6, 0xf8, 0xfa, 0xfc, 0xfe,
+    0x66, 0x7e, 0x80, 0x84, 0x96, 0x98, 0xba, 0xbc,
+    0xbe
+];
+export const TAPLEAF_DEFAULT_VERSION = 0xc0;
+export const LOCK_SCRIPT_REGEX = {
+    'p2pkh': /^76a914[0-9a-f]{40}88ac$/i,
+    'p2sh': /^a914[0-9a-f]{40}87$/i,
+    'p2wpkh': /^0014[0-9a-f]{40}$/i,
+    'p2wsh': /^0020[0-9a-f]{64}$/i,
+    'p2tr': /^5120[0-9a-f]{64}$/i,
+    'opreturn': /^6a[0-9a-f]{2,}$/i,
+};
+export const SCRIPT_INT_KEY = '';
+export const TX_SIZE = {
+    GLOBAL_BASE: 8,
+    GLOBAL_WIT: 10,
+    TXIN_BASE: 32 + 4 + 4,
+    TXOUT_BASE: 8,
+};
+export const SIGHASH_DEFAULT = 0x01;
+export const SIGHASH_SEGWIT = [0x01, 0x02, 0x03, 0x81, 0x82, 0x83];
+export const SIGHASH_TAPROOT = [0x00, ...SIGHASH_SEGWIT];

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export * from './class/index.js';
+export * as Address from './lib/address/index.js';
+export * as Meta from './lib/meta/index.js';
+export * as PSBT from './lib/psbt/index.js';
+export * as Script from './lib/script/index.js';
+export * as Sighash from './lib/sighash/index.js';
+export * as Taproot from './lib/taproot/index.js';
+export * as Tx from './lib/tx/index.js';
+export * as CONST from './const.js';
+export * as SCHEMA from './schema/index.js';
+export type * from './types/index.js';

package/dist/index.js

@@ -0,0 +1,10 @@
+export * from './class/index.js';
+export * as Address from './lib/address/index.js';
+export * as Meta from './lib/meta/index.js';
+export * as PSBT from './lib/psbt/index.js';
+export * as Script from './lib/script/index.js';
+export * as Sighash from './lib/sighash/index.js';
+export * as Taproot from './lib/taproot/index.js';
+export * as Tx from './lib/tx/index.js';
+export * as CONST from './const.js';
+export * as SCHEMA from './schema/index.js';

package/dist/lib/address/encode.d.ts

@@ -0,0 +1,3 @@
+import type { DecodedAddress } from '../../types/address.js';
+export declare function decode_address(address: string): DecodedAddress;
+export declare function encode_address(config: DecodedAddress): string;