@argent/x-shared 1.57.0 → 1.58.0

package/dist/src/tokens/service/types/webToken.model.d.ts

@@ -197,8 +197,8 @@ export declare const webTokenWithBalanceAndPriceSchema: z.ZodObject<z.objectUtil
 }>, "strip", z.ZodTypeAny, {
     address: `0x${string}`;
     networkId: string;
-    balance: string;
     currencyValue: string;
+    balance: string;
     symbol?: string | undefined;
     name?: string | undefined;
     decimals?: number | undefined;
@@ -215,8 +215,8 @@ export declare const webTokenWithBalanceAndPriceSchema: z.ZodObject<z.objectUtil
 }, {
     address: string;
     networkId: string;
-    balance: string;
     currencyValue: string;
+    balance: string;
     symbol?: string | undefined;
     name?: string | undefined;
     decimals?: number | undefined;
@@ -267,8 +267,8 @@ export declare const webTokensWithBalanceAndPriceSchema: z.ZodArray<z.ZodObject<
 }>, "strip", z.ZodTypeAny, {
     address: `0x${string}`;
     networkId: string;
-    balance: string;
     currencyValue: string;
+    balance: string;
     symbol?: string | undefined;
     name?: string | undefined;
     decimals?: number | undefined;
@@ -285,8 +285,8 @@ export declare const webTokensWithBalanceAndPriceSchema: z.ZodArray<z.ZodObject<
 }, {
     address: string;
     networkId: string;
-    balance: string;
     currencyValue: string;
+    balance: string;
     symbol?: string | undefined;
     name?: string | undefined;
     decimals?: number | undefined;

package/dist/src/utils/number/abbreviateNumber.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("../../../_virtual/numeral.cjs"),o=require("./isNumeric.cjs"),b=(e,i=",",a=2)=>{let r=e;if(typeof e=="string"&&(r=e.replaceAll(i,"")),!o.isNumeric(r))return;const t=Number(r);if(Math.abs(t)<1e3)return t.toString();const u=`0.[${"0".repeat(a)}]a`;return n.default(t).format(u).toUpperCase()};exports.abbreviateNumber=b;

package/dist/src/utils/number/abbreviateNumber.d.ts

@@ -0,0 +1,13 @@
+import { BigNumberish } from 'starknet';
+/**
+ * Abbreviates large numbers into a more readable format with metric prefixes (K, M, B, etc.)
+ * @param value - The number to abbreviate. Can be a number, string, or bigint
+ * @param groupSeparator - The separator used for grouping digits in string input (default: ",")
+ * @param digitsAfterDecimal - Number of decimal places to show in abbreviated result (default: 2)
+ * @returns Abbreviated number as string (e.g. "1.23K", "45.6M") or undefined if input is invalid
+ * @example
+ * abbreviateNumber(1234) // "1.23K"
+ * abbreviateNumber("1,234,567") // "1.23M"
+ * abbreviateNumber(1234567890) // "1.23B"
+ */
+export declare const abbreviateNumber: (value?: BigNumberish, groupSeparator?: string, digitsAfterDecimal?: number) => string | undefined;

package/dist/src/utils/number/abbreviateNumber.js

@@ -0,0 +1,15 @@
+import m from "../../../_virtual/numeral.js";
+import { isNumeric as n } from "./isNumeric.js";
+const p = (r, o = ",", a = 2) => {
+  let e = r;
+  if (typeof r == "string" && (e = r.replaceAll(o, "")), !n(e))
+    return;
+  const t = Number(e);
+  if (Math.abs(t) < 1e3)
+    return t.toString();
+  const i = `0.[${"0".repeat(a)}]a`;
+  return m(t).format(i).toUpperCase();
+};
+export {
+  p as abbreviateNumber
+};

package/dist/src/utils/number/index.d.ts

@@ -2,3 +2,4 @@ export * from './isAllowedAddressHexInputValue';
 export * from './isAllowedNumericInputValue';
 export * from './isNumeric';
 export * from './prettifyNumber';
+export * from './abbreviateNumber';

package/dist/src/utils/number/prettifyNumber.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("../../../node_modules/.pnpm/bignumber.js@9.1.2/node_modules/bignumber.js/bignumber.cjs"),P=require("./isNumeric.cjs"),c={CURRENCY:{minDecimalPlaces:2,maxDecimalPlaces:10,minDecimalSignificantDigits:2,decimalPlacesWhenZero:2,allowLeadingZerosInDecimalPart:!0},TOKEN:{minDecimalPlaces:4,maxDecimalPlaces:16,minDecimalSignificantDigits:2,decimalPlacesWhenZero:1,allowLeadingZerosInDecimalPart:!0}},h=(t,e)=>l(t,{...c.CURRENCY,...e||{}}),C=(t,e)=>l(t,{...c.TOKEN,...e||{}}),l=(t,{minDecimalPlaces:e,maxDecimalPlaces:N,minDecimalSignificantDigits:p,decimalPlacesWhenZero:m,allowLeadingZerosInDecimalPart:u}=c.CURRENCY)=>{if(!P.isNumeric(t))return null;const r=new s.BigNumber(typeof t=="bigint"?t.toString():t);let i;const b=`0.${"".padStart(m-1,"0")}1`;if(r.lt(new s.BigNumber(b))&&!u)i=`0.${"".padStart(m,"0")}`;else if(r.gte(1))i=e!==0?r.toFormat(e):r.toFormat(e,s.BigNumber.ROUND_FLOOR);else{const o=r.toFormat(N).split(".")[1].match(/^0+/),d=u&&o&&o.length?o[0].length:0,y=Math.max(d+p,e);i=r.toFormat(y)}const[D,g]=i.split(".");let a=D;if(g){const n=g.replace(/0+$/,"");a+=n?`.${n}`:""}const f=1+i.indexOf(".")+m;return a.length<f&&(a=i.substring(0,f)),a};exports.prettifyCurrencyNumber=h;exports.prettifyNumber=l;exports.prettifyNumberConfig=c;exports.prettifyTokenNumber=C;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const h=require("../../../node_modules/.pnpm/bignumber.js@9.1.2/node_modules/bignumber.js/bignumber.cjs"),x=require("./isNumeric.cjs"),u={CURRENCY:{minDecimalPlaces:2,maxDecimalPlaces:10,minDecimalSignificantDigits:2,decimalPlacesWhenZero:2,allowLeadingZerosInDecimalPart:!0,groupSeparator:",",decimalSeparator:"."},TOKEN:{minDecimalPlaces:4,maxDecimalPlaces:16,minDecimalSignificantDigits:2,decimalPlacesWhenZero:1,allowLeadingZerosInDecimalPart:!0,groupSeparator:",",decimalSeparator:"."}},E=(r,e)=>D(r,{...u.CURRENCY,...e||{}}),T=(r,e)=>D(r,{...u.TOKEN,...e||{}}),R={groupSize:3,decimalSeparator:".",groupSeparator:","},D=(r,{minDecimalPlaces:e,maxDecimalPlaces:y,minDecimalSignificantDigits:C,decimalPlacesWhenZero:p,allowLeadingZerosInDecimalPart:S,groupSeparator:N,decimalSeparator:o=R.decimalSeparator,maxNrDigits:g,roundingMode:s}=u.CURRENCY)=>{if(!x.isNumeric(r))return null;const c={...R,groupSeparator:N,decimalSeparator:o},i=new h.BigNumber(typeof r=="bigint"?r.toString():r);let a;const F=`0.${"".padStart(p-1,"0")}1`;if(i.lt(new h.BigNumber(F))&&!S)a=`0.${"".padStart(p,"0")}`;else if(i.gte(1))a=e!==0?s?i.toFormat(e,s,c):i.toFormat(e,c):i.toFormat(e,h.BigNumber.ROUND_FLOOR,c);else{const l=(s?i.toFormat(y,s,c):i.toFormat(y,c)).split(o)[1].match(/^0+/),m=S&&l&&l.length?l[0].length:0,f=Math.max(m+C,e);a=s?i.toFormat(f,s,c):i.toFormat(f,c)}const[b,O]=a.split(o);let t=b;if(O){const n=O.replace(/0+$/,"");t+=n?`.${n}`:""}const P=1+a.indexOf(".")+p;if(t.length<P&&(t=a.substring(0,P)),g){const n=t.replace(new RegExp(`[${N}${o}]`,"g"),"").length;if(b.replace(new RegExp(`[${N}]`,"g"),"").length>g)t=b;else if(n>g){const l=n-g,m=t.indexOf(o);if(m!==-1){const f=Math.max(0,t.length-m-1-l);t=t.substring(0,m+1+f)}}}return t};exports.prettifyCurrencyNumber=E;exports.prettifyNumber=D;exports.prettifyNumberConfig=u;exports.prettifyTokenNumber=T;

package/dist/src/utils/number/prettifyNumber.d.ts

@@ -1,3 +1,4 @@
+import { BigNumber } from 'big-decimal-number';
 import { BigNumberish } from 'starknet';
 export interface IPrettifyNumberConfig {
     minDecimalPlaces: number;
@@ -8,13 +9,18 @@ export interface IPrettifyNumberConfig {
     decimalPlacesWhenZero: number;
     /** allow leading zeros in the decimal part  e.g. 0.0123 -> 0.012 */
     allowLeadingZerosInDecimalPart: boolean;
+    /** group separator for the number e.g. 123456 -> 123,456 */
+    groupSeparator: string;
+    /** decimal separator for the number e.g. 123456 -> 123.456 */
+    decimalSeparator: string;
+    /** maximum number of digits to display. Does not override the other decimal places config.It is applied as a last step.
+     * If the number has more integer digits than maxNrDigits, it will keep only the integer part.
+     * If the number has more digits than maxNrDigits, it will trim the decimal part. */
+    maxNrDigits?: number;
+    /** rounding mode for the number */
+    roundingMode?: BigNumber.RoundingMode;
 }
 export declare const prettifyNumberConfig: Record<string, IPrettifyNumberConfig>;
 export declare const prettifyCurrencyNumber: (number: BigNumberish, overrides?: Partial<IPrettifyNumberConfig>) => string | null;
 export declare const prettifyTokenNumber: (number: BigNumberish, overrides?: Partial<IPrettifyNumberConfig>) => string | null;
-/**
- * Prettify an input number for display according to the config
- *
- * @see test suite for examples
- */
-export declare const prettifyNumber: (number: BigNumberish, { minDecimalPlaces, maxDecimalPlaces, minDecimalSignificantDigits, decimalPlacesWhenZero, allowLeadingZerosInDecimalPart, }?: IPrettifyNumberConfig) => string | null;
+export declare const prettifyNumber: (number: BigNumberish, { minDecimalPlaces, maxDecimalPlaces, minDecimalSignificantDigits, decimalPlacesWhenZero, allowLeadingZerosInDecimalPart, groupSeparator, decimalSeparator, maxNrDigits, roundingMode, }?: IPrettifyNumberConfig) => string | null;

package/dist/src/utils/number/prettifyNumber.js

@@ -1,52 +1,76 @@
-import { BigNumber as m } from "../../../node_modules/.pnpm/bignumber.js@9.1.2/node_modules/bignumber.js/bignumber.js";
-import { isNumeric as C } from "./isNumeric.js";
-const s = {
+import { BigNumber as u } from "../../../node_modules/.pnpm/bignumber.js@9.1.2/node_modules/bignumber.js/bignumber.js";
+import { isNumeric as y } from "./isNumeric.js";
+const N = {
   CURRENCY: {
     minDecimalPlaces: 2,
     maxDecimalPlaces: 10,
     minDecimalSignificantDigits: 2,
     decimalPlacesWhenZero: 2,
-    allowLeadingZerosInDecimalPart: !0
+    allowLeadingZerosInDecimalPart: !0,
+    groupSeparator: ",",
+    decimalSeparator: "."
   },
   TOKEN: {
     minDecimalPlaces: 4,
     maxDecimalPlaces: 16,
     minDecimalSignificantDigits: 2,
     decimalPlacesWhenZero: 1,
-    allowLeadingZerosInDecimalPart: !0
+    allowLeadingZerosInDecimalPart: !0,
+    groupSeparator: ",",
+    decimalSeparator: "."
   }
-}, y = (t, e) => D(t, {
-  ...s.CURRENCY,
+}, T = (r, e) => x(r, {
+  ...N.CURRENCY,
   ...e || {}
-}), O = (t, e) => D(t, {
-  ...s.TOKEN,
+}), d = (r, e) => x(r, {
+  ...N.TOKEN,
   ...e || {}
-}), D = (t, { minDecimalPlaces: e, maxDecimalPlaces: p, minDecimalSignificantDigits: u, decimalPlacesWhenZero: c, allowLeadingZerosInDecimalPart: l } = s.CURRENCY) => {
-  if (!C(t))
+}), F = {
+  groupSize: 3,
+  decimalSeparator: ".",
+  groupSeparator: ","
+}, x = (r, { minDecimalPlaces: e, maxDecimalPlaces: O, minDecimalSignificantDigits: w, decimalPlacesWhenZero: p, allowLeadingZerosInDecimalPart: P, groupSeparator: h, decimalSeparator: s = F.decimalSeparator, maxNrDigits: g, roundingMode: c } = N.CURRENCY) => {
+  if (!y(r))
     return null;
-  const i = new m(typeof t == "bigint" ? t.toString() : t);
-  let r;
-  const N = `0.${"".padStart(c - 1, "0")}1`;
-  if (i.lt(new m(N)) && !l)
-    r = `0.${"".padStart(c, "0")}`;
+  const a = {
+    ...F,
+    groupSeparator: h,
+    decimalSeparator: s
+  }, i = new u(typeof r == "bigint" ? r.toString() : r);
+  let o;
+  const C = `0.${"".padStart(p - 1, "0")}1`;
+  if (i.lt(new u(C)) && !P)
+    o = `0.${"".padStart(p, "0")}`;
   else if (i.gte(1))
-    r = e !== 0 ? i.toFormat(e) : i.toFormat(e, m.ROUND_FLOOR);
+    o = e !== 0 ? c ? i.toFormat(e, c, a) : i.toFormat(e, a) : i.toFormat(e, u.ROUND_FLOOR, a);
   else {
-    const o = i.toFormat(p).split(".")[1].match(/^0+/), P = l && o && o.length ? o[0].length : 0, h = Math.max(P + u, e);
-    r = i.toFormat(h);
+    const l = (c ? i.toFormat(O, c, a) : i.toFormat(O, a)).split(s)[1].match(/^0+/), m = P && l && l.length ? l[0].length : 0, f = Math.max(m + w, e);
+    o = c ? i.toFormat(f, c, a) : i.toFormat(f, a);
   }
-  const [d, g] = r.split(".");
-  let n = d;
-  if (g) {
-    const a = g.replace(/0+$/, "");
-    n += a ? `.${a}` : "";
+  const [D, R] = o.split(s);
+  let t = D;
+  if (R) {
+    const n = R.replace(/0+$/, "");
+    t += n ? `.${n}` : "";
   }
-  const f = 1 + r.indexOf(".") + c;
-  return n.length < f && (n = r.substring(0, f)), n;
+  const S = 1 + o.indexOf(".") + p;
+  if (t.length < S && (t = o.substring(0, S)), g) {
+    const n = t.replace(new RegExp(`[${h}${s}]`, "g"), "").length;
+    if (D.replace(new RegExp(`[${h}]`, "g"), "").length > g)
+      t = D;
+    else if (n > g) {
+      const l = n - g, m = t.indexOf(s);
+      if (m !== -1) {
+        const f = Math.max(0, t.length - m - 1 - l);
+        t = t.substring(0, m + 1 + f);
+      }
+    }
+  }
+  return t;
 };
 export {
-  y as prettifyCurrencyNumber,
-  D as prettifyNumber,
-  s as prettifyNumberConfig,
-  O as prettifyTokenNumber
+  T as prettifyCurrencyNumber,
+  x as prettifyNumber,
+  N as prettifyNumberConfig,
+  d as prettifyTokenNumber
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argent/x-shared",
-  "version": "1.57.0",
+  "version": "1.58.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/argentlabs/x-shared.git"
@@ -50,6 +50,7 @@
     "@semantic-release/git": "10.0.1",
     "@types/async-retry": "1.4.9",
     "@types/lodash-es": "4.17.12",
+    "@types/numeral": "2.0.5",
     "@types/ua-parser-js": "0.7.39",
     "@typescript-eslint/eslint-plugin": "8.18.0",
     "@typescript-eslint/parser": "8.18.0",
@@ -73,6 +74,7 @@
     "@starknet-io/types-js": "^0.7.7",
     "big-decimal-number": "npm:bignumber.js@^9.1.2",
     "micro-starknet": "^0.2.3",
+    "numeral": "2.0.6",
     "starknet": "6.21.1",
     "starknet4-deprecated": "npm:starknet@4.4.0",
     "starknet5": "npm:starknet@5.25.0"