@alephium/web3 0.5.0-rc.9 → 0.5.1

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

@@ -0,0 +1,189 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tests1 = exports.tests = void 0;
+/*
+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/>.
+*/
+exports.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'
+    }
+];
+exports.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/dist/src/utils/number.js

@@ -0,0 +1,148 @@
+"use strict";
+/*
+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/>.
+*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.number256ToBigint = exports.convertAlphAmount = exports.convertAmountWithDecimals = exports.prettifyNumber = exports.prettifyExactAmount = exports.prettifyTokenAmount = exports.prettifyAttoAlphAmount = exports.prettifyNumberConfig = exports.isNumeric = void 0;
+// 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
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const isNumeric = (numToCheck) => !isNaN(parseFloat(numToCheck)) && isFinite(numToCheck);
+exports.isNumeric = isNumeric;
+exports.prettifyNumberConfig = {
+    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
+    }
+};
+function prettifyAttoAlphAmount(amount) {
+    return prettifyNumber(amount, 18, exports.prettifyNumberConfig.ALPH);
+}
+exports.prettifyAttoAlphAmount = prettifyAttoAlphAmount;
+function prettifyTokenAmount(amount, decimals) {
+    return prettifyNumber(amount, decimals, exports.prettifyNumberConfig.TOKEN);
+}
+exports.prettifyTokenAmount = prettifyTokenAmount;
+function prettifyExactAmount(amount, decimals) {
+    return prettifyNumber(amount, decimals, exports.prettifyNumberConfig.Exact);
+}
+exports.prettifyExactAmount = prettifyExactAmount;
+function prettifyNumber(amount, decimals, config) {
+    const number = toFixedNumber(number256ToBigint(amount), decimals);
+    if (!(0, exports.isNumeric)(number)) {
+        return undefined;
+    }
+    const numberBN = new bignumber_js_1.default(number);
+    let untrimmed;
+    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;
+}
+exports.prettifyNumber = prettifyNumber;
+const BN_N1 = BigInt(-1);
+const BN_0 = BigInt(0);
+// Constant to pull zeros from for multipliers
+const Zeros = '0000';
+function toFixedNumber(val, decimals) {
+    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;
+}
+function convertAmountWithDecimals(amount, decimals) {
+    try {
+        const result = new bignumber_js_1.default(amount).multipliedBy(Math.pow(10, decimals));
+        return BigInt(result.toFormat(0, { groupSeparator: '' }));
+    }
+    catch (e) {
+        return undefined;
+    }
+}
+exports.convertAmountWithDecimals = convertAmountWithDecimals;
+function convertAlphAmount(amount) {
+    return convertAmountWithDecimals(amount, 18);
+}
+exports.convertAlphAmount = convertAlphAmount;
+function number256ToBigint(number) {
+    return typeof number === 'string' ? BigInt(number) : number;
+}
+exports.number256ToBigint = number256ToBigint;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.5.0-rc.9",
+  "version": "0.5.1",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -27,8 +27,8 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.7.0",
-    "explorer_backend_version": "1.12.0"
+    "alephium_version": "1.7.1",
+    "explorer_backend_version": "1.13.0"
   },
   "scripts": {
     "build": "rm -rf dist/* && npx tsc --build . && webpack",
@@ -46,7 +46,8 @@
     "buffer": "^6.0.3",
     "cross-fetch": "^3.1.5",
     "elliptic": "6.5.4",
-    "eventemitter3": "^4.0.7"
+    "eventemitter3": "^4.0.7",
+    "bignumber.js": "^9.0.2"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.18.9",
@@ -78,7 +79,7 @@
     "rewire": "^6.0.0",
     "shelljs": "^0.8.5",
     "stream-browserify": "^3.0.0",
-    "swagger-typescript-api": "^9.2.0",
+    "swagger-typescript-api": "12.0.3",
     "terser-webpack-plugin": "^5.3.1",
     "ts-jest": "^28.0.2",
     "ts-node": "^10.7.0",