@talismn/util 0.0.10 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @talismn/util
+
+## 0.1.1
+
+### Patch Changes
+
+- Fixed publish config
+
+## 0.1.0
+
+### Minor Changes
+
+- 43c1a3a: Initial release

package/README.md

@@ -1,3 +1,5 @@
 # @talismn/util
 
-**A set of util functions for working with polkadot & talisman data.**
+This library hosts non-UI code meant to be shared between Talisman projects
+
+It doesn't need to be published as npm package, therefore it is simply transpiled with tsc.

package/dist/BigMath.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Javascript's `Math` library for `BigInt`.
+ * Taken from https://stackoverflow.com/questions/51867270/is-there-a-library-similar-to-math-that-supports-javascript-bigint/64953280#64953280
+ */
+export declare const BigMath: {
+    abs(x: bigint): bigint;
+    sign(x: bigint): bigint;
+    min(value: bigint, ...values: bigint[]): bigint;
+    max(value: bigint, ...values: bigint[]): bigint;
+};

package/dist/BigMath.js

@@ -0,0 +1,31 @@
+/**
+ * Javascript's `Math` library for `BigInt`.
+ * Taken from https://stackoverflow.com/questions/51867270/is-there-a-library-similar-to-math-that-supports-javascript-bigint/64953280#64953280
+ */
+export const BigMath = {
+    abs(x) {
+        return x < BigInt("0") ? -x : x;
+    },
+    sign(x) {
+        if (x === BigInt("0"))
+            return BigInt("0");
+        return x < BigInt("0") ? BigInt("-1") : BigInt("1");
+    },
+    // TODO: Improve our babel/tsc config to let us use the `**` operator on bigint values.
+    // Error thrown: Exponentiation cannot be performed on 'bigint' values unless the 'target' option is set to 'es2016' or later. ts(2791)
+    // pow(base: bigint, exponent: bigint) {
+    //   return base ** exponent
+    // },
+    min(value, ...values) {
+        for (const v of values)
+            if (v < value)
+                value = v;
+        return value;
+    },
+    max(value, ...values) {
+        for (const v of values)
+            if (v > value)
+                value = v;
+        return value;
+    },
+};

package/dist/FunctionPropertyNames.d.ts

@@ -0,0 +1,8 @@
+export declare type FunctionPropertyNames<T> = {
+    [K in keyof T]: T[K] extends Function ? K : never;
+}[keyof T];
+export declare type FunctionProperties<T> = Pick<T, FunctionPropertyNames<T>>;
+export declare type NonFunctionPropertyNames<T> = {
+    [K in keyof T]: T[K] extends Function ? never : K;
+}[keyof T];
+export declare type NonFunctionProperties<T> = Pick<T, NonFunctionPropertyNames<T>>;

package/dist/FunctionPropertyNames.js

@@ -0,0 +1,3 @@
+/* eslint-disable @typescript-eslint/ban-types */
+// Some handy types from https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types
+export {};

package/dist/formatDecimals.d.ts

@@ -0,0 +1,11 @@
+export declare const MAX_DECIMALS_FORMAT = 12;
+/**
+ * Custom decimal number formatting for Talisman
+ * note that the NumberFormat().format() call is the ressource heavy part, it's not worth trying to optimize other parts
+ * @param num input number
+ * @param digits number of significant digits to display
+ * @param locale locale used to format the number
+ * @param options formatting options
+ * @returns the formatted value
+ */
+export declare const formatDecimals: (num?: string | number | null, digits?: number, options?: Partial<Intl.NumberFormatOptions>, locale?: string) => string;

package/dist/formatDecimals.js

@@ -0,0 +1,44 @@
+import BigNumber from "bignumber.js";
+export const MAX_DECIMALS_FORMAT = 12;
+/**
+ * Custom decimal number formatting for Talisman
+ * note that the NumberFormat().format() call is the ressource heavy part, it's not worth trying to optimize other parts
+ * @param num input number
+ * @param digits number of significant digits to display
+ * @param locale locale used to format the number
+ * @param options formatting options
+ * @returns the formatted value
+ */
+export const formatDecimals = (num, digits = 4, options = {}, locale = "en-US") => {
+    if (num === null || num === undefined)
+        return "";
+    const value = new BigNumber(num);
+    // very small numbers should display "< 0.0001"
+    const minDisplayVal = 1 / Math.pow(10, digits);
+    if (value.gt(0) && value.lt(minDisplayVal))
+        return `< ${formatDecimals(minDisplayVal)}`;
+    // count digits
+    const flooredValue = value.integerValue();
+    const intDigits = flooredValue.isEqualTo(0) ? 0 : flooredValue.toString().length;
+    // we never want to display a rounded up value
+    // to prevent JS default rounding, we will remove/truncate insignificant digits ourselves before formatting
+    let truncatedValue = value;
+    //remove insignificant fraction digits
+    const excessFractionDigitsPow10 = new BigNumber(10).pow(digits > intDigits ? digits - intDigits : 0);
+    truncatedValue = truncatedValue
+        .multipliedBy(excessFractionDigitsPow10)
+        .integerValue()
+        .dividedBy(excessFractionDigitsPow10);
+    //remove insignificant integer digits
+    const excessIntegerDigits = new BigNumber(intDigits > digits ? intDigits - digits : 0);
+    const excessIntegerDigitsPow10 = new BigNumber(10).pow(excessIntegerDigits);
+    if (excessIntegerDigits.gt(0))
+        truncatedValue = truncatedValue
+            .dividedBy(excessIntegerDigitsPow10)
+            .integerValue()
+            .multipliedBy(excessIntegerDigitsPow10);
+    // format
+    return Intl.NumberFormat(locale, Object.assign({ 
+        //compact notation (K, M, B) if above 9999
+        notation: truncatedValue.gt(9999) ? "compact" : "standard", maximumSignificantDigits: digits + (truncatedValue.lt(1) ? 1 : 0) }, options)).format(truncatedValue.toNumber());
+};

package/dist/getBase64ImageUrl.d.ts

@@ -0,0 +1 @@
+export declare const getBase64ImageUrl: (base64: string) => string | null;

package/dist/getBase64ImageUrl.js

@@ -0,0 +1,8 @@
+export const getBase64ImageUrl = (base64) => {
+    const match = /^data:([^;]*?);base64,(.*?)$/.exec(base64);
+    if (!match)
+        return null;
+    const buffer = Buffer.from(match[2], "base64");
+    const blob = new Blob([new Uint8Array(buffer, 0, buffer.length)], { type: match[1] });
+    return URL.createObjectURL(blob);
+};

package/dist/index.d.ts

@@ -1,9 +1,7 @@
-export * from './bigNumbers';
-export * from './chains';
-export * from './decodeAnyAddress';
-export * from './deferred';
-export * from './encodeAnyAddress';
-export * from './hexToBytes';
-export * from './planckToTokens';
-export * from './tokensToPlanck';
-export * from './useFuncMemo';
+export * from "./BigMath";
+export * from "./FunctionPropertyNames";
+export * from "./formatDecimals";
+export * from "./getBase64ImageUrl";
+export * from "./isArrayOf";
+export * from "./planckToTokens";
+export * from "./tokensToPlanck";

package/dist/index.js

@@ -1,28 +1,7 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
-var __reExport = (target, module2, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && key !== "default")
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
-  }
-  return target;
-};
-var __toModule = (module2) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
-};
-__markAsModule(exports);
-__reExport(exports, __toModule(require("./bigNumbers")));
-__reExport(exports, __toModule(require("./chains")));
-__reExport(exports, __toModule(require("./decodeAnyAddress")));
-__reExport(exports, __toModule(require("./deferred")));
-__reExport(exports, __toModule(require("./encodeAnyAddress")));
-__reExport(exports, __toModule(require("./hexToBytes")));
-__reExport(exports, __toModule(require("./planckToTokens")));
-__reExport(exports, __toModule(require("./tokensToPlanck")));
-__reExport(exports, __toModule(require("./useFuncMemo")));
+export * from "./BigMath";
+export * from "./FunctionPropertyNames";
+export * from "./formatDecimals";
+export * from "./getBase64ImageUrl";
+export * from "./isArrayOf";
+export * from "./planckToTokens";
+export * from "./tokensToPlanck";

package/dist/isArrayOf.d.ts

@@ -0,0 +1 @@
+export declare function isArrayOf<T, P extends Array<unknown>>(array: unknown[], func: new (...args: P) => T): array is T[];

package/dist/isArrayOf.js

@@ -0,0 +1,5 @@
+export function isArrayOf(array, func) {
+    if (array.length > 0 && array[0] instanceof func)
+        return true;
+    return false;
+}

package/dist/planckToTokens.d.ts

@@ -1 +1,3 @@
+export declare function planckToTokens(planck: string, tokenDecimals: number): string;
 export declare function planckToTokens(planck: string, tokenDecimals?: number): string | undefined;
+export declare function planckToTokens(planck?: string, tokenDecimals?: number): string | undefined;

package/dist/planckToTokens.js

@@ -1,39 +1,9 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
-var __export = (target, all) => {
-  __markAsModule(target);
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __reExport = (target, module2, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && key !== "default")
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
-  }
-  return target;
-};
-var __toModule = (module2) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
-};
-__export(exports, {
-  planckToTokens: () => planckToTokens
-});
-var import_bignumber = __toModule(require("bignumber.js"));
-function planckToTokens(planck, tokenDecimals) {
-  if (!planck || typeof tokenDecimals !== "number")
-    return;
-  const base = new import_bignumber.default(10);
-  const exponent = new import_bignumber.default(tokenDecimals).negated();
-  const multiplier = base.pow(exponent);
-  return new import_bignumber.default(planck).multipliedBy(multiplier).toString();
+import BigNumber from "bignumber.js";
+export function planckToTokens(planck, tokenDecimals) {
+    if (typeof planck !== "string" || typeof tokenDecimals !== "number")
+        return;
+    const base = new BigNumber(10);
+    const exponent = new BigNumber(tokenDecimals).negated();
+    const multiplier = base.pow(exponent);
+    return new BigNumber(planck).multipliedBy(multiplier).toString(10);
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  planckToTokens
-});

package/dist/tokensToPlanck.d.ts

@@ -1 +1,3 @@
+export declare function tokensToPlanck(tokens: string, tokenDecimals: number): string;
 export declare function tokensToPlanck(tokens: string, tokenDecimals?: number): string | undefined;
+export declare function tokensToPlanck(tokens?: string, tokenDecimals?: number): string | undefined;

package/dist/tokensToPlanck.js

@@ -1,39 +1,9 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
-var __export = (target, all) => {
-  __markAsModule(target);
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __reExport = (target, module2, desc) => {
-  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
-    for (let key of __getOwnPropNames(module2))
-      if (!__hasOwnProp.call(target, key) && key !== "default")
-        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
-  }
-  return target;
-};
-var __toModule = (module2) => {
-  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
-};
-__export(exports, {
-  tokensToPlanck: () => tokensToPlanck
-});
-var import_bignumber = __toModule(require("bignumber.js"));
-function tokensToPlanck(tokens, tokenDecimals) {
-  if (!tokens || typeof tokenDecimals !== "number")
-    return;
-  const base = new import_bignumber.default(10);
-  const exponent = new import_bignumber.default(tokenDecimals);
-  const multiplier = base.pow(exponent);
-  return new import_bignumber.default(tokens).multipliedBy(multiplier).toString();
+import BigNumber from "bignumber.js";
+export function tokensToPlanck(tokens, tokenDecimals) {
+    if (typeof tokens !== "string" || typeof tokenDecimals !== "number")
+        return;
+    const base = new BigNumber(10);
+    const exponent = new BigNumber(tokenDecimals);
+    const multiplier = base.pow(exponent);
+    return new BigNumber(tokens).multipliedBy(multiplier).toString(10);
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  tokensToPlanck
-});

package/package.json

@@ -1,73 +1,50 @@
 {
   "name": "@talismn/util",
-  "version": "0.0.10",
-  "description": "A set of util functions for working with polkadot & talisman data.",
-  "main": "./src/index.ts",
-  "types": "./dist/index.d.ts",
-  "browser": "./dist/index.js",
-  "exports": "./dist/index.js",
-  "scripts": {
-    "prepare": "husky install",
-    "pre-commit": "lint-staged",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "watch": "nodemon --watch src --ext js,ts --exec yarn prepack",
-    "build": "esbuild-node-tsc",
-    "build:types": "tsc --emitDeclarationOnly",
-    "prepack": "yarn build && yarn build:types"
-  },
+  "version": "0.1.1",
   "author": "Talisman",
-  "license": "GPL-3.0-only",
-  "peerDependencies": {
-    "@polkadot/api": "*",
-    "@polkadot/keyring": "*",
-    "@polkadot/util-crypto": "*",
-    "react": ">=17"
-  },
-  "dependencies": {
-    "@polkadot/extension-inject": "^0.39.3",
-    "@polkadot/networks": "^7.3.1",
-    "bignumber.js": "^9.0.1"
+  "homepage": "https://talisman.xyz",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
   },
-  "devDependencies": {
-    "@polkadot/api": "^5.9.1",
-    "@polkadot/keyring": "^7.4.1",
-    "@polkadot/util-crypto": "^7.4.1",
-    "@types/react": "^17.0.2",
-    "esbuild-node-tsc": "^1.6.1",
-    "husky": "^6.0.0",
-    "import-sort-style-module": "^6.0.0",
-    "lint-staged": "^11.1.2",
-    "prettier": "^2.3.2",
-    "prettier-plugin-import-sort": "^0.0.7",
-    "react": "^17.0.2",
-    "typescript": "^4.3.5"
-  },
-  "files": [
-    "dist/**/*"
-  ],
   "repository": {
+    "directory": "packages/util",
     "type": "git",
-    "url": "git+https://github.com/TalismanSociety/util.git"
+    "url": "https://github.com/talismansociety/talisman.git"
   },
-  "bugs": {
-    "url": "https://github.com/TalismanSociety/util/issues"
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "engines": {
+    "node": ">=14"
   },
-  "homepage": "https://github.com/TalismanSociety/util#readme",
-  "packageManager": "yarn@3.0.1",
-  "lint-staged": {
-    "*.{ts,tsx,js,jsx,html,css,scss}": "prettier --write"
+  "scripts": {
+    "dev": "tsc --watch --declarationMap",
+    "build": "tsc --declarationMap",
+    "build:packages:prod": "rm -rf dist && tsc",
+    "prepack": "yarn build:packages:prod",
+    "test": "jest",
+    "lint": "eslint . --max-warnings 0",
+    "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
-  "prettier": {
-    "arrowParens": "avoid",
-    "printWidth": 120,
-    "quoteProps": "consistent",
-    "semi": false,
-    "singleQuote": true
+  "dependencies": {
+    "bignumber.js": "^9.1.0"
   },
-  "importSort": {
-    ".js, .jsx, .ts, .tsx": {
-      "style": "module",
-      "parser": "typescript"
-    }
+  "devDependencies": {
+    "@talismn/eslint-config": "^0.0.0",
+    "@talismn/tsconfig": "^0.0.0",
+    "@types/jest": "^27.5.1",
+    "eslint": "^8.4.0",
+    "jest": "^28.1.0",
+    "ts-jest": "^28.0.2",
+    "typescript": "^4.6.4"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@talismn/eslint-config"
+    ]
   }
 }