@alephium/web3 0.5.0-rc.14 → 0.5.0-rc.16

package/dist/src/api/api-explorer.d.ts

@@ -1,3 +1,19 @@
+export interface AcceptedTransaction {
+    /** @format 32-byte-hash */
+    hash: string;
+    /** @format block-hash */
+    blockHash: string;
+    /** @format int64 */
+    timestamp: number;
+    inputs?: Input[];
+    outputs?: Output[];
+    /** @format int32 */
+    gasAmount: number;
+    /** @format uint256 */
+    gasPrice: string;
+    coinbase: boolean;
+    type: string;
+}
 export interface AddressBalance {
     /** @format uint256 */
     balance: string;
@@ -19,6 +35,7 @@ export interface AssetOutput {
     key: string;
     /** @format uint256 */
     attoAlphAmount: string;
+    /** @format address */
     address: string;
     tokens?: Token[];
     /** @format int64 */
@@ -49,22 +66,6 @@ export interface BlockEntryLite {
     /** @format bigint */
     hashRate: string;
 }
-export interface ConfirmedTransaction {
-    /** @format 32-byte-hash */
-    hash: string;
-    /** @format block-hash */
-    blockHash: string;
-    /** @format int64 */
-    timestamp: number;
-    inputs?: Input[];
-    outputs?: Output[];
-    /** @format int32 */
-    gasAmount: number;
-    /** @format uint256 */
-    gasPrice: string;
-    coinbase: boolean;
-    type: string;
-}
 export interface ContractOutput {
     /** @format int32 */
     hint: number;
@@ -72,6 +73,7 @@ export interface ContractOutput {
     key: string;
     /** @format uint256 */
     attoAlphAmount: string;
+    /** @format address */
     address: string;
     tokens?: Token[];
     /** @format 32-byte-hash */
@@ -83,7 +85,9 @@ export interface Event {
     blockHash: string;
     /** @format 32-byte-hash */
     txHash: string;
+    /** @format address */
     contractAddress: string;
+    /** @format address */
     inputAddress?: string;
     /** @format int32 */
     eventIndex: number;
@@ -105,6 +109,7 @@ export interface Input {
     unlockScript?: string;
     /** @format 32-byte-hash */
     txHashRef?: string;
+    /** @format address */
     address?: string;
     /** @format uint256 */
     attoAlphAmount?: string;
@@ -126,6 +131,22 @@ export interface LogbackValue {
     name: string;
     level: string;
 }
+export interface MempoolTransaction {
+    /** @format 32-byte-hash */
+    hash: string;
+    /** @format int32 */
+    chainFrom: number;
+    /** @format int32 */
+    chainTo: number;
+    inputs?: Input[];
+    outputs?: Output[];
+    /** @format int32 */
+    gasAmount: number;
+    /** @format uint256 */
+    gasPrice: string;
+    /** @format int64 */
+    lastSeen: number;
+}
 export interface NotFound {
     detail: string;
     resource: string;
@@ -137,6 +158,23 @@ export interface OutputRef {
     /** @format 32-byte-hash */
     key: string;
 }
+export interface PendingTransaction {
+    /** @format 32-byte-hash */
+    hash: string;
+    /** @format int32 */
+    chainFrom: number;
+    /** @format int32 */
+    chainTo: number;
+    inputs?: Input[];
+    outputs?: Output[];
+    /** @format int32 */
+    gasAmount: number;
+    /** @format uint256 */
+    gasPrice: string;
+    /** @format int64 */
+    lastSeen: number;
+    type: string;
+}
 export interface PerChainCount {
     /** @format int32 */
     chainFrom: number;
@@ -214,27 +252,10 @@ export interface Transaction {
     gasPrice: string;
     coinbase: boolean;
 }
-export declare type TransactionLike = ConfirmedTransaction | UnconfirmedTransaction;
+export declare type TransactionLike = AcceptedTransaction | PendingTransaction;
 export interface Unauthorized {
     detail: string;
 }
-export interface UnconfirmedTransaction {
-    /** @format 32-byte-hash */
-    hash: string;
-    /** @format int32 */
-    chainFrom: number;
-    /** @format int32 */
-    chainTo: number;
-    inputs?: Input[];
-    outputs?: Output[];
-    /** @format int32 */
-    gasAmount: number;
-    /** @format uint256 */
-    gasPrice: string;
-    /** @format int64 */
-    lastSeen: number;
-    type: string;
-}
 export declare type Val = ValAddress | ValArray | ValBool | ValByteVec | ValI256 | ValU256;
 export interface ValAddress {
     /** @format address */
@@ -388,7 +409,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name GetTransactionsTransactionHash
          * @request GET:/transactions/{transaction_hash}
          */
-        getTransactionsTransactionHash: (transactionHash: string, params?: RequestParams) => Promise<ConfirmedTransaction | UnconfirmedTransaction>;
+        getTransactionsTransactionHash: (transactionHash: string, params?: RequestParams) => Promise<AcceptedTransaction | PendingTransaction>;
     };
     addresses: {
         /**
@@ -481,13 +502,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getAddressesAddressTotalTransactions: (address: string, params?: RequestParams) => Promise<number>;
         /**
-         * @description List unconfirmed transactions of a given address
+         * @description List mempool transactions of a given address
          *
          * @tags Addresses
-         * @name GetAddressesAddressUnconfirmedTransactions
-         * @request GET:/addresses/{address}/unconfirmed-transactions
+         * @name GetAddressesAddressMempoolTransactions
+         * @request GET:/addresses/{address}/mempool/transactions
          */
-        getAddressesAddressUnconfirmedTransactions: (address: string, params?: RequestParams) => Promise<TransactionLike[]>;
+        getAddressesAddressMempoolTransactions: (address: string, params?: RequestParams) => Promise<MempoolTransaction[]>;
         /**
          * @description Get address balance
          *
@@ -648,15 +669,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getInfosAverageBlockTimes: (params?: RequestParams) => Promise<PerChainDuration[]>;
     };
-    unconfirmedTransactions: {
+    mempool: {
         /**
-         * @description list unconfirmed transactions
+         * @description list mempool transactions
          *
-         * @tags Transactions
-         * @name GetUnconfirmedTransactions
-         * @request GET:/unconfirmed-transactions
+         * @tags Mempool
+         * @name GetMempoolTransactions
+         * @request GET:/mempool/transactions
          */
-        getUnconfirmedTransactions: (query?: {
+        getMempoolTransactions: (query?: {
             /**
              * Page number
              * @format int32
@@ -669,7 +690,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             limit?: number;
             /** Reverse pagination */
             reverse?: boolean;
-        }, params?: RequestParams) => Promise<TransactionLike[]>;
+        }, params?: RequestParams) => Promise<MempoolTransaction[]>;
     };
     tokens: {
         /**

package/dist/src/api/api-explorer.js

@@ -291,14 +291,14 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse),
             /**
-             * @description List unconfirmed transactions of a given address
+             * @description List mempool transactions of a given address
              *
              * @tags Addresses
-             * @name GetAddressesAddressUnconfirmedTransactions
-             * @request GET:/addresses/{address}/unconfirmed-transactions
+             * @name GetAddressesAddressMempoolTransactions
+             * @request GET:/addresses/{address}/mempool/transactions
              */
-            getAddressesAddressUnconfirmedTransactions: (address, params = {}) => this.request({
-                path: `/addresses/${address}/unconfirmed-transactions`,
+            getAddressesAddressMempoolTransactions: (address, params = {}) => this.request({
+                path: `/addresses/${address}/mempool/transactions`,
                 method: 'GET',
                 format: 'json',
                 ...params
@@ -500,16 +500,16 @@ class Api extends HttpClient {
                 ...params
             }).then(utils_1.convertHttpResponse)
         };
-        this.unconfirmedTransactions = {
+        this.mempool = {
             /**
-             * @description list unconfirmed transactions
+             * @description list mempool transactions
              *
-             * @tags Transactions
-             * @name GetUnconfirmedTransactions
-             * @request GET:/unconfirmed-transactions
+             * @tags Mempool
+             * @name GetMempoolTransactions
+             * @request GET:/mempool/transactions
              */
-            getUnconfirmedTransactions: (query, params = {}) => this.request({
-                path: `/unconfirmed-transactions`,
+            getMempoolTransactions: (query, params = {}) => this.request({
+                path: `/mempool/transactions`,
                 method: 'GET',
                 query: query,
                 format: 'json',

package/dist/src/api/index.d.ts

@@ -29,7 +29,7 @@ export declare class ExplorerProvider {
     readonly transactions: any;
     readonly addresses: any;
     readonly infos: any;
-    readonly unconfirmedTransactions: any;
+    readonly mempool: any;
     readonly tokens: any;
     readonly charts: any;
     readonly utils: any;

package/dist/src/api/index.js

@@ -121,7 +121,7 @@ class ExplorerProvider {
         this.transactions = api_explorer_1.Api['transactions'];
         this.addresses = api_explorer_1.Api['addresses'];
         this.infos = api_explorer_1.Api['infos'];
-        this.unconfirmedTransactions = api_explorer_1.Api['unconfirmedTransactions'];
+        this.mempool = api_explorer_1.Api['mempool'];
         this.tokens = api_explorer_1.Api['tokens'];
         this.charts = api_explorer_1.Api['charts'];
         this.utils = api_explorer_1.Api['utils'];
@@ -143,7 +143,7 @@ class ExplorerProvider {
         this.transactions = { ...explorerApi.transactions };
         this.addresses = { ...explorerApi.addresses };
         this.infos = { ...explorerApi.infos };
-        this.unconfirmedTransactions = { ...explorerApi.unconfirmedTransactions };
+        this.mempool = { ...explorerApi.mempool };
         this.tokens = { ...explorerApi.tokens };
         this.charts = { ...explorerApi.charts };
         this.utils = { ...explorerApi.utils };

package/dist/src/signer/types.d.ts

@@ -109,6 +109,7 @@ export interface SubmissionResult {
 }
 export interface EnableOptionsBase {
     chainGroup?: number;
+    keyType?: KeyType;
     networkId: string;
-    onDisconnected: () => Promise<void>;
+    onDisconnected: () => Promise<void> | void;
 }

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

@@ -0,0 +1,14 @@
+export declare const isNumeric: (numToCheck: any) => boolean;
+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 declare const prettifyNumberConfig: Record<string, IPrettifyNumberConfig>;
+export declare function prettifyAttoAlphAmount(amount: bigint): string | null;
+export declare function prettifyTokenAmount(amount: bigint, decimals: number): string | null;
+export declare function prettifyExactAmount(amount: bigint, decimals: number): string | null;
+export declare function prettifyNumber(amount: bigint, decimals: number, config: IPrettifyNumberConfig): string | null;

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

@@ -0,0 +1,7 @@
+export declare const tests: {
+    raw: bigint;
+    decimal: number;
+    exact: string;
+    alphFormat: string;
+    tokenFormat: string;
+}[];

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

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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'
+    }
+];

package/dist/src/utils/number.js

@@ -0,0 +1,130 @@
+"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.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(amount, decimals);
+    if (!(0, exports.isNumeric)(number)) {
+        return null;
+    }
+    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;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.5.0-rc.14",
+  "version": "0.5.0-rc.16",
   "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.1-rc2",
-    "explorer_backend_version": "1.13.0-rc0"
+    "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",