@alephium/web3 0.9.0-rc.0 → 0.9.0-rc.1

package/dist/src/transaction/index.js

@@ -0,0 +1,35 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./status"), exports);
+__exportStar(require("./sign-verify"), exports);

package/dist/src/transaction/sign-verify.d.ts

@@ -0,0 +1,3 @@
+import { KeyType } from '../signer';
+export declare function transactionSign(txId: string, privateKey: string, keyType?: KeyType): string;
+export declare function transactionVerifySignature(txId: string, publicKey: string, signature: string, keyType?: KeyType): boolean;

package/dist/src/transaction/sign-verify.js

@@ -0,0 +1,52 @@
+"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.transactionVerifySignature = exports.transactionSign = void 0;
+const utils = __importStar(require("../utils"));
+function transactionSign(txId, privateKey, keyType) {
+    return utils.sign(txId, privateKey, keyType);
+}
+exports.transactionSign = transactionSign;
+function transactionVerifySignature(txId, publicKey, signature, keyType) {
+    return utils.verifySignature(txId, publicKey, signature, keyType);
+}
+exports.transactionVerifySignature = transactionVerifySignature;

package/dist/src/transaction/status.d.ts

@@ -0,0 +1,11 @@
+import { node } from '../api';
+import { Subscription, SubscribeOptions } from '../utils';
+export type TxStatus = node.TxStatus;
+export declare class TxStatusSubscription extends Subscription<TxStatus> {
+    readonly txId: string;
+    readonly fromGroup?: number;
+    readonly toGroup?: number;
+    constructor(options: SubscribeOptions<TxStatus>, txId: string, fromGroup?: number, toGroup?: number);
+    polling(): Promise<void>;
+}
+export declare function subscribeToTxStatus(options: SubscribeOptions<TxStatus>, txId: string, fromGroup?: number, toGroup?: number): TxStatusSubscription;

package/dist/src/transaction/status.js

@@ -0,0 +1,49 @@
+"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/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.subscribeToTxStatus = exports.TxStatusSubscription = void 0;
+const __1 = require("..");
+const utils_1 = require("../utils");
+class TxStatusSubscription extends utils_1.Subscription {
+    constructor(options, txId, fromGroup, toGroup) {
+        super(options);
+        this.txId = txId;
+        this.fromGroup = fromGroup;
+        this.toGroup = toGroup;
+        this.startPolling();
+    }
+    async polling() {
+        try {
+            const txStatus = await __1.web3.getCurrentNodeProvider().transactions.getTransactionsStatus({
+                txId: this.txId,
+                fromGroup: this.fromGroup,
+                toGroup: this.toGroup
+            });
+            await this.messageCallback(txStatus);
+        }
+        catch (err) {
+            await this.errorCallback(err, this);
+        }
+    }
+}
+exports.TxStatusSubscription = TxStatusSubscription;
+function subscribeToTxStatus(options, txId, fromGroup, toGroup) {
+    return new TxStatusSubscription(options, txId, fromGroup, toGroup);
+}
+exports.subscribeToTxStatus = subscribeToTxStatus;

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

@@ -0,0 +1 @@
+export declare function addressToGroup(address: string, totalNumberOfGroups: number): number;

package/dist/src/utils/address.js

@@ -0,0 +1,42 @@
+"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.addressToGroup = void 0;
+const bs58_1 = __importDefault(require("./bs58"));
+const djb2_1 = __importDefault(require("./djb2"));
+function addressToGroup(address, totalNumberOfGroups) {
+    const bytes = bs58_1.default.decode(address).slice(1);
+    const value = (0, djb2_1.default)(bytes) | 1;
+    const hash = toPosInt(xorByte(value));
+    const group = hash % totalNumberOfGroups;
+    return group;
+}
+exports.addressToGroup = addressToGroup;
+function xorByte(value) {
+    const byte0 = value >> 24;
+    const byte1 = value >> 16;
+    const byte2 = value >> 8;
+    return byte0 ^ byte1 ^ byte2 ^ value;
+}
+function toPosInt(byte) {
+    return byte & 0xff;
+}

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

@@ -0,0 +1,5 @@
+/** This source is under MIT License and come originally from https://github.com/cryptocoinjs/bs58 **/
+import basex from 'base-x';
+export declare const bs58: basex.BaseConverter;
+export declare function isBase58(s: string): boolean;
+export default bs58;

package/dist/src/utils/bs58.js

@@ -0,0 +1,40 @@
+"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.isBase58 = exports.bs58 = void 0;
+/** This source is under MIT License and come originally from https://github.com/cryptocoinjs/bs58 **/
+const base_x_1 = __importDefault(require("base-x"));
+const ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
+exports.bs58 = (0, base_x_1.default)(ALPHABET);
+function isBase58(s) {
+    if (s === '' || s.trim() === '') {
+        return false;
+    }
+    try {
+        return exports.bs58.encode(exports.bs58.decode(s)) === s;
+    }
+    catch (err) {
+        return false;
+    }
+}
+exports.isBase58 = isBase58;
+exports.default = exports.bs58;

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

@@ -0,0 +1 @@
+export default function djb2(bytes: Uint8Array): number;

package/dist/src/utils/djb2.js

@@ -0,0 +1,27 @@
+"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/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+function djb2(bytes) {
+    let hash = 5381;
+    for (let i = 0; i < bytes.length; i++) {
+        hash = (hash << 5) + hash + (bytes[`${i}`] & 0xff);
+    }
+    return hash;
+}
+exports.default = djb2;

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

@@ -0,0 +1,7 @@
+export * from './address';
+export * from './bs58';
+export * from './djb2';
+export * from './utils';
+export * from './subscription';
+export * from './sign';
+export * from './number';

package/dist/src/utils/index.js

@@ -0,0 +1,40 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./address"), exports);
+__exportStar(require("./bs58"), exports);
+__exportStar(require("./djb2"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./subscription"), exports);
+__exportStar(require("./sign"), exports);
+__exportStar(require("./number"), exports);

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

@@ -0,0 +1,18 @@
+import { Number256 } from '..';
+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: Number256): string | undefined;
+export declare function prettifyTokenAmount(amount: Number256, decimals: number): string | undefined;
+export declare function prettifyExactAmount(amount: Number256, decimals: number): string | undefined;
+export declare function prettifyNumber(amount: Number256, decimals: number, config: IPrettifyNumberConfig): string | undefined;
+export declare function convertAmountWithDecimals(amount: string | number, decimals: number): bigint | undefined;
+export declare function convertAlphAmountWithDecimals(amount: string | number): bigint | undefined;
+export declare function number256ToBigint(number: Number256): bigint;

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

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

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
+    }
+];