@opcat-labs/opcat 1.0.1 → 1.0.3

package/types/transaction/unspentoutput.d.cts

@@ -0,0 +1,83 @@
+export = UnspentOutput;
+/**
+ * Represents an unspent output information: its script, associated amount and address,
+ * transaction id and output index.
+ *
+ * @constructor
+ * @param {object} data
+ * @param {string} data.txid the previous transaction id
+ * @param {string=} data.txId alias for `txid`
+ * @param {number} data.vout the index in the transaction
+ * @param {number=} data.outputIndex alias for `vout`
+ * @param {string|Script} data.scriptPubKey the script that must be resolved to release the funds
+ * @param {string|Script=} data.script alias for `scriptPubKey`
+ * @param {number} data.amount amount of bitcoins associated
+ * @param {number=} data.satoshis alias for `amount`, but expressed in satoshis (1 OPCAT = 1e8 satoshis)
+ * @param {string|Address=} data.address the associated address to the script, if provided
+ */
+declare function UnspentOutput(data: {
+    txid: string;
+    txId?: string | undefined;
+    vout: number;
+    outputIndex?: number | undefined;
+    scriptPubKey: string | Script;
+    script?: (string | Script) | undefined;
+    amount: number;
+    satoshis?: number | undefined;
+    address?: (string | Address) | undefined;
+}): UnspentOutput;
+declare class UnspentOutput {
+    /**
+     * Represents an unspent output information: its script, associated amount and address,
+     * transaction id and output index.
+     *
+     * @constructor
+     * @param {object} data
+     * @param {string} data.txid the previous transaction id
+     * @param {string=} data.txId alias for `txid`
+     * @param {number} data.vout the index in the transaction
+     * @param {number=} data.outputIndex alias for `vout`
+     * @param {string|Script} data.scriptPubKey the script that must be resolved to release the funds
+     * @param {string|Script=} data.script alias for `scriptPubKey`
+     * @param {number} data.amount amount of bitcoins associated
+     * @param {number=} data.satoshis alias for `amount`, but expressed in satoshis (1 OPCAT = 1e8 satoshis)
+     * @param {string|Address=} data.address the associated address to the script, if provided
+     */
+    constructor(data: {
+        txid: string;
+        txId?: string | undefined;
+        vout: number;
+        outputIndex?: number | undefined;
+        scriptPubKey: string | Script;
+        script?: (string | Script) | undefined;
+        amount: number;
+        satoshis?: number | undefined;
+        address?: (string | Address) | undefined;
+    });
+    /**
+     * Provide an informative output when displaying this object in the console
+     * @returns string
+     */
+    inspect(): string;
+    /**
+     * String representation: just "txid:index"
+     * @returns string
+     */
+    toString(): string;
+    /**
+     * Returns a plain object (no prototype or methods) with the associated info for this output
+     * @return {object}
+     */
+    toObject: () => object;
+    toJSON(): object;
+}
+declare namespace UnspentOutput {
+    /**
+     * Deserialize an UnspentOutput from an object
+     * @param {object|string} data
+     * @return UnspentOutput
+     */
+    function fromObject(data: any): UnspentOutput;
+}
+import Script = require("../script/script.cjs");
+import Address = require("../address.cjs");

package/types/util/_.d.cts

@@ -0,0 +1,26 @@
+export function isArray(t: any): boolean;
+export function isNumber(t: any): boolean;
+export function isObject(t: any): boolean;
+export function isString(t: any): boolean;
+export function isUndefined(t: any): boolean;
+export function isFunction(t: any): boolean;
+export function isNull(t: any): boolean;
+export function isDate(t: any): boolean;
+export function extend(a: any, b: any): any;
+export function noop(): void;
+export function every(a: any, f: any): any;
+export function map(a: any, f: any): any[];
+export function includes(a: any, e: any): any;
+export function each(a: any, f: any): any;
+export function clone(o: any): any;
+export function pick(object: any, keys: any): {};
+export function values(o: any): any[];
+export function filter(a: any, f: any): any;
+export function reduce(a: any, f: any, s: any): any;
+export function without(a: any, n: any): any;
+export function shuffle(a: any): any;
+export function difference(a: any, b: any): any;
+export function findIndex(a: any, f: any): any;
+export function some(a: any, f: any): any;
+export function range(n: any): any[];
+export function isPositiveNumber(n: any): boolean;

package/types/util/derivation.d.cts

@@ -0,0 +1,21 @@
+export = Derivation;
+/**
+ * Represents a derivation function or class (purpose to be determined based on implementation).
+ * @constructor
+ */
+declare function Derivation(): void;
+declare class Derivation {
+}
+declare namespace Derivation {
+    let RootElementAlias: string[];
+    let Hardened: number;
+    /**
+     * function that splits a string path into a derivation index array.
+     * It will return null if the string path is malformed.
+     * It does not validate if indexes are in bounds.
+     *
+     * @param {string} path
+     * @return {Array}
+     */
+    function getDerivationIndexes(path: string): any[];
+}

package/types/util/index.d.cts

@@ -0,0 +1,5 @@
+import js = require("./js.cjs");
+import preconditions = require("./preconditions.cjs");
+import _ = require("./_.cjs");
+import derivation = require("./derivation.cjs");
+export { js, preconditions, _, derivation };

package/types/util/js.d.cts

@@ -0,0 +1,50 @@
+export = JSUtil;
+/**
+ * Utility functions for JavaScript operations.
+ * @constructor
+ */
+declare function JSUtil(): void;
+declare class JSUtil {
+}
+declare namespace JSUtil {
+    /**
+     * Determines whether a string contains only hexadecimal values
+     *
+     * @name JSUtil.isHexa
+     * @param {string} value
+     * @return {boolean} true if the string is the hexa representation of a number
+     */
+    export function isHexa(value: string): boolean;
+    import isHexaString = isHexa;
+    export { isHexaString };
+    /**
+     * Checks that a value is a natural number, a positive integer or zero.
+     *
+     * @param {*} value
+     * @return {Boolean}
+     */
+    export function isNaturalNumber(value: any): boolean;
+    /**
+    * Transform a 4-byte integer (unsigned value) into a Buffer of length 4 (Big Endian Byte Order)
+    *
+    * @param {number} integer
+    * @return {Buffer}
+    */
+    export function integerAsBuffer(integer: number): Buffer;
+    /**
+     * Test if an argument is a valid JSON object. If it is, returns a truthy
+     * value (the json object decoded), so no double JSON.parse call is necessary
+     *
+     * @param {string} arg
+     * @return {Object|boolean} false if the argument is not a JSON string.
+     */
+    export function isValidJSON(arg: string): any;
+    /**
+       * Define immutable properties on a target object
+       *
+       * @param {Object} target - An object to be extended
+       * @param {Object} values - An object of properties
+       * @return {Object} The target object
+       */
+    export function defineImmutable(target: any, values: any): any;
+}

package/types/util/preconditions.d.cts

@@ -0,0 +1,3 @@
+export function checkState(condition: any, message: any): void;
+export function checkArgument(condition: any, argumentName: any, message: any, docsPath: any): void;
+export function checkArgumentType(argument: any, type: any, argumentName: any): void;