@alephium/web3 0.2.0-test.1 → 0.2.0

package/src/utils/subscription.ts

@@ -17,8 +17,6 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
 import EventEmitter from 'eventemitter3'
-import { getCurrentNodeProvider } from '../global'
-import { NodeProvider } from '../api'
 
 type MessageCallback<Message> = (message: Message) => Promise<void>
 type ErrorCallback<Message> = (error: any, subscription: Subscription<Message>) => Promise<void>
@@ -30,7 +28,6 @@ export interface SubscribeOptions<Message> {
 }
 
 export abstract class Subscription<Message> {
-  provider: NodeProvider
   pollingInterval: number
 
   protected messageCallback: MessageCallback<Message>
@@ -40,7 +37,6 @@ export abstract class Subscription<Message> {
   protected cancelled: boolean
 
   constructor(options: SubscribeOptions<Message>) {
-    this.provider = getCurrentNodeProvider()
     this.pollingInterval = options.pollingInterval
     this.messageCallback = options.messageCallback
     this.errorCallback = options.errorCallback

package/src/utils/utils.ts

@@ -24,21 +24,9 @@ import { Buffer } from 'buffer/'
 
 import { TOTAL_NUMBER_OF_GROUPS } from '../constants'
 import djb2 from './djb2'
-import * as node from '../api/api-alephium'
-import * as explorer from '../api/api-explorer'
 
 const ec = new EC('secp256k1')
 
-export function convertHttpResponse<T>(
-  response: node.HttpResponse<T, { detail: string }> | explorer.HttpResponse<T, { detail: string }>
-): T {
-  if (response.error) {
-    throw new Error(response.error.detail)
-  } else {
-    return response.data
-  }
-}
-
 export function signatureEncode(signature: EC.Signature): string {
   let sNormalized = signature.s
   if (ec.n && signature.s.cmp(ec.nh) === 1) {
@@ -51,7 +39,7 @@ export function signatureEncode(signature: EC.Signature): string {
 }
 
 // the signature should be in hex string format for 64 bytes
-export const signatureDecode = (ec: EC, signature: string): SignatureInput => {
+export function signatureDecode(ec: EC, signature: string): SignatureInput {
   if (signature.length !== 128) {
     throw new Error('Invalid signature length')
   }
@@ -66,7 +54,7 @@ export const signatureDecode = (ec: EC, signature: string): SignatureInput => {
   }
 }
 
-const xorByte = (intValue: number) => {
+export function xorByte(intValue: number): number {
   const byte0 = (intValue >> 24) & 0xff
   const byte1 = (intValue >> 16) & 0xff
   const byte2 = (intValue >> 8) & 0xff
@@ -85,7 +73,7 @@ enum AddressType {
   P2C = 0x03
 }
 
-export const groupOfAddress = (address: string): number => {
+export function groupOfAddress(address: string): number {
   const decoded = bs58.decode(address)
 
   if (decoded.length == 0) throw new Error('Address string is empty')
@@ -103,7 +91,7 @@ export const groupOfAddress = (address: string): number => {
   }
 }
 
-const groupOfAddressBytes = (bytes: Uint8Array): number => {
+function groupOfAddressBytes(bytes: Uint8Array): number {
   const hint = djb2(bytes) | 1
   const hash = xorByte(hint)
   const group = hash % TOTAL_NUMBER_OF_GROUPS
@@ -111,7 +99,7 @@ const groupOfAddressBytes = (bytes: Uint8Array): number => {
 }
 
 // Pay to public key hash address
-const groupOfP2pkhAddress = (address: Uint8Array): number => {
+function groupOfP2pkhAddress(address: Uint8Array): number {
   if (address.length != 32) {
     throw new Error(`Invalid p2pkh address length: ${address.length}`)
   }
@@ -120,7 +108,7 @@ const groupOfP2pkhAddress = (address: Uint8Array): number => {
 }
 
 // Pay to multiple public key hash address
-const groupOfP2mpkhAddress = (address: Uint8Array): number => {
+function groupOfP2mpkhAddress(address: Uint8Array): number {
   if ((address.length - 2) % 32 != 0) {
     throw new Error(`Invalid p2mpkh address length: ${address.length}`)
   }
@@ -129,7 +117,7 @@ const groupOfP2mpkhAddress = (address: Uint8Array): number => {
 }
 
 // Pay to script hash address
-const groupOfP2shAddress = (address: Uint8Array): number => {
+function groupOfP2shAddress(address: Uint8Array): number {
   return groupOfAddressBytes(address)
 }
 
@@ -163,6 +151,10 @@ export function binToHex(bin: Uint8Array): string {
   return Buffer.from(bin).toString('hex')
 }
 
+export function groupOfPrivateKey(privateKey: string): number {
+  return groupOfAddress(addressFromPublicKey(publicKeyFromPrivateKey(privateKey)))
+}
+
 export function publicKeyFromPrivateKey(privateKey: string): string {
   const key = ec.keyFromPrivate(privateKey)
   return key.getPublic(true, 'hex')

package/webpack.config.js

@@ -51,6 +51,9 @@ module.exports = {
       type: 'umd'
     }
   },
+  experiments: {
+    asyncWebAssembly: true
+  },
   optimization: {
     minimize: true
   }

package/.eslintrc.json

@@ -1,21 +0,0 @@
-{
-  "plugins": ["security", "header"],
-  "extends": [
-    "prettier",
-    "plugin:prettier/recommended",
-    "plugin:security/recommended",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "rules": {
-    "header/header": [2, "scripts/header.js"]
-  },
-  "overrides": [
-    {
-      "files": ["*.ts"],
-      "rules": {
-        "security/detect-non-literal-fs-filename": "off"
-      }
-    }
-  ]
-}

package/LICENSE

@@ -1,165 +0,0 @@
-                   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.

package/contracts/add/add.ral

@@ -1,13 +0,0 @@
-Contract Add(sub: Sub, mut result : U256) {
-    event Add(x: U256, y: U256)
-
-    pub fn add(array: [U256; 2]) -> ([U256; 2]) {
-        return addPrivate(array)
-    }
-
-    fn addPrivate(array: [U256; 2]) -> ([U256; 2]) {
-        emit Add(array[0], array[1])
-        result = result + array[0] + array[1]
-        return [result, sub.sub(array)]
-    }
-}

package/contracts/greeter/greeter.ral

@@ -1,7 +0,0 @@
-Contract Greeter(btcPrice: U256) implements GreeterInterface {
-    @using(readonly = true)
-    pub fn greet() -> U256 {
-        checkCaller!(true, 0)
-        return btcPrice
-    }
-}

package/contracts/greeter/greeter_interface.ral

@@ -1,4 +0,0 @@
-Interface GreeterInterface {
-    @using(readonly = true)
-    pub fn greet() -> U256
-}

package/contracts/greeter_main.ral

@@ -1,7 +0,0 @@
-TxScript GreeterMain(greeterContractId: ByteVec) {
-    let greeter0 = Greeter(greeterContractId)
-    assert!(greeter0.greet() == 1, 0)
-
-    let greeter1 = GreeterInterface(greeterContractId)
-    assert!(greeter1.greet() == 1, 0)
-}

package/contracts/main.ral

@@ -1,4 +0,0 @@
-TxScript Main(addContractId: ByteVec) {
-    let add = Add(addContractId)
-    add.add([2, 1])
-}

package/contracts/sub/sub.ral

@@ -1,10 +0,0 @@
-Contract Sub(mut result : U256) {
-    event Sub(x: U256, y: U256)
-
-    @using(externalCallCheck = false)
-    pub fn sub(array: [U256; 2]) -> U256 {
-        emit Sub(array[0], array[1])
-        result = result + array[0] - array[1]
-        return result
-    }
-}

package/contracts/test/metadata.ral

@@ -1,18 +0,0 @@
-Contract MetaData() {
-    @using(preapprovedAssets = true, assetsInContract = false)
-    pub fn foo() -> () {
-        transferAlph!(callerAddress!(), callerAddress!(), 1 alph)
-        return
-    }
-
-    @using(preapprovedAssets = false, assetsInContract = true)
-    fn bar() -> () {
-        transferAlphToSelf!(selfAddress!(), 1 alph)
-        return
-    }
-
-    @using(readonly = true)
-    fn baz() -> () {
-        return
-    }
-}

package/contracts/test/warnings.ral

@@ -1,8 +0,0 @@
-Contract Warnings(@unused a: U256, b: U256) {
-    const C = 0
-
-    @using(readonly = true)
-    pub fn foo(@unused x: U256, y: U256) -> () {
-        return
-    }
-}

package/dev/user.conf

@@ -1,29 +0,0 @@
-// in most cases, modify the following two lines
-alephium.genesis.allocations = [{address = "1DrDyTr9RpRsQnDnXo2YRiPzPW4ooHX5LLoqXrqfMrpQH", amount = 1000000000000000000000000, lock-duration = 0 seconds}] // 1 million token allocated for your address
-alephium.consensus.num-zeros-at-least-in-hash = 0
-alephium.consensus.uncle-dependency-gap-time = 0 seconds
-alephium.network.leman-hard-fork-timestamp = 1643500800000 // GMT: 30 January 2022 00:00:00
-
-alephium.network.network-id = 4
-alephium.discovery.bootstrap = []
-alephium.wallet.locking-timeout = 99999 minutes
-alephium.mempool.auto-mine-for-dev = true
-alephium.node.event-log.enabled=true
-
-alephium.network.rest-port = 22973
-alephium.network.ws-port = 21973
-alephium.network.miner-api-port = 20973
-alephium.api.network-interface = "0.0.0.0"
-alephium.api.api-key-enabled = false
-alephium.mining.api-interface = "0.0.0.0"
-alephium.network.bind-address  = "0.0.0.0:19973"
-alephium.network.internal-address  = "alephium:19973"
-alephium.network.coordinator-address  = "alephium:19973"
-
-// arbitrary mining addresses
-alephium.mining.miner-addresses = [
-"1FsroWmeJPBhcPiUr37pWXdojRBe6jdey9uukEXk1TheA",
-"1CQvSXsmM5BMFKguKDPpNUfw1idiut8UifLtT8748JdHc",
-"193maApeJWrz9GFwWCfa982ccLARVE9Y1WgKSJaUs7UAx",
-"16fZKYPCZJv2TP3FArA9FLUQceTS9U8xVnSjxFG9MBKyY"
-]

package/dist/scripts/create-project.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/scripts/create-project.js

@@ -1,125 +0,0 @@
-#!/usr/bin/env node
-"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 });
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const process_1 = __importDefault(require("process"));
-const path_1 = __importDefault(require("path"));
-const find_up_1 = __importDefault(require("find-up"));
-const child_process_1 = require("child_process");
-const commander_1 = __importDefault(require("commander"));
-function getPackageRoot() {
-    const packageJsonPath = find_up_1.default.sync('package.json', { cwd: path_1.default.dirname(__filename) });
-    if (packageJsonPath) {
-        return path_1.default.dirname(packageJsonPath);
-    }
-    else {
-        throw new Error('Cannot find `package.json`');
-    }
-}
-function extractProjectType(projectType) {
-    if (typeof projectType === 'undefined') {
-        return 'base';
-    }
-    else if (['base', 'react'].includes(projectType)) {
-        return projectType;
-    }
-    else {
-        console.log(`Invalid project type: ${projectType}, expect: base or react`);
-        process_1.default.exit(1);
-    }
-}
-function extractProjectRoot() {
-    const projectRoot = path_1.default.join(projectParent, projectName);
-    if (fs_extra_1.default.existsSync(projectRoot)) {
-        console.log(`Project ${projectName} already exists. Try a different name.`);
-        console.log();
-        process_1.default.exit(1);
-    }
-    return projectRoot;
-}
-function copy(dir, files) {
-    const packageDevDir = path_1.default.join(packageRoot, dir);
-    const projectDevDir = path_1.default.join(projectRoot, dir);
-    if (!fs_extra_1.default.existsSync(projectDevDir)) {
-        fs_extra_1.default.mkdirSync(projectDevDir);
-    }
-    for (const file of files) {
-        fs_extra_1.default.copyFileSync(path_1.default.join(packageDevDir, file), path_1.default.join(projectDevDir, file));
-    }
-}
-function prepareShared(packageRoot, projectRoot) {
-    console.log('Copying files');
-    console.log(`  from ${packageRoot}`);
-    console.log(`  to ${projectRoot}`);
-    console.log('...');
-    fs_extra_1.default.copySync(path_1.default.join(packageRoot, 'templates/shared'), projectRoot);
-    copy('', ['.editorconfig', '.eslintignore', '.gitattributes', 'LICENSE']);
-    copy('dev', ['user.conf']);
-    copy('scripts', ['start-devnet.js', 'stop-devnet.js']);
-    if (fs_extra_1.default.existsSync(path_1.default.join(packageRoot, 'gitignore'))) {
-        fs_extra_1.default.copySync(path_1.default.join(packageRoot, 'gitignore'), path_1.default.join(projectRoot, '.gitignore'));
-    }
-    else {
-        fs_extra_1.default.copySync(path_1.default.join(packageRoot, '.gitignore'), path_1.default.join(projectRoot, '.gitignore'));
-    }
-    console.log();
-}
-function prepareBase(packageRoot, projectRoot) {
-    prepareShared(packageRoot, projectRoot);
-    copy('contracts', ['greeter_main.ral']);
-    copy('contracts/greeter', ['greeter.ral', 'greeter_interface.ral']);
-    fs_extra_1.default.copySync(path_1.default.join(packageRoot, 'templates/base'), projectRoot);
-}
-function prepareReact(packageRoot, projectRoot, projectName) {
-    console.log('Creating the React app');
-    (0, child_process_1.execSync)(`npx create-react-app ${projectName} --template typescript`);
-    prepareShared(packageRoot, projectRoot);
-    fs_extra_1.default.copySync(path_1.default.join(packageRoot, 'templates/react'), projectRoot);
-    console.log('Initialize the project');
-    (0, child_process_1.execSync)('npm install --save-dev react-app-rewired crypto-browserify stream-browserify buffer process eslint-config-prettier eslint-plugin-header eslint-plugin-prettier eslint-plugin-react', { cwd: projectRoot });
-    (0, child_process_1.execSync)('npm install && npm run prettier', { cwd: projectRoot });
-    console.log();
-}
-const program = new commander_1.default.Command('Create sample project')
-    .arguments('<project-directory>')
-    .option('-t, --template <path-to-template>', 'specify a template for the project: either base or react')
-    .parse(process_1.default.argv);
-const projectName = program.processedArgs[0];
-const projectType = program.opts()['template'];
-const packageRoot = getPackageRoot();
-const projectParent = process_1.default.cwd();
-const projectRoot = extractProjectRoot();
-switch (extractProjectType(projectType)) {
-    case 'base':
-        prepareBase(packageRoot, projectRoot);
-        break;
-    case 'react':
-        prepareReact(packageRoot, projectRoot, projectName);
-        break;
-}
-console.log('✅ Done.');
-console.log();
-console.log('✨ Project is initialized!');
-console.log();
-console.log(`Next step: checkout the readme under <${projectName}>`);
-console.log();

package/dist/scripts/rename-gitignore.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/scripts/start-devnet.d.ts

@@ -1 +0,0 @@
-export {};