@alephium/web3 0.0.3 → 0.1.0-rc.0

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

@@ -0,0 +1,30 @@
+import { ec as EC, SignatureInput } from 'elliptic';
+import * as node from '../api/api-alephium';
+import * as explorer from '../api/api-explorer';
+export declare function convertHttpResponse<T>(response: node.HttpResponse<T, {
+    detail: string;
+}> | explorer.HttpResponse<T, {
+    detail: string;
+}>): T;
+export declare function signatureEncode(signature: EC.Signature): string;
+export declare const signatureDecode: (ec: EC, signature: string) => SignatureInput;
+export declare function isHexString(input: string): boolean;
+export declare const groupOfAddress: (address: string) => number;
+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 publicKeyFromPrivateKey(privateKey: string): string;
+export declare function addressFromPublicKey(publicKey: string): 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): string;
+export declare function stringToHex(str: string): string;
+declare type _Eq<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;
+export declare type Eq<X, Y> = _Eq<{
+    [P in keyof X]: X[P];
+}, {
+    [P in keyof Y]: Y[P];
+}>;
+export declare function assertType<T extends true>(): void;
+export {};

package/dist/{lib → src/utils}/utils.js

@@ -20,25 +20,33 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tokenIdFromAddress = exports.groupOfAddress = exports.getStorage = exports.signatureDecode = exports.signatureEncode = void 0;
+exports.assertType = exports.stringToHex = exports.subContractId = exports.contractIdFromTx = exports.addressFromContractId = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.isHexString = exports.signatureDecode = exports.signatureEncode = exports.convertHttpResponse = void 0;
+const elliptic_1 = require("elliptic");
 const bn_js_1 = __importDefault(require("bn.js"));
+const blakejs_1 = __importDefault(require("blakejs"));
 const bs58_1 = __importDefault(require("./bs58"));
-const storage_node_1 = __importDefault(require("./storage-node"));
-const storage_browser_1 = __importDefault(require("./storage-browser"));
-const constants_1 = require("./constants");
+const buffer_1 = require("buffer/");
+const constants_1 = require("../constants");
 const djb2_1 = __importDefault(require("./djb2"));
-const signatureEncode = (ec, signature) => {
+const ec = new elliptic_1.ec('secp256k1');
+function convertHttpResponse(response) {
+    if (response.error) {
+        throw new Error(response.error.detail);
+    }
+    else {
+        return response.data;
+    }
+}
+exports.convertHttpResponse = convertHttpResponse;
+function signatureEncode(signature) {
     let sNormalized = signature.s;
     if (ec.n && signature.s.cmp(ec.nh) === 1) {
         sNormalized = ec.n.sub(signature.s);
     }
-    const r = signature.r.toArrayLike(Buffer, 'be', 33).slice(1);
-    const s = sNormalized.toArrayLike(Buffer, 'be', 33).slice(1);
-    const xs = new Uint8Array(r.byteLength + s.byteLength);
-    xs.set(new Uint8Array(r), 0);
-    xs.set(new Uint8Array(s), r.byteLength);
-    return Buffer.from(xs).toString('hex');
-};
+    const r = signature.r.toString('hex', 66).slice(2);
+    const s = sNormalized.toString('hex', 66).slice(2);
+    return r + s;
+}
 exports.signatureEncode = signatureEncode;
 // the signature should be in hex string format for 64 bytes
 const signatureDecode = (ec, signature) => {
@@ -56,11 +64,6 @@ const signatureDecode = (ec, signature) => {
     }
 };
 exports.signatureDecode = signatureDecode;
-const getStorage = () => {
-    const isBrowser = typeof window !== 'undefined' && typeof window.document !== 'undefined';
-    return isBrowser ? new storage_browser_1.default() : new storage_node_1.default();
-};
-exports.getStorage = getStorage;
 const xorByte = (intValue) => {
     const byte0 = (intValue >> 24) & 0xff;
     const byte1 = (intValue >> 16) & 0xff;
@@ -68,6 +71,10 @@ const xorByte = (intValue) => {
     const byte3 = intValue & 0xff;
     return (byte0 ^ byte1 ^ byte2 ^ byte3) & 0xff;
 };
+function isHexString(input) {
+    return input.length % 2 === 0 && /[0-9a-f]*$/.test(input);
+}
+exports.isHexString = isHexString;
 var AddressType;
 (function (AddressType) {
     AddressType[AddressType["P2PKH"] = 0] = "P2PKH";
@@ -119,17 +126,74 @@ const groupOfP2mpkhAddress = (address) => {
 const groupOfP2shAddress = (address) => {
     return groupOfAddressBytes(address);
 };
+function contractIdFromAddress(address) {
+    return idFromAddress(address);
+}
+exports.contractIdFromAddress = contractIdFromAddress;
 function tokenIdFromAddress(address) {
+    return idFromAddress(address);
+}
+exports.tokenIdFromAddress = tokenIdFromAddress;
+function idFromAddress(address) {
     const decoded = bs58_1.default.decode(address);
     if (decoded.length == 0)
         throw new Error('Address string is empty');
     const addressType = decoded[0];
     const addressBody = decoded.slice(1);
     if (addressType == AddressType.P2C) {
-        return Buffer.from(addressBody).toString('hex');
+        return addressBody;
     }
     else {
         throw new Error(`Invalid contract address type: ${addressType}`);
     }
 }
-exports.tokenIdFromAddress = tokenIdFromAddress;
+function hexToBinUnsafe(hex) {
+    return buffer_1.Buffer.from(hex, 'hex');
+}
+exports.hexToBinUnsafe = hexToBinUnsafe;
+function binToHex(bin) {
+    return buffer_1.Buffer.from(bin).toString('hex');
+}
+exports.binToHex = binToHex;
+function publicKeyFromPrivateKey(privateKey) {
+    const key = ec.keyFromPrivate(privateKey);
+    return key.getPublic(true, 'hex');
+}
+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);
+}
+exports.addressFromPublicKey = addressFromPublicKey;
+function addressFromContractId(contractId) {
+    const addressType = buffer_1.Buffer.from([AddressType.P2C]);
+    const hash = buffer_1.Buffer.from(hexToBinUnsafe(contractId));
+    const bytes = buffer_1.Buffer.concat([addressType, hash]);
+    return bs58_1.default.encode(bytes);
+}
+exports.addressFromContractId = addressFromContractId;
+function contractIdFromTx(txId, outputIndex) {
+    const txIdBin = hexToBinUnsafe(txId);
+    const data = buffer_1.Buffer.concat([txIdBin, buffer_1.Buffer.from([outputIndex])]);
+    const hash = blakejs_1.default.blake2b(data, undefined, 32);
+    return binToHex(hash);
+}
+exports.contractIdFromTx = contractIdFromTx;
+function subContractId(parentContractId, pathInHex) {
+    const data = buffer_1.Buffer.concat([hexToBinUnsafe(pathInHex), hexToBinUnsafe(parentContractId)]);
+    return binToHex(blakejs_1.default.blake2b(blakejs_1.default.blake2b(data, undefined, 32), undefined, 32));
+}
+exports.subContractId = subContractId;
+function stringToHex(str) {
+    let hex = '';
+    for (let i = 0; i < str.length; i++) {
+        hex += '' + str.charCodeAt(i).toString(16);
+    }
+    return hex;
+}
+exports.stringToHex = stringToHex;
+// eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/no-unused-vars
+function assertType() { }
+exports.assertType = assertType;

package/gitignore

@@ -1,9 +1,10 @@
 node_modules/
 dist/
+build/
+web/
 .vscode
 .DS_Store
 coverage/
-dev/logs
-dev/network*
-dev/alephium*
-artifacts/
+/dev/
+!dev/user.conf
+/artifacts/

package/package.json

@@ -1,27 +1,22 @@
 {
   "name": "@alephium/web3",
-  "version": "0.0.3",
+  "version": "0.1.0-rc.0",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
-  "main": "dist/lib/index.js",
+  "main": "dist/src/index.js",
   "browser": "dist/alephium-web3.min.js",
-  "types": "dist/lib/index.d.ts",
+  "types": "dist/src/index.d.ts",
   "exports": {
-    ".": "./dist/lib/index.js",
-    "./api/alephium": "./dist/api/api-alephium.js",
-    "./api/explorer": "./dist/api/api-explorer.js"
+    ".": "./dist/src/index.js",
+    "./test": "./dist/src/test/index.js"
   },
   "typesVersions": {
     "*": {
-      "api/alephium": [
-        "dist/api/api-alephium"
-      ],
-      "api/explorer": [
-        "dist/api/api-explorer"
+      "test": [
+        "dist/src/test/"
       ]
     }
   },
-  "type": "commonjs",
   "repository": {
     "type": "git",
     "url": "git@github.com:alephium/alephium-web3.git"
@@ -32,42 +27,47 @@
   },
   "author": "Alephium dev <dev@alephium.org>",
   "config": {
-    "alephium_version": "1.3.0-rc9",
-    "explorer_backend_version": "1.6.0-rc8"
+    "alephium_version": "1.4.0-rc2",
+    "explorer_backend_version": "1.7.0-leman1"
   },
   "scripts": {
-    "build": "rm -rf dist && npx tsc --build . && webpack",
+    "build": "rm -rf dist/* && npx tsc --build . && webpack",
+    "bundle": "webpack",
     "update-schemas": "npm run update-schema:alephium && npm run update-schema:explorer",
-    "update-schema:alephium": "npx swagger-typescript-api -t ./api -o ./api -n api-alephium.ts -p https://raw.githubusercontent.com/alephium/alephium/v${npm_package_config_alephium_version}/api/src/main/resources/openapi.json",
-    "update-schema:explorer": "npx swagger-typescript-api -t ./api -o ./api -n api-explorer.ts -p https://raw.githubusercontent.com/alephium/explorer-backend/v${npm_package_config_explorer_backend_version}/app/src/main/resources/explorer-backend-openapi.json",
+    "update-schema:alephium": "npx swagger-typescript-api -t ./configs -o ./src/api -n api-alephium.ts -p https://raw.githubusercontent.com/alephium/alephium/v${npm_package_config_alephium_version}/api/src/main/resources/openapi.json",
+    "update-schema:explorer": "npx swagger-typescript-api -t ./configs -o ./src/api -n api-explorer.ts -p https://raw.githubusercontent.com/alephium/explorer-backend/v${npm_package_config_explorer_backend_version}/app/src/main/resources/explorer-backend-openapi.json",
     "check-versions": "node scripts/check-versions.js ${npm_package_config_alephium_version} ${npm_package_config_explorer_backend_version}",
     "dev": "tsnd --respawn lib/index.ts",
-    "lint": "eslint . --ext .ts",
-    "lint:fix": "eslint . --fix --ext .ts",
-    "jest": "jest --useStderr --silent=false --verbose=true --config jestconfig.json",
-    "test": "npm run build && npm run jest",
-    "test:watch": "npm run build && npm run jest -- --watch",
+    "lint": "eslint . --ext ts",
+    "lint:fix": "eslint . --fix --ext ts",
+    "test": "jest -i --config ./configs/jest.config.ts",
+    "test:client": "jest -i --config ./configs/jest-client.config.ts",
+    "test:unit": "jest -i --config ./configs/jest-unit.config.ts",
+    "test:watch": "npm run test -- --watch --coverage=false",
+    "test:watch:unit": "npm run test:unit -- --watch --coverage=false",
+    "test:watch:client": "npm run test:client -- --watch --coverage=false",
     "prepublishOnly": "npm run build",
     "prepack": "node scripts/rename-gitignore.js .gitignore gitignore",
     "postpack": "node scripts/rename-gitignore.js gitignore .gitignore",
-    "format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
-    "devnet:start": "node scripts/start-devnet.js ${npm_package_config_alephium_version}",
-    "devnet:restart": "npm run devnet:start",
-    "devnet:stop": "node scripts/stop-devnet.js"
+    "prettier": "prettier --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
+    "start-devnet": "node scripts/start-devnet.js ${npm_package_config_alephium_version}",
+    "restart-devnet": "npm run start-devnet",
+    "stop-devnet": "node scripts/stop-devnet.js"
   },
+  "type": "commonjs",
   "bin": {
-    "alephium": "dist/cli/create-project.js"
+    "alephium": "dist/scripts/create-project.js"
   },
   "dependencies": {
-    "base-x": "^4.0.0",
-    "bcfg": "~0.1.6",
-    "bip32": "^2.0.6",
-    "bip39": "^3.0.4",
-    "blakejs": "^1.1.1",
-    "chalk": "^4.1.2",
+    "@scure/bip32": "1.0.1",
+    "base-x": "4.0.0",
+    "bip39": "3.0.4",
+    "blakejs": "1.2.1",
+    "commander": "^9.1.0",
     "cross-fetch": "^3.1.5",
-    "crypto-js": "^4.1.1",
-    "elliptic": "^6.5.4",
+    "crypto-js": "4.1.1",
+    "elliptic": "6.5.4",
+    "eventemitter3": "^4.0.7",
     "find-up": "^2.1.0",
     "fs-extra": "^10.0.1"
   },
@@ -76,7 +76,7 @@
     "@types/elliptic": "^6.4.13",
     "@types/find-up": "^2.1.0",
     "@types/fs-extra": "^9.0.13",
-    "@types/jest": "^27.0.1",
+    "@types/jest": "^27.5.1",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^16.7.8",
     "@types/rewire": "^2.5.28",
@@ -84,23 +84,30 @@
     "@typescript-eslint/parser": "^4.30.0",
     "babel-eslint": "^10.1.0",
     "buffer": "^6.0.3",
+    "clean-webpack-plugin": "4.0.0",
     "crypto-browserify": "^3.12.0",
     "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.1.0",
+    "eslint-plugin-react": "^7.29.4",
+    "eslint-plugin-security": "1.4.0",
+    "html-webpack-plugin": "5.5.0",
+    "jest": "^28.1.0",
     "jest-localstorage-mock": "^2.4.18",
     "jest-websocket-mock": "^2.2.1",
     "mock-fs": "^5.1.2",
     "mock-socket": "^9.0.8",
     "prettier": "^2.3.2",
+    "process": "^0.11.10",
+    "react-app-rewired": "^2.2.1",
     "rewire": "^6.0.0",
     "shelljs": "^0.8.5",
     "stream-browserify": "^3.0.0",
     "swagger-typescript-api": "^9.2.0",
-    "ts-jest": "^27.0.5",
-    "ts-node": "^10.2.1",
+    "terser-webpack-plugin": "^5.3.1",
+    "ts-jest": "^28.0.2",
+    "ts-node": "^10.7.0",
     "tslib": "^2.3.1",
     "typescript": "^4.4.2",
     "webpack": "^5.72.0",
@@ -109,5 +116,14 @@
   "engines": {
     "node": ">=14.0.0",
     "npm": ">=7.0.0"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "tabWidth": 2,
+    "useTabs": false,
+    "semi": false,
+    "singleQuote": true,
+    "bracketSameLine": false,
+    "trailingComma": "none"
   }
 }

package/scripts/create-project.ts

@@ -0,0 +1,136 @@
+#!/usr/bin/env node
+/*
+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/>.
+*/
+
+import fsExtra from 'fs-extra'
+import process from 'process'
+import path from 'path'
+import findup from 'find-up'
+import { execSync } from 'child_process'
+import commander from 'commander'
+
+function getPackageRoot(): string {
+  const packageJsonPath = findup.sync('package.json', { cwd: path.dirname(__filename) })
+
+  if (packageJsonPath) {
+    return path.dirname(packageJsonPath)
+  } else {
+    throw new Error('Cannot find `package.json`')
+  }
+}
+
+function extractProjectType(projectType: string): string {
+  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.exit(1)
+  }
+}
+
+function extractProjectRoot(): string {
+  const projectRoot = path.join(projectParent, projectName)
+  if (fsExtra.existsSync(projectRoot)) {
+    console.log(`Project ${projectName} already exists. Try a different name.`)
+    console.log()
+    process.exit(1)
+  }
+  return projectRoot
+}
+
+function copy(dir: string, files: string[]) {
+  const packageDevDir = path.join(packageRoot, dir)
+  const projectDevDir = path.join(projectRoot, dir)
+  if (!fsExtra.existsSync(projectDevDir)) {
+    fsExtra.mkdirSync(projectDevDir)
+  }
+  for (const file of files) {
+    fsExtra.copyFileSync(path.join(packageDevDir, file), path.join(projectDevDir, file))
+  }
+}
+
+function prepareShared(packageRoot: string, projectRoot: string) {
+  console.log('Copying files')
+  console.log(`  from ${packageRoot}`)
+  console.log(`  to ${projectRoot}`)
+  console.log('...')
+
+  fsExtra.copySync(path.join(packageRoot, 'templates/shared'), projectRoot)
+  copy('', ['.editorconfig', '.eslintignore', '.gitattributes', 'LICENSE'])
+  copy('dev', ['user.conf'])
+  copy('scripts', ['start-devnet.js', 'stop-devnet.js'])
+  if (fsExtra.existsSync(path.join(packageRoot, 'gitignore'))) {
+    fsExtra.copySync(path.join(packageRoot, 'gitignore'), path.join(projectRoot, '.gitignore'))
+  } else {
+    fsExtra.copySync(path.join(packageRoot, '.gitignore'), path.join(projectRoot, '.gitignore'))
+  }
+
+  console.log()
+}
+
+function prepareBase(packageRoot: string, projectRoot: string) {
+  prepareShared(packageRoot, projectRoot)
+  copy('contracts', ['greeter.ral', 'greeter_interface.ral', 'greeter_main.ral'])
+  fsExtra.copySync(path.join(packageRoot, 'templates/base'), projectRoot)
+}
+
+function prepareReact(packageRoot: string, projectRoot: string, projectName: string) {
+  console.log('Creating the React app')
+  execSync(`npx create-react-app ${projectName} --template typescript`)
+
+  prepareShared(packageRoot, projectRoot)
+  fsExtra.copySync(path.join(packageRoot, 'templates/react'), projectRoot)
+
+  console.log('Initialize the project')
+  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 }
+  )
+  execSync('npm install && npm run prettier', { cwd: projectRoot })
+  console.log()
+}
+
+const program = new commander.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.argv)
+
+const projectName = program.processedArgs[0]
+const projectType = program.opts()['template']
+
+const packageRoot = getPackageRoot()
+const projectParent = process.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/scripts/header.js

@@ -0,0 +1,17 @@
+/*
+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/>.
+*/

package/scripts/start-devnet.js

@@ -71,10 +71,10 @@ function launchDevnet(devDir, jarFile) {
   fs.writeFileSync(devDir + path.sep + 'alephium.pid', p.pid.toString(), { falg: 'w' })
 }
 
-const testWallet = 'alephium-js-sdk-test-only-wallet'
+const testWallet = 'alephium-web3-test-only-wallet'
 const password = 'alph'
 const mnemonic =
-  'vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault vault'
+  'vault alarm sad mass witness property virus style good flower rice alpha viable evidence run glare pretty scout evil judge enroll refuse another lava'
 
 async function prepareWallet() {
   const wallets = await fetch('http://127.0.0.1:22973/wallets', { method: 'Get' }).then((res) => res.json())
@@ -95,7 +95,7 @@ async function createWallet() {
 
 async function unlockWallet() {
   console.log('Unlock the test wallet')
-  await fetch('http://127.0.0.1:22973/wallets/alephium-js-sdk-test-only-wallet/unlock', {
+  await fetch('http://127.0.0.1:22973/wallets/alephium-web3-test-only-wallet/unlock', {
     method: 'POST',
     body: '{ "password": "alph" }'
   })