@w3ux/utils 0.0.2 → 0.1.1

package/base.d.ts

@@ -62,5 +62,10 @@ declare const appendOrEmpty: (condition: boolean | string | undefined, value: st
  * @summary Returns ` value` if condition is truthy, or ` fallback` otherwise.
  */
 declare const appendOr: (condition: boolean | string | undefined, value: string, fallback: string) => string;
+/**
+ * @name appendOr
+ * @summary Formats an address with the supplied ss58 prefix, or returns null if invalid.
+ */
+declare const formatAccountSs58: (address: string, ss58: number) => string;
 
-export { appendOr, appendOrEmpty, camelize, ellipsisFn, greaterThanZero, isNotZero, minDecimalPlaces, pageFromUri, rmCommas, shuffle, withTimeout };
+export { appendOr, appendOrEmpty, camelize, ellipsisFn, formatAccountSs58, greaterThanZero, isNotZero, minDecimalPlaces, pageFromUri, rmCommas, shuffle, withTimeout };

package/base.js

@@ -1,5 +1,6 @@
 // src/base.ts
 import { BigNumber } from "bignumber.js";
+import Keyring from "@polkadot/keyring";
 var camelize = (str) => {
   const convertToString = (string) => {
     if (string) {
@@ -96,11 +97,25 @@ var withTimeout = (ms, promise, options) => {
 };
 var appendOrEmpty = (condition, value) => condition ? ` ${value}` : "";
 var appendOr = (condition, value, fallback) => condition ? ` ${value}` : ` ${fallback}`;
+var formatAccountSs58 = (address, ss58) => {
+  try {
+    const keyring = new Keyring();
+    keyring.setSS58Format(ss58);
+    const formatted = keyring.addFromAddress(address).address;
+    if (formatted !== address) {
+      return formatted;
+    }
+    return null;
+  } catch (e) {
+    return null;
+  }
+};
 export {
   appendOr,
   appendOrEmpty,
   camelize,
   ellipsisFn,
+  formatAccountSs58,
   greaterThanZero,
   isNotZero,
   minDecimalPlaces,

package/index.d.ts

@@ -1,5 +1,5 @@
-export { appendOr, appendOrEmpty, camelize, ellipsisFn, greaterThanZero, isNotZero, minDecimalPlaces, pageFromUri, rmCommas, shuffle, withTimeout } from './base.js';
-export { addedTo, applyWidthAsPadding, capitalizeFirstLetter, determinePoolDisplay, evalUnits, extractUrlValue, inChrome, isValidAddress, isValidHttpUrl, localStorageOrDefault, makeCancelable, matchedProperties, mergeDeep, planckToUnit, remToUnit, removeVarFromUrlHash, removedFrom, setStateWithRef, snakeToCamel, sortWithNull, transformToBaseUnit, unescape, unimplemented, unitToPlanck, varToUrlHash } from './unit.js';
+export { appendOr, appendOrEmpty, camelize, ellipsisFn, formatAccountSs58, greaterThanZero, isNotZero, minDecimalPlaces, pageFromUri, rmCommas, shuffle, withTimeout } from './base.js';
+export { addedTo, applyWidthAsPadding, capitalizeFirstLetter, determinePoolDisplay, evalUnits, extractUrlValue, inChrome, isValidAddress, isValidHttpUrl, localStorageOrDefault, makeCancelable, matchedProperties, mergeDeep, planckToUnit, remToUnit, removeVarFromUrlHash, removedFrom, setStateWithRef, snakeToCamel, sortWithNull, stringToBigNumber, transformToBaseUnit, unescape, unimplemented, unitToPlanck, varToUrlHash } from './unit.js';
 import 'bignumber.js';
 import './types.js';
 import 'react';

package/index.js

@@ -1,5 +1,6 @@
 // src/base.ts
 import { BigNumber } from "bignumber.js";
+import Keyring from "@polkadot/keyring";
 var camelize = (str) => {
   const convertToString = (string) => {
     if (string) {
@@ -96,6 +97,19 @@ var withTimeout = (ms, promise, options) => {
 };
 var appendOrEmpty = (condition, value) => condition ? ` ${value}` : "";
 var appendOr = (condition, value, fallback) => condition ? ` ${value}` : ` ${fallback}`;
+var formatAccountSs58 = (address, ss58) => {
+  try {
+    const keyring = new Keyring();
+    keyring.setSS58Format(ss58);
+    const formatted = keyring.addFromAddress(address).address;
+    if (formatted !== address) {
+      return formatted;
+    }
+    return null;
+  } catch (e) {
+    return null;
+  }
+};
 
 // src/unit.ts
 import { decodeAddress, encodeAddress } from "@polkadot/keyring";
@@ -358,6 +372,7 @@ var mergeDeep = (target, ...sources) => {
   }
   return mergeDeep(target, ...sources);
 };
+var stringToBigNumber = (value) => new BigNumber2(rmCommas(value));
 export {
   addedTo,
   appendOr,
@@ -369,6 +384,7 @@ export {
   ellipsisFn,
   evalUnits,
   extractUrlValue,
+  formatAccountSs58,
   greaterThanZero,
   inChrome,
   isNotZero,
@@ -389,6 +405,7 @@ export {
   shuffle,
   snakeToCamel,
   sortWithNull,
+  stringToBigNumber,
   transformToBaseUnit,
   unescape,
   unimplemented,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w3ux/utils",
-  "version": "0.0.2",
+  "version": "0.1.1",
   "license": "GPL-3.0-only",
   "type": "module",
   "dependencies": {

package/unit.d.ts

@@ -43,7 +43,7 @@ declare const setStateWithRef: <T>(value: T, setState: (_state: T) => void, ref:
  * @summary Retrieve the local stroage value with the key, return defult value if it is not
  * found.
  */
-declare const localStorageOrDefault: <T>(key: string, _default: T, parse?: boolean) => string | T;
+declare const localStorageOrDefault: <T>(key: string, _default: T, parse?: boolean) => T | string;
 /**
  * @name isValidAddress
  * @summary Return whether an address is valid Substrate address.
@@ -161,5 +161,10 @@ declare const unimplemented: ({ ...props }: {
  * @param ...sources
  */
 declare const mergeDeep: (target: AnyObject, ...sources: AnyObject[]) => AnyObject;
+/**
+ * @name stringToBigNumber
+ * @summary Converts a balance string into a `BigNumber`.
+ */
+declare const stringToBigNumber: (value: string) => BigNumber;
 
-export { addedTo, applyWidthAsPadding, capitalizeFirstLetter, determinePoolDisplay, evalUnits, extractUrlValue, inChrome, isValidAddress, isValidHttpUrl, localStorageOrDefault, makeCancelable, matchedProperties, mergeDeep, planckToUnit, remToUnit, removeVarFromUrlHash, removedFrom, setStateWithRef, snakeToCamel, sortWithNull, transformToBaseUnit, unescape, unimplemented, unitToPlanck, varToUrlHash };
+export { addedTo, applyWidthAsPadding, capitalizeFirstLetter, determinePoolDisplay, evalUnits, extractUrlValue, inChrome, isValidAddress, isValidHttpUrl, localStorageOrDefault, makeCancelable, matchedProperties, mergeDeep, planckToUnit, remToUnit, removeVarFromUrlHash, removedFrom, setStateWithRef, snakeToCamel, sortWithNull, stringToBigNumber, transformToBaseUnit, unescape, unimplemented, unitToPlanck, varToUrlHash };

package/unit.js

@@ -5,6 +5,7 @@ import { BigNumber as BigNumber2 } from "bignumber.js";
 
 // src/base.ts
 import { BigNumber } from "bignumber.js";
+import Keyring from "@polkadot/keyring";
 var ellipsisFn = (str, amount = 6, position = "center") => {
   const half = str.length / 2;
   if (amount <= 4) {
@@ -31,6 +32,7 @@ var ellipsisFn = (str, amount = 6, position = "center") => {
     return "..." + str.slice(amount);
   }
 };
+var rmCommas = (val) => val.replace(/,/g, "");
 
 // src/unit.ts
 var remToUnit = (rem) => Number(rem.slice(0, rem.length - 3)) * parseFloat(getComputedStyle(document.documentElement).fontSize);
@@ -290,6 +292,7 @@ var mergeDeep = (target, ...sources) => {
   }
   return mergeDeep(target, ...sources);
 };
+var stringToBigNumber = (value) => new BigNumber2(rmCommas(value));
 export {
   addedTo,
   applyWidthAsPadding,
@@ -311,6 +314,7 @@ export {
   setStateWithRef,
   snakeToCamel,
   sortWithNull,
+  stringToBigNumber,
   transformToBaseUnit,
   unescape,
   unimplemented,