@alephium/web3 0.5.0-rc.9 → 0.5.1

package/src/utils/number.fixture.ts

@@ -0,0 +1,187 @@
+/*
+Copyright 2018 - 2022 The Alephium Authors
+This file is part of the alephium project.
+
+The library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+The library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with the library. If not, see <http://www.gnu.org/licenses/>.
+*/
+export const tests = [
+  {
+    raw: 123456n,
+    decimal: 5,
+    exact: '1.23456',
+    alphFormat: '1.23',
+    tokenFormat: '1.2346'
+  },
+  {
+    raw: 12345612n,
+    decimal: 2,
+    exact: '123,456.12',
+    alphFormat: '123,456.12',
+    tokenFormat: '123,456.12'
+  },
+  {
+    raw: 123456123456n,
+    decimal: 6,
+    exact: '123,456.123456',
+    alphFormat: '123,456.12',
+    tokenFormat: '123,456.1235'
+  },
+  {
+    raw: 12n,
+    decimal: 2,
+    exact: '0.12',
+    alphFormat: '0.12',
+    tokenFormat: '0.12'
+  },
+  {
+    raw: 123456n,
+    decimal: 6,
+    exact: '0.123456',
+    alphFormat: '0.12',
+    tokenFormat: '0.1235'
+  },
+  {
+    raw: 123456n,
+    decimal: 7,
+    exact: '0.0123456',
+    alphFormat: '0.012',
+    tokenFormat: '0.0123'
+  },
+  {
+    raw: 123456n,
+    decimal: 8,
+    exact: '0.00123456',
+    alphFormat: '0.0012',
+    tokenFormat: '0.0012'
+  },
+  {
+    raw: 123456n,
+    decimal: 9,
+    exact: '0.000123456',
+    alphFormat: '0.00012',
+    tokenFormat: '0.00012'
+  },
+  {
+    raw: 123456n,
+    decimal: 11,
+    exact: '0.00000123456',
+    alphFormat: '0.0000012',
+    tokenFormat: '0.0000012'
+  },
+  {
+    raw: -123456n,
+    decimal: 11,
+    exact: '-0.00000123456',
+    alphFormat: '-0.0000012',
+    tokenFormat: '-0.0000012'
+  },
+  {
+    raw: 8923088n,
+    decimal: 10,
+    exact: '0.0008923088',
+    alphFormat: '0.00089',
+    tokenFormat: '0.00089'
+  },
+  {
+    raw: 885n,
+    decimal: 6,
+    exact: '0.000885',
+    alphFormat: '0.00089',
+    tokenFormat: '0.00089'
+  },
+  {
+    raw: 100000000000n,
+    decimal: 18,
+    exact: '0.0000001',
+    alphFormat: '0.0000001',
+    tokenFormat: '0.0000001'
+  },
+  {
+    raw: 1504000000000000000n,
+    decimal: 18,
+    exact: '1.504',
+    alphFormat: '1.50',
+    tokenFormat: '1.504'
+  },
+  {
+    raw: 1505000000000000000n,
+    decimal: 18,
+    exact: '1.505',
+    alphFormat: '1.51',
+    tokenFormat: '1.505'
+  },
+  {
+    raw: 1500050000000000000n,
+    decimal: 18,
+    exact: '1.50005',
+    alphFormat: '1.50',
+    tokenFormat: '1.5001'
+  },
+  {
+    raw: 100n,
+    decimal: 0,
+    exact: '100',
+    alphFormat: '100.00',
+    tokenFormat: '100.0'
+  },
+  {
+    raw: 123456789n,
+    decimal: 0,
+    exact: '123,456,789',
+    alphFormat: '123,456,789.00',
+    tokenFormat: '123,456,789.0'
+  },
+  {
+    raw: -123456789n,
+    decimal: 0,
+    exact: '-123,456,789',
+    alphFormat: '-123,456,789.00',
+    tokenFormat: '-123,456,789.0'
+  },
+  {
+    raw: 0n,
+    decimal: 0,
+    exact: '0',
+    alphFormat: '0.00',
+    tokenFormat: '0.0'
+  }
+]
+
+export const tests1 = [
+  {
+    raw: '0',
+    decimals: 18,
+    amount: 0n
+  },
+  {
+    raw: '1.23',
+    decimals: 2,
+    amount: 123n
+  },
+  {
+    raw: '1',
+    decimals: 5,
+    amount: 100000n
+  },
+  {
+    raw: '1',
+    decimals: 18,
+    amount: 1000000000000000000n
+  },
+  {
+    raw: '1.23456789',
+    decimals: 18,
+    amount: 1234567890000000000n
+  }
+]

package/src/utils/number.ts

@@ -0,0 +1,162 @@
+/*
+Copyright 2018 - 2022 The Alephium Authors
+This file is part of the alephium project.
+
+The library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+The library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with the library. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+// Credits:
+// 1. https://github.com/argentlabs/argent-x/blob/e63affa7f28b27333dca4081a3dcd375bb2da40b/packages/extension/src/shared/utils/number.ts
+// 2. https://github.com/ethers-io/ethers.js/blob/724881f34d428406488a1c9f9dbebe54b6edecda/src.ts/utils/fixednumber.ts
+
+import BigNumber from 'bignumber.js'
+import { Number256 } from '..'
+
+export const isNumeric = (numToCheck: any): boolean => !isNaN(parseFloat(numToCheck)) && isFinite(numToCheck)
+
+export interface IPrettifyNumberConfig {
+  minDecimalPlaces: number
+  maxDecimalPlaces: number
+  /** significant digits to show in decimals while respecting decimal places */
+  minDecimalSignificantDigits: number
+  /** special case for zero, e.g. we may want to display $0.00 or 0.0 ALPH */
+  decimalPlacesWhenZero: number
+}
+
+export const prettifyNumberConfig: Record<string, IPrettifyNumberConfig> = {
+  ALPH: {
+    minDecimalPlaces: 2,
+    maxDecimalPlaces: 10,
+    minDecimalSignificantDigits: 2,
+    decimalPlacesWhenZero: 2
+  },
+  TOKEN: {
+    minDecimalPlaces: 4,
+    maxDecimalPlaces: 16,
+    minDecimalSignificantDigits: 2,
+    decimalPlacesWhenZero: 1
+  },
+  Exact: {
+    minDecimalPlaces: 18,
+    maxDecimalPlaces: 18,
+    minDecimalSignificantDigits: 0,
+    decimalPlacesWhenZero: 0
+  }
+}
+
+export function prettifyAttoAlphAmount(amount: Number256): string | undefined {
+  return prettifyNumber(amount, 18, prettifyNumberConfig.ALPH)
+}
+
+export function prettifyTokenAmount(amount: Number256, decimals: number): string | undefined {
+  return prettifyNumber(amount, decimals, prettifyNumberConfig.TOKEN)
+}
+
+export function prettifyExactAmount(amount: Number256, decimals: number): string | undefined {
+  return prettifyNumber(amount, decimals, prettifyNumberConfig.Exact)
+}
+
+export function prettifyNumber(amount: Number256, decimals: number, config: IPrettifyNumberConfig): string | undefined {
+  const number = toFixedNumber(number256ToBigint(amount), decimals)
+
+  if (!isNumeric(number)) {
+    return undefined
+  }
+
+  const numberBN = new BigNumber(number)
+
+  let untrimmed: string
+  if (numberBN.gte(1)) {
+    /** simplest case, formatting to minDecimalPlaces will look good */
+    untrimmed = numberBN.toFormat(config.minDecimalPlaces)
+  } else {
+    /** now need to interrogate the appearance of decimal number < 1 */
+    /** longest case - max decimal places e.g. 0.0008923088123 -> 0.0008923088 */
+    const maxDecimalPlacesString = numberBN.toFormat(config.maxDecimalPlaces)
+    /** count the zeros, which will then allow us to know the final length with desired significant digits */
+    const decimalPart = maxDecimalPlacesString.split('.')[1]
+    const zeroMatches = decimalPart?.match(/^0+/)
+    const leadingZerosInDecimalPart = zeroMatches && zeroMatches.length ? zeroMatches[0].length : 0
+    /** now we can re-format with leadingZerosInDecimalPart + maxDecimalSignificanDigits to give us the pretty version */
+    /** e.g. 0.0008923088123 -> 0.00089 */
+    const prettyDecimalPlaces = Math.max(
+      leadingZerosInDecimalPart + config.minDecimalSignificantDigits,
+      config.minDecimalPlaces
+    )
+    untrimmed = numberBN.toFormat(prettyDecimalPlaces)
+  }
+  /** the untrimmed string may have trailing zeros, e.g. 0.0890 */
+  /** trim to a minimum specified by the config, e.g. we may want to display $0.00 or 0.0 ETH */
+  let trimmed = untrimmed.replace(/0+$/, '')
+  const minLength = 1 + untrimmed.indexOf('.') + config.decimalPlacesWhenZero
+  if (trimmed.length < minLength) {
+    trimmed = untrimmed.substring(0, minLength)
+  }
+  if (trimmed[trimmed.length - 1] === '.') {
+    trimmed = trimmed.slice(0, -1)
+  }
+  return trimmed
+}
+
+const BN_N1 = BigInt(-1)
+const BN_0 = BigInt(0)
+
+// Constant to pull zeros from for multipliers
+const Zeros = '0000'
+
+function toFixedNumber(val: bigint, decimals: number): string {
+  let negative = ''
+  if (val < BN_0) {
+    negative = '-'
+    val *= BN_N1
+  }
+  let str = val.toString()
+  // No decimal point for whole values
+  if (decimals === 0) {
+    return negative + str
+  }
+  // Pad out to the whole component (including a whole digit)
+  while (str.length <= decimals) {
+    str = Zeros + str
+  }
+  // Insert the decimal point
+  const index = str.length - decimals
+  str = str.substring(0, index) + '.' + str.substring(index)
+  // Trim the whole component (leaving at least one 0)
+  while (str[0] === '0' && str[1] !== '.') {
+    str = str.substring(1)
+  }
+  // Trim the decimal component (leaving at least one 0)
+  while (str[str.length - 1] === '0' && str[str.length - 2] !== '.') {
+    str = str.substring(0, str.length - 1)
+  }
+  return negative + str
+}
+
+export function convertAmountWithDecimals(amount: string | number, decimals: number): bigint | undefined {
+  try {
+    const result = new BigNumber(amount).multipliedBy(Math.pow(10, decimals))
+    return BigInt(result.toFormat(0, { groupSeparator: '' }))
+  } catch (e) {
+    return undefined
+  }
+}
+
+export function convertAlphAmount(amount: string | number): bigint | undefined {
+  return convertAmountWithDecimals(amount, 18)
+}
+
+export function number256ToBigint(number: Number256): bigint {
+  return typeof number === 'string' ? BigInt(number) : number
+}