@atomicfinance/crypto 3.0.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @atomicfinance/crypto
+
+## 3.0.0
+
+### Major Changes
+
+- a06082e: Create unified standalone `bitcoin-abstraction-layer` package

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+/// <reference types="node" />
+import bech32 from 'bech32';
+import base58 from 'bs58';
+declare function isHex(hex: string): boolean;
+/**
+ * Ensure message is in buffer format.
+ * @param {string} message - any string.
+ * @return {string} Returns Buffer.
+ */
+declare function ensureBuffer(message: string | Buffer | any): false | Buffer;
+/**
+ * Get hash160 of message.
+ * @param {!string|Buffer} message - message in string or Buffer.
+ * @return {string} Returns the hash160 of a string.
+ */
+declare function hash160(message: Buffer): any;
+/**
+ * Get sha256 of message.
+ * @param {!string|Buffer} message - message in string or Buffer.
+ * @return {string} Returns the sha256 of a string.
+ */
+declare function sha256(message: string | Buffer): any;
+/**
+ * Get ripemd160 of message.
+ * @param {!string|Buffer} message - message in string or Buffer.
+ * @return {string} Returns the ripemd160 of a string.
+ */
+declare function ripemd160(message: string | Buffer): any;
+/**
+ * Pad a hex string with '0'
+ * @param {string} hex - The hex string to pad.
+ * @param {number} lengthBytes - The length of the final string in bytes
+ * @return {string} Returns a padded string with length greater or equal to the given length
+ *  rounded up to the nearest even number.
+ */
+declare function padHexStart(hex: string, lengthBytes?: number): string;
+export { 
+/**
+ * Base58 object with decode, decodeUnsafe, and encode functions.
+ */
+base58, 
+/**
+ * Get bech32 of message.
+ * @param {!string} message - any string.
+ * @return {string} Returns the bech32 of a string.
+ */
+bech32, sha256, ripemd160, hash160, ensureBuffer, padHexStart, isHex, };

package/dist/index.js

@@ -0,0 +1,89 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHex = exports.padHexStart = exports.ensureBuffer = exports.hash160 = exports.ripemd160 = exports.sha256 = exports.bech32 = exports.base58 = void 0;
+const bech32_1 = __importDefault(require("bech32"));
+exports.bech32 = bech32_1.default;
+const bs58_1 = __importDefault(require("bs58"));
+exports.base58 = bs58_1.default;
+const crypto_hashing_1 = __importDefault(require("crypto-hashing"));
+function isHex(hex) {
+    if (!hex.match(/([0-9]|[a-f])/gim))
+        return false;
+    const buf = Buffer.from(hex, 'hex').toString('hex');
+    return buf === hex.toLowerCase();
+}
+exports.isHex = isHex;
+/**
+ * Ensure message is in buffer format.
+ * @param {string} message - any string.
+ * @return {string} Returns Buffer.
+ */
+function ensureBuffer(message) {
+    if (Buffer.isBuffer(message))
+        return message;
+    switch (typeof message) {
+        case 'string':
+            message = isHex(message)
+                ? Buffer.from(message, 'hex')
+                : Buffer.from(message);
+            break;
+        case 'object':
+            message = Buffer.from(JSON.stringify(message));
+            break;
+    }
+    return Buffer.isBuffer(message) ? message : false;
+}
+exports.ensureBuffer = ensureBuffer;
+/**
+ * Get hash of a message in hex.
+ * @param {!string} algorithm - Hashing algorithm.
+ * @param {!string|Buffer} message - Message to be hashed.
+ * @return {string} Returns the hash of a string.
+ */
+function hashToHex(algorithm, message) {
+    return crypto_hashing_1.default(algorithm, ensureBuffer(message)).toString('hex');
+}
+/**
+ * Get hash160 of message.
+ * @param {!string|Buffer} message - message in string or Buffer.
+ * @return {string} Returns the hash160 of a string.
+ */
+function hash160(message) {
+    return hashToHex('hash160', message);
+}
+exports.hash160 = hash160;
+/**
+ * Get sha256 of message.
+ * @param {!string|Buffer} message - message in string or Buffer.
+ * @return {string} Returns the sha256 of a string.
+ */
+function sha256(message) {
+    return hashToHex('sha256', message);
+}
+exports.sha256 = sha256;
+/**
+ * Get ripemd160 of message.
+ * @param {!string|Buffer} message - message in string or Buffer.
+ * @return {string} Returns the ripemd160 of a string.
+ */
+function ripemd160(message) {
+    return hashToHex('ripemd160', message);
+}
+exports.ripemd160 = ripemd160;
+/**
+ * Pad a hex string with '0'
+ * @param {string} hex - The hex string to pad.
+ * @param {number} lengthBytes - The length of the final string in bytes
+ * @return {string} Returns a padded string with length greater or equal to the given length
+ *  rounded up to the nearest even number.
+ */
+function padHexStart(hex, lengthBytes) {
+    let lengthString = lengthBytes * 2 || hex.length;
+    lengthString += lengthString % 2;
+    return hex.padStart(lengthString, '0');
+}
+exports.padHexStart = padHexStart;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AA+F1B,iBA/FK,gBAAM,CA+FL;AA9FR,gDAA0B;AAwFxB,iBAxFK,cAAM,CAwFL;AAvFR,oEAAwC;AAExC,SAAS,KAAK,CAAC,GAAW;IACxB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC;QAAE,OAAO,KAAK,CAAC;IAEjD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAEpD,OAAO,GAAG,KAAK,GAAG,CAAC,WAAW,EAAE,CAAC;AACnC,CAAC;AA2FC,sBAAK;AAzFP;;;;GAIG;AACH,SAAS,YAAY,CAAC,OAA8B;IAClD,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAE7C,QAAQ,OAAO,OAAO,EAAE;QACtB,KAAK,QAAQ;YACX,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;gBACtB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC;gBAC7B,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzB,MAAM;QACR,KAAK,QAAQ;YACX,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;YAC/C,MAAM;KACT;IAED,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;AACpD,CAAC;AAmEC,oCAAY;AAjEd;;;;;GAKG;AACH,SAAS,SAAS,CAAC,SAAiB,EAAE,OAAwB;IAC5D,OAAO,wBAAU,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACtE,CAAC;AAED;;;;GAIG;AACH,SAAS,OAAO,CAAC,OAAe;IAC9B,OAAO,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AACvC,CAAC;AA+CC,0BAAO;AA7CT;;;;GAIG;AACH,SAAS,MAAM,CAAC,OAAwB;IACtC,OAAO,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACtC,CAAC;AAoCC,wBAAM;AAlCR;;;;GAIG;AACH,SAAS,SAAS,CAAC,OAAwB;IACzC,OAAO,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC;AA4BC,8BAAS;AA1BX;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,GAAW,EAAE,WAAoB;IACpD,IAAI,YAAY,GAAG,WAAW,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC;IACjD,YAAY,IAAI,YAAY,GAAG,CAAC,CAAC;IAEjC,OAAO,GAAG,CAAC,QAAQ,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;AACzC,CAAC;AAiBC,kCAAW"}

package/lib/crypto-hashing.d.ts

@@ -0,0 +1 @@
+declare module 'crypto-hashing'

package/lib/index.ts

@@ -0,0 +1,103 @@
+import bech32 from 'bech32';
+import base58 from 'bs58';
+import cryptoHash from 'crypto-hashing';
+
+function isHex(hex: string) {
+  if (!hex.match(/([0-9]|[a-f])/gim)) return false;
+
+  const buf = Buffer.from(hex, 'hex').toString('hex');
+
+  return buf === hex.toLowerCase();
+}
+
+/**
+ * Ensure message is in buffer format.
+ * @param {string} message - any string.
+ * @return {string} Returns Buffer.
+ */
+function ensureBuffer(message: string | Buffer | any) {
+  if (Buffer.isBuffer(message)) return message;
+
+  switch (typeof message) {
+    case 'string':
+      message = isHex(message)
+        ? Buffer.from(message, 'hex')
+        : Buffer.from(message);
+      break;
+    case 'object':
+      message = Buffer.from(JSON.stringify(message));
+      break;
+  }
+
+  return Buffer.isBuffer(message) ? message : false;
+}
+
+/**
+ * Get hash of a message in hex.
+ * @param {!string} algorithm - Hashing algorithm.
+ * @param {!string|Buffer} message - Message to be hashed.
+ * @return {string} Returns the hash of a string.
+ */
+function hashToHex(algorithm: string, message: string | Buffer) {
+  return cryptoHash(algorithm, ensureBuffer(message)).toString('hex');
+}
+
+/**
+ * Get hash160 of message.
+ * @param {!string|Buffer} message - message in string or Buffer.
+ * @return {string} Returns the hash160 of a string.
+ */
+function hash160(message: Buffer) {
+  return hashToHex('hash160', message);
+}
+
+/**
+ * Get sha256 of message.
+ * @param {!string|Buffer} message - message in string or Buffer.
+ * @return {string} Returns the sha256 of a string.
+ */
+function sha256(message: string | Buffer) {
+  return hashToHex('sha256', message);
+}
+
+/**
+ * Get ripemd160 of message.
+ * @param {!string|Buffer} message - message in string or Buffer.
+ * @return {string} Returns the ripemd160 of a string.
+ */
+function ripemd160(message: string | Buffer) {
+  return hashToHex('ripemd160', message);
+}
+
+/**
+ * Pad a hex string with '0'
+ * @param {string} hex - The hex string to pad.
+ * @param {number} lengthBytes - The length of the final string in bytes
+ * @return {string} Returns a padded string with length greater or equal to the given length
+ *  rounded up to the nearest even number.
+ */
+function padHexStart(hex: string, lengthBytes?: number) {
+  let lengthString = lengthBytes * 2 || hex.length;
+  lengthString += lengthString % 2;
+
+  return hex.padStart(lengthString, '0');
+}
+
+export {
+  /**
+   * Base58 object with decode, decodeUnsafe, and encode functions.
+   */
+  base58,
+  /**
+   * Get bech32 of message.
+   * @param {!string} message - any string.
+   * @return {string} Returns the bech32 of a string.
+   */
+  bech32,
+  sha256,
+  ripemd160,
+  hash160,
+  ensureBuffer,
+  padHexStart,
+  isHex,
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@atomicfinance/crypto",
+  "version": "3.0.0",
+  "description": "",
+  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "directories": {
+    "dist": "dist",
+    "src": "lib"
+  },
+  "files": [
+    "dist",
+    "lib"
+  ],
+  "scripts": {
+    "build": "../../node_modules/.bin/tsc --project tsconfig.json",
+    "test": "../../node_modules/.bin/nyc --reporter=lcov --reporter=text --extension=.ts ../../node_modules/.bin/mocha --recursive \"tests/**/*.test.*\"",
+    "lint": "../../node_modules/.bin/eslint --ignore-path ../../.eslintignore  -c ../../.eslintrc.js .",
+    "lint:fix": "../../node_modules/.bin/eslint --fix --ignore-path ../../.eslintignore  -c ../../.eslintrc.js ."
+  },
+  "author": "Atomic Finance <info@atomic.finance>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=14"
+  },
+  "dependencies": {
+    "bech32": "^1.1.3",
+    "bs58": "^4.0.1",
+    "crypto-hashing": "^1.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/bech32": "^1.1.2",
+    "@types/bs58": "^4.0.1"
+  },
+  "sideEffects": false
+}