@atomicfinance/types 4.0.0 → 4.0.1

package/.yalc/@node-dlc/bitcoin/dist/OutPoint.d.ts

@@ -0,0 +1,57 @@
+/// <reference types="node" />
+import { StreamReader } from '@node-dlc/bufio';
+import { HashValue } from './HashValue';
+import { ICloneable } from './ICloneable';
+/**
+ * A tuple defining a transaction output which contains the transaction
+ * identifier and the output index.
+ */
+export declare class OutPoint implements ICloneable<OutPoint> {
+    /**
+     * Creates an OutPoint from a byte stream.
+     * @param reader
+     */
+    static parse(reader: StreamReader): OutPoint;
+    /**
+     * Creates an OutPoint instance from an Outpoint serialized
+     * to the standard string of "txid:vout" where the txid is in RPC
+     * (reversed) byte order
+     */
+    static fromString(text: string): OutPoint;
+    /**
+     * Transaction identifier
+     */
+    txid: HashValue;
+    /**
+     * Index of output in transaction
+     */
+    outputIndex: number;
+    /**
+     * Constructs a new OutPoint
+     * @param txid TxId as a HashValue or an RPC (big-endian) string
+     * @param outputIndex
+     */
+    constructor(txid: HashValue | string, outputIndex: number);
+    /**
+     * Converts the outpoint to a human readable string in the format
+     * [txid]:[voutidx]
+     */
+    toString(): string;
+    /**
+     * Converts the outpoint to a JSON object with the txid and index
+     * tuple
+     */
+    toJSON(): {
+        txid: string;
+        index: number;
+    };
+    /**
+     * Serializes the OutPoint to a buffer where the txid is serialized
+     * in internal byte order, and the output index is uint32LE
+     */
+    serialize(): Buffer;
+    /**
+     * Clones by performing deep copy
+     */
+    clone(): OutPoint;
+}

package/.yalc/@node-dlc/bitcoin/dist/OutPoint.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutPoint = void 0;
+const bufio_1 = require("@node-dlc/bufio");
+const HashByteOrder_1 = require("./HashByteOrder");
+const HashValue_1 = require("./HashValue");
+/**
+ * A tuple defining a transaction output which contains the transaction
+ * identifier and the output index.
+ */
+class OutPoint {
+    /**
+     * Creates an OutPoint from a byte stream.
+     * @param reader
+     */
+    static parse(reader) {
+        const txid = HashValue_1.HashValue.parse(reader);
+        const outputIndex = reader.readUInt32LE();
+        return new OutPoint(txid, outputIndex);
+    }
+    /**
+     * Creates an OutPoint instance from an Outpoint serialized
+     * to the standard string of "txid:vout" where the txid is in RPC
+     * (reversed) byte order
+     */
+    static fromString(text) {
+        const parts = /^([0-9a-f]{64,64}):(\d+)$/i.exec(text);
+        if (!parts) {
+            throw new Error('invalid argument');
+        }
+        const txid = HashValue_1.HashValue.fromRpc(parts[1]);
+        const voutIdx = parseInt(parts[2]);
+        if (voutIdx < 0) {
+            throw new Error('invalid argument');
+        }
+        return new OutPoint(txid, voutIdx);
+    }
+    /**
+     * Constructs a new OutPoint
+     * @param txid TxId as a HashValue or an RPC (big-endian) string
+     * @param outputIndex
+     */
+    constructor(txid, outputIndex) {
+        if (txid instanceof HashValue_1.HashValue) {
+            this.txid = txid;
+        }
+        else {
+            this.txid = HashValue_1.HashValue.fromRpc(txid);
+        }
+        this.outputIndex = outputIndex;
+    }
+    /**
+     * Converts the outpoint to a human readable string in the format
+     * [txid]:[voutidx]
+     */
+    toString() {
+        return `${this.txid.toString(HashByteOrder_1.HashByteOrder.RPC)}:${this.outputIndex}`;
+    }
+    /**
+     * Converts the outpoint to a JSON object with the txid and index
+     * tuple
+     */
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    toJSON() {
+        return {
+            txid: this.txid.toString(HashByteOrder_1.HashByteOrder.RPC),
+            index: this.outputIndex,
+        };
+    }
+    /**
+     * Serializes the OutPoint to a buffer where the txid is serialized
+     * in internal byte order, and the output index is uint32LE
+     */
+    serialize() {
+        const writer = new bufio_1.BufferWriter(Buffer.alloc(36));
+        writer.writeBytes(this.txid.serialize());
+        writer.writeUInt32LE(this.outputIndex);
+        return writer.toBuffer();
+    }
+    /**
+     * Clones by performing deep copy
+     */
+    clone() {
+        return new OutPoint(this.txid.clone(), this.outputIndex);
+    }
+}
+exports.OutPoint = OutPoint;
+//# sourceMappingURL=OutPoint.js.map

package/.yalc/@node-dlc/bitcoin/dist/OutPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutPoint.js","sourceRoot":"","sources":["../lib/OutPoint.ts"],"names":[],"mappings":";;;AAAA,2CAA6D;AAE7D,mDAAgD;AAChD,2CAAwC;AAGxC;;;GAGG;AACH,MAAa,QAAQ;IACnB;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,MAAoB;QACtC,MAAM,IAAI,GAAG,qBAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,WAAW,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC;QAC1C,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,IAAY;QACnC,MAAM,KAAK,GAAG,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;QACD,MAAM,IAAI,GAAG,qBAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,IAAI,OAAO,GAAG,CAAC,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAYD;;;;OAIG;IACH,YAAY,IAAwB,EAAE,WAAmB;QACvD,IAAI,IAAI,YAAY,qBAAS,EAAE;YAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,qBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACrC;QACD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,6BAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;IACxE,CAAC;IAED;;;OAGG;IACH,6EAA6E;IACtE,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,6BAAa,CAAC,GAAG,CAAC;YAC3C,KAAK,EAAE,IAAI,CAAC,WAAW;SACxB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,SAAS;QACd,MAAM,MAAM,GAAG,IAAI,oBAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAClD,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACzC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACvC,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,KAAK;QACV,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;CACF;AA1FD,4BA0FC"}

package/.yalc/@node-dlc/bitcoin/dist/Script.d.ts

@@ -0,0 +1,185 @@
+/// <reference types="node" />
+import { StreamReader } from '@node-dlc/bufio';
+import { ICloneable } from './ICloneable';
+import { ScriptCmd } from './ScriptCmd';
+/**
+ * Bitcoin Script
+ */
+export declare class Script implements ICloneable<Script> {
+    /**
+     *
+     * @param val
+     */
+    static number(val: number | bigint): ScriptCmd;
+    /**
+     * Creates a standard (though no longer used) pay-to-pubkey
+     * scriptPubKey using the provided pubkey.
+     *
+     * P2PK format:
+     *      <pubkey> OP_CHECKSIG
+     *
+     * @param pubkey 33-byte compressed or 65-byte uncompressed SEC
+     * encoded pubkey
+     */
+    static p2pkLock(pubkey: Buffer): Script;
+    /**
+     * Creates a standard (though no longer used) pay-to-pubkey
+     * scriptSig using the provided signature.
+     *
+     * P2PK format:
+     *      <sig>
+     *
+     * @param sig DER encoded signature + 1-byte sighash type
+     */
+    static p2pkUnlock(sig: Buffer): Script;
+    /**
+     * Creates a standard Pay-to-Public-Key-Hash scriptPubKey by accepting a
+     * hash of a public key as input and generating the script in the standard
+     * P2PKH script format:
+     *   OP_DUP OP_HASH160 <hash160pubkey> OP_EQUALVERIFY OP_CHECKSIG
+     *
+     * @param value either the 20-byte hash160 of a pubkey or an SEC
+     * encoded compressed or uncompressed pubkey
+     */
+    static p2pkhLock(value: Buffer): Script;
+    /**
+     * Creates a standard Pay-to-Public-Key-Hash scriptSig
+     * @param sig BIP66 compliant DER encoded signuture + hash byte
+     * @param pubkey SEC encoded public key
+     */
+    static p2pkhUnlock(sig: Buffer, pubkey: Buffer): Script;
+    /**
+     * Creates a standard Pay-to-MultiSig scriptPubKey by accepting m of n
+     * public keys as inputs in the format:
+     *   OP_<m> <pubkey1> <pubkey2> <pubkey..m> OP_<n> OP_CHECKMULTISIG
+     */
+    static p2msLock(m: number, ...pubkeys: Buffer[]): Script;
+    /**
+     * Creates a standard Pay-to-MultiSig scripSig using the provided
+     * signatures. The signatures must be in the order of the pub keys
+     * used in the lock script. This function also correctly adds OP_0
+     * as the first element on the stack to ensure the p2ms off-by-one
+     * error is correctly accounted for.
+     *
+     * Each signature must be DER encoded using BIP66 and
+     * include a 1-byte sighash type at the end. The builder validates
+     * the signatures. As such they will be 10 to 74 bytes.
+     *
+     * @param pubkeys
+     */
+    static p2msUnlock(...sigs: Buffer[]): Script;
+    /**
+     * Creates a standard Pay-to-Script-Hash scriptPubKey by accepting a hash of
+     * the redeem script as input and generating the P2SH script:
+     *   OP_HASH160 <hashScript> OP_EQUAL
+     *
+     * Accepts the redeem script either as a Script object or as the
+     * hash160 of the redeem script. When the hash160 Buffer is provided
+     * it will throw if the Buffer is not 20-bytes.
+     *
+     * @param value can be either the redeem script as a Script type or
+     * the hash160 as a 20-byte buffer
+     */
+    static p2shLock(value: Script | Buffer): Script;
+    /**
+     * Creates a p2sh unlock script for use in a transaction input
+     * scriptSig value. The redeem script, which is the preimage of the
+     * of the script hash used to lock the p2sh output, must be provided
+     * along with any additional data required to unlock the script.
+     *
+     * @param redeemScript preimage of the script hash
+     * @param data script commands will be added as unlock data
+     */
+    static p2shUnlock(redeemScript: Script, data: Script): Script;
+    /**
+     * Creates a p2sh unlock script for use in a transaction input
+     * scriptSig value. The redeem script, which is the preimage of the
+     * of the script hash used to lock the p2sh output, must be provided
+     * along with any additional data required to unlock the script.
+     *
+     * @param redeemScript preimage of the script hash
+     * @param data ScriptCmd data used to unlock the script
+     */
+    static p2shUnlock(redeemScript: Script, ...data: ScriptCmd[]): Script;
+    /**
+     * Create a standard Pay-to-Witness-PubKey-Hash scriptPubKey by accepting
+     * the hash160 of a compressed public key point as input. It is of the
+     * format:
+     *   OP_0 <hash160_pubkey>
+     *
+     * @param value either a 20-byte pubkeyhash or a valid pubkey
+     */
+    static p2wpkhLock(value: Buffer): Script;
+    /**
+     * Create a standard Pay-to-Witness-Script-Hash scriptPubKey by accepting
+     * the sha256 of the witness script as input. It is of the format:
+     *   OP_0 <sha256_redeem_script>
+     */
+    static p2wshLock(value: Buffer | Script): Script;
+    /**
+     * Parses a stream of bytes representing a Script. The stream must start
+     * with a Varint length of Script data. The Script data is then parsed into
+     * data blocks or op_codes depending on the meaning of the bytes
+     * @param stream
+     */
+    static parse(reader: StreamReader): Script;
+    /**
+     * When supplied with a Buffer of cmds this method will parse the commands
+     * into data blocks or op_codes depending on the meaning of the bytes
+     * @param buf
+     */
+    static parseCmds(buf: Buffer): ScriptCmd[];
+    /**
+     * Commands belonging to the script
+     */
+    readonly cmds: ScriptCmd[];
+    /**
+     * Constructs a Script with the supplied ScriptCmd values
+     * @param cmds
+     */
+    constructor(...cmds: ScriptCmd[]);
+    /**
+     * Returns true if other script is an exact match of the current script.
+     * This requires all data element sto be exact matches and all operations
+     * to be exact matches.
+     * @param other
+     */
+    equals(other: Script): boolean;
+    /**
+     * Returns a string with the friendly name of the opcode. For data,
+     * it returns the value in hexadecimal format.
+     */
+    toString(): string;
+    /**
+     * Returns a JSON serialization of the Script.
+     */
+    toJSON(): string;
+    /**
+     * Serializes the Script to a Buffer by serializing the cmds prefixed with
+     * the overall length as a varint. Therefore the format of this method is
+     * the format used when encoding a Script and is:
+     *
+     * [varint]: length
+     * [length]: script_cmds
+     */
+    serialize(): Buffer;
+    /**
+     * Serializes the commands to a buffer. This information is the raw
+     * serialization and can be directly parsed with the `parseCmds` method.
+     */
+    serializeCmds(): Buffer;
+    /**
+     * Clone via deep copy
+     */
+    clone(): Script;
+    /**
+     * Performs a hash160 on the serialized commands. This is useful for
+     * turning a script into a P2SH redeem script.
+     */
+    hash160(): Buffer;
+    /**
+     * Performs a sha256 hash on the serialized commands. This is useful
+     * fro turning a script into a P2WSH lock script.
+     */
+    sha256(): Buffer;
+}