@bsv/sdk 1.6.7 → 1.6.9

package/dist/esm/src/wallet/utilityHelpers.js

@@ -0,0 +1,275 @@
+import { Beef, Hash, PrivateKey, PublicKey, Random, Script, Transaction, Utils } from "@bsv/sdk";
+// import { sdk } from "..";
+// import { Chain } from "../sdk/types";
+export function toWalletNetwork(chain) {
+    return chain === 'main' ? 'mainnet' : 'testnet';
+}
+export function makeAtomicBeef(tx, beef) {
+    if (Array.isArray(beef))
+        beef = Beef.fromBinary(beef);
+    beef.mergeTransaction(tx);
+    return beef.toBinaryAtomic(tx.id('hex'));
+}
+/**
+ * Coerce a bsv transaction encoded as a hex string, serialized Buffer, or Transaction to Transaction
+ * If tx is already a Transaction, just return it.
+ * @publicbody
+ */
+export function asBsvSdkTx(tx) {
+    if (Array.isArray(tx)) {
+        tx = Transaction.fromBinary(tx);
+    }
+    else if (typeof tx === 'string') {
+        tx = Transaction.fromHex(tx);
+    }
+    return tx;
+}
+/**
+ * Coerce a bsv script encoded as a hex string, serialized Buffer, or Script to Script
+ * If script is already a Script, just return it.
+ * @publicbody
+ */
+export function asBsvSdkScript(script) {
+    if (Array.isArray(script)) {
+        script = Script.fromBinary(script);
+    }
+    else if (typeof script === 'string') {
+        script = Script.fromHex(script);
+    }
+    return script;
+}
+/**
+ * @param privKey bitcoin private key in 32 byte hex string form
+ * @returns @bsv/sdk PrivateKey
+ */
+export function asBsvSdkPrivateKey(privKey) {
+    return PrivateKey.fromString(privKey, 'hex');
+}
+/**
+ * @param pubKey bitcoin public key in standard compressed key hex string form
+ * @returns @bsv/sdk PublicKey
+ */
+export function asBsvSdkPublickKey(pubKey) {
+    return PublicKey.fromString(pubKey);
+}
+/**
+ * Helper function.
+ *
+ * Verifies that a possibly optional value has a value.
+ */
+export function verifyTruthy(v, description) {
+    if (v == null)
+        throw new sdk.WERR_INTERNAL(description ?? 'A truthy value is required.');
+    return v;
+}
+/**
+ * Helper function.
+ *
+ * Verifies that a hex string is trimmed and lower case.
+ */
+export function verifyHexString(v) {
+    if (typeof v !== 'string')
+        throw new sdk.WERR_INTERNAL('A string is required.');
+    v = v.trim().toLowerCase();
+    return v;
+}
+/**
+ * Helper function.
+ *
+ * Verifies that an optional or null hex string is undefined or a trimmed lowercase string.
+ */
+export function verifyOptionalHexString(v) {
+    if (!v)
+        return undefined;
+    return verifyHexString(v);
+}
+/**
+ * Helper function.
+ *
+ * Verifies that an optional or null number has a numeric value.
+ */
+export function verifyNumber(v) {
+    if (typeof v !== 'number')
+        throw new sdk.WERR_INTERNAL('A number is required.');
+    return v;
+}
+/**
+ * Helper function.
+ *
+ * Verifies that an optional or null number has a numeric value.
+ */
+export function verifyInteger(v) {
+    if (typeof v !== 'number' || !Number.isInteger(v))
+        throw new sdk.WERR_INTERNAL('An integer is required.');
+    return v;
+}
+/**
+ * Helper function.
+ *
+ * Verifies that a database record identifier is an integer greater than zero.
+ */
+export function verifyId(id) {
+    id = verifyInteger(id);
+    if (id < 1)
+        throw new sdk.WERR_INTERNAL(`id must be valid integer greater than zero.`);
+    return id;
+}
+/**
+ * Helper function.
+ *
+ * @throws WERR_BAD_REQUEST if results has length greater than one.
+ *
+ * @returns results[0] or undefined if length is zero.
+ */
+export function verifyOneOrNone(results) {
+    if (results.length > 1)
+        throw new sdk.WERR_BAD_REQUEST('Result must be unique.');
+    return results[0];
+}
+/**
+ * Helper function.
+ *
+ * @throws WERR_BAD_REQUEST if results has length other than one.
+ *
+ * @returns results[0].
+ */
+export function verifyOne(results, errorDescrition) {
+    if (results.length !== 1)
+        throw new sdk.WERR_BAD_REQUEST(errorDescrition ?? 'Result must exist and be unique.');
+    return results[0];
+}
+/**
+ * Returns an await'able Promise that resolves in the given number of msecs.
+ * @publicbody
+ */
+export function wait(msecs) {
+    return new Promise(resolve => setTimeout(resolve, msecs));
+}
+/**
+ * @returns count cryptographically secure random bytes as Buffer
+ */
+export function randomBytes(count) {
+    return Random(count);
+}
+/**
+ * @returns count cryptographically secure random bytes as hex encoded string
+ */
+export function randomBytesHex(count) {
+    return Utils.toHex(Random(count));
+}
+/**
+ * @returns count cryptographically secure random bytes as base64 encoded string
+ */
+export function randomBytesBase64(count) {
+    return Utils.toBase64(Random(count));
+}
+/**
+ * Coerce a value to Buffer if currently encoded as a string or
+ * @param val Buffer or string or number[]. If string, encoding param applies. If number[], Buffer.from constructor is used.
+ * @param encoding defaults to 'hex'. Only applies to val of type string
+ * @returns input val if it is a Buffer or new Buffer from string val
+ * @publicbody
+ */
+export function asBuffer(val, encoding) {
+    let b;
+    if (Buffer.isBuffer(val))
+        b = val;
+    else if (typeof val === 'string')
+        b = Buffer.from(val, encoding ?? 'hex');
+    else
+        b = Buffer.from(val);
+    return b;
+}
+/**
+ * Coerce a value to an encoded string if currently a Buffer or number[]
+ * @param val Buffer or string or number[]. If string, encoding param applies. If number[], Buffer.from constructor is used.
+ * @param encoding defaults to 'hex'
+ * @returns input val if it is a string; or if number[], first converted to Buffer then as Buffer; if Buffer encoded using `encoding`
+ * @publicbody
+ */
+export function asString(val, encoding) {
+    if (Array.isArray(val))
+        val = Buffer.from(val);
+    return Buffer.isBuffer(val) ? val.toString(encoding ?? 'hex') : val;
+}
+export function asArray(val, encoding) {
+    let a;
+    if (Array.isArray(val))
+        a = val;
+    else if (Buffer.isBuffer(val))
+        a = Array.from(val);
+    else
+        a = Array.from(Buffer.from(val, encoding || 'hex'));
+    return a;
+}
+export function validateSecondsSinceEpoch(time) {
+    const date = new Date(time * 1000);
+    if (date.getTime() / 1000 !== time || time < 1600000000 || time > 100000000000) {
+        throw new sdk.WERR_INVALID_PARAMETER('time', `valid "since epoch" unix time`);
+    }
+    return date;
+}
+/**
+ * Compares lengths and direct equality of values.
+ * @param arr1
+ * @param arr2
+ * @returns
+ */
+export function arraysEqual(arr1, arr2) {
+    if (arr1.length !== arr2.length)
+        return false;
+    for (let i = 0; i < arr1.length; i++) {
+        if (arr1[i] !== arr2[i])
+            return false;
+    }
+    return true;
+}
+export function optionalArraysEqual(arr1, arr2) {
+    if (!arr1 && !arr2)
+        return true;
+    if (!arr1 || !arr2)
+        return false;
+    return arraysEqual(arr1, arr2);
+}
+export function maxDate(d1, d2) {
+    if (d1 && d2) {
+        if (d1 > d2)
+            return d1;
+        return d2;
+    }
+    if (d1)
+        return d1;
+    if (d2)
+        return d2;
+    return undefined;
+}
+/**
+ * Calculate the SHA256 hash of an array of bytes
+ * @returns sha256 hash of buffer contents.
+ * @publicbody
+ */
+export function sha256Hash(data) {
+    const first = new Hash.SHA256().update(data).digest();
+    return first;
+}
+/**
+ * Calculate the SHA256 hash of the SHA256 hash of an array of bytes.
+ * @param data an array of bytes
+ * @returns double sha256 hash of data, byte 0 of hash first.
+ * @publicbody
+ */
+export function doubleSha256HashLE(data) {
+    const first = new Hash.SHA256().update(data).digest();
+    const second = new Hash.SHA256().update(first).digest();
+    return second;
+}
+/**
+ * Calculate the SHA256 hash of the SHA256 hash of an array of bytes.
+ * @param data is an array of bytes.
+ * @returns reversed (big-endian) double sha256 hash of data, byte 31 of hash first.
+ * @publicbody
+ */
+export function doubleSha256BE(data) {
+    return doubleSha256HashLE(data).reverse();
+}
+//# sourceMappingURL=utilityHelpers.js.map

package/dist/esm/src/wallet/utilityHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilityHelpers.js","sourceRoot":"","sources":["../../../../src/wallet/utilityHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjG,4BAA4B;AAC5B,wCAAwC;AAExC,MAAM,UAAU,eAAe,CAAC,KAAY;IACxC,OAAO,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,EAAe,EAAE,IAAqB;IACjE,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACnB,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IAChC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAA;IACzB,OAAO,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;AAC5C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,EAA0C;IACjE,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;QACpB,EAAE,GAAG,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;IACnC,CAAC;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;QAChC,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAChC,CAAC;IACD,OAAO,EAAE,CAAA;AACb,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,MAAyC;IACpE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;IACtC,CAAC;SAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACnC,CAAC;IACD,OAAO,MAAM,CAAA;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe;IAC9C,OAAO,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;AAChD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAC7C,OAAO,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;AACvC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAI,CAAuB,EAAE,WAAoB;IACzE,IAAI,CAAC,IAAI,IAAI;QAAE,MAAM,IAAI,GAAG,CAAC,aAAa,CAAC,WAAW,IAAI,6BAA6B,CAAC,CAAA;IACxF,OAAO,CAAC,CAAA;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,CAAS;IACrC,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,MAAM,IAAI,GAAG,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;IAChF,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;IAC1B,OAAO,CAAC,CAAA;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,CAAiB;IACrD,IAAI,CAAC,CAAC;QAAE,OAAO,SAAS,CAAA;IACxB,OAAO,eAAe,CAAC,CAAC,CAAC,CAAA;AAC7B,CAAC;AAGD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,CAA4B;IACrD,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,MAAM,IAAI,GAAG,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAA;IAC/E,OAAO,CAAC,CAAA;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,CAA4B;IACtD,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QAAE,MAAM,IAAI,GAAG,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IAC1G,OAAO,CAAC,CAAA;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,EAA6B;IAClD,EAAE,GAAG,aAAa,CAAC,EAAE,CAAC,CAAA;IACtB,IAAI,EAAE,GAAG,CAAC;QAAE,MAAM,IAAI,GAAG,CAAC,aAAa,CAAC,6CAA6C,CAAC,CAAA;IACtF,OAAO,EAAE,CAAA;AACb,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAI,OAAY;IAC3C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,GAAG,CAAC,gBAAgB,CAAC,wBAAwB,CAAC,CAAA;IAChF,OAAO,OAAO,CAAC,CAAC,CAAC,CAAA;AACrB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAI,OAAY,EAAE,eAAwB;IAC/D,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,GAAG,CAAC,gBAAgB,CAAC,eAAe,IAAI,kCAAkC,CAAC,CAAA;IAC/G,OAAO,OAAO,CAAC,CAAC,CAAC,CAAA;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,IAAI,CAAC,KAAa;IAC9B,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;AAC7D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa;IACrC,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;AACxB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IACxC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AACrC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC3C,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AACxC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAC,GAA+B,EAAE,QAAyB;IAC/E,IAAI,CAAS,CAAA;IACb,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,CAAC,GAAG,GAAG,CAAA;SAC5B,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,IAAI,KAAK,CAAC,CAAA;;QACpE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACzB,OAAO,CAAC,CAAA;AACZ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAC,GAA+B,EAAE,QAAyB;IAC/E,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC9C,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;AACvE,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,GAA+B,EAAE,QAAyB;IAC9E,IAAI,CAAW,CAAA;IACf,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,CAAC,GAAG,GAAG,CAAA;SAC1B,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;;QAC7C,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAA;IACxD,OAAO,CAAC,CAAA;AACZ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,IAAY;IAClD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;IAClC,IAAI,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,KAAK,IAAI,IAAI,IAAI,GAAG,UAAU,IAAI,IAAI,GAAG,YAAY,EAAE,CAAC;QAAC,MAAM,IAAI,GAAG,CAAC,sBAAsB,CAAC,MAAM,EAAE,+BAA+B,CAAC,CAAA;IAAC,CAAC;IACjK,OAAO,IAAI,CAAA;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,IAAc,EAAE,IAAc;IACtD,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;IAC1C,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAe,EAAE,IAAe;IAChE,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAA;IAC/B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAA;IAChC,OAAO,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AAClC,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAS,EAAE,EAAS;IACxC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC;QACX,IAAI,EAAE,GAAG,EAAE;YAAE,OAAO,EAAE,CAAA;QACtB,OAAO,EAAE,CAAA;IACb,CAAC;IACD,IAAI,EAAE;QAAE,OAAO,EAAE,CAAA;IACjB,IAAI,EAAE;QAAE,OAAO,EAAE,CAAA;IACjB,OAAO,SAAS,CAAA;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,IAAc;IACrC,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAA;IACrD,OAAO,KAAK,CAAA;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAc;IAC7C,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAA;IACrD,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAA;IACvD,OAAO,MAAM,CAAA;AACjB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,IAAc;IACzC,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAA;AAC7C,CAAC"}