@alephium/web3 0.5.0-rc.2 → 0.5.0-rc.20

package/dist/src/utils/number.js

@@ -0,0 +1,144 @@
+"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.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 = typeof amount === 'string' ? amount : toFixedNumber(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;

package/dist/src/utils/sign.d.ts

@@ -0,0 +1,3 @@
+import { KeyType } from '../signer';
+export declare function sign(hash: string, privateKey: string, _keyType?: KeyType): string;
+export declare function verifySignature(hash: string, publicKey: string, signature: string, _keyType?: KeyType): boolean;

package/dist/src/utils/sign.js

@@ -0,0 +1,89 @@
+"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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifySignature = exports.sign = void 0;
+const elliptic_1 = require("elliptic");
+const __1 = require("..");
+const necc = __importStar(require("@noble/secp256k1"));
+const crypto_1 = require("crypto");
+const ec = new elliptic_1.ec('secp256k1');
+necc.utils.sha256Sync = (...messages) => {
+    const sha256 = (0, crypto_1.createHash)('sha256');
+    for (const message of messages)
+        sha256.update(message);
+    return sha256.digest();
+};
+necc.utils.hmacSha256Sync = (key, ...messages) => {
+    const hash = (0, crypto_1.createHmac)('sha256', Buffer.from(key));
+    messages.forEach((m) => hash.update(m));
+    return Uint8Array.from(hash.digest());
+};
+// hash has to be 32 bytes
+function sign(hash, privateKey, _keyType) {
+    const keyType = _keyType ?? 'default';
+    if (keyType === 'default') {
+        const key = ec.keyFromPrivate(privateKey);
+        const signature = key.sign(hash);
+        return (0, __1.encodeSignature)(signature);
+    }
+    else {
+        const signature = necc.schnorr.signSync((0, __1.hexToBinUnsafe)(hash), (0, __1.hexToBinUnsafe)(privateKey));
+        return (0, __1.binToHex)(signature);
+    }
+}
+exports.sign = sign;
+function verifySignature(hash, publicKey, signature, _keyType) {
+    const keyType = _keyType ?? 'default';
+    try {
+        if (keyType === 'default') {
+            const key = ec.keyFromPublic(publicKey, 'hex');
+            return key.verify(hash, (0, __1.signatureDecode)(ec, signature));
+        }
+        else {
+            return necc.schnorr.verifySync((0, __1.hexToBinUnsafe)(signature), (0, __1.hexToBinUnsafe)(hash), (0, __1.hexToBinUnsafe)(publicKey));
+        }
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.verifySignature = verifySignature;

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

@@ -1,5 +1,6 @@
 import { ec as EC, SignatureInput } from 'elliptic';
 import BN from 'bn.js';
+import { KeyType } from '../signer';
 export declare function encodeSignature(signature: EC.Signature | {
     r: BN;
     s: BN;
@@ -13,9 +14,9 @@ export declare function contractIdFromAddress(address: string): Uint8Array;
 export declare function tokenIdFromAddress(address: string): Uint8Array;
 export declare function hexToBinUnsafe(hex: string): Uint8Array;
 export declare function binToHex(bin: Uint8Array): string;
-export declare function groupOfPrivateKey(privateKey: string): number;
-export declare function publicKeyFromPrivateKey(privateKey: string): string;
-export declare function addressFromPublicKey(publicKey: string): string;
+export declare function groupOfPrivateKey(privateKey: string, keyType?: KeyType): number;
+export declare function publicKeyFromPrivateKey(privateKey: string, _keyType?: KeyType): string;
+export declare function addressFromPublicKey(publicKey: string, _keyType?: KeyType): string;
 export declare function addressFromContractId(contractId: string): string;
 export declare function contractIdFromTx(txId: string, outputIndex: number): string;
 export declare function subContractId(parentContractId: string, pathInHex: string, group: number): string;

package/dist/src/utils/utils.js

@@ -153,20 +153,35 @@ function binToHex(bin) {
     return buffer_1.Buffer.from(bin).toString('hex');
 }
 exports.binToHex = binToHex;
-function groupOfPrivateKey(privateKey) {
-    return groupOfAddress(addressFromPublicKey(publicKeyFromPrivateKey(privateKey)));
+function groupOfPrivateKey(privateKey, keyType) {
+    return groupOfAddress(addressFromPublicKey(publicKeyFromPrivateKey(privateKey, keyType), keyType));
 }
 exports.groupOfPrivateKey = groupOfPrivateKey;
-function publicKeyFromPrivateKey(privateKey) {
-    const key = ec.keyFromPrivate(privateKey);
-    return key.getPublic(true, 'hex');
+function publicKeyFromPrivateKey(privateKey, _keyType) {
+    const keyType = _keyType ?? 'default';
+    if (keyType === 'default') {
+        const key = ec.keyFromPrivate(privateKey);
+        return key.getPublic(true, 'hex');
+    }
+    else {
+        return ec.g.mul(new bn_js_1.default(privateKey, 16)).encode('hex', true).slice(2);
+    }
 }
 exports.publicKeyFromPrivateKey = publicKeyFromPrivateKey;
-function addressFromPublicKey(publicKey) {
-    const addressType = buffer_1.Buffer.from([AddressType.P2PKH]);
-    const hash = buffer_1.Buffer.from(blakejs_1.default.blake2b(buffer_1.Buffer.from(publicKey, 'hex'), undefined, 32));
-    const bytes = buffer_1.Buffer.concat([addressType, hash]);
-    return bs58_1.default.encode(bytes);
+function addressFromPublicKey(publicKey, _keyType) {
+    const keyType = _keyType ?? 'default';
+    if (keyType === 'default') {
+        const addressType = buffer_1.Buffer.from([AddressType.P2PKH]);
+        const hash = buffer_1.Buffer.from(blakejs_1.default.blake2b(buffer_1.Buffer.from(publicKey, 'hex'), undefined, 32));
+        const bytes = buffer_1.Buffer.concat([addressType, hash]);
+        return bs58_1.default.encode(bytes);
+    }
+    else {
+        const lockupScript = buffer_1.Buffer.from(`0101000000000458144020${publicKey}8685`, 'hex');
+        const lockupScriptHash = blakejs_1.default.blake2b(lockupScript, undefined, 32);
+        const addressType = buffer_1.Buffer.from([AddressType.P2SH]);
+        return bs58_1.default.encode(buffer_1.Buffer.concat([addressType, lockupScriptHash]));
+    }
 }
 exports.addressFromPublicKey = addressFromPublicKey;
 function addressFromContractId(contractId) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.5.0-rc.2",
+  "version": "0.5.0-rc.20",
   "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",
@@ -40,12 +40,14 @@
   },
   "type": "commonjs",
   "dependencies": {
+    "@noble/secp256k1": "1.7.1",
     "base-x": "4.0.0",
     "blakejs": "1.2.1",
     "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",
@@ -77,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",